Use Base64UrlHelper class in common lib ... (#14412)

isra-fel · wyunchi-ms · commit 3ee2b81ef892 · 2021-04-07T09:38:33.000+08:00
... instead of duplicating in Az.Accounts and Az.KeyVault
diff --git a/src/Accounts/Accounts/Token/GetAzureRmAccessToken.cs b/src/Accounts/Accounts/Token/GetAzureRmAccessToken.cs
@@ -21,10 +21,10 @@
 using Microsoft.Azure.Commands.Common.Authentication;
 using Microsoft.Azure.Commands.Common.Authentication.Abstractions;
 using Microsoft.Azure.Commands.Profile.Models;
-using Microsoft.Azure.Commands.Profile.Utilities;
 using Microsoft.Azure.Commands.ResourceManager.Common;
 using Microsoft.Azure.Commands.ResourceManager.Common.ArgumentCompleters;
 using Microsoft.Azure.PowerShell.Authenticators;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
 
 namespace Microsoft.Azure.Commands.Profile
 {
@@ -117,7 +117,7 @@ public override void ExecuteCmdlet()
                 try
                 {
                     var tokenParts = accessToken.AccessToken.Split('.');
-                    var decodedToken = Base64UrlHelpers.DecodeToString(tokenParts[1]);
+                    var decodedToken = Base64UrlHelper.DecodeToString(tokenParts[1]);
 
                     var tokenDocument = JsonDocument.Parse(decodedToken);
                     int expSeconds = tokenDocument.RootElement.EnumerateObject()
diff --git a/src/Accounts/Accounts/Utilities/Base64UrlHelpers.cs b/src/Accounts/Accounts/Utilities/Base64UrlHelpers.cs
diff --git a/src/KeyVault/KeyVault/SecurityDomain/Models/Base64UrlEncoder.cs b/src/KeyVault/KeyVault/SecurityDomain/Models/Base64UrlEncoder.cs
diff --git a/src/KeyVault/KeyVault/SecurityDomain/Models/CertKeys.cs b/src/KeyVault/KeyVault/SecurityDomain/Models/CertKeys.cs
@@ -1,5 +1,6 @@
 ﻿using System;
 using System.Collections.Generic;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
 
 namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models
 {
@@ -26,7 +27,7 @@ public void LoadKey(KeyPath path)
         {
             CertKey certKey = new CertKey();
             certKey.Load(path);
-            string encodedThumbprint = Base64UrlEncoder.Encode(certKey.GetThumbprint());
+            string encodedThumbprint = Base64UrlHelper.Encode(certKey.GetThumbprint());
             _keys.Add(encodedThumbprint, certKey);
         }
 
diff --git a/src/KeyVault/KeyVault/SecurityDomain/Models/JWE.cs b/src/KeyVault/KeyVault/SecurityDomain/Models/JWE.cs
@@ -5,6 +5,7 @@
 using System.IO;
 using System.Security.Cryptography.X509Certificates;
 using Microsoft.Azure.Commands.KeyVault.SecurityDomain.Common;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
 
 namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models
 {
@@ -52,11 +53,11 @@ public JweDecode(string compact_jwe)
             }
 
             encoded_header = parts[0];
-            string header = Base64UrlEncoder.Decode(encoded_header);
-            encrypted_key = Base64UrlEncoder.DecodeBytes(parts[1]);
-            init_vector = Base64UrlEncoder.DecodeBytes(parts[2]);
-            ciphertext = Base64UrlEncoder.DecodeBytes(parts[3]);
-            auth_tag = Base64UrlEncoder.DecodeBytes(parts[4]);
+            string header = Base64UrlHelper.DecodeToString(encoded_header);
+            encrypted_key = Base64UrlHelper.DecodeToBytes(parts[1]);
+            init_vector = Base64UrlHelper.DecodeToBytes(parts[2]);
+            ciphertext = Base64UrlHelper.DecodeToBytes(parts[3]);
+            auth_tag = Base64UrlHelper.DecodeToBytes(parts[4]);
 
             protected_header = JsonConvert.DeserializeObject<JWE_header>(header);
         }
@@ -79,7 +80,7 @@ public void EncodeHeader()
                                                 Formatting.None,
                                                 new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore });
 
-            encoded_header = Base64UrlEncoder.Encode(header_json);
+            encoded_header = Base64UrlHelper.Encode(header_json);
         }
 
         public string EncodeCompact()
@@ -88,25 +89,25 @@ public string EncodeCompact()
 
             if (encrypted_key != null)
             {
-                ret += Base64UrlEncoder.Encode(encrypted_key);
+                ret += Base64UrlHelper.Encode(encrypted_key);
             }
 
             ret += ".";
             if (init_vector != null)
             {
-                ret += Base64UrlEncoder.Encode(init_vector);
+                ret += Base64UrlHelper.Encode(init_vector);
             }
 
             ret += ".";
             if (ciphertext != null)
             {
-                ret += Base64UrlEncoder.Encode(ciphertext);
+                ret += Base64UrlHelper.Encode(ciphertext);
             }
 
             ret += ".";
             if (auth_tag != null)
             {
-                ret += Base64UrlEncoder.Encode(auth_tag);
+                ret += Base64UrlHelper.Encode(auth_tag);
             }
 
             return ret;
diff --git a/src/KeyVault/KeyVault/SecurityDomain/Models/JWK.cs b/src/KeyVault/KeyVault/SecurityDomain/Models/JWK.cs
@@ -3,6 +3,7 @@
 using System.Security.Cryptography;
 using System.Security.Cryptography.X509Certificates;
 using Microsoft.Azure.Commands.KeyVault.SecurityDomain.Common;
+using Microsoft.WindowsAzure.Commands.Utilities.Common;
 using Newtonsoft.Json;
 
 namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models
@@ -96,12 +97,12 @@ public string ToJson()
 
         void SetExponent(byte[] exp)
         {
-            e = Base64UrlEncoder.Encode(exp);
+            e = Base64UrlHelper.Encode(exp);
         }
 
         void SetModulus(byte[] modulus)
         {
-            n = Base64UrlEncoder.Encode(modulus);
+            n = Base64UrlHelper.Encode(modulus);
         }
 
         void SetKeyType(JwkKeyType keyType)
@@ -236,12 +237,12 @@ public static byte[] ToByteArray(String HexString)
 
         void SetX5t(X509Certificate2 cert)
         {
-            x5t = Base64UrlEncoder.Encode(ToByteArray(cert.Thumbprint));
+            x5t = Base64UrlHelper.Encode(ToByteArray(cert.Thumbprint));
         }
 
         void SetX5t256(X509Certificate2 cert)
         {
-            x5t_S256 = Base64UrlEncoder.Encode(Utils.Sha256Thumbprint(cert));
+            x5t_S256 = Base64UrlHelper.Encode(Utils.Sha256Thumbprint(cert));
         }
 
         public string kty { get; set; }
diff --git a/src/KeyVault/KeyVault/SecurityDomain/Models/SecurityDomainClient.cs b/src/KeyVault/KeyVault/SecurityDomain/Models/SecurityDomainClient.cs
@@ -493,7 +493,7 @@ public SecurityDomainRestoreData EncryptForRestore(PlaintextList plaintextList,
                 JWE jwe_wrapped = new JWE();
                 jwe_wrapped.Encrypt(cert, master_key);
                 securityDomainRestoreData.WrappedKey.enc_key = jwe_wrapped.EncodeCompact();
-                securityDomainRestoreData.WrappedKey.x5t_256 = Base64UrlEncoder.Encode(Utils.Sha256Thumbprint(cert));
+                securityDomainRestoreData.WrappedKey.x5t_256 = Base64UrlHelper.Encode(Utils.Sha256Thumbprint(cert));
                 return securityDomainRestoreData;
             }
             catch (Exception ex)

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,6 @@`
`1`	`1`	`using System;`
`2`	`2`	`using System.Collections.Generic;`
	`3`	`+using Microsoft.WindowsAzure.Commands.Utilities.Common;`
`3`	`4`
`4`	`5`	`namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models`
`5`	`6`	`{`
`@@ -26,7 +27,7 @@ public void LoadKey(KeyPath path)`
`26`	`27`	`{`
`27`	`28`	`CertKey certKey = new CertKey();`
`28`	`29`	`certKey.Load(path);`
`29`		`- string encodedThumbprint = Base64UrlEncoder.Encode(certKey.GetThumbprint());`
	`30`	`+ string encodedThumbprint = Base64UrlHelper.Encode(certKey.GetThumbprint());`
`30`	`31`	`_keys.Add(encodedThumbprint, certKey);`
`31`	`32`	`}`
`32`	`33`
Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,7 @@`
`5`	`5`	`using System.IO;`
`6`	`6`	`using System.Security.Cryptography.X509Certificates;`
`7`	`7`	`using Microsoft.Azure.Commands.KeyVault.SecurityDomain.Common;`
	`8`	`+using Microsoft.WindowsAzure.Commands.Utilities.Common;`
`8`	`9`
`9`	`10`	`namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models`
`10`	`11`	`{`
`@@ -52,11 +53,11 @@ public JweDecode(string compact_jwe)`
`52`	`53`	`}`
`53`	`54`
`54`	`55`	`encoded_header = parts[0];`
`55`		`- string header = Base64UrlEncoder.Decode(encoded_header);`
`56`		`- encrypted_key = Base64UrlEncoder.DecodeBytes(parts[1]);`
`57`		`- init_vector = Base64UrlEncoder.DecodeBytes(parts[2]);`
`58`		`- ciphertext = Base64UrlEncoder.DecodeBytes(parts[3]);`
`59`		`- auth_tag = Base64UrlEncoder.DecodeBytes(parts[4]);`
	`56`	`+ string header = Base64UrlHelper.DecodeToString(encoded_header);`
	`57`	`+ encrypted_key = Base64UrlHelper.DecodeToBytes(parts[1]);`
	`58`	`+ init_vector = Base64UrlHelper.DecodeToBytes(parts[2]);`
	`59`	`+ ciphertext = Base64UrlHelper.DecodeToBytes(parts[3]);`
	`60`	`+ auth_tag = Base64UrlHelper.DecodeToBytes(parts[4]);`
`60`	`61`
`61`	`62`	`protected_header = JsonConvert.DeserializeObject<JWE_header>(header);`
`62`	`63`	`}`
`@@ -79,7 +80,7 @@ public void EncodeHeader()`
`79`	`80`	`Formatting.None,`
`80`	`81`	`new JsonSerializerSettings { NullValueHandling = NullValueHandling.Ignore });`
`81`	`82`
`82`		`- encoded_header = Base64UrlEncoder.Encode(header_json);`
	`83`	`+ encoded_header = Base64UrlHelper.Encode(header_json);`
`83`	`84`	`}`
`84`	`85`
`85`	`86`	`public string EncodeCompact()`
`@@ -88,25 +89,25 @@ public string EncodeCompact()`
`88`	`89`
`89`	`90`	`if (encrypted_key != null)`
`90`	`91`	`{`
`91`		`- ret += Base64UrlEncoder.Encode(encrypted_key);`
	`92`	`+ ret += Base64UrlHelper.Encode(encrypted_key);`
`92`	`93`	`}`
`93`	`94`
`94`	`95`	`ret += ".";`
`95`	`96`	`if (init_vector != null)`
`96`	`97`	`{`
`97`		`- ret += Base64UrlEncoder.Encode(init_vector);`
	`98`	`+ ret += Base64UrlHelper.Encode(init_vector);`
`98`	`99`	`}`
`99`	`100`
`100`	`101`	`ret += ".";`
`101`	`102`	`if (ciphertext != null)`
`102`	`103`	`{`
`103`		`- ret += Base64UrlEncoder.Encode(ciphertext);`
	`104`	`+ ret += Base64UrlHelper.Encode(ciphertext);`
`104`	`105`	`}`
`105`	`106`
`106`	`107`	`ret += ".";`
`107`	`108`	`if (auth_tag != null)`
`108`	`109`	`{`
`109`		`- ret += Base64UrlEncoder.Encode(auth_tag);`
	`110`	`+ ret += Base64UrlHelper.Encode(auth_tag);`
`110`	`111`	`}`
`111`	`112`
`112`	`113`	`return ret;`
Original file line number	Diff line number	Diff line change
`@@ -3,6 +3,7 @@`
`3`	`3`	`using System.Security.Cryptography;`
`4`	`4`	`using System.Security.Cryptography.X509Certificates;`
`5`	`5`	`using Microsoft.Azure.Commands.KeyVault.SecurityDomain.Common;`
	`6`	`+using Microsoft.WindowsAzure.Commands.Utilities.Common;`
`6`	`7`	`using Newtonsoft.Json;`
`7`	`8`
`8`	`9`	`namespace Microsoft.Azure.Commands.KeyVault.SecurityDomain.Models`
`@@ -96,12 +97,12 @@ public string ToJson()`
`96`	`97`
`97`	`98`	`void SetExponent(byte[] exp)`
`98`	`99`	`{`
`99`		`- e = Base64UrlEncoder.Encode(exp);`
	`100`	`+ e = Base64UrlHelper.Encode(exp);`
`100`	`101`	`}`
`101`	`102`
`102`	`103`	`void SetModulus(byte[] modulus)`
`103`	`104`	`{`
`104`		`- n = Base64UrlEncoder.Encode(modulus);`
	`105`	`+ n = Base64UrlHelper.Encode(modulus);`
`105`	`106`	`}`
`106`	`107`
`107`	`108`	`void SetKeyType(JwkKeyType keyType)`
`@@ -236,12 +237,12 @@ public static byte[] ToByteArray(String HexString)`
`236`	`237`
`237`	`238`	`void SetX5t(X509Certificate2 cert)`
`238`	`239`	`{`
`239`		`- x5t = Base64UrlEncoder.Encode(ToByteArray(cert.Thumbprint));`
	`240`	`+ x5t = Base64UrlHelper.Encode(ToByteArray(cert.Thumbprint));`
`240`	`241`	`}`
`241`	`242`
`242`	`243`	`void SetX5t256(X509Certificate2 cert)`
`243`	`244`	`{`
`244`		`- x5t_S256 = Base64UrlEncoder.Encode(Utils.Sha256Thumbprint(cert));`
	`245`	`+ x5t_S256 = Base64UrlHelper.Encode(Utils.Sha256Thumbprint(cert));`
`245`	`246`	`}`
`246`	`247`
`247`	`248`	`public string kty { get; set; }`
Original file line number	Diff line number	Diff line change
`@@ -493,7 +493,7 @@ public SecurityDomainRestoreData EncryptForRestore(PlaintextList plaintextList,`
`493`	`493`	`JWE jwe_wrapped = new JWE();`
`494`	`494`	`jwe_wrapped.Encrypt(cert, master_key);`
`495`	`495`	`securityDomainRestoreData.WrappedKey.enc_key = jwe_wrapped.EncodeCompact();`
`496`		`- securityDomainRestoreData.WrappedKey.x5t_256 = Base64UrlEncoder.Encode(Utils.Sha256Thumbprint(cert));`
	`496`	`+ securityDomainRestoreData.WrappedKey.x5t_256 = Base64UrlHelper.Encode(Utils.Sha256Thumbprint(cert));`
`497`	`497`	`return securityDomainRestoreData;`
`498`	`498`	`}`
`499`	`499`	`catch (Exception ex)`