一、概述
开年第一篇,该篇主要讲述了接口开发中,如何安全认证、如何用php签名认证。
二、说说历史
签名认证是什么?为什么要做签名认证?签名认证哪里会用到?no、no、no.....是不是,是不是,一下子疑问就这么多了!没事儿,通过追溯历史,我们来明白这些。
1、签名认证是什么?
2、为什么要做签名认证?
在使用http或者soap传输数据的时候,签名作为其中一个参数,可以起到关键作用:1、鉴权(通过客户的密钥,服务端的密钥匹配);2、数据防篡改(参数是明文传输,将参数及密钥加密作为签名与服务器匹配);下面来分析下具体的方式:
将请求参数中的各个键值对按照key的字符串顺序升序排列(大小写敏感),把key和value拼成一串之后最后加上密钥,组成key1value1key2value2PRIVATEKEY的格式,转成utf-8编码的字节序列后计算md5,作为请求的签名。计算出来的签名串应当全为小写形式。如果某个参数的值为空,则此参数不参与签名。
3、签名认证哪里会用到?
最常见的使我们在开发接口的时候,为了不被非法访问,往往我们会做签名认证,比如支付接口......
然后就是第三方平台的开发,比如微信公众平台......
三、流程分析
客户端:首先我们为提供给用户一份接口文档,文档里面我们给用户提供api地址、签名算法解析过程、数据说明。
服务端:进行客户端检验,通常就是参数个数、格式验证,app_key验证(这个是博主这里使用的,这个app_key会交给用户,用户访问接口的时候必须带上该app_key),签名结果验证。
以我这次写的为例子来描述一下整个流程:
用户参照我们提供的接口文档,请求我们的接口,用户按照我们接口说明的签名算法生成签名串作为参数,然后带上必要的参数(GET、POST),如果服务端验证成功,则返回真实数据。
在服务端:我们首要验证提交参数的个数、格式是否正确,然后我们通过提交的参数用签名算法生成一个签名串,最后服务端生成的签名串和客户端提交过来的签名串进行比较,成功返回真实数据。
四、上代码
1 php 2 namespace ceshi; 3 4 /** 5 * 签名认证算法 6 * HMAC-SHA256加密方式 7 * 登录认证加入access_token:access-token通过登录接口去获取,通过刷新接口去刷新,需要注意返回的过期时间,要在过期时间之前刷新重新获取access-token。目前约定所有接口都必须传access-token,也就是用户必须先登录才可以看到相关内容 8 * 随机函数可换更好的方法-本实例随机函数比较简单,随机性不够 9 * ApiSign类作为服务端,类以外的代码作为客户端示例代码 10 * author jiechengyang https://www.cnblogs.com/YangJieCheng/ 11 */ 12 class ApiSign 13 { 14 CONST DELAY_TIME = 2000; 15 CONST ACCESS_TOCEN_PATH = './access_token'; 16 17 private $_config = []; 18 protected $AppKey = 'voBVVQxfMxDmhuxV70'; 19 protected $AppSecret = 'QJF5P8qWFJakF9Ve89ZcIstHKbkt5fVA'; 20 protected $timeout = 300; 21 protected $algo = 'sha256'; 22 public $loginCheck = false; 23 24 public function __construct($config, $loginCheck) 25 { 26 $this->_config = $config; 27 empty($this->AppKey) && $this->AppKey = $this->generateRandomString(); 28 empty($this->AppSecret) && $this->AppSecret = $this->generateRangeNum(); 29 $this->loginCheck = $loginCheck; 30 if ($this->init()) { 31 echo '恭喜,签名认证成功'; 32 echo <<<JS 33 45 JS; 46 } 47 } 48 49 protected function init() 50 { 51 if (!isset($this->_config['_key']) 52 || !isset($this->_config['_sign']) 53 || !isset($this->_config['_time']) 54 || !isset($this->_config['_nonce']) 55 || strlen($this->_config['_nonce']) !== 32 56 || !is_numeric($this->_config['_time'])) { 57 $this->callback(['message' => '请求参数不全, 或参数不规范'], 'error'); 58 } 59 60 if (!isset($this->_config['_time']) || $this->getIsTimeOut()) { 61 $this->callback(['message' => '请求超时'], 'error'); 62 } 63 64 // 客户端验证 65 $requestSignature = $this->_config['_sign']; 66 $requestSignature = str_replace(' ', '+', $requestSignature); 67 if($this->_config['_key'] !== $this->AppKey) { 68 $this->callback(['message' => '非法的app_key'], 'error'); 69 } 70 71 $signature = $this->generateSign($this->_config); 72 if ($requestSignature != $signature) { 73 $this->callback(['message' => '签名错误'], 'error'); 74 } 75 76 $accessToken = $this->getAccessToken(); 77 78 // 用户登录token验证 79 if ($this->loginCheck && $accessToken != $this->_config['access_token']) { 80 $this->callback(['message' => 'access_token错误'], 'error'); 81 } 82 83 return true; 84 } 85 86 private function callback($json=[], $status='ok') 87 { 88 $config = [ 89 'ok' => [200, '操作成功'], 90 'error' => [300, '操作失败'], 91 'timeout' => [300, '操作超时'], 92 ]; 93 $json['statusCode'] = $config[$status][0]; 94 !isset($json['message']) && $json['message'] = $config[$status][1]; 95 echo json_encode($json); 96 exit; 97 } 98 99 private function getIsTimeOut() 100 { 101 if (abs($this->_config['_time'] - time()) > $this->timeout) { 102 return true; 103 } 104 105 return false; 106 } 107 108 /** 109 * 生成随便数 110 */ 111 public function generateRangeNum($length = 32, $isToLower = false) 112 { 113 $str = $this->generateRandomString($length); 114 if ($isToLower) { 115 $str = strtolower($str); 116 } 117 118 return $str; 119 } 120 121 private function generateRandomString($length = 10) { 122 $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; 123 $randomString = ''; 124 for ($i = 0; $i < $length; $i++) { 125 $randomString .= $characters[rand(0, strlen($characters) - 1)]; 126 } 127 128 return $randomString; 129 } 130 131 protected function generateSign($params) 132 { 133 if (isset($params['_sign'])) { 134 unset($params['_sign']); 135 } 136 137 if($this->loginCheck && isset($params['access_token'])) { 138 unset($params['access_token']); 139 } 140 141 ksort($params); 142 $str = ''; 143 foreach ($params as $key => $value) { 144 $str .= $key . '=' . $value . '&'; 145 } 146 147 $str = rtrim($str, '&'); 148 149 return hash_hmac($this->algo, $str, $this->AppSecret, false); 150 } 151 152 public function getAccessToken() 153 { 154 155 if (!file_exists(self::ACCESS_TOCEN_PATH)) { 156 $json = ['value' => $this->_config['access_token'], 'expires_in' => 7200, 'time' => time()]; 157 file_put_contents(self::ACCESS_TOCEN_PATH, json_encode($json)); 158 return $this->_config['access_token']; 159 } 160 161 $accessToken = json_decode(file_get_contents(self::ACCESS_TOCEN_PATH), true); 162 if (time() - $accessToken['time'] > $accessToken['expires_in'] - self::DELAY_TIME) { 163 $json = ['value' => $this->_config['access_token'], 'expires_in' => 7200, 'time' => time()]; 164 file_put_contents(self::ACCESS_TOCEN_PATH, json_encode($json)); 165 return $this->_config['access_token']; 166 } 167 168 return $accessToken['value']; 169 170 } 171 } 172 173 /** 174 * 生成随便数 175 */ 176 function generateRangeNum($length = 32, $isToLower = false) 177 { 178 $str = generateRandomString($length); 179 if ($isToLower) { 180 $str = strtolower($str); 181 } 182 183 return $str; 184 } 185 186 function generateRandomString($length = 10) { 187 $characters = '0123456789abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ'; 188 $randomString = ''; 189 for ($i = 0; $i < $length; $i++) { 190 $randomString .= $characters[rand(0, strlen($characters) - 1)]; 191 } 192 193 return $randomString; 194 } 195 196 function generateSign($algo, $params, $AppSecret) 197 { 198 if (isset($params['_sign'])) { 199 unset($params['_sign']); 200 } 201 202 ksort($params); 203 $str = ''; 204 foreach ($params as $key => $value) { 205 $str .= $key . '=' . $value . '&'; 206 } 207 208 $str = rtrim($str, '&'); 209 210 return hash_hmac($algo, $str, $AppSecret, false); 211 } 212 213 header("content-type:text/html;charset:utf-8"); 214 $algo = 'sha256'; 215 $AppKey = 'voBVVQxfMxDmhuxV70'; 216 $AppKey = 'Rd1bW719zRbCXOBx3L';//---用于公司项目测试 217 $AppSecret = 'QJF5P8qWFJakF9Ve89ZcIstHKbkt5fVA'; 218 $AppSecret = '73ZBAnbwVPDu0dvdlYE0RMvzsbhehejd';//---用于公司项目测试 219 $nonce = generateRangeNum(32); 220 $nonce = 'kj4ESP2Qcngaj3eAjpnrhCQR9g4yKnTM';//---用于公司项目测试 221 $loginCheck = false; 222 $params = [ 223 '_key' => $AppKey, 224 '_time' => time(), 225 '_nonce' => $nonce, 226 ]; 227 $sign = generateSign($algo, $params, $AppSecret); 228 echo $params['_time'],'
';//---用于公司项目测试 229 echo $sign;exit;//---用于公司项目测试 230 $params['_sign'] = $sign; 231 232 $loginCheck && $params['access_token'] = generateRangeNum(16); 233 // echo '';print_r($params);234 $apiSignModel = new ApiSign($params, $loginCheck);