如何寫出安全的API接口？接口參數加密簽名設計思路

       開發中常常用到接口，尤爲是在面向服務的soa架構中，數據交互全是用的接口。        

       幾年之前我認爲，我寫個接口，不向任何人告知個人接口地址，個人接口就是安全的，如今回想真是too young,too simple。但凡部署在廣域網的應用程序，隨隨便便的好多工具能夠根據ip或域名掃描應用程序的全部暴露的接口，進而分析參數，注入程序，分分鐘被攻擊。        

       那咋才能保證接口的安全性呢？

（一）面臨的主要安全問題

a.網絡環境假設：

a1.假設公共網絡（Internet，如：WIFI、非家庭網絡、非辦公網絡等） 是不安全的，一切基於HTTP協議的請求/響應(Request or Response)都是能夠被截獲的、篡改、重放(重發)的。

b.接口安全要求：

b1.防假裝攻擊（案例：在公共網絡環境中，第三方 有意或惡意 的調用咱們的接口）

b2.防篡改攻擊（案例：在公共網絡環境中，請求頭/查詢字符串/內容 在傳輸過程被修改）

b3.防重放攻擊（案例：在公共網絡環境中，請求被截獲，稍後被重放或屢次重放）

b4.防數據信息泄漏（案例：截獲用戶登陸請求，截獲到帳號、密碼等）

（二）可參考的商業標準

可參見： HTTP數據傳輸安全方案  HTTPS（HTTP安全商業標準）

http://baike.baidu.com/view/14121.htm

 

（三）可參考國內互聯網廠商參考

新浪OpenAPI、騰訊、淘寶 等。

 

（四）設計原則

1.輕量級

2.適合於異構系統（跨操做系統、多語言簡易實現）

3.易於開發

4.易於測試

5.易於部署

6.知足接口安全需求（知足b1 b2 b3要求），無過分設計。

 

其它：接口安全要求b4部分，主要針對目前用戶中心的登陸接口

設計原則是：使用HTTPS安全協議 或 傳輸內容使用非對稱加密，目前咱們採用的後者。 

 

（五）適用範圍

1.全部寫操做接口（增、刪、改 操做）

2.非公開的讀接口（如：涉密/敏感/隱私 等信息）

 

（六）接口參數簽名 實現思路參考

必要的輸入參數

參數名	類型	必選	描述
_appid	string	是	調用方身份ID，接口提供方用此來識別調不一樣的調用者，該參數是API基本規範的一部分，請詳見API公共規範。
_sign	string	是	一次接口調用的簽名值，服務器端 「防止 假裝請求/防篡改/ 防重發」 識別的重要依據。
_timestamp	Int	是	時間戳（long Timestamp = DateTime.Now.Ticks;）

 

簽名算法過程：

1.對除簽名外的全部請求參數按key作的升序排列,value無需編碼。
 （假設當前時間的時間戳是12345678）

例如：有c=3,b=2,a=1 三個參，另加上時間戳後， 按key排序後爲：a=1，b=2，c=3，_timestamp=12345678。

2 把參數名和參數值鏈接成字符串，獲得拼裝字符：a1b2c3_timestamp12345678

3 用申請到的appkey 鏈接到接拼裝字符串頭部和尾部，而後進行32位MD5加密，最後將到得MD5加密摘要轉化成大寫。

示例：假設appkey=test，md5(testa1b2c3_timestamp12345678test)，取得MD5摘要值 C5F3EB5D7DC2748AED89E90AF00081E6 。

 

再看一個更具體的Sample Code:

如何得取以下請求的簽名值：
http://api.demo.com/dog/add?1=壹&A=aaa&Z=zzz&_appid=club&_timestamp=12345678&a=AAA&z=ZZZ

C#實現代碼以下 ( 請新建一個C#代碼文件 SampleCode.cs )：

test()方法展現瞭如何取得該請的簽名參數值 ( _sign=8B0E081689789CF66490E65BB8E1B0E7 )，現實業務中依據本身的狀況，把建立請求的過程封裝成公共方法，使得請求url的建立過程對開發人員透明，簡化處理。

 

[下方會提供 .Net的 Sample Code] 

-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------

.Net

using System; using System.Collections.Generic; using System.Linq; using System.Text; namespace test3 { public class SampleCode { public static string test() { int _timestamp = 12345678; var param = new SortedDictionary<string, string>(new AsciiComparer()); param.Add("z", "ZZZ"); param.Add("a", "AAA"); param.Add("Z", "zzz"); param.Add("A", "aaa"); param.Add("2", "貳"); param.Add("1", "壹"); param.Add("_appid", "club"); param.Add("_timestamp", _timestamp.ToString()); string _sign = GetSign(param); string urlParam = string.Join("&", param.Select(i => i.Key + "=" + i.Value)); string url = "http://api.demo.com/dog/add?" + urlParam + "&_sign=" + _sign; return url; } public static string GetSign(SortedDictionary<string, string> paramList, string appKey = "test") { paramList.Remove("_sign"); StringBuilder sb = new StringBuilder(appKey); foreach (var p in paramList) sb.Append(p.Key).Append(p.Value); sb.Append(appKey); return GetMD5(sb.ToString()); } public static string GetMD5(string str) { if (string.IsNullOrEmpty(str)) return str; var sb = new StringBuilder(32); var md5 = System.Security.Cryptography.MD5.Create(); var output = md5.ComputeHash(Encoding.UTF8.GetBytes(str)); for (int i = 0; i < output.Length; i++) sb.Append(output[i].ToString("X").PadLeft(2, '0')); return sb.ToString(); } } /// <summary>
    /// 基於ASCII碼排序規則的String比較器 /// Author：HeDaHong /// </summary>
    public class AsciiComparer : System.Collections.Generic.IComparer<string> { public int Compare(string a, string b) { if (a == b) return 0; else if (string.IsNullOrEmpty(a)) return -1; else if (string.IsNullOrEmpty(b)) return 1; if (a.Length <= b.Length) { for (int i = 0; i < a.Length; i++) { if (a[i] < b[i]) return -1; else if (a[i] > b[i]) return 1; else
                        continue; } return a.Length == b.Length ? 0 : -1; } else { for (int i = 0; i < b.Length; i++) { if (a[i] < b[i]) return -1; else if (a[i] > b[i]) return 1; else
                        continue; } return 1; } } } }

 

 總結：

1. 接口調用方和接口提供方約定好統一的參數加密算法
2. 接口調用方在調用時把加密後的_sign放在參數中去請求接口
3. 接口提供方接到響應後，判斷時間戳是否是在有效時間內（這個時間間隔根據你的安全範圍能夠是10分鐘，5分鐘，20秒等，過時失效，前提是須要保證接口提供方和調用方的服務器時間爲準確的網絡同步時間）
   
4. 把參數中除了_sign之外的參數進行加密，而後把加密結果和傳過來的_sign比較，相同則執行調用請求。

有同窗說難以理解，我這兩天寫個demo，請參考下一篇文章：http://www.cnblogs.com/codeon/p/6123863.html