Replaced 'Security.LoadPrivateKey' with 'AuthenticationUtils.LoadSigningKey'

jaaufauvre · jaaufauvre · commit f99ad63ff2d9 · 2019-03-16T18:15:34.000Z
diff --git a/Mastercard.Developer.OAuth1Signer.Core/Utils/AuthenticationUtils.cs b/Mastercard.Developer.OAuth1Signer.Core/Utils/AuthenticationUtils.cs
@@ -0,0 +1,24 @@
+﻿using System;
+using System.Security.Cryptography;
+using System.Security.Cryptography.X509Certificates;
+// ReSharper disable InconsistentNaming
+
+namespace Mastercard.Developer.OAuth1Signer.Core.Utils
+{
+    /// <summary>
+    /// Utility class.
+    /// </summary>
+    public static class AuthenticationUtils
+    {
+        /// <summary>
+        /// Load a RSA key out of a PKCS#12 container.
+        /// </summary>
+        public static RSA LoadSigningKey(string pkcs12KeyFilePath, string signingKeyAlias, string signingKeyPassword,
+            X509KeyStorageFlags keyStorageFlags = X509KeyStorageFlags.DefaultKeySet)
+        {
+            if (pkcs12KeyFilePath == null) throw new ArgumentNullException(nameof(pkcs12KeyFilePath));
+            var signingCertificate = new X509Certificate2(pkcs12KeyFilePath, signingKeyPassword, keyStorageFlags);
+            return signingCertificate.GetRSAPrivateKey();
+        }
+    }
+}
diff --git a/Mastercard.Developer.OAuth1Signer.Core/Utils/SecurityUtils.cs b/Mastercard.Developer.OAuth1Signer.Core/Utils/SecurityUtils.cs
@@ -8,17 +8,13 @@ namespace Mastercard.Developer.OAuth1Signer.Core.Utils
     /// <summary>
     /// Utility class.
     /// </summary>
+    [Obsolete("Use AuthenticationUtils instead.")]
     public static class SecurityUtils
     {
-        /// <summary>
-        /// Load a RSA key out of a PKCS#12 container.
-        /// </summary>
         public static RSA LoadPrivateKey(string pkcs12KeyFilePath, string signingKeyAlias, string signingKeyPassword, 
             X509KeyStorageFlags keyStorageFlags = X509KeyStorageFlags.DefaultKeySet)
         {
-            if (pkcs12KeyFilePath == null) throw new ArgumentNullException(nameof(pkcs12KeyFilePath));
-            var signingCertificate = new X509Certificate2(pkcs12KeyFilePath, signingKeyPassword, keyStorageFlags);
-            return signingCertificate.GetRSAPrivateKey();
+            return AuthenticationUtils.LoadSigningKey(pkcs12KeyFilePath, signingKeyAlias, signingKeyPassword, keyStorageFlags);
         }
     }
 }
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Authenticators/RestSharpOAuth1AuthenticatorTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/Authenticators/RestSharpOAuth1AuthenticatorTest.cs
@@ -13,7 +13,7 @@ public class RestSharpOAuth1AuthenticatorTest
         public void TestPreAuthenticate_ShouldSignRequest()
         {
             // GIVEN
-            var signingKey = TestUtils.GetTestPrivateKey();
+            var signingKey = TestUtils.GetTestSigningKey();
             const string consumerKey = "Some key";
             var baseUri = new Uri("https://api.mastercard.com/");
             var request = new RestRequest
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/OAuthTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/OAuthTest.cs
@@ -137,7 +137,7 @@ public void TestGetSignatureBaseString_Nominal()
         public void TestSignSignatureBaseString()
         {
             const string expectedSignatureString = "IJeNKYGfUhFtj5OAPRI92uwfjJJLCej3RCMLbp7R6OIYJhtwxnTkloHQ2bgV7fks4GT/A7rkqrgUGk0ewbwIC6nS3piJHyKVc7rvQXZuCQeeeQpFzLRiH3rsb+ZS+AULK+jzDje4Fb+BQR6XmxuuJmY6YrAKkj13Ln4K6bZJlSxOizbNvt+Htnx+hNd4VgaVBeJKcLhHfZbWQxK76nMnjY7nDcM/2R6LUIR2oLG1L9m55WP3bakAvmOr392ulv1+mWCwDAZZzQ4lakDD2BTu0ZaVsvBW+mcKFxYeTq7SyTQMM4lEwFPJ6RLc8jJJ+veJXHekLVzWg4qHRtzNBLz1mA==";
-            Assert.AreEqual(expectedSignatureString, OAuth.SignSignatureBaseString("baseString", Encoding.UTF8, TestUtils.GetTestPrivateKey()));
+            Assert.AreEqual(expectedSignatureString, OAuth.SignSignatureBaseString("baseString", Encoding.UTF8, TestUtils.GetTestSigningKey()));
         }
 
         [TestMethod]
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Signers/NetHttpClientSignerTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/Signers/NetHttpClientSignerTest.cs
@@ -13,7 +13,7 @@ public class NetHttpClientSignerTest
         public void TestSign_ShouldAddOAuth1HeaderToPostRequest()
         {
             // GIVEN
-            var signingKey = TestUtils.GetTestPrivateKey();
+            var signingKey = TestUtils.GetTestSigningKey();
             const string consumerKey = "Some key";
             var request = new HttpRequestMessage
             {
@@ -34,7 +34,7 @@ public void TestSign_ShouldAddOAuth1HeaderToPostRequest()
         public void TestSign_ShouldAddOAuth1HeaderToGetRequest()
         {
             // GIVEN
-            var signingKey = TestUtils.GetTestPrivateKey();
+            var signingKey = TestUtils.GetTestSigningKey();
             const string consumerKey = "Some key";
             var request = new HttpRequestMessage
             {
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Signers/RestSharpSignerTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/Signers/RestSharpSignerTest.cs
@@ -13,7 +13,7 @@ public class RestSharpSignerTest
         public void TestSign_ShouldAddOAuth1HeaderToPostRequest()
         {
             // GIVEN
-            var signingKey = TestUtils.GetTestPrivateKey();
+            var signingKey = TestUtils.GetTestSigningKey();
             const string consumerKey = "Some key";
             var baseUri = new Uri("https://api.mastercard.com/");
             var request = new RestRequest
@@ -42,7 +42,7 @@ public void TestSign_ShouldAddOAuth1HeaderToPostRequest()
         public void TestSign_ShouldAddOAuth1HeaderToGetRequest()
         {
             // GIVEN
-            var signingKey = TestUtils.GetTestPrivateKey();
+            var signingKey = TestUtils.GetTestSigningKey();
             const string consumerKey = "Some key";
             var baseUri = new Uri("https://api.mastercard.com/");
             var request = new RestRequest
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Test/TestUtils.cs b/Mastercard.Developer.OAuth1Signer.Tests/Test/TestUtils.cs
@@ -6,7 +6,7 @@ namespace Mastercard.Developer.OAuth1Signer.Tests.Test
 {
     internal static class TestUtils
     {
-        internal static RSA GetTestPrivateKey() => SecurityUtils.LoadPrivateKey(
+        internal static RSA GetTestSigningKey() => AuthenticationUtils.LoadSigningKey(
             "./_Resources/test_key_container.p12", 
             "mykeyalias", 
             "Password1",
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Utils/AuthenticationUtilsTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/Utils/AuthenticationUtilsTest.cs
@@ -0,0 +1,27 @@
+﻿using System.Security.Cryptography.X509Certificates;
+using Mastercard.Developer.OAuth1Signer.Core.Utils;
+using Microsoft.VisualStudio.TestTools.UnitTesting;
+
+namespace Mastercard.Developer.OAuth1Signer.Tests.Utils
+{
+    [TestClass]
+    public class AuthenticationUtilsTest
+    {
+        [TestMethod]
+        public void TestLoadSigningKey_ShouldReturnKey()
+        {
+            // GIVEN
+            const string keyContainerPath = "./_Resources/test_key_container.p12";
+            const string keyAlias = "mykeyalias";
+            const string keyPassword = "Password1";
+
+            // WHEN
+            const X509KeyStorageFlags flags = X509KeyStorageFlags.MachineKeySet | X509KeyStorageFlags.Exportable; // https://github.com/dotnet/corefx/issues/14745
+            var privateKey = AuthenticationUtils.LoadSigningKey(keyContainerPath, keyAlias, keyPassword, flags);
+
+            // THEN
+            Assert.AreEqual(2048, privateKey.KeySize);
+            Assert.AreEqual("RSA", privateKey.KeyExchangeAlgorithm);
+        }
+    }
+}
diff --git a/Mastercard.Developer.OAuth1Signer.Tests/Utils/SecurityUtilsTest.cs b/Mastercard.Developer.OAuth1Signer.Tests/Utils/SecurityUtilsTest.cs
@@ -1,10 +1,12 @@
-﻿using System.Security.Cryptography.X509Certificates;
+﻿using System;
+using System.Security.Cryptography.X509Certificates;
 using Mastercard.Developer.OAuth1Signer.Core.Utils;
 using Microsoft.VisualStudio.TestTools.UnitTesting;
 
 namespace Mastercard.Developer.OAuth1Signer.Tests.Utils
 {
     [TestClass]
+    [Obsolete("Use AuthenticationUtils instead.")]
     public class SecurityUtilsTest
     {
         [TestMethod]
diff --git a/README.md b/README.md
@@ -53,12 +53,12 @@ dotnet add package Mastercard.Developer.OAuth1Signer.RestSharp
 
 ### Loading the Signing Key <a name="loading-the-signing-key"></a>
 
-A `System.Security.Cryptography.RSA` key object can be created by calling the `SecurityUtils.LoadPrivateKey` method:
+A `System.Security.Cryptography.RSA` key object can be created by calling the `AuthenticationUtils.LoadSigningKey` method:
 ```cs
-var signingKey = SecurityUtils.LoadPrivateKey(
-						"<insert PKCS#12 key file path>", 
-						"<insert key alias>", 
-						"<insert key password>");
+var signingKey = AuthenticationUtils.LoadSigningKey(
+                        "<insert PKCS#12 key file path>", 
+                        "<insert key alias>", 
+                        "<insert key password>");
 ```
 
 ### Creating the OAuth Authorization Header <a name="creating-the-oauth-authorization-header"></a>

Original file line number	Diff line number	Diff line change
`@@ -8,17 +8,13 @@ namespace Mastercard.Developer.OAuth1Signer.Core.Utils`
`8`	`8`	`/// <summary>`
`9`	`9`	`/// Utility class.`
`10`	`10`	`/// </summary>`
	`11`	`+ [Obsolete("Use AuthenticationUtils instead.")]`
`11`	`12`	`public static class SecurityUtils`
`12`	`13`	`{`
`13`		`- /// <summary>`
`14`		`- /// Load a RSA key out of a PKCS#12 container.`
`15`		`- /// </summary>`
`16`	`14`	`public static RSA LoadPrivateKey(string pkcs12KeyFilePath, string signingKeyAlias, string signingKeyPassword,`
`17`	`15`	`X509KeyStorageFlags keyStorageFlags = X509KeyStorageFlags.DefaultKeySet)`
`18`	`16`	`{`
`19`		`- if (pkcs12KeyFilePath == null) throw new ArgumentNullException(nameof(pkcs12KeyFilePath));`
`20`		`- var signingCertificate = new X509Certificate2(pkcs12KeyFilePath, signingKeyPassword, keyStorageFlags);`
`21`		`- return signingCertificate.GetRSAPrivateKey();`
	`17`	`+ return AuthenticationUtils.LoadSigningKey(pkcs12KeyFilePath, signingKeyAlias, signingKeyPassword, keyStorageFlags);`
`22`	`18`	`}`
`23`	`19`	`}`
`24`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class RestSharpOAuth1AuthenticatorTest`
`13`	`13`	`public void TestPreAuthenticate_ShouldSignRequest()`
`14`	`14`	`{`
`15`	`15`	`// GIVEN`
`16`		`- var signingKey = TestUtils.GetTestPrivateKey();`
	`16`	`+ var signingKey = TestUtils.GetTestSigningKey();`
`17`	`17`	`const string consumerKey = "Some key";`
`18`	`18`	`var baseUri = new Uri("https://api.mastercard.com/");`
`19`	`19`	`var request = new RestRequest`
Original file line number	Diff line number	Diff line change
`@@ -137,7 +137,7 @@ public void TestGetSignatureBaseString_Nominal()`
`137`	`137`	`public void TestSignSignatureBaseString()`
`138`	`138`	`{`
`139`	`139`	`const string expectedSignatureString = "IJeNKYGfUhFtj5OAPRI92uwfjJJLCej3RCMLbp7R6OIYJhtwxnTkloHQ2bgV7fks4GT/A7rkqrgUGk0ewbwIC6nS3piJHyKVc7rvQXZuCQeeeQpFzLRiH3rsb+ZS+AULK+jzDje4Fb+BQR6XmxuuJmY6YrAKkj13Ln4K6bZJlSxOizbNvt+Htnx+hNd4VgaVBeJKcLhHfZbWQxK76nMnjY7nDcM/2R6LUIR2oLG1L9m55WP3bakAvmOr392ulv1+mWCwDAZZzQ4lakDD2BTu0ZaVsvBW+mcKFxYeTq7SyTQMM4lEwFPJ6RLc8jJJ+veJXHekLVzWg4qHRtzNBLz1mA==";`
`140`		`- Assert.AreEqual(expectedSignatureString, OAuth.SignSignatureBaseString("baseString", Encoding.UTF8, TestUtils.GetTestPrivateKey()));`
	`140`	`+ Assert.AreEqual(expectedSignatureString, OAuth.SignSignatureBaseString("baseString", Encoding.UTF8, TestUtils.GetTestSigningKey()));`
`141`	`141`	`}`
`142`	`142`
`143`	`143`	`[TestMethod]`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@ public class NetHttpClientSignerTest`
`13`	`13`	`public void TestSign_ShouldAddOAuth1HeaderToPostRequest()`
`14`	`14`	`{`
`15`	`15`	`// GIVEN`
`16`		`- var signingKey = TestUtils.GetTestPrivateKey();`
	`16`	`+ var signingKey = TestUtils.GetTestSigningKey();`
`17`	`17`	`const string consumerKey = "Some key";`
`18`	`18`	`var request = new HttpRequestMessage`
`19`	`19`	`{`
`@@ -34,7 +34,7 @@ public void TestSign_ShouldAddOAuth1HeaderToPostRequest()`
`34`	`34`	`public void TestSign_ShouldAddOAuth1HeaderToGetRequest()`
`35`	`35`	`{`
`36`	`36`	`// GIVEN`
`37`		`- var signingKey = TestUtils.GetTestPrivateKey();`
	`37`	`+ var signingKey = TestUtils.GetTestSigningKey();`
`38`	`38`	`const string consumerKey = "Some key";`
`39`	`39`	`var request = new HttpRequestMessage`
`40`	`40`	`{`
Original file line number	Diff line number	Diff line change
`@@ -6,7 +6,7 @@ namespace Mastercard.Developer.OAuth1Signer.Tests.Test`
`6`	`6`	`{`
`7`	`7`	`internal static class TestUtils`
`8`	`8`	`{`
`9`		`- internal static RSA GetTestPrivateKey() => SecurityUtils.LoadPrivateKey(`
	`9`	`+ internal static RSA GetTestSigningKey() => AuthenticationUtils.LoadSigningKey(`
`10`	`10`	`"./_Resources/test_key_container.p12",`
`11`	`11`	`"mykeyalias",`
`12`	`12`	`"Password1",`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,12 @@`
`1`		`-using System.Security.Cryptography.X509Certificates;`
	`1`	`+using System;`
	`2`	`+using System.Security.Cryptography.X509Certificates;`
`2`	`3`	`using Mastercard.Developer.OAuth1Signer.Core.Utils;`
`3`	`4`	`using Microsoft.VisualStudio.TestTools.UnitTesting;`
`4`	`5`
`5`	`6`	`namespace Mastercard.Developer.OAuth1Signer.Tests.Utils`
`6`	`7`	`{`
`7`	`8`	`[TestClass]`
	`9`	`+ [Obsolete("Use AuthenticationUtils instead.")]`
`8`	`10`	`public class SecurityUtilsTest`
`9`	`11`	`{`
`10`	`12`	`[TestMethod]`