聊聊API设计的签名

1. 首先,举两个签名的实例

​ 最近在与三方系统对接的时候遇到好多API需要签名的实例,其中有一个签名是这样的:

  1. 调用方申请App Key 和 App Secret
  2. 在生成请求时,首先生成一个nonce无意义的字符串,字符串由调用方决定。App Key + nonce + App Secret 拼接后,进行SHA1加密,将App Key, nonce, 和加密后的串作为请求的一部分附加在请求上。
  3. 服务提供方不对nonce是否使用过进行校验。收到请求后,验证签名,验证通过后处理。

​ 另外一个签名是这样的

  1. 调用方申请 App Secret
  2. 生成请求时,使用所有参数根据字母顺序排序后拼接的字符串 + App Secret 进行MD5加密,然后将加密结果作为参数追加到请求上。
  3. 服务提供方收到请求后,首先根据参数识别出调用方,然后找到对应的App Secret进行加密并比对。结果比对成功后继续处理请求。

​ 在我看来,这两个签名设计的都有所欠缺。

​ 对于第一个签名设计:因为服务方不对nonce是否使用过进行判断,所以同一组App Key + nonce + App Secret 生成的签名可以被不同的请求多次使用,这就导致了请求可以被“伪造”:对于蓄意破坏者,只需要拦截到一组签名,即可无限次地成功访问被调用接口。如果目标接口是删除接口,那系统的风险就很大了。

​ 对于第二个签名设计:签名的识别是依赖于具体业务的。如果签名只用于某一个特殊的接口,问题不大,只需要对接口的参数做特殊处理即可;但如果签名被多个接口复用,签名的通用性就值得商榷了。

2. 为什么要使用签名

​ API签名主要使用在系统间进行交互时。采用API签名,第一是保证请求的数据正确性、保证接口安全;第二是识别API调用者的身份。

  1. 保证请求数据正确、保证接口安全: 以上面一节提到的签名2为例,当请求中的某一个字段的值变化时,原有的签名结果就会发生变化。所以,只要参数发生变化,签名就要发生变化,否则请求将会是一个无效的请求。从这一点上讲,上一节提到的签名1就没能做到这个功能。
  2. 识别API调用者身份:一般情况下,生成签名的算法都会成对出现一个App Key 和一个 App Secret,根据App Key 能识别出调用者身份;根据App Secret 能识别出签名是否合法。从这一点上讲,以上签名的签名2 做的就不是很好,其通用性并不是很强。
3. 一个比较合理的签名过程

​ 下面是一个比较合理的签名过程:

  1. 调用方申请App Key 和 App Secret
  2. 在生成请求时,使用所有字母顺序排序后拼接的字符串 + App Secret 拼接后进行MD5加密,然后将 App Key, 加密结果追加到请求上。
  3. 服务收到请求后,根据App Key识别出调用方,然后从字典中查询到对应的App Secret,与请求参数拼接、加密,与请求中的签名进行对比,签名结果相同的为合法请求。

​ 这种签名方式符合上一节提到的使用签名的目的:由于请求的参数会作为签名的一部分,所以请求参数变化后,签名结果一定会随之发生变化,否则将无法认证通过;通过App Key 可以快速识别出API 调用者的身份,而无需与实际业务逻辑掺杂起来,通用性更强。

​ 针对以上签名算法,签名的实现过程如下:

private static String genSign(List<NameValuePair> nvps) throws NoSuchAlgorithmException, IOException {
    List<String> nvs = Lists.newArrayList();
    for (NameValuePair nvp: nvps) {
        boolean noSignValue = nvp == null || nvp.getValue() == null ||
                SIGN_EXCEPTIONS.contains(nvp.getName());
        if (noSignValue) continue;
        nvs.add(String.format("%s=%s", nvp.getName(), nvp.getValue()));
    }
    Collections.sort(nvs);
    StringBuilder sb = new StringBuilder();
    for (String nv: nvs) sb.append(String.format("%s", nv));
    String encodeSource = String.format("%s%s", sb.toString(), APP_SECRET);
    return MD5Util.MD5Encode(encodeSource, ENCRYPT_CHARSET).toLowerCase();
}

​ API调用方将签名结果和 App Key 作为参数追加在请求尾部;API提供方使用签名方法进行签名并比对结果,即可方便地识别请求者身份、判断请求是否合法。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,732评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,496评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,264评论 0 338
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,807评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,806评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,675评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,029评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,683评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,704评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,666评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,773评论 1 332
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,413评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,016评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,978评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,204评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,083评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,503评论 2 343

推荐阅读更多精彩内容