西安网络公司|西安做网站|西安网站建设|西安网站制作|宏博网络-专注于高端网站网页设计开发十余年

029-81773686

宏 · 新闻

当前位置: 首页 > 宏 · 新闻行业视野  

西安网络公司,HOOBOO教您在开发API时是如何设计签名验证的?

2020.08.02

西安网络公司,HOOBOO在开发过程中,我们经常会与接口打交道,有的时候是调取别人网站的接口,有的时候是为他人提供自己网站的接口,但是在这调取的过程中都离不开签名验证。


我们在设计签名验证的时候,请注意要满足以下几点:


可变性:每次的签名必须是不一样的。


时效性:每次请求的时效,过期作废等。


唯一性:每次的签名是唯一的。


完整性:能够对传入数据进行验证,防止篡改。




一、签名参数sign生成的方法


第1步: 将所有参数(注意是所有参数),除去sign本身,以及值是空的参数,按参数名字母升序排序。


第2步: 然后把排序后的参数按参数1值1参数2值2…参数n值n(这里的参数和值必须是传输参数的原始值,不能是经过处理的,如不能将"转成”后再拼接)的方式拼接成一个字符串。


第3步: 把分配给接入方的验证密钥key拼接在第2步得到的字符串前面。


第2步: 在上一步得到的字符串前面加上验证密钥key(这里的密钥key是接口提供方分配给接口接入方的),然后计算md5值,得到32位字符串,然后转成大写.


第4步: 计算第3步字符串的md5值(32位),然后转成大写,得到的字符串作为sign的值。


举例:


假设传输的数据是/interface.php?sign=sign_value&p2=v2&p1=v1&method=cancel&p3=&pn=vn(实际情况最好是通过post方式发送),其中sign参数对应的sign_value就是签名的值。


第一步,拼接字符串,首先去除sign参数本身,然后去除值是空的参数p3,剩下p2=v2&p1=v1&method=cancel&pn=vn,然后按参数名字符升序排序,method=cancel&p1=v1&p2=v2&pn=vn.


第二步,然后做参数名和值的拼接,最后得到methodcancelp1v1p2v2pnvn


第三步,在上面拼接得到的字符串前加上验证密钥key,我们假设是abc,得到新的字符串abcmethodcancelp1v1p2v2pnvn


第四步,然后将这个字符串进行md5计算,假设得到的是abcdef,然后转为大写,得到ABCDEF这个值即为sign签名值。


注意,计算md5之前请确保接口与接入方的字符串编码一致,如统一使用utf-8编码或者GBK编码,如果编码方式不一致则计算出来的签名会校验失败。


二、签名验证方法:


根据前面描述的签名参数sign生成的方法规则,计算得到参数的签名值,和参数中通知过来的sign对应的参数值进行对比,如果是一致的,那么就校验通过,如果不一致,说明参数被修改过。


三、下面直接看代码


<?php

// 设置一个公钥(key)和私钥(secret),公钥用于区分用户,私钥加密数据,不能公开

$key = "kjjewlqscxc0dcc509a6f75849b";

$secret = "1235cds32e3d61a0411511d3b16f0636";


// 待发送的数据包

$data = array(

  'username' => 'abc@qq.com',

  'sex' => '1',

  'age' => '16',

  'addr' => 'guangzhou',

  'key' => $key,

  'timestamp' => time(),

);


// 获取sign

function getSign($secret, $data) {

  // 对数组的值按key排序

  ksort($data);

  // 生成url的形式

  $params = http_build_query($data);

  // 生成sign

  $sign = md5($params . $secret);

  return $sign;

}


// 发送的数据加上sign

$data['sign'] = getSign($secret, $data);


/**

 * 后台验证sign是否合法

 * @param [type] $secret [description]

 * @param [type] $data  [description]

 * @return [type]     [description]

 */

function verifySign($secret, $data) {

  // 验证参数中是否有签名

  if (!isset($data['sign']) || !$data['sign']) {

    echo '发送的数据签名不存在';

    die();

  }

  if (!isset($data['timestamp']) || !$data['timestamp']) {

    echo '发送的数据参数不合法';

    die();

  }

  // 验证请求, 10分钟失效

  if (time() - $data['timestamp'] > 600) {

    echo '验证失效, 请重新发送请求';

    die();

  }

  $sign = $data['sign'];

  unset($data['sign']);

  ksort($data);

  $params = http_build_query($data);

  // $secret是通过key在api的数据库中查询得到

  $sign2 = md5($params . $secret);

  if ($sign == $sign2) {

    die('验证通过');

  } else {

    die('请求不合法');

  }

}

?>


精彩案例

让价值共享 记录企业发展脚步 感恩相伴 029-81773686   18966895139