mcs/class/System/Mono.Net.Security/MonoTlsProviderFactory.cs

   1 //
   2 // MonoTlsProviderFactory.cs
   3 //
   4 // Author:
   5 //       Martin Baulig <martin.baulig@xamarin.com>
   6 //
   7 // Copyright (c) 2015 Xamarin, Inc.
   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
  27 #if SECURITY_DEP
  28 #if MONO_SECURITY_ALIAS
  29 extern alias MonoSecurity;
  30 using MSI = MonoSecurity::Mono.Security.Interface;
  31 using MX = MonoSecurity::Mono.Security.X509;
  32 #else
  33 using MSI = Mono.Security.Interface;
  34 using MX = Mono.Security.X509;
  35 #endif
  36 using System.Security.Cryptography.X509Certificates;
  37 #endif
  38
  39 using System;
  40 using System.Net;
  41 using System.Collections.Generic;
  42
  43 #if !MOBILE
  44 using System.Reflection;
  45 #endif
  46
  47 namespace Mono.Net.Security
  48 {
  49         /*
  50          * Keep in sync with Mono.Security/Mono.Security.Interface/MonoTlsProvider.cs.
  51          *
  52          */
  53         static partial class MonoTlsProviderFactory
  54         {
  55                 #region Internal API
  56
  57                 /*
  58                  * APIs in this section are for consumption within System.dll only - do not access via
  59                  * reflection or from friend assemblies.
  60                  *
  61                  * @IMonoTlsProvider is defined as empty interface outside 'SECURITY_DEP', so we don't need
  62                  * this conditional here.
  63                  */
  64
  65                 internal static IMonoTlsProvider GetProviderInternal ()
  66                 {
  67                         lock (locker) {
  68                                 if (currentProvider != null)
  69                                         return currentProvider;
  70
  71                                 try {
  72                                         defaultProvider = GetDefaultProviderInternal ();
  73                                 } catch (Exception ex) {
  74                                         throw new NotSupportedException ("TLS Support not available.", ex);
  75                                 }
  76
  77                                 if (defaultProvider == null)
  78                                         throw new NotSupportedException ("TLS Support not available.");
  79
  80                                 currentProvider = defaultProvider;
  81                                 return currentProvider;
  82                         }
  83                 }
  84
  85                 internal static IMonoTlsProvider GetDefaultProviderInternal ()
  86                 {
  87                         lock (locker) {
  88                                 if (defaultProvider != null)
  89                                         return defaultProvider;
  90
  91                                 try {
  92                                         defaultProvider = CreateDefaultProvider ();
  93                                 } catch (Exception ex) {
  94                                         throw new NotSupportedException ("TLS Support not available.", ex);
  95                                 }
  96
  97                                 if (defaultProvider == null)
  98                                         throw new NotSupportedException ("TLS Support not available.");
  99
 100                                 return defaultProvider;
 101                         }
 102                 }
 103
 104                 static IMonoTlsProvider CreateDefaultProvider ()
 105                 {
 106 #if SECURITY_DEP
 107                         MSI.MonoTlsProvider provider = null;
 108 #if MONO_FEATURE_NEW_SYSTEM_SOURCE
 109                         /*
 110                          * This is a hack, which is used in the Mono.Security.Providers.NewSystemSource
 111                          * assembly, which will provide a "fake" System.dll.  Use the public Mono.Security
 112                          * API to get the "real" System.dll's provider via reflection, then wrap it with
 113                          * the "fake" version's perceived view.
 114                          *
 115                          * NewSystemSource needs to compile MonoTlsProviderFactory.cs, IMonoTlsProvider.cs,
 116                          * MonoTlsProviderWrapper.cs and CallbackHelpers.cs from this directory and only these.
 117                          */
 118                         provider = MSI.MonoTlsProviderFactory.GetProvider ();
 119 #else
 120                         provider = CreateDefaultProviderImpl ();
 121 #endif
 122                         if (provider != null)
 123                                 return new Private.MonoTlsProviderWrapper (provider);
 124 #endif
 125                         return null;
 126                 }
 127
 128                 static object locker = new object ();
 129                 static IMonoTlsProvider defaultProvider;
 130                 static IMonoTlsProvider currentProvider;
 131
 132                 #endregion
 133
 134 #if SECURITY_DEP && !MONO_FEATURE_NEW_SYSTEM_SOURCE
 135
 136                 static Dictionary<string,string> providerRegistration;
 137
 138                 static Type LookupProviderType (string name, bool throwOnError)
 139                 {
 140                         lock (locker) {
 141                                 InitializeProviderRegistration ();
 142                                 string typeName;
 143                                 if (!providerRegistration.TryGetValue (name, out typeName)) {
 144                                         if (throwOnError)
 145                                                 throw new NotSupportedException (string.Format ("No such TLS Provider: `{0}'.", name));
 146                                         return null;
 147                                 }
 148                                 var type = Type.GetType (typeName, false);
 149                                 if (type == null && throwOnError)
 150                                         throw new NotSupportedException (string.Format ("Could not find TLS Provider: `{0}'.", typeName));
 151                                 return type;
 152                         }
 153                 }
 154
 155                 static MSI.MonoTlsProvider LookupProvider (string name, bool throwOnError)
 156                 {
 157                         var type = LookupProviderType (name, throwOnError);
 158                         if (type == null)
 159                                 return null;
 160
 161                         try {
 162                                 return (MSI.MonoTlsProvider)Activator.CreateInstance (type, true);
 163                         } catch (Exception ex) {
 164                                 throw new NotSupportedException (string.Format ("Unable to instantiate TLS Provider `{0}'.", type), ex);
 165                         }
 166                 }
 167
 168                 static void InitializeProviderRegistration ()
 169                 {
 170                         lock (locker) {
 171                                 if (providerRegistration != null)
 172                                         return;
 173                                 providerRegistration = new Dictionary<string,string> ();
 174                                 providerRegistration.Add ("legacy", "Mono.Net.Security.Private.MonoLegacyTlsProvider");
 175                                 providerRegistration.Add ("newtls", "Mono.Security.Providers.NewTls.NewTlsProvider, Mono.Security.Providers.NewTls, Version=4.0.0.0, Culture=neutral, PublicKeyToken=0738eb9f132ed756");
 176                                 providerRegistration.Add ("oldtls", "Mono.Security.Providers.OldTls.OldTlsProvider, Mono.Security.Providers.OldTls, Version=4.0.0.0, Culture=neutral, PublicKeyToken=0738eb9f132ed756");
 177 #if HAVE_BTLS
 178                                 if (Mono.Btls.MonoBtlsProvider.IsSupported ())
 179                                         providerRegistration.Add ("btls", "Mono.Btls.MonoBtlsProvider");
 180 #endif
 181                                 X509Helper2.Initialize ();
 182                         }
 183                 }
 184
 185 #if MOBILE_STATIC || !MOBILE
 186                 static MSI.MonoTlsProvider TryDynamicLoad ()
 187                 {
 188                         var variable = Environment.GetEnvironmentVariable ("MONO_TLS_PROVIDER");
 189                         if (variable == null)
 190                                 return null;
 191
 192                         if (string.Equals (variable, "default", StringComparison.OrdinalIgnoreCase))
 193                                 return null;
 194
 195                         return LookupProvider (variable, true);
 196                 }
 197
 198                 static MSI.MonoTlsProvider CreateDefaultProviderImpl ()
 199                 {
 200                         var provider = TryDynamicLoad ();
 201                         if (provider != null)
 202                                 return provider;
 203
 204                         return new Private.MonoLegacyTlsProvider ();
 205                 }
 206 #endif
 207
 208                 #region Mono.Security visible API
 209
 210                 /*
 211                  * "Public" section, intended to be consumed via reflection.
 212                  *
 213                  * Mono.Security.dll provides a public wrapper around these.
 214                  */
 215
 216                 internal static MSI.MonoTlsProvider GetProvider ()
 217                 {
 218                         var provider = GetProviderInternal ();
 219                         if (provider == null)
 220                                 throw new NotSupportedException ("No TLS Provider available.");
 221
 222                         return provider.Provider;
 223                 }
 224
 225                 internal static MSI.MonoTlsProvider GetDefaultProvider ()
 226                 {
 227                         var provider = GetDefaultProviderInternal ();
 228                         if (provider == null)
 229                                 throw new NotSupportedException ("No TLS Provider available.");
 230
 231                         return provider.Provider;
 232                 }
 233
 234                 internal static MSI.MonoTlsProvider GetProvider (string name)
 235                 {
 236                         return LookupProvider (name, false);
 237                 }
 238
 239                 internal static bool HasProvider {
 240                         get {
 241                                 lock (locker) {
 242                                         return currentProvider != null;
 243                                 }
 244                         }
 245                 }
 246
 247                 internal static void SetDefaultProvider (string name)
 248                 {
 249                         lock (locker) {
 250                                 var provider = LookupProvider (name, true);
 251                                 currentProvider = new Private.MonoTlsProviderWrapper (provider);
 252                         }
 253                 }
 254
 255                 internal static HttpWebRequest CreateHttpsRequest (Uri requestUri, MSI.MonoTlsProvider provider, MSI.MonoTlsSettings settings)
 256                 {
 257                         lock (locker) {
 258                                 var internalProvider = provider != null ? new Private.MonoTlsProviderWrapper (provider) : null;
 259                                 return new HttpWebRequest (requestUri, internalProvider, settings);
 260                         }
 261                 }
 262
 263                 internal static HttpListener CreateHttpListener (X509Certificate certificate, MSI.MonoTlsProvider provider, MSI.MonoTlsSettings settings)
 264                 {
 265                         lock (locker) {
 266                                 var internalProvider = provider != null ? new Private.MonoTlsProviderWrapper (provider) : null;
 267                                 return new HttpListener (certificate, internalProvider, settings);
 268                         }
 269                 }
 270                 #endregion
 271
 272 #endif
 273
 274         }
 275 }
 276