mcs/class/System/Mono.Btls/MonoBtlsContext.cs

   1 //
   2 // MonoBtlsContext.cs
   3 //
   4 // Author:
   5 //       Martin Baulig <martin.baulig@xamarin.com>
   6 //
   7 // Copyright (c) 2016 Xamarin Inc. (http://www.xamarin.com)
   8 //
   9 // Permission is hereby granted, free of charge, to any person obtaining a copy
  10 // of this software and associated documentation files (the "Software"), to deal
  11 // in the Software without restriction, including without limitation the rights
  12 // to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
  13 // copies of the Software, and to permit persons to whom the Software is
  14 // furnished to do so, subject to the following conditions:
  15 //
  16 // The above copyright notice and this permission notice shall be included in
  17 // all copies or substantial portions of the Software.
  18 //
  19 // THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
  20 // IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
  21 // FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
  22 // AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
  23 // LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
  24 // OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
  25 // THE SOFTWARE.
  26 #if SECURITY_DEP && MONO_FEATURE_BTLS
  27 #if MONO_SECURITY_ALIAS
  28 extern alias MonoSecurity;
  29 #endif
  30
  31 using System;
  32 using System.IO;
  33 using System.Threading;
  34 using System.Threading.Tasks;
  35 using System.Security.Cryptography.X509Certificates;
  36 using System.Security.Authentication;
  37 using System.Runtime.InteropServices;
  38
  39 #if MONO_SECURITY_ALIAS
  40 using MonoSecurity::Mono.Security.Interface;
  41 #else
  42 using Mono.Security.Interface;
  43 #endif
  44
  45 using MNS = Mono.Net.Security;
  46
  47 namespace Mono.Btls
  48 {
  49         class MonoBtlsContext : MNS.MobileTlsContext, IMonoBtlsBioMono
  50         {
  51                 X509Certificate remoteCertificate;
  52                 X509Certificate clientCertificate;
  53                 X509CertificateImplBtls nativeServerCertificate;
  54                 X509CertificateImplBtls nativeClientCertificate;
  55                 MonoBtlsSslCtx ctx;
  56                 MonoBtlsSsl ssl;
  57                 MonoBtlsBio bio;
  58                 MonoBtlsBio errbio;
  59
  60                 MonoTlsConnectionInfo connectionInfo;
  61                 bool certificateValidated;
  62                 bool isAuthenticated;
  63                 bool connected;
  64
  65                 public MonoBtlsContext (
  66                         MNS.MobileAuthenticatedStream parent,
  67                         bool serverMode, string targetHost,
  68                         SslProtocols enabledProtocols, X509Certificate serverCertificate,
  69                         X509CertificateCollection clientCertificates, bool askForClientCert)
  70                         : base (parent, serverMode, targetHost, enabledProtocols,
  71                                 serverCertificate, clientCertificates, askForClientCert)
  72                 {
  73                         if (serverMode)
  74                                 nativeServerCertificate = GetPrivateCertificate (serverCertificate);
  75                 }
  76
  77                 static X509CertificateImplBtls GetPrivateCertificate (X509Certificate certificate)
  78                 {
  79                         var impl = certificate.Impl as X509CertificateImplBtls;
  80                         if (impl != null)
  81                                 return (X509CertificateImplBtls)impl.Clone ();
  82
  83                         var password = Guid.NewGuid ().ToString ();
  84                         var buffer = certificate.Export (X509ContentType.Pfx, password);
  85
  86                         impl = new X509CertificateImplBtls ();
  87                         impl.Import (buffer, password, X509KeyStorageFlags.DefaultKeySet);
  88                         return impl;
  89                 }
  90
  91                 new public MonoBtlsProvider Provider {
  92                         get { return (MonoBtlsProvider)base.Provider; }
  93                 }
  94
  95                 int VerifyCallback (MonoBtlsX509StoreCtx storeCtx)
  96                 {
  97                         using (var chainImpl = new X509ChainImplBtls (storeCtx))
  98                         using (var managedChain = new X509Chain (chainImpl)) {
  99                                 var leaf = managedChain.ChainElements[0].Certificate;
 100                                 var result = ValidateCertificate (leaf, managedChain);
 101                                 certificateValidated = true;
 102                                 return result ? 1 : 0;
 103                         }
 104                 }
 105
 106                 int SelectCallback ()
 107                 {
 108                         Debug ("SELECT CALLBACK!");
 109
 110                         GetPeerCertificate ();
 111                         if (remoteCertificate == null)
 112                                 throw new TlsException (AlertDescription.InternalError, "Cannot request client certificate before receiving one from the server.");
 113
 114                         var clientCert = SelectClientCertificate (remoteCertificate, null);
 115                         Debug ("SELECT CALLBACK #1: {0}", clientCert);
 116                         if (clientCert == null)
 117                                 return 1;
 118
 119                         nativeClientCertificate = GetPrivateCertificate (clientCert);
 120                         Debug ("SELECT CALLBACK #2: {0}", nativeClientCertificate);
 121                         clientCertificate = new X509Certificate (nativeClientCertificate);
 122                         SetPrivateCertificate (nativeClientCertificate);
 123                         return 1;
 124                 }
 125
 126                 public override void StartHandshake ()
 127                 {
 128                         InitializeConnection ();
 129
 130                         ssl = new MonoBtlsSsl (ctx);
 131
 132                         bio = new MonoBtlsBioMono (this);
 133                         ssl.SetBio (bio);
 134
 135                         if (IsServer) {
 136                                 SetPrivateCertificate (nativeServerCertificate);
 137                         } else {
 138                                 ssl.SetServerName (ServerName);
 139                         }
 140                 }
 141
 142                 void SetPrivateCertificate (X509CertificateImplBtls privateCert)
 143                 {
 144                         Debug ("SetPrivateCertificate: {0}", privateCert);
 145                         ssl.SetCertificate (privateCert.X509);
 146                         ssl.SetPrivateKey (privateCert.NativePrivateKey);
 147                         var intermediate = privateCert.IntermediateCertificates;
 148                         if (intermediate == null)
 149                                 return;
 150                         for (int i = 0; i < intermediate.Count; i++) {
 151                                 var impl = (X509CertificateImplBtls)intermediate [i];
 152                                 Debug ("SetPrivateCertificate - add intermediate: {0}", impl);
 153                                 ssl.AddIntermediateCertificate (impl.X509);
 154                         }
 155                 }
 156
 157                 static Exception GetException (MonoBtlsSslError status)
 158                 {
 159                         string file;
 160                         int line;
 161                         var error = MonoBtlsError.GetError (out file, out line);
 162                         if (error == 0)
 163                                 return new MonoBtlsException (status);
 164
 165                         var text = MonoBtlsError.GetErrorString (error);
 166
 167                         string message;
 168                         if (file != null)
 169                                 message = string.Format ("{0} {1}\n  at {2}:{3}", status, text, file, line);
 170                         else
 171                                 message = string.Format ("{0} {1}", status, text);
 172                         return new MonoBtlsException (message);
 173                 }
 174
 175                 public override bool ProcessHandshake ()
 176                 {
 177                         var done = false;
 178                         while (!done) {
 179                                 Debug ("ProcessHandshake");
 180                                 MonoBtlsError.ClearError ();
 181                                 var status = DoProcessHandshake ();
 182                                 Debug ("ProcessHandshake #1: {0}", status);
 183
 184                                 switch (status) {
 185                                 case MonoBtlsSslError.None:
 186                                         if (connected)
 187                                                 done = true;
 188                                         else
 189                                                 connected = true;
 190                                         break;
 191                                 case MonoBtlsSslError.WantRead:
 192                                 case MonoBtlsSslError.WantWrite:
 193                                         return false;
 194                                 default:
 195                                         throw GetException (status);
 196                                 }
 197                         }
 198
 199                         ssl.PrintErrors ();
 200
 201                         return true;
 202                 }
 203
 204                 MonoBtlsSslError DoProcessHandshake ()
 205                 {
 206                         if (connected)
 207                                 return ssl.Handshake ();
 208                         else if (IsServer)
 209                                 return ssl.Accept ();
 210                         else
 211                                 return ssl.Connect ();
 212                 }
 213
 214                 public override void FinishHandshake ()
 215                 {
 216                         InitializeSession ();
 217
 218                         isAuthenticated = true;
 219                 }
 220
 221                 void InitializeConnection ()
 222                 {
 223                         ctx = new MonoBtlsSslCtx ();
 224
 225 #if MARTIN_DEBUG
 226                         errbio = MonoBtlsBio.CreateMonoStream (Console.OpenStandardError ());
 227                         ctx.SetDebugBio (errbio);
 228 #endif
 229
 230                         MonoBtlsProvider.SetupCertificateStore (ctx.CertificateStore, Settings, IsServer);
 231
 232                         if (!IsServer || AskForClientCertificate)
 233                                 ctx.SetVerifyCallback (VerifyCallback, false);
 234                         if (!IsServer)
 235                                 ctx.SetSelectCallback (SelectCallback);
 236
 237                         ctx.SetVerifyParam (MonoBtlsProvider.GetVerifyParam (Settings, ServerName, IsServer));
 238
 239                         TlsProtocolCode minProtocol, maxProtocol;
 240                         GetProtocolVersions (out minProtocol, out maxProtocol);
 241
 242                         ctx.SetMinVersion ((int)minProtocol);
 243                         ctx.SetMaxVersion ((int)maxProtocol);
 244
 245                         if (Settings != null && Settings.EnabledCiphers != null) {
 246                                 var ciphers = new short [Settings.EnabledCiphers.Length];
 247                                 for (int i = 0; i < ciphers.Length; i++)
 248                                         ciphers [i] = (short)Settings.EnabledCiphers [i];
 249                                 ctx.SetCiphers (ciphers, true);
 250                         }
 251                 }
 252
 253                 void GetPeerCertificate ()
 254                 {
 255                         if (remoteCertificate != null)
 256                                 return;
 257                         using (var remoteCert = ssl.GetPeerCertificate ()) {
 258                                 if (remoteCert != null)
 259                                         remoteCertificate = MonoBtlsProvider.CreateCertificate (remoteCert);
 260                         }
 261                 }
 262
 263                 void InitializeSession ()
 264                 {
 265                         GetPeerCertificate ();
 266
 267                         if (IsServer && AskForClientCertificate && !certificateValidated) {
 268                                 if (!ValidateCertificate (null, null))
 269                                         throw new TlsException (AlertDescription.CertificateUnknown);
 270                         }
 271
 272                         var cipher = (CipherSuiteCode)ssl.GetCipher ();
 273                         var protocol = (TlsProtocolCode)ssl.GetVersion ();
 274                         var serverName = ssl.GetServerName ();
 275                         Debug ("GET CONNECTION INFO: {0:x}:{0} {1:x}:{1} {2}", cipher, protocol, (TlsProtocolCode)protocol);
 276
 277                         connectionInfo = new MonoTlsConnectionInfo {
 278                                 CipherSuiteCode = cipher,
 279                                 ProtocolVersion = GetProtocol (protocol),
 280                                 PeerDomainName = serverName
 281                         };
 282                 }
 283
 284                 static TlsProtocols GetProtocol (TlsProtocolCode protocol)
 285                 {
 286                         switch (protocol) {
 287                         case TlsProtocolCode.Tls10:
 288                                 return TlsProtocols.Tls10;
 289                         case TlsProtocolCode.Tls11:
 290                                 return TlsProtocols.Tls11;
 291                         case TlsProtocolCode.Tls12:
 292                                 return TlsProtocols.Tls12;
 293                         default:
 294                                 throw new NotSupportedException ();
 295                         }
 296                 }
 297
 298                 public override void Flush ()
 299                 {
 300                         throw new NotImplementedException ();
 301                 }
 302
 303                 public override int Read (byte[] buffer, int offset, int size, out bool wantMore)
 304                 {
 305                         Debug ("Read: {0} {1} {2}", buffer.Length, offset, size);
 306
 307                         var data = Marshal.AllocHGlobal (size);
 308                         if (data == IntPtr.Zero)
 309                                 throw new OutOfMemoryException ();
 310
 311                         try {
 312                                 MonoBtlsError.ClearError ();
 313                                 var status = ssl.Read (data, ref size);
 314                                 Debug ("Read done: {0} {1}", status, size);
 315
 316                                 if (status == MonoBtlsSslError.WantRead) {
 317                                         wantMore = true;
 318                                         return 0;
 319                                 } else if (status == MonoBtlsSslError.ZeroReturn) {
 320                                         wantMore = false;
 321                                         return size;
 322                                 } else if (status != MonoBtlsSslError.None) {
 323                                         throw GetException (status);
 324                                 }
 325
 326                                 if (size > 0)
 327                                         Marshal.Copy (data, buffer, offset, size);
 328
 329                                 wantMore = false;
 330                                 return size;
 331                         } finally {
 332                                 Marshal.FreeHGlobal (data);
 333                         }
 334                 }
 335
 336                 public override int Write (byte[] buffer, int offset, int size, out bool wantMore)
 337                 {
 338                         Debug ("Write: {0} {1} {2}", buffer.Length, offset, size);
 339
 340                         var data = Marshal.AllocHGlobal (size);
 341                         if (data == IntPtr.Zero)
 342                                 throw new OutOfMemoryException ();
 343
 344                         try {
 345                                 MonoBtlsError.ClearError ();
 346                                 Marshal.Copy (buffer, offset, data, size);
 347                                 var status = ssl.Write (data, ref size);
 348                                 Debug ("Write done: {0} {1}", status, size);
 349
 350                                 if (status == MonoBtlsSslError.WantWrite) {
 351                                         wantMore = true;
 352                                         return 0;
 353                                 } else if (status != MonoBtlsSslError.None) {
 354                                         throw GetException (status);
 355                                 }
 356
 357                                 wantMore = false;
 358                                 return size;
 359                         } finally {
 360                                 Marshal.FreeHGlobal (data);
 361                         }
 362                 }
 363
 364                 public override void Shutdown ()
 365                 {
 366                         Debug ("Shutdown!");
 367 //                      ssl.SetQuietShutdown ();
 368                         ssl.Shutdown ();
 369                 }
 370
 371                 void Dispose<T> (ref T disposable)
 372                         where T : class, IDisposable
 373                 {
 374                         try {
 375                                 if (disposable != null)
 376                                         disposable.Dispose ();
 377                         } catch {
 378                                 ;
 379                         } finally {
 380                                 disposable = null;
 381                         }
 382                 }
 383
 384                 protected override void Dispose (bool disposing)
 385                 {
 386                         try {
 387                                 if (disposing) {
 388                                         Dispose (ref ssl);
 389                                         Dispose (ref ctx);
 390                                         Dispose (ref remoteCertificate);
 391                                         Dispose (ref nativeServerCertificate);
 392                                         Dispose (ref nativeClientCertificate);
 393                                         Dispose (ref clientCertificate);
 394                                         Dispose (ref bio);
 395                                         Dispose (ref errbio);
 396                                 }
 397                         } finally {
 398                                 base.Dispose (disposing);
 399                         }
 400                 }
 401
 402                 int IMonoBtlsBioMono.Read (byte[] buffer, int offset, int size, out bool wantMore)
 403                 {
 404                         Debug ("InternalRead: {0} {1}", offset, size);
 405                         var ret = Parent.InternalRead (buffer, offset, size, out wantMore);
 406                         Debug ("InternalReadDone: {0} {1}", ret, wantMore);
 407                         return ret;
 408                 }
 409
 410                 bool IMonoBtlsBioMono.Write (byte[] buffer, int offset, int size)
 411                 {
 412                         Debug ("InternalWrite: {0} {1}", offset, size);
 413                         var ret = Parent.InternalWrite (buffer, offset, size);
 414                         Debug ("InternalWrite done: {0}", ret);
 415                         return ret;
 416                 }
 417
 418                 void IMonoBtlsBioMono.Flush ()
 419                 {
 420                         ;
 421                 }
 422
 423                 void IMonoBtlsBioMono.Close ()
 424                 {
 425                         ;
 426                 }
 427
 428                 public override bool HasContext {
 429                         get { return ssl != null && ssl.IsValid; }
 430                 }
 431                 public override bool IsAuthenticated {
 432                         get { return isAuthenticated; }
 433                 }
 434                 public override MonoTlsConnectionInfo ConnectionInfo {
 435                         get { return connectionInfo; }
 436                 }
 437                 internal override bool IsRemoteCertificateAvailable {
 438                         get { return remoteCertificate != null; }
 439                 }
 440                 internal override X509Certificate LocalClientCertificate {
 441                         get { return clientCertificate; }
 442                 }
 443                 public override X509Certificate RemoteCertificate {
 444                         get { return remoteCertificate; }
 445                 }
 446                 public override TlsProtocols NegotiatedProtocol {
 447                         get { return connectionInfo.ProtocolVersion; }
 448                 }
 449         }
 450 }
 451 #endif