首页 > 编程语言 >PHP开发API接口签名生成及验证

PHP开发API接口签名生成及验证

时间:2024-01-16 10:58:09浏览次数:36  
标签:验证 接口 sign API 参数 签名 key PHP data

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

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

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

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

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

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

一、签名参数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& amp;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 = "c4ca4238a0b923820dcc509a6f75849b";
$secret = "28c8edde3d61a0411511d3b1866f0636";
 
// 待发送的数据包
$data = array(
    'username' => '[email protected]',
    '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('请求不合法');
    }
}
?>

  

标签:验证,接口,sign,API,参数,签名,key,PHP,data
From: https://www.cnblogs.com/shenqilun/p/17967125

相关文章

  • FastAPI学习-29 log_config 设置 logger 日志格式
    前言FastAPI服务是通过uvicorn来提供的,日志都是uvicorn里配置的。官方文档地址:https://www.uvicorn.org/settings/#logginguvicorn的logging日志我们可以通过uvicorn.run()方式启动服务uvicorn.run("example:app",port=5000,reload=True,access_log=False)于......
  • JavaSE(12) - 常用API(下)
    JavaSE(12)-常用API(下)JDK7以前的时间相关类Date类如何创建日期对象Datedate=newDate();//空参构造创建的对象,默认表示系统当前时间Datedate=newDate(指定毫秒值);//有参构造创建的对象,表示指定时间如何修改时间对象中的毫秒值setTime(毫秒值);如......
  • 《工作流篇》activiti的表、对象、接口
    表参考链接:https://www.cnblogs.com/imsoft/p/Activity.html参考链接:https://blog.csdn.net/weixin_42617164/article/details/127638003参考链接:https://blog.csdn.net/lp2388163/article/details/98206450参考链接:https://blog.csdn.net/qq_35133320/article/details/825333......
  • 华为联合伙伴发布《云端控制平台与物流自动导引车通用接口指南》
    本文分享自华为云社区《华为联合30+伙伴发布《云端控制平台与物流自动导引车通用接口指南》,助力物流机器人集群调度》,作者:云容器大未来。背景介绍当今社会正处在一个技术飞速发展、机器人与人工智能深入应用于工业领域的时代。在物流、制造和零售等领域,自动导引车(AGV)已经......
  • Postman/Jmeter工具实现接口测试,为什么还要用代码来实现接口自动化测试?
    这种工具包括一些开源框架最大缺点就是不够灵活,如果是单接口的测试还行,但是有的项目接口比较庞大和负责,这种情况下就不大适用工具(工具适用于小型项目,代码适用于中大型项目)主要有以下几个原因:1敏捷开发,接口巨大,工具对于实现团队协作很不友好,很不方便2工具的功能都是定义好的,一旦......
  • 接口自动化框架是如何搭建的?
    1框架文件架构2优势:(1)     采用的yaml作为测试用例,对测试用例做了非常严格的规范,name,request(method,url),validator,(2)     支持多种请求方式和传参方式  Get:params,Post:表单和json传参,也支持文件上传,同时包括内置MD5,Base64,签名和加密算法(3)     支持轻量......
  • 你们公司没有通用的接口自动化框架吗,为什么还要你来搭建这套框架?
    因为公司每个项目组业务都比较复杂,每个项目组的需求都不一样,所以需要做自动化项目组需要自己搭建自动化框架,这样更符合项目的业务场景,使用起来更加高效你主要负责哪部分框架搭建,你们是怎么合作?      我主要负责requests的统一请求封装以及接口关联,以及规范yaml用例和日志......
  • 【App Service】遇见本地访问Azure App Service应用慢或者是调用第三方接口慢的调试小
    问题描述当应用部署到微软云Azure后,如果遇见本地访问AzureAppService应用慢或者是调用第三方接口慢的时候,有什么好的调试方法呢?来判断具体时那一段请求耗时呢?问题解答当然浏览器本身的开发者工具(F12)就是一种非常好的工具。当时,当安装浏览器不方便时,curl就是一个非常好......
  • 如何统计接口自动化覆盖率?
    Python可以适用coveragepy来统计代码行覆盖率,使用方式coveragerun-mpytest 运行之后生成新的.coverage文件,这个文件以二进制形式保存着我们覆盖率的数据,如何读取覆盖率数据呢?通过cmdline命令执行coveragereport可以查看覆盖率数据。可通过coveragereport-m查看哪......
  • 【OpenFeign】【使用问题】OpenFeign 里如何调用 form-data 接口或者 MultipartFile
    1 前言今儿有个需求涉及到文件上传的东西,关键是OpenFeign去调用,当然最后底牌我也可以创建普通的HTTP请求或者RestTemplate自己请求是不是也行,但是本人这个倔驴型性格,偶尔也会跟自己犟犟,就是要用OpenFeign把它搞出来。首先我有两个这样的接口://客户导入接口@PostMa......