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 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 = CreateDefaultProvider ();
  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 #if MONO_FEATURE_NEW_SYSTEM_SOURCE
 108                         /*
 109                          * This is a hack, which is used in the Mono.Security.Providers.NewSystemSource
 110                          * assembly, which will provide a "fake" System.dll.  Use the public Mono.Security
 111                          * API to get the "real" System.dll's provider via reflection, then wrap it with
 112                          * the "fake" version's perceived view.
 113                          *
 114                          * NewSystemSource needs to compile MonoTlsProviderFactory.cs, IMonoTlsProvider.cs,
 115                          * MonoTlsProviderWrapper.cs and CallbackHelpers.cs from this directory and only these.
 116                          */
 117                         var userProvider = MSI.MonoTlsProviderFactory.GetProvider ();
 118                         return new Private.MonoTlsProviderWrapper (userProvider);
 119 #else
 120                         return CreateDefaultProviderImpl ();
 121 #endif
 122 #else
 123                         return null;
 124 #endif
 125                 }
 126
 127                 static object locker = new object ();
 128                 static IMonoTlsProvider defaultProvider;
 129                 static IMonoTlsProvider currentProvider;
 130
 131                 #endregion
 132
 133 #if SECURITY_DEP && !MONO_FEATURE_NEW_SYSTEM_SOURCE
 134
 135 #if !MOBILE
 136                 static Dictionary<string,string> providerRegistration;
 137
 138                 internal static void RegisterProvider (string name, string type)
 139                 {
 140                         lock (locker) {
 141                                 InitializeProviderRegistration ();
 142                                 providerRegistration.Add (name, type);
 143                         }
 144                 }
 145
 146                 static string LookupProvider (string name)
 147                 {
 148                         lock (locker) {
 149                                 InitializeProviderRegistration ();
 150                                 string type;
 151                                 if (!providerRegistration.TryGetValue (name, out type))
 152                                         type = null;
 153                                 return type;
 154                         }
 155                 }
 156
 157                 static void InitializeProviderRegistration ()
 158                 {
 159                         lock (locker) {
 160                                 if (providerRegistration != null)
 161                                         return;
 162                                 providerRegistration = new Dictionary<string,string> ();
 163                                 providerRegistration.Add ("newtls", "Mono.Security.Providers.NewTls.NewTlsProvider, Mono.Security.Providers.NewTls, Version=4.0.0.0, Culture=neutral, PublicKeyToken=84e3aee7225169c2");
 164                                 providerRegistration.Add ("oldtls", "Mono.Security.Providers.OldTls.OldTlsProvider, Mono.Security.Providers.OldTls, Version=4.0.0.0, Culture=neutral, PublicKeyToken=84e3aee7225169c2");
 165                         }
 166                 }
 167
 168                 static IMonoTlsProvider TryDynamicLoad ()
 169                 {
 170                         var variable = Environment.GetEnvironmentVariable ("MONO_TLS_PROVIDER");
 171                         if (variable == null)
 172                                 return null;
 173
 174                         if (string.Equals (variable, "default", StringComparison.OrdinalIgnoreCase))
 175                                 return null;
 176
 177                         string typeName;
 178                         if (variable.IndexOfAny (new char[] { ',', '.', '=' }) > 0) {
 179                                 typeName = variable;
 180                         } else {
 181                                 typeName = LookupProvider (variable);
 182                                 if (typeName == null)
 183                                         throw new NotSupportedException (string.Format ("No such TLS Provider: `{0}'.", typeName));
 184                         }
 185
 186                         var type = Type.GetType (typeName, false);
 187                         if (type == null)
 188                                 throw new NotSupportedException (string.Format ("Could not find TLS Provider: `{0}'.", typeName));
 189
 190                         MSI.MonoTlsProvider provider;
 191                         try {
 192                                 provider = (MSI.MonoTlsProvider)Activator.CreateInstance (type);
 193                         } catch (Exception ex) {
 194                                 throw new NotSupportedException (string.Format ("Unable to instantiate TLS Provider `{0}'.", typeName), ex);
 195                         }
 196
 197                         return new Private.MonoTlsProviderWrapper (provider);
 198                 }
 199 #endif
 200
 201                 static IMonoTlsProvider CreateDefaultProviderImpl ()
 202                 {
 203 #if !MOBILE
 204                         var provider = TryDynamicLoad ();
 205                         if (provider != null)
 206                                 return provider;
 207 #endif
 208
 209                         return new Private.MonoDefaultTlsProvider ();
 210                 }
 211
 212                 #region Mono.Security visible API
 213
 214                 /*
 215                  * "Public" section, intended to be consumed via reflection.
 216                  *
 217                  * Mono.Security.dll provides a public wrapper around these.
 218                  */
 219
 220                 internal static MSI.MonoTlsProvider GetProvider ()
 221                 {
 222                         var provider = GetProviderInternal ();
 223                         if (provider == null)
 224                                 throw new NotSupportedException ("No TLS Provider available.");
 225
 226                         return provider.Provider;
 227                 }
 228
 229                 internal static MSI.MonoTlsProvider GetDefaultProvider ()
 230                 {
 231                         var provider = GetDefaultProviderInternal ();
 232                         if (provider == null)
 233                                 throw new NotSupportedException ("No TLS Provider available.");
 234
 235                         return provider.Provider;
 236                 }
 237
 238                 internal static bool HasProvider {
 239                         get {
 240                                 lock (locker) {
 241                                         return currentProvider != null;
 242                                 }
 243                         }
 244                 }
 245
 246                 internal static void InstallProvider (MSI.MonoTlsProvider provider)
 247                 {
 248                         lock (locker) {
 249                                 currentProvider = new Private.MonoTlsProviderWrapper (provider);
 250                         }
 251                 }
 252
 253                 internal static HttpWebRequest CreateHttpsRequest (Uri requestUri, MSI.MonoTlsProvider provider, MSI.MonoTlsSettings settings)
 254                 {
 255                         lock (locker) {
 256                                 var internalProvider = provider != null ? new Private.MonoTlsProviderWrapper (provider) : null;
 257                                 return new HttpWebRequest (requestUri, internalProvider, settings);
 258                         }
 259                 }
 260
 261                 internal static HttpListener CreateHttpListener (X509Certificate certificate, MSI.MonoTlsProvider provider, MSI.MonoTlsSettings settings)
 262                 {
 263                         lock (locker) {
 264                                 var internalProvider = provider != null ? new Private.MonoTlsProviderWrapper (provider) : null;
 265                                 return new HttpListener (certificate, internalProvider, settings);
 266                         }
 267                 }
 268                 #endregion
 269
 270 #endif
 271
 272         }
 273 }
 274