通用 HTTP 签名组件的另类实现

1、初衷

开发中经常需要做一些接口的签名生成和校验工作，最开始的时候都是每个接口去按照约定单独实现，久而久之就变的非常难维护，因此就琢磨怎么能够写了一个比较通用的签名生成工具。
2、思路

采用链式调用的方式，使得签名的步骤可以动态拼凑组合。
3、直接看效果

1.     //设置数据源
2.     var signSource = new Dictionary<string, string>()
3.     {
4.         { "param1", "1" },
5.         { "param3", "3+" },
6.         { "param2", "2" }
7.     };
8.     var signer = new HttpSigner();
9.     signer.SetSignData(signSource);
11.     //设置数据源并配置规则
12.     signer.SetSignData(signSource, setting =>
13.     {
14.         //按参数名排序
15.         //result --> param1 param2 param3
16.         setting.IsOrderByWithKey = false;
18.         //是否对签名数据的参数值进行UrlEncode
19.         setting.IsDoUrlEncodeForSourceValue = false;
21.         //签名主体是否包含参数名
22.         setting.IsSignTextContainKey = true;
23.         //签名主体中参数和参数值的连接符（需要启用IsSignTextContainKey）
24.         setting.SignTextKeyValueSeparator = "=";
25.         //签名主体中不同参数项的连接符
26.         setting.SignTextItemSeparator = "&";
27.         //以上都开启后  --> param1=1&param2=2&param3=3
29.         //编码
30.         setting.DefaultEncoding = Encoding.UTF8;
31.     });
33.     //签名主体设置前缀
34.     signer.SetSignData(signSource).SetSignTextPrefix("TestPrefix");
36.     //签名主体设置后缀
37.     signer.SetSignData(signSource).SetSignTextSuffix("TestSuffix");
39.     //签名主体进行Base64
40.     signer.SetSignData(signSource).SetSignTextBase64();
42.     //签名主体进行MD5,(方法参数为签名结果是否转小写)
43.     signer.SetSignData(signSource).SetSignTextMD5(bool isToLower = true);
45.     //签名主体进行SHA1,(方法参数为签名结果是否转小写)
46.     signer.SetSignData(signSource).SetSignTextSHA1(bool isToLower = true);
48.     //获取签名结果
49.     string signString = signer.SetSignData(signSource).GetSignResult();
51.     //组合调用
52.     string signString = signer.SetSignData(signSource).SetSignTextBase64().SetSignTextMD5().SetSignTextSHA1();

复制代码

4、代码实现

HttpSignItem类

用于保存签名的参数集合。

1. namespace JiuLing.CommonLibs.Security.HttpSign
2. {
3.     internal class HttpSignItem
4.     {
5.         public string Key { get; set; }
6.         public string Value { get; set; }
8.         public HttpSignItem(string key, string value)
9.         {
10.             Key = key;
11.             Value = value;
12.         }
13.     }
14. }

复制代码

HttpSignSetting类

用于签名的基本配置。

1. using System.Text;
3. namespace JiuLing.CommonLibs.Security.HttpSign
4. {
5.     /// <summary>
6.     /// 签名配置
7.     /// </summary>
8.     public class HttpSignSetting
9.     {
10.         /// <summary>
11.         /// 是否按参数名进行排序
12.         /// </summary>
13.         public bool IsOrderByWithKey { get; set; } = false;
15.         /// <summary>
16.         /// 是否对签名数据的参数值进行UrlEncode
17.         /// </summary>
18.         public bool IsDoUrlEncodeForSourceValue { get; set; } = false;
20.         /// <summary>
21.         /// 签名主体是否包含参数名
22.         /// </summary>
23.         public bool IsSignTextContainKey { get; set; } = true;
25.         /// <summary>
26.         /// 签名主体中参数和参数值的连接符（需要启用IsSignTextContainKey）
27.         /// </summary>
28.         public string SignTextKeyValueSeparator { get; set; } = "=";
30.         /// <summary>
31.         /// 签名主体中不同参数项的连接符
32.         /// </summary>
33.         public string SignTextItemSeparator { get; set; } = "&";
35.         /// <summary>
36.         /// 编码
37.         /// </summary>
38.         public Encoding DefaultEncoding { get; set; } = Encoding.UTF8;
39.     }
40. }

复制代码

HttpSigner类

签名组件的具体实现。

1. using System;
2. using System.Collections.Generic;
3. using System.Linq;
5. namespace JiuLing.CommonLibs.Security.HttpSign
6. {
7.     /// <summary>
8.     /// 网络请求签名工具
9.     /// </summary>
10.     public class HttpSigner
11.     {
12.         /// <summary>
13.         /// 签名配置
14.         /// </summary>
15.         private readonly HttpSignSetting _setting = new HttpSignSetting();
16.         /// <summary>
17.         /// 最终的签名串
18.         /// </summary>
19.         private string _signString;
21.         /// <summary>
22.         /// 设置签名数据
23.         /// </summary>
24.         /// <param name="signSource">待签名的键值对</param>
25.         /// <param name="setting">配置签名规则</param>
26.         /// <returns></returns>
27.         /// <exception cref="ArgumentException"></exception>
28.         public HttpSigner SetSignData(Dictionary<string, string> signSource, Action<HttpSignSetting> setting = null)
29.         {
30.             setting?.Invoke(_setting);
31.             if (_setting == null)
32.             {
33.                 throw new ArgumentNullException("无效的签名配置", "setting");
34.             }
36.             if (signSource == null || signSource.Count == 0)
37.             {
38.                 throw new ArgumentException("待签名数据异常", nameof(signSource));
39.             }
41.             var signSourceList = new List<HttpSignItem>(signSource.Count);
42.             foreach (var item in signSource)
43.             {
44.                 var itemValue = item.Value;
45.                 if (_setting.IsDoUrlEncodeForSourceValue)
46.                 {
47.                     itemValue = System.Web.HttpUtility.UrlEncode(itemValue, _setting.DefaultEncoding);
48.                 }
49.                 signSourceList.Add(new HttpSignItem(item.Key, itemValue));
50.             }
52.             if (_setting.IsOrderByWithKey)
53.             {
54.                 signSourceList = signSourceList.OrderBy(x => x.Key).ToList();
55.             }
57.             if (_setting.IsSignTextContainKey)
58.             {
59.                 _signString = string.Join(_setting.SignTextItemSeparator, signSourceList.Select(x => $"{x.Key}{_setting.SignTextKeyValueSeparator}{x.Value}"));
60.             }
61.             else
62.             {
63.                 _signString = string.Join(_setting.SignTextItemSeparator, signSourceList.Select(x => x.Value));
64.             }
66.             return this;
67.         }
69.         /// <summary>
70.         /// 签名主体设置前缀
71.         /// </summary>
72.         /// <param name="input">前缀值</param>
73.         /// <returns></returns>
74.         public HttpSigner SetSignTextPrefix(string input)
75.         {
76.             _signString = $"{input}{_signString}";
77.             return this;
78.         }
80.         /// <summary>
81.         /// 签名主体设置后缀
82.         /// </summary>
83.         /// <param name="input">后缀值</param>
84.         /// <returns></returns>
85.         public HttpSigner SetSignTextSuffix(string input)
86.         {
87.             _signString = $"{_signString}{input}";
88.             return this;
89.         }
91.         /// <summary>
92.         /// 签名主体设置后缀
93.         /// </summary>
94.         /// <returns></returns>
95.         public HttpSigner SetUrlEncode()
96.         {
97.             _signString = System.Web.HttpUtility.UrlEncode(_signString, _setting.DefaultEncoding);
98.             return this;
99.         }
101.         /// <summary>
102.         /// 签名主体进行Base64
103.         /// </summary>
104.         /// <returns></returns>
105.         public HttpSigner SetSignTextBase64()
106.         {
107.             _signString = Base64Utils.GetStringValue(_signString);
108.             return this;
109.         }
111.         /// <summary>
112.         /// 签名主体进行MD5
113.         /// </summary>
114.         /// <param name="isToLower">签名结果是否转小写</param>
115.         /// <returns></returns>
116.         public HttpSigner SetSignTextMD5(bool isToLower = true)
117.         {
118.             if (isToLower)
119.             {
120.                 _signString = MD5Utils.GetStringValueToLower(_signString);
121.             }
122.             else
123.             {
124.                 _signString = MD5Utils.GetStringValueToUpper(_signString);
125.             }
126.             return this;
127.         }
129.         /// <summary>
130.         /// 签名主体进行SHA1
131.         /// </summary>
132.         /// <param name="isToLower">签名结果是否转小写</param>
133.         /// <returns></returns>
134.         public HttpSigner SetSignTextSHA1(bool isToLower = true)
135.         {
136.             if (isToLower)
137.             {
138.                 _signString = SHA1Utils.GetStringValueToLower(_signString);
139.             }
140.             else
141.             {
142.                 _signString = SHA1Utils.GetStringValueToUpper(_signString);
143.             }
144.             return this;
145.         }
147.         /// <summary>
148.         /// 获取签名结果
149.         /// </summary>
150.         /// <returns></returns>
151.         public string GetSignResult()
152.         {
153.             return _signString;
154.         }
155.     }
156. }

复制代码

5、附上仓库地址

以上代码包含在我的通用类库中，可以直接Nuget搜索JiuLing.CommonLibs安装。
GitHub类库地址
文章代码地址

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！