釘釘客戶端JS-API權限簽名算法.NET版

　　前段時間寫了一篇博文《釘釘如何進行PC端開發》，在里面並未解決本地生成簽名的問題，需要到官網進行生成，由於釘釘門票等認證信息會超期，因此，必須能本地用代碼自動更新相關參數信息，來換取簽名。官方文檔由於這塊並未有.NET版本的簽名API可供調用，無奈只能自己摸索着進行實現。可笑的是，在看釘釘文檔時候並未理解其算法，但是卻在看微信JS-API簽名生成算法的時候頓悟了。感覺二者這個權限體系認證很是類似。

　　話不多說，切入正題。

　　釘釘廣泛文檔對於JS-API的說明是這樣的：

開發者在web頁面使用釘釘容器提供的jsapi時，需要驗證調用權限，並以參數signature標識合法性

簽名生成的規則：

List keyArray = sort(noncestr,timestamp,jsapi_ticket,url);

String str = assemble(keyArray);

signature = sha1(str);

參與簽名的字段包括在上文中獲取的jsapi_ticket，noncestr（隨機字符串，自己隨便填寫即可）,timestamp（當前時間戳，具體值為當前時間到1970年1月1號的秒數）,url（當前網頁的URL，不包含#及其后面部分）。例如：

• noncestr=Zn4zmLFKD0wzilzM
• jsapi_ticket=mS5k98fdkdgDKxkXGEs8LORVREiweeWETE40P37wkidkfksDSKDJFD5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcKIDU8l
• timestamp=1414588745
• url=http://open.dingtalk.com

步驟1. sort()含義為對所有待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）

步驟2. assemble()含義為根據步驟1中獲的參數字段的順序，使用URL鍵值對的格式（即key1=value1&key2=value2…）拼接成字符串

步驟2. sha1()的含義為對在步驟2拼接好的字符串進行sha1加密。（PS：明明是步驟3好么！）

　　一開始沒有理解，用代碼生成簽名和官方的就是對不上，很是打擊。但是后來發現就是沒有理解文檔中的第一步，后來發現是：簽名參數按照【字段名】而非一開始理解的參數值。

　　既然理解了，那么先看看簽名參數按照字段名noncestr、jsapi_ticket、timestamp和url的字典排序吧：

ArrayList AL = new ArrayList();
AL.Add("noncestr");
AL.Add("jsapi_ticket");
AL.Add("timestamp");
AL.Add("url");
AL.Sort();

那么下一步就是拼接字符串了：

string assemble =string.Format("jsapi_ticket={0}&noncestr={1}&timestamp={2}&url={3}", jsapi_ticket, noncestr,sTimeStamp, url);

最后一步驟：

 sha = new SHA1CryptoServiceProvider();
 enc = new ASCIIEncoding();
 byte[] dataToHash = enc.GetBytes(assemble);
byte[] dataHashed = sha.ComputeHash(dataToHash);
hash = BitConverter.ToString(dataHashed).Replace("-", "");
hash = hash.ToLower();

完整代碼如下，注意此包含時間戳的生產方法：

using System;
using System.Text;
using System.Security.Cryptography;
using Suite.Corp;
using System.Collections;
/*
* Author：JackWangCUMT
* Date:2016-04-26 8:36
* Blogs:http://www.cnblogs.com/isaboy
* GitHub:https://github.com/JackWangCUMT
* QQ:308106637
*/
namespace myDDDev
{
    public static class DingTalkAuth
    {
        /// <summary>
        ///開發者在web頁面使用釘釘容器提供的jsapi時，需要驗證調用權限，並以參數signature標識合法性
        ///簽名生成的規則：
        ///List keyArray = sort(noncestr, timestamp, jsapi_ticket, url);
        /// String str = assemble(keyArray);
        ///signature = sha1(str);
        /// </summary>
        /// <param name="noncestr">隨機字符串，自己隨便填寫即可</param>
        /// <param name="sTimeStamp">當前時間戳，具體值為當前時間到1970年1月1號的秒數</param>
        /// <param name="jsapi_ticket">獲取的jsapi_ticket</param>
        /// <param name="url">當前網頁的URL，不包含#及其后面部分</param>
        /// <param name="signature">生成的簽名</param>
        /// <returns>0 成功，2 失敗</returns>
        public static int GenSigurate(string noncestr, string sTimeStamp, string jsapi_ticket, string url, ref string signature)
        {


            //例如：
            //noncestr = Zn4zmLFKD0wzilzM
            //jsapi_ticket = mS5k98fdkdgDKxkXGEs8LORVREiweeWETE40P37wkidkfksDSKDJFD5h9nbSlYy3-Sl-HhTdfl2fzFy1AOcKIDU8l
            //timestamp = 1414588745
            //url = http://open.dingtalk.com

            //步驟1.sort()含義為對所有待簽名參數按照字段名的ASCII 碼從小到大排序（字典序）
            //注意，此處是是按照【字段名】的ASCII字典序，而不是參數值的字典序（這個細節折磨我很久了)
            //0:jsapi_ticket 1:noncestr 2:timestamp 3:url;

            //步驟2.assemble()含義為根據步驟1中獲的參數字段的順序，使用URL鍵值對的格式（即key1 = value1 & key2 = value2…）拼接成字符串
            //string assemble = "jsapi_ticket=3fOo5UfWhmvRKnRGMmm6cWwmIxDMCnniyVYL2fqcz1I4GNU4054IOlif0dZjDaXUScEjoOnJWOVrdwTCkYrwSl&noncestr=CUMT1987wlrrlw&timestamp=1461565921&url=https://jackwangcumt.github.io/home.html";
            string assemble =string.Format("jsapi_ticket={0}&noncestr={1}&timestamp={2}&url={3}", jsapi_ticket, noncestr,sTimeStamp, url);
            //步驟2.sha1()的含義為對在步驟2拼接好的字符串進行sha1加密。
            SHA1 sha;
            ASCIIEncoding enc;
            string hash = "";
            try
            {
                sha = new SHA1CryptoServiceProvider();
                enc = new ASCIIEncoding();
                byte[] dataToHash = enc.GetBytes(assemble);
                byte[] dataHashed = sha.ComputeHash(dataToHash);
                hash = BitConverter.ToString(dataHashed).Replace("-", "");
                hash = hash.ToLower();
            }
            catch (Exception)
            {
                return 2;
            }
            signature = hash;
            return 0;
           
        }

        /// <summary>
        /// 獲取時間戳timestamp（當前時間戳，具體值為當前時間到1970年1月1號的秒數）
        /// </summary>
        /// <returns></returns>
        public static string GetTimeStamp()
        {
            TimeSpan ts = DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, 0);
            return Convert.ToInt64(ts.TotalSeconds).ToString();
        }
        /// <summary>
        /// 字典排序
        /// </summary>
        public class DictionarySort : System.Collections.IComparer
        {
            public int Compare(object oLeft, object oRight)
            {
                string sLeft = oLeft as string;
                string sRight = oRight as string;
                int iLeftLength = sLeft.Length;
                int iRightLength = sRight.Length;
                int index = 0;
                while (index < iLeftLength && index < iRightLength)
                {
                    if (sLeft[index] < sRight[index])
                        return -1;
                    else if (sLeft[index] > sRight[index])
                        return 1;
                    else
                        index++;
                }
                return iLeftLength - iRightLength;

            }
        }
    }
}

 代碼已經放置在GitHub上：https://github.com/JackWangCUMT/DDHelper