refactor(wxapi): 优化加解密及哈希算法工具类

This commit is contained in:
Fu Diwei 2024-02-04 22:52:14 +08:00 committed by RHQYZ
parent a7eaf61c01
commit 3a4e65b1c6
12 changed files with 81 additions and 66 deletions

View File

@ -183,7 +183,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
List<string> tmp = new List<string>(capacity: 3) { client.Credentials.PushToken!, webhookTimestamp, webhookNonce }; List<string> tmp = new List<string>(capacity: 3) { client.Credentials.PushToken!, webhookTimestamp, webhookNonce };
tmp.Sort(StringComparer.Ordinal); tmp.Sort(StringComparer.Ordinal);
string sign = Utilities.SHA1Utility.Hash(string.Concat(tmp)); string sign = Utilities.SHA1Utility.Hash(string.Concat(tmp)).Value!;
return string.Equals(sign, webhookSignature, StringComparison.OrdinalIgnoreCase); return string.Equals(sign, webhookSignature, StringComparison.OrdinalIgnoreCase);
} }

View File

@ -23,7 +23,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
if (request.DeliverySignature is null) if (request.DeliverySignature is null)
{ {
string msgText = $"{request.ShopId}{request.ShopOrderId}{client.Credentials.ImmeDeliveryAppSecret}"; string msgText = $"{request.ShopId}{request.ShopOrderId}{client.Credentials.ImmeDeliveryAppSecret}";
request.DeliverySignature = Utilities.SHA1Utility.Hash(msgText).ToLower(); request.DeliverySignature = Utilities.SHA1Utility.Hash(msgText).Value!.ToLower();
} }
return request; return request;

View File

@ -50,7 +50,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
+ $"&org_loc={request.GetRequestPath()}" + $"&org_loc={request.GetRequestPath()}"
+ $"&method={request.GetRequestMethod()}" + $"&method={request.GetRequestMethod()}"
+ $"&secret={client.Credentials.MidasAppKey}"; + $"&secret={client.Credentials.MidasAppKey}";
request.Signature = Utilities.HMACUtility.HashWithSHA256(client.Credentials.MidasAppKey ?? string.Empty, msgText).ToLower(); request.Signature = Utilities.HMACUtility.HashWithSHA256(client.Credentials.MidasAppKey ?? string.Empty, msgText).Value!.ToLower();
} }
return request; return request;

View File

@ -41,7 +41,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
case Constants.MidasSignMethods.HMAC_SHA256: case Constants.MidasSignMethods.HMAC_SHA256:
{ {
string msgText = tmpRawData; string msgText = tmpRawData;
request.Signature = Utilities.HMACUtility.HashWithSHA256(request.SessionKey, msgText).ToLower(); request.Signature = Utilities.HMACUtility.HashWithSHA256(request.SessionKey, msgText).Value!.ToLower();
} }
break; break;
@ -58,7 +58,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request); tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request);
string msgText = $"{request.GetRequestPath()}&{tmpRawData}"; string msgText = $"{request.GetRequestPath()}&{tmpRawData}";
request.PaySign = Utilities.HMACUtility.HashWithSHA256(client.Credentials.MidasAppKeyV2 ?? string.Empty, msgText).ToLower(); request.PaySign = Utilities.HMACUtility.HashWithSHA256(client.Credentials.MidasAppKeyV2 ?? string.Empty, msgText).Value!.ToLower();
} }
return request; return request;

View File

@ -22,7 +22,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request); tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request);
string msgText = tmpRawData; string msgText = tmpRawData;
request.Signature = Utilities.HMACUtility.HashWithSHA256(request.SessionKey, msgText).ToLower(); request.Signature = Utilities.HMACUtility.HashWithSHA256(request.SessionKey, msgText).Value!.ToLower();
} }
if (request.PaySign is null) if (request.PaySign is null)
@ -30,7 +30,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request); tmpRawData = tmpRawData ?? client.JsonSerializer.Serialize(request);
string msgText = $"{request.GetRequestPath()}&{tmpRawData}"; string msgText = $"{request.GetRequestPath()}&{tmpRawData}";
request.PaySign = Utilities.HMACUtility.HashWithSHA256(client.Credentials.VirtualPaymentAppKey ?? string.Empty, msgText).ToLower(); request.PaySign = Utilities.HMACUtility.HashWithSHA256(client.Credentials.VirtualPaymentAppKey ?? string.Empty, msgText).Value!.ToLower();
} }
return request; return request;

View File

@ -27,7 +27,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
string timestamp = DateTimeOffset.Now.ToLocalTime().ToUnixTimeSeconds().ToString(); string timestamp = DateTimeOffset.Now.ToLocalTime().ToUnixTimeSeconds().ToString();
string nonce = Guid.NewGuid().ToString("N"); string nonce = Guid.NewGuid().ToString("N");
string sign = Utilities.SHA1Utility.Hash($"jsapi_ticket={jsapiTicket}&noncestr={nonce}&timestamp={timestamp}&url={url.Split('#')[0]}").ToLower(); string sign = Utilities.SHA1Utility.Hash($"jsapi_ticket={jsapiTicket}&noncestr={nonce}&timestamp={timestamp}&url={url.Split('#')[0]}").Value!.ToLower();
return new ReadOnlyDictionary<string, string>(new Dictionary<string, string>() return new ReadOnlyDictionary<string, string>(new Dictionary<string, string>()
{ {
@ -56,7 +56,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api
List<string> tmp = new List<string>(capacity: 5) { cardType, timestamp, client.Credentials.AppId, nonce, wxcardTicket }; List<string> tmp = new List<string>(capacity: 5) { cardType, timestamp, client.Credentials.AppId, nonce, wxcardTicket };
tmp.Sort(StringComparer.Ordinal); tmp.Sort(StringComparer.Ordinal);
string cardSign = Utilities.SHA1Utility.Hash(string.Concat(tmp)).ToLower(); string cardSign = Utilities.SHA1Utility.Hash(string.Concat(tmp)).Value!.ToLower();
return new ReadOnlyDictionary<string, string>(new Dictionary<string, string>() return new ReadOnlyDictionary<string, string>(new Dictionary<string, string>()
{ {

View File

@ -1,9 +1,10 @@
using System; using System;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text;
namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
{ {
using SKIT.FlurlHttpClient.Primitives;
/// <summary> /// <summary>
/// AES 算法工具类。 /// AES 算法工具类。
/// </summary> /// </summary>
@ -37,21 +38,22 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
/// <summary> /// <summary>
/// 基于 CBC 模式解密数据。 /// 基于 CBC 模式解密数据。
/// </summary> /// </summary>
/// <param name="encodingKey">经 Base64 编码后的 AES 密钥。</param> /// <param name="encodingKey">经过编码后的(通常为 Base64AES 密钥。</param>
/// <param name="encodingIV">经 Base64 编码后的 AES 初始化向量。</param> /// <param name="encodingIV">经过编码后的(通常为 Base64初始化向量。</param>
/// <param name="encodingCipherText">经 Base64 编码后的待解密数据。</param> /// <param name="encodingCipher">经过编码后的(通常为 Base64待解密数据。</param>
/// <returns>解密后的文本数据。</returns> /// <returns>解密后的数据。</returns>
public static string DecryptWithCBC(string encodingKey, string encodingIV, string encodingCipherText) public static EncodedString DecryptWithCBC(EncodedString encodingKey, EncodedString encodingIV, EncodedString encodingCipher)
{ {
if (encodingKey is null) throw new ArgumentNullException(nameof(encodingKey)); if (encodingKey.Value is null) throw new ArgumentNullException(nameof(encodingKey));
if (encodingCipherText is null) throw new ArgumentNullException(nameof(encodingCipherText)); if (encodingIV.Value is null) throw new ArgumentNullException(nameof(encodingIV));
if (encodingCipher.Value is null) throw new ArgumentNullException(nameof(encodingCipher));
byte[] plainBytes = DecryptWithCBC( byte[] plainBytes = DecryptWithCBC(
keyBytes: Convert.FromBase64String(encodingKey), keyBytes: EncodedString.FromString(encodingKey, fallbackEncodingKind: EncodingKinds.Base64),
ivBytes: Convert.FromBase64String(encodingIV), ivBytes: EncodedString.FromString(encodingIV, fallbackEncodingKind: EncodingKinds.Base64),
cipherBytes: Convert.FromBase64String(encodingCipherText) cipherBytes: EncodedString.FromString(encodingCipher, fallbackEncodingKind: EncodingKinds.Base64)
); );
return Encoding.UTF8.GetString(plainBytes); return EncodedString.ToLiteralString(plainBytes);
} }
/// <summary> /// <summary>
@ -82,21 +84,22 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
/// <summary> /// <summary>
/// 基于 CBC 模式加密数据。 /// 基于 CBC 模式加密数据。
/// </summary> /// </summary>
/// <param name="encodingKey">经 Base64 编码后的 AES 密钥。</param> /// <param name="encodingKey">经过编码后的(通常为 Base64AES 密钥。</param>
/// <param name="encodingIV">经 Base64 编码后的 AES 初始化向量。</param> /// <param name="encodingIV">经过编码后的(通常为 Base64初始化向量。</param>
/// <param name="plainText">待加密文本。</param> /// <param name="plainData">待加密数据。</param>
/// <returns>经 Base64 编码的加密后的数据。</returns> /// <returns>经 Base64 编码的加密后的数据。</returns>
public static string EncryptWithCBC(string encodingKey, string encodingIV, string plainText) public static EncodedString EncryptWithCBC(EncodedString encodingKey, EncodedString encodingIV, string plainData)
{ {
if (encodingKey is null) throw new ArgumentNullException(nameof(encodingKey)); if (encodingKey.Value is null) throw new ArgumentNullException(nameof(encodingKey));
if (plainText is null) throw new ArgumentNullException(nameof(plainText)); if (encodingIV.Value is null) throw new ArgumentNullException(nameof(encodingIV));
if (plainData is null) throw new ArgumentNullException(nameof(plainData));
byte[] plainBytes = EncryptWithCBC( byte[] plainBytes = EncryptWithCBC(
keyBytes: Convert.FromBase64String(encodingKey), keyBytes: EncodedString.FromString(encodingKey, fallbackEncodingKind: EncodingKinds.Base64),
ivBytes: Convert.FromBase64String(encodingIV), ivBytes: EncodedString.FromString(encodingIV, fallbackEncodingKind: EncodingKinds.Base64),
plainBytes: Encoding.UTF8.GetBytes(plainText) plainBytes: EncodedString.FromLiteralString(plainData)
); );
return Convert.ToBase64String(plainBytes); return EncodedString.ToBase64String(plainBytes);
} }
} }
} }

View File

@ -1,44 +1,49 @@
using System; using System;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text;
namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
{ {
using SKIT.FlurlHttpClient.Primitives;
/// <summary> /// <summary>
/// HMAC 算法工具类。 /// HMAC 算法工具类。
/// </summary> /// </summary>
public static class HMACUtility public static class HMACUtility
{ {
/// <summary> /// <summary>
/// 获取 HMAC-SHA-256 消息认证码 /// 计算 HMAC-SHA-256 哈希值
/// </summary> /// </summary>
/// <param name="secretBytes">密钥字节数组。</param> /// <param name="keyBytes">密钥字节数组。</param>
/// <param name="msgBytes">信息字节数组。</param> /// <param name="msgBytes">要计算哈希值的信息字节数组。</param>
/// <returns>消息认证码字节数组。</returns> /// <returns>哈希值字节数组。</returns>
public static byte[] HashWithSHA256(byte[] secretBytes, byte[] msgBytes) public static byte[] HashWithSHA256(byte[] keyBytes, byte[] msgBytes)
{ {
if (secretBytes is null) throw new ArgumentNullException(nameof(secretBytes)); if (keyBytes is null) throw new ArgumentNullException(nameof(keyBytes));
if (msgBytes is null) throw new ArgumentNullException(nameof(msgBytes)); if (msgBytes is null) throw new ArgumentNullException(nameof(msgBytes));
using HMAC hmac = new HMACSHA256(secretBytes); #if NET5_0_OR_GREATER
return HMACSHA256.HashData(keyBytes, msgBytes);
#else
using HMAC hmac = new HMACSHA256(keyBytes);
return hmac.ComputeHash(msgBytes); return hmac.ComputeHash(msgBytes);
#endif
} }
/// <summary> /// <summary>
/// 获取 HMAC-SHA-256 消息认证码 /// 计算 HMAC-SHA-256 哈希值
/// </summary> /// </summary>
/// <param name="secret">密钥。</param> /// <param name="key">密钥。</param>
/// <param name="message">文本信息。</param> /// <param name="message">要计算哈希值的信息。</param>
/// <returns>消息认证码。</returns> /// <returns>经过十六进制编码的哈希值。</returns>
public static string HashWithSHA256(string secret, string message) public static EncodedString HashWithSHA256(string key, string message)
{ {
if (secret is null) throw new ArgumentNullException(nameof(secret)); if (key is null) throw new ArgumentNullException(nameof(key));
if (message is null) throw new ArgumentNullException(nameof(message)); if (message is null) throw new ArgumentNullException(nameof(message));
byte[] secretBytes = Encoding.UTF8.GetBytes(secret); byte[] keyBytes = EncodedString.FromLiteralString(key);
byte[] msgBytes = Encoding.UTF8.GetBytes(message); byte[] msgBytes = EncodedString.FromLiteralString(message);
byte[] hashBytes = HashWithSHA256(secretBytes, msgBytes); byte[] hashBytes = HashWithSHA256(keyBytes, msgBytes);
return BitConverter.ToString(hashBytes).Replace("-", string.Empty); return EncodedString.ToHexString(hashBytes);
} }
} }
} }

View File

@ -1,39 +1,44 @@
using System; using System;
using System.Security.Cryptography; using System.Security.Cryptography;
using System.Text;
namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
{ {
using SKIT.FlurlHttpClient.Primitives;
/// <summary> /// <summary>
/// SHA-1 算法工具类。 /// SHA-1 算法工具类。
/// </summary> /// </summary>
public static class SHA1Utility public static class SHA1Utility
{ {
/// <summary> /// <summary>
/// 获取 SHA-1 信息摘要 /// 计算 SHA-1 哈希值
/// </summary> /// </summary>
/// <param name="bytes">信息字节数组。</param> /// <param name="bytes">要计算哈希值的信息字节数组。</param>
/// <returns>信息摘要字节数组。</returns> /// <returns>哈希值字节数组。</returns>
public static byte[] Hash(byte[] bytes) public static byte[] Hash(byte[] bytes)
{ {
if (bytes is null) throw new ArgumentNullException(nameof(bytes)); if (bytes is null) throw new ArgumentNullException(nameof(bytes));
using SHA1 sha = SHA1.Create(); #if NET5_0_OR_GREATER
return sha.ComputeHash(bytes); return SHA1.HashData(bytes);
#else
using SHA1 sha1 = SHA1.Create();
return sha1.ComputeHash(bytes);
#endif
} }
/// <summary> /// <summary>
/// 获取 SHA-1 信息摘要。 /// 计算 SHA-1 哈希值
/// </summary> /// </summary>
/// <param name="message">文本信息。</param> /// <param name="message">要计算哈希值的信息。</param>
/// <returns>信息摘要。</returns> /// <returns>经过十六进制编码的哈希值。</returns>
public static string Hash(string message) public static EncodedString Hash(string message)
{ {
if (message is null) throw new ArgumentNullException(nameof(message)); if (message is null) throw new ArgumentNullException(nameof(message));
byte[] msgBytes = Encoding.UTF8.GetBytes(message); byte[] msgBytes = EncodedString.FromLiteralString(message);
byte[] hashBytes = Hash(msgBytes); byte[] hashBytes = Hash(msgBytes);
return BitConverter.ToString(hashBytes).Replace("-", string.Empty); return EncodedString.ToHexString(hashBytes);
} }
} }
} }

View File

@ -233,7 +233,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.Utilities
tmp.Sort(StringComparer.Ordinal); tmp.Sort(StringComparer.Ordinal);
string rawText = string.Join(string.Empty, tmp); string rawText = string.Join(string.Empty, tmp);
string signText = SHA1Utility.Hash(rawText); string signText = SHA1Utility.Hash(rawText).Value!;
return signText.ToLower(); return signText.ToLower();
} }

View File

@ -2,6 +2,8 @@ using Xunit;
namespace SKIT.FlurlHttpClient.Wechat.Api.UnitTests namespace SKIT.FlurlHttpClient.Wechat.Api.UnitTests
{ {
using SKIT.FlurlHttpClient.Primitives;
public class TestCase_ToolsAESUtilityTests public class TestCase_ToolsAESUtilityTests
{ {
[Fact(DisplayName = "测试用例AES-CBC 解密")] [Fact(DisplayName = "测试用例AES-CBC 解密")]
@ -12,7 +14,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.UnitTests
string cipherText = "Gu2PVnxVWl+jK4F8c0liGxfkB5Bj3m5HRvwgEIk1Yb+36RZ3Bg7YmUnud/ooiHz0PQroipsH7GCjlGwUeT04NwmrFaP1y3dRYPLpS43ed9QZWcFIFo+8vTs3Zco6S98DUvaNEAs8duhz/BzfBOZaIHMziRqEtPFI0ZDzCgJluBirJ6Wl3UkygZ5/QLo3KA53qGdip7K48Rq8XbCwuidTCw=="; string cipherText = "Gu2PVnxVWl+jK4F8c0liGxfkB5Bj3m5HRvwgEIk1Yb+36RZ3Bg7YmUnud/ooiHz0PQroipsH7GCjlGwUeT04NwmrFaP1y3dRYPLpS43ed9QZWcFIFo+8vTs3Zco6S98DUvaNEAs8duhz/BzfBOZaIHMziRqEtPFI0ZDzCgJluBirJ6Wl3UkygZ5/QLo3KA53qGdip7K48Rq8XbCwuidTCw==";
string expectedPlainData = "{\"phoneNumber\":\"186****5613\",\"purePhoneNumber\":\"186****5613\",\"countryCode\":\"86\",\"watermark\":{\"timestamp\":1634545675,\"appid\":\"wxc****17e87e0e0a7\"}}"; string expectedPlainData = "{\"phoneNumber\":\"186****5613\",\"purePhoneNumber\":\"186****5613\",\"countryCode\":\"86\",\"watermark\":{\"timestamp\":1634545675,\"appid\":\"wxc****17e87e0e0a7\"}}";
string actualPlainData = Utilities.AESUtility.DecryptWithCBC(encodingKey: key, encodingIV: iv, encodingCipherText: cipherText); string actualPlainData = Utilities.AESUtility.DecryptWithCBC(encodingKey: new EncodedString(key, EncodingKinds.Base64), encodingIV: new EncodedString(iv, EncodingKinds.Base64), encodingCipher: new EncodedString(cipherText, EncodingKinds.Base64))!;
Assert.Equal(expectedPlainData, actualPlainData, ignoreCase: true); Assert.Equal(expectedPlainData, actualPlainData, ignoreCase: true);
} }

View File

@ -9,7 +9,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.UnitTests
{ {
string rawData = "jsapi_ticket=HoagFKDcsGMVCIY2vOjf9nGrZ3eaM0qXs5ROFN_3k_HrGc0VocemA6wMXkvrL-Ei4IitXxwKF62CJWR8mWXZ3Q&noncestr=e7b435f73835402da44f16640ddc8696&timestamp=1621348162&url=https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=jsapisign"; string rawData = "jsapi_ticket=HoagFKDcsGMVCIY2vOjf9nGrZ3eaM0qXs5ROFN_3k_HrGc0VocemA6wMXkvrL-Ei4IitXxwKF62CJWR8mWXZ3Q&noncestr=e7b435f73835402da44f16640ddc8696&timestamp=1621348162&url=https://mp.weixin.qq.com/debug/cgi-bin/sandbox?t=jsapisign";
string actualHash = Utilities.SHA1Utility.Hash(rawData); string actualHash = Utilities.SHA1Utility.Hash(rawData)!;
string expectedHash = "b214ea1f8ae019c207f8c6ffb843c8474cbab28c"; string expectedHash = "b214ea1f8ae019c207f8c6ffb843c8474cbab28c";
Assert.Equal(expectedHash, actualHash, ignoreCase: true); Assert.Equal(expectedHash, actualHash, ignoreCase: true);
@ -21,7 +21,7 @@ namespace SKIT.FlurlHttpClient.Wechat.Api.UnitTests
string secret = "zNLgAGgqsEWJOg1nFVaO5r7fAlIQxr1u"; string secret = "zNLgAGgqsEWJOg1nFVaO5r7fAlIQxr1u";
string rawData = "appid=wx1234567&offer_id=12345678&openid=odkx20ENSNa2w5y3g_qOkOvBNM1g&pf=android&ts=1507530737&zone_id=1&org_loc=/cgi-bin/midas/getbalance&method=POST&secret=zNLgAGgqsEWJOg1nFVaO5r7fAlIQxr1u"; string rawData = "appid=wx1234567&offer_id=12345678&openid=odkx20ENSNa2w5y3g_qOkOvBNM1g&pf=android&ts=1507530737&zone_id=1&org_loc=/cgi-bin/midas/getbalance&method=POST&secret=zNLgAGgqsEWJOg1nFVaO5r7fAlIQxr1u";
string actualHash = Utilities.HMACUtility.HashWithSHA256(secret, rawData); string actualHash = Utilities.HMACUtility.HashWithSHA256(secret, rawData)!;
string expectedHash = "1ad64e8dcb2ec1dc486b7fdf01f4a15159fc623dc3422470e51cf6870734726b"; string expectedHash = "1ad64e8dcb2ec1dc486b7fdf01f4a15159fc623dc3422470e51cf6870734726b";
Assert.Equal(expectedHash, actualHash, ignoreCase: true); Assert.Equal(expectedHash, actualHash, ignoreCase: true);