Add Custom Certificate settings (#537)

WireMock.Net Solution.sln

@@ -71,6 +71,8 @@ Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.WebApplication
 EndProject
 Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "WireMock.Net.WebApplication.NETCore3", "examples\WireMock.Net.WebApplication.NETCore3\WireMock.Net.WebApplication.NETCore3.csproj", "{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4}"
 EndProject
+Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "WireMock.Net.Console.NETCoreApp3WithCertificate", "examples\WireMock.Net.Console.NETCoreApp3WithCertificate\WireMock.Net.Console.NETCoreApp3WithCertificate.csproj", "{925E421A-1B3F-4202-B48F-734743573A4B}"
+EndProject
 Global
 	GlobalSection(SolutionConfigurationPlatforms) = preSolution
 		Debug|Any CPU = Debug|Any CPU
@@ -173,6 +175,10 @@ Global
 		{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4}.Debug|Any CPU.Build.0 = Debug|Any CPU
 		{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4}.Release|Any CPU.ActiveCfg = Release|Any CPU
 		{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4}.Release|Any CPU.Build.0 = Release|Any CPU
+		{925E421A-1B3F-4202-B48F-734743573A4B}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{925E421A-1B3F-4202-B48F-734743573A4B}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{925E421A-1B3F-4202-B48F-734743573A4B}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{925E421A-1B3F-4202-B48F-734743573A4B}.Release|Any CPU.Build.0 = Release|Any CPU
 	EndGlobalSection
 	GlobalSection(SolutionProperties) = preSolution
 		HideSolutionNode = FALSE
@@ -202,6 +208,7 @@ Global
 		{B6269AAC-170A-4346-8B9A-579DED3D9A95} = {8F890C6F-9ACC-438D-928A-AD61CDA862F2}
 		{6F38CB3A-6DA1-408A-AECD-E434523C2838} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 		{E1C56967-3DC7-46CB-A1DF-B13167A0D9D4} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
+		{925E421A-1B3F-4202-B48F-734743573A4B} = {985E0ADB-D4B4-473A-AA40-567E279B7946}
 	EndGlobalSection
 	GlobalSection(ExtensibilityGlobals) = postSolution
 		SolutionGuid = {DC539027-9852-430C-B19F-FD035D018458}

examples/WireMock.Net.Console.NETCoreApp3WithCertificate/Program.cs

@@ -0,0 +1,36 @@
+using WireMock.Logging;
+using WireMock.Server;
+using WireMock.Settings;
+
+namespace WireMock.Net.Console.NETCoreApp3WithCertificate
+{
+    class Program
+    {
+        static void Main(string[] args)
+        {
+            string url = "https://localhost:8433/";
+
+            var server = WireMockServer.Start(new WireMockServerSettings
+            {
+                Urls = new[] { url },
+                StartAdminInterface = true,
+                Logger = new WireMockConsoleLogger(),
+                CertificateSettings = new WireMockCertificateSettings
+                {
+                    X509StoreName = "My",
+                    X509StoreLocation = "CurrentUser",
+                    X509StoreThumbprintOrSubjectName = "FE16586076A8B3F3E2F1466803A6C4C7CA35455B"
+
+                    // X509CertificateFilePath = "example.pfx",
+                    // X509CertificatePassword = "wiremock"
+                }
+
+            });
+            System.Console.WriteLine("WireMockServer listening at {0}", string.Join(",", server.Urls));
+
+            System.Console.WriteLine("Press any key to stop the server");
+            System.Console.ReadKey();
+            server.Stop();
+        }
+    }
+}

examples/WireMock.Net.Console.NETCoreApp3WithCertificate/WireMock.Net.Console.NETCoreApp3WithCertificate.csproj

@@ -0,0 +1,18 @@
+<Project Sdk="Microsoft.NET.Sdk">
+
+  <PropertyGroup>
+    <OutputType>Exe</OutputType>
+    <TargetFramework>netcoreapp3.1</TargetFramework>
+  </PropertyGroup>
+
+  <ItemGroup>
+    <ProjectReference Include="..\..\src\WireMock.Net.StandAlone\WireMock.Net.StandAlone.csproj" />
+  </ItemGroup>
+
+  <ItemGroup>
+    <None Update="example.pfx">
+      <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
+    </None>
+  </ItemGroup>
+
+</Project>

examples/WireMock.Net.Console.NETCoreApp3WithCertificate/base64_encoded.cer

@@ -0,0 +1,28 @@
+-----BEGIN CERTIFICATE-----
+MIIEsDCCApigAwIBAgIQJbH6hSGKdoFI0B7qCIOK7jANBgkqhkiG9w0BAQUFADAU
+MRIwEAYDVQQDEwlsb2NhbGhvc3QwHhcNMjAxMDMwMjMwMDAwWhcNMzAxMTA2MjMw
+MDAwWjAUMRIwEAYDVQQDEwlsb2NhbGhvc3QwggIiMA0GCSqGSIb3DQEBAQUAA4IC
+DwAwggIKAoICAQCl5fQSrRgT3Q6WoULR98Y+rrDWtTTgVpbLU04G0hLZ4yUeP7Wa
+yuVbvx7zX8XT4lA8Hu5T/GG91U077JcSSEjnPBFsh4hE7FkRoSYIEW6BFG7D7eUG
+dGHnDV8UkSRQ97LJPyjXuHVDJzNDJ9xQGMzOZ4n8vQ7SEKBw9hRG2ugkP5b2jVIN
+e1E549tq2jnIVpKCZ4+prf64ZLsaokX7VHe+b/CW3GoAqUUaUjdTpAQ7LpypJuFz
+415enOrKQe+UEBdqhGlgcC/O/Bw0uq4qVk+NNe5DEINVwoYs9XjNdzxuIkkAtcCt
+avTEzhHf8zWYLb5Nt2DIOcRGVELvRhsBX4um5f7dOGzMbXzBfUdjkP2O4hi6crhm
+Hba5bNkj4Zw2EHR9Xua3nadGCj22z0vpMKP2gXdFVnxFqQlaUWBLtwwN9p6tCQHl
+kU7wypvOHUsMa2Ojg5eZP4RpYFvZG3kkc9zTZCSakgw2n0ampBbvxPP11/AYIXtz
+HKu3CKcpjVQ+lE0DAU/Mm77QJ24TMbXmAydwCf1UCdFbDUZhdM9lspHvA0J9eiCv
+LOE94BrpVKuZ6TrAW0LZjAmBnkqYQAewhTW7GSgARE+QQcwfyu03Ck7id3Zt4FeQ
+sQDo0NNj7zQOy3Y1GK0ZYAVZv/GUeHMkxpClSWPoub/f5SJ4YzD5Il0cQQIDAQAB
+MA0GCSqGSIb3DQEBBQUAA4ICAQBd91xfUepnWcKwmupie2h1CAAQZEunyW78i++t
+evABfBu0TgV4s6Xe0umFv9V4r+O+rrF3ddSudbSOPBEb0Ooe+e3YGlNk1JrI1EEn
+fhb0YI8bMfBNpl85yNqxgByra7JF2mG4qbAnjrCs/PZkXo/34N29SY6dyZ7mffR3
+r/l01Rdm3ogRwGkiMUeKb3iGwLUy1T55svuI3Zc13N+NJT1s9NqpwWeK/jFK/WRN
+5Hi9W3DmlGCYAwFPCyBaQagxpGuGIpNsU0hKp86W5EvJpBpmCihfwlydH8ZbkHJ9
+jx2UDgTCaDzmaiKysiTP2HHDBsReL4tjakBksa9jkTfy5ajB53F3aUVs4jvTA46L
+w8wcAJlRPBz5siBrv4CH/0lBMyNeYzuqmDY3ulF4IMKNb5Kk9Ye4Pt0474z50A4v
+fSah+9iwI/mubaJ5tK522AtWtUoOIAswIwpDQyNeJPOggyzT2Y2OYZdGuFAoMYuq
+ZD58k4Yo+vky9K88l8NuzNJJvtgTKtT+/9qfMucxFmnvwbKEEULP3sw1FUKkPtM4
+f242FIV/XnOeloDmhGGeTB7aODB+gGCvgmOH92njjUEIv+SnYQkflQaRhhyNIACi
+ZvWlP/96H+X4fUG5kVNBHY021ZWmurUDqVxWUaswg63+DfsZcYtt6wgxiAN4ssXG
+wLnLPw==
+-----END CERTIFICATE-----

src/WireMock.Net/Http/HttpClientHelper.cs

@@ -41,7 +41,7 @@ public static HttpClient CreateHttpClient(IProxyAndRecordSettings settings)
             {
                 handler.ClientCertificateOptions = ClientCertificateOption.Manual;
 
-                var x509Certificate2 = ClientCertificateHelper.GetCertificate(settings.ClientX509Certificate2ThumbprintOrSubjectName);
+                var x509Certificate2 = CertificateLoader.LoadCertificate(settings.ClientX509Certificate2ThumbprintOrSubjectName);
                 handler.ClientCertificates.Add(x509Certificate2);
             }
 

src/WireMock.Net/HttpsCertificate/CertificateLoader.cs

@@ -0,0 +1,100 @@
+using System;
+using System.IO;
+using System.Security.Cryptography.X509Certificates;
+
+namespace WireMock.HttpsCertificate
+{
+    internal static class CertificateLoader
+    {
+        /// <summary>
+        /// Used by the WireMock.Net server
+        /// </summary>
+        public static X509Certificate2 LoadCertificate(
+            string storeName,
+            string storeLocation,
+            string thumbprintOrSubjectName,
+            string filePath,
+            string password,
+            string host)
+        {
+            if (!string.IsNullOrEmpty(storeName) && !string.IsNullOrEmpty(storeLocation))
+            {
+                var thumbprintOrSubjectNameOrHost = thumbprintOrSubjectName ?? host;
+
+                var certStore = new X509Store((StoreName)Enum.Parse(typeof(StoreName), storeName), (StoreLocation)Enum.Parse(typeof(StoreLocation), storeLocation));
+                try
+                {
+                    certStore.Open(OpenFlags.ReadOnly);
+
+                    // Attempt to find by Thumbprint first
+                    var matchingCertificates = certStore.Certificates.Find(X509FindType.FindByThumbprint, thumbprintOrSubjectNameOrHost, false);
+                    if (matchingCertificates.Count == 0)
+                    {
+                        // Fallback to SubjectName
+                        matchingCertificates = certStore.Certificates.Find(X509FindType.FindBySubjectName, thumbprintOrSubjectNameOrHost, false);
+                        if (matchingCertificates.Count == 0)
+                        {
+                            // No certificates matched the search criteria.
+                            throw new FileNotFoundException($"No Certificate found with in store '{storeName}', location '{storeLocation}' for Thumbprint or SubjectName '{thumbprintOrSubjectNameOrHost}'.");
+                        }
+                    }
+
+                    // Use the first matching certificate.
+                    return matchingCertificates[0];
+                }
+                finally
+                {
+#if NETSTANDARD || NET46
+                    certStore.Dispose();
+#else
+                    certStore.Close();
+#endif
+                }
+            }
+
+            if (!string.IsNullOrEmpty(filePath) && !string.IsNullOrEmpty(password))
+            {
+                return new X509Certificate2(filePath, password);
+            }
+
+            throw new InvalidOperationException("X509StoreName and X509StoreLocation OR X509CertificateFilePath and X509CertificatePassword are mandatory.");
+        }
+
+        /// <summary>
+        /// Used for Proxy
+        /// </summary>
+        public static X509Certificate2 LoadCertificate(string thumbprintOrSubjectName)
+        {
+            var certStore = new X509Store(StoreName.My, StoreLocation.LocalMachine);
+            try
+            {
+                // Certificate must be in the local machine store
+                certStore.Open(OpenFlags.ReadOnly);
+
+                // Attempt to find by Thumbprint first
+                var matchingCertificates = certStore.Certificates.Find(X509FindType.FindByThumbprint, thumbprintOrSubjectName, false);
+                if (matchingCertificates.Count == 0)
+                {
+                    // Fallback to SubjectName
+                    matchingCertificates = certStore.Certificates.Find(X509FindType.FindBySubjectName, thumbprintOrSubjectName, false);
+                    if (matchingCertificates.Count == 0)
+                    {
+                        // No certificates matched the search criteria.
+                        throw new FileNotFoundException("No certificate found with specified Thumbprint or SubjectName.", thumbprintOrSubjectName);
+                    }
+                }
+
+                // Use the first matching certificate.
+                return matchingCertificates[0];
+            }
+            finally
+            {
+#if NETSTANDARD || NET46
+                certStore.Dispose();
+#else
+                certStore.Close();
+#endif
+            }
+        }
+    }
+}

src/WireMock.Net/Owin/AspNetCoreSelfHost.NETStandard.cs

@@ -1,10 +1,10 @@
 #if USE_ASPNETCORE && !NETSTANDARD1_3
-using System;
 using System.Collections.Generic;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Server.Kestrel.Core;
 using Microsoft.Extensions.Configuration;
 using Microsoft.Extensions.DependencyInjection;
+using WireMock.HttpsCertificate;
 
 namespace WireMock.Owin
 {
@@ -18,20 +18,34 @@ private static void SetKestrelOptionsLimits(KestrelServerOptions options)
             options.Limits.MaxResponseBufferSize = null;
         }
 
-        private static void SetHttpsAndUrls(KestrelServerOptions options, ICollection<(string Url, int Port)> urlDetails)
+        private static void SetHttpsAndUrls(KestrelServerOptions kestrelOptions, IWireMockMiddlewareOptions wireMockMiddlewareOptions, IEnumerable<HostUrlDetails> urlDetails)
         {
-            foreach (var detail in urlDetails)
+            foreach (var urlDetail in urlDetails)
             {
-                if (detail.Url.StartsWith("https://", StringComparison.OrdinalIgnoreCase))
+                if (urlDetail.IsHttps)
                 {
-                    options.Listen(System.Net.IPAddress.Any, detail.Port, listenOptions =>
+                    kestrelOptions.Listen(System.Net.IPAddress.Any, urlDetail.Port, listenOptions =>
                     {
-                        listenOptions.UseHttps();
+                        if (wireMockMiddlewareOptions.CustomCertificateDefined)
+                        {
+                            listenOptions.UseHttps(CertificateLoader.LoadCertificate(
+                                wireMockMiddlewareOptions.X509StoreName,
+                                wireMockMiddlewareOptions.X509StoreLocation,
+                                wireMockMiddlewareOptions.X509ThumbprintOrSubjectName,
+                                wireMockMiddlewareOptions.X509CertificateFilePath,
+                                wireMockMiddlewareOptions.X509CertificatePassword,
+                                urlDetail.Host)
+                            );
+                        }
+                        else
+                        {
+                            listenOptions.UseHttps();
+                        }
                     });
                 }
                 else
                 {
-                    options.Listen(System.Net.IPAddress.Any, detail.Port);
+                    kestrelOptions.Listen(System.Net.IPAddress.Any, urlDetail.Port);
                 }
             }
         }

src/WireMock.Net/Owin/AspNetCoreSelfHost.NETStandard13.cs

@@ -1,7 +1,5 @@
 #if USE_ASPNETCORE && NETSTANDARD1_3
-using System;
 using System.Collections.Generic;
-using System.Linq;
 using Microsoft.AspNetCore.Hosting;
 using Microsoft.AspNetCore.Server.Kestrel;
 using Microsoft.Extensions.Configuration;
@@ -19,12 +17,28 @@ private static void SetKestrelOptionsLimits(KestrelServerOptions options)
             options.Limits.MaxResponseBufferSize = null;
         }
 
-        private static void SetHttpsAndUrls(KestrelServerOptions options, ICollection<(string Url, int Port)> urlDetails)
+        private static void SetHttpsAndUrls(KestrelServerOptions options, IWireMockMiddlewareOptions wireMockMiddlewareOptions, IEnumerable<HostUrlDetails> urlDetails)
         {
-            var urls = urlDetails.Select(u => u.Url);
-            if (urls.Any(u => u.StartsWith("https://", StringComparison.OrdinalIgnoreCase)))
+            foreach (var urlDetail in urlDetails)
             {
-                options.UseHttps(PublicCertificateHelper.GetX509Certificate2());
+                if (urlDetail.IsHttps)
+                {
+                    if (wireMockMiddlewareOptions.CustomCertificateDefined)
+                    {
+                        options.UseHttps(CertificateLoader.LoadCertificate(
+                            wireMockMiddlewareOptions.X509StoreName,
+                            wireMockMiddlewareOptions.X509StoreLocation,
+                            wireMockMiddlewareOptions.X509ThumbprintOrSubjectName,
+                            wireMockMiddlewareOptions.X509CertificateFilePath,
+                            wireMockMiddlewareOptions.X509CertificatePassword,
+                            urlDetail.Host)
+                        );
+                    }
+                    else
+                    {
+                        options.UseHttps(PublicCertificateHelper.GetX509Certificate2());
+                    }
+                }
             }
         }
     }