🏆作者简介,黑夜开发者,全栈领域新星创作者✌,CSDN博客专家,阿里云社区专家博主,2023年6月CSDN上海赛道top4。
🏆数年电商行业从业经验,历任核心研发工程师,项目技术负责人。
🏆本文已收录于PHP专栏:PHP进阶实战教程。
🏆另有专栏PHP入门基础教程,希望各位大佬多多支持❤️。
🎉欢迎 👍点赞✍评论⭐收藏
文章目录
🚀一、引言
在Web开发中,API(Application Programming
Interface)是不可或缺的一部分。为了确保API请求的安全性,常常需要对API请求进行签名验证。本文将介绍如何使用PHP设计一套API签名验证的程序,并提供具体的设计步骤和代码。
🚀二、验证过程概述
本篇文章主要通过openssl来实现安全的加密解密,API签名验证的过程通常包括以下几个步骤,:
- 客户端使用私钥对请求数据进行加密,并将加密结果作为签名参数(例如传递给API的
signature
参数)。 - 服务端接收到API请求后,根据相应规则从请求参数中提取出签名参数。
- 服务端使用相同的私钥和加密算法对请求数据进行加密,并得到一个临时的签名。
- 服务端将临时的签名与客户端传递的签名进行比较,如果两者一致,则API请求通过验证,否则验证失败。
🚀三、设计步骤
下面是一套设计API签名验证程序的具体步骤:
🔎3.1 生成密钥对
首先,我们需要生成一对公钥和私钥,用于加密和解密。可以使用openssl扩展来生成密钥对,具体代码如下:
1 |
<span class="token variable">$config</span> <span class="token operator">=</span> <span class="token keyword">array</span><span class="token punctuation">(</span> <span class="token string double-quoted-string">"private_key_bits"</span> <span class="token operator">=></span> <span class="token number">1024</span><span class="token punctuation">,</span> <span class="token string double-quoted-string">"private_key_type"</span> <span class="token operator">=></span> <span class="token constant">OPENSSL_KEYTYPE_RSA</span><span class="token punctuation">,</span> <span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 生成私钥和公钥</span> <span class="token variable">$res</span> <span class="token operator">=</span> <span class="token function">openssl_pkey_new</span><span class="token punctuation">(</span><span class="token variable">$config</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 提取私钥</span> <span class="token function">openssl_pkey_export</span><span class="token punctuation">(</span><span class="token variable">$res</span><span class="token punctuation">,</span> <span class="token variable">$private_key</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 提取公钥</span> <span class="token variable">$public_key</span> <span class="token operator">=</span> <span class="token function">openssl_pkey_get_details</span><span class="token punctuation">(</span><span class="token variable">$res</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$public_key</span> <span class="token operator">=</span> <span class="token variable">$public_key</span><span class="token punctuation">[</span><span class="token string double-quoted-string">"key"</span><span class="token punctuation">]</span><span class="token punctuation">;</span> <span class="token comment">// 保存私钥和公钥到文件</span> <span class="token function">file_put_contents</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'private.key'</span><span class="token punctuation">,</span> <span class="token variable">$private_key</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">file_put_contents</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'public.key'</span><span class="token punctuation">,</span> <span class="token variable">$public_key</span><span class="token punctuation">)</span><span class="token punctuation">;</span> |
上述代码将生成私钥保存到private.key
文件中,公钥保存到public.key
文件中。
🔎3.2 签名生成和验证函数的实现
🍁3.2.1 准备工作
在签名生成和验证之前,我们需要加载私钥和公钥。可以创建一个Signature
类,并在构造函数中加载私钥和公钥,如下所示:
1 |
<span class="token keyword">class</span> <span class="token class-name-definition class-name">Signature</span> <span class="token punctuation">{<!-- --></span> <span class="token keyword">private</span> <span class="token variable">$private_key</span><span class="token punctuation">;</span> <span class="token keyword">private</span> <span class="token variable">$public_key</span><span class="token punctuation">;</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">__construct</span><span class="token punctuation">(</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">private_key</span> <span class="token operator">=</span> <span class="token function">openssl_pkey_get_private</span><span class="token punctuation">(</span><span class="token function">file_get_contents</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'private.key'</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">public_key</span> <span class="token operator">=</span> <span class="token function">openssl_pkey_get_public</span><span class="token punctuation">(</span><span class="token function">file_get_contents</span><span class="token punctuation">(</span><span class="token string single-quoted-string">'public.key'</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token comment">// 其他方法和代码将在后面介绍</span> <span class="token punctuation">}</span> |
🍁3.2.2 生成签名
为了生成签名,我们需要定义一个方法,该方法接收请求参数数组并返回签名结果。可以使用openssl扩展中的openssl_sign
函数生成签名,代码如下:
1 |
<span class="token keyword">class</span> <span class="token class-name-definition class-name">Signature</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 省略部分代码</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">generateSignature</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 将请求参数数组转换为字符串</span> <span class="token variable">$data</span> <span class="token operator">=</span> <span class="token function">http_build_query</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 使用私钥进行签名</span> <span class="token function">openssl_sign</span><span class="token punctuation">(</span><span class="token variable">$data</span><span class="token punctuation">,</span> <span class="token variable">$signature</span><span class="token punctuation">,</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">private_key</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 将签名结果进行Base64编码</span> <span class="token variable">$signature</span> <span class="token operator">=</span> <span class="token function">base64_encode</span><span class="token punctuation">(</span><span class="token variable">$signature</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">return</span> <span class="token variable">$signature</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
🍁3.2.3 验证签名
为了验证签名,我们需要定义一个方法,该方法接收请求参数数组和客户端传递的签名,并返回验证结果。可以使用openssl扩展中的openssl_verify
函数验证签名,代码如下:
1 |
<span class="token keyword">class</span> <span class="token class-name-definition class-name">Signature</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 省略部分代码</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">verifySignature</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">,</span> <span class="token variable">$clientSignature</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 将请求参数数组转换为字符串</span> <span class="token variable">$data</span> <span class="token operator">=</span> <span class="token function">http_build_query</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 对客户端传递的签名进行Base64解码</span> <span class="token variable">$clientSignature</span> <span class="token operator">=</span> <span class="token function">base64_decode</span><span class="token punctuation">(</span><span class="token variable">$clientSignature</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 使用公钥进行签名验证</span> <span class="token variable">$result</span> <span class="token operator">=</span> <span class="token function">openssl_verify</span><span class="token punctuation">(</span><span class="token variable">$data</span><span class="token punctuation">,</span> <span class="token variable">$clientSignature</span><span class="token punctuation">,</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">public_key</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">return</span> <span class="token variable">$result</span> <span class="token operator">===</span> <span class="token number">1</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
🔎3.3 使用SDK调用API
为了方便客户端调用API并进行签名验证,我们可以创建一个简单的SDK。SDK将提供一些封装好的方法,让开发者能够轻松地调用API并进行签名验证。
以下是一个示例SDK的代码:
1 |
<span class="token keyword">class</span> <span class="token class-name-definition class-name">APIClient</span> <span class="token punctuation">{<!-- --></span> <span class="token keyword">private</span> <span class="token variable">$apiURL</span><span class="token punctuation">;</span> <span class="token keyword">private</span> <span class="token variable">$signature</span><span class="token punctuation">;</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">__construct</span><span class="token punctuation">(</span><span class="token variable">$apiURL</span><span class="token punctuation">,</span> <span class="token variable">$privateKeyPath</span><span class="token punctuation">,</span> <span class="token variable">$publicKeyPath</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">apiURL</span> <span class="token operator">=</span> <span class="token variable">$apiURL</span><span class="token punctuation">;</span> <span class="token comment">// 初始化签名验证类</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">signature</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">Signature</span><span class="token punctuation">(</span><span class="token variable">$privateKeyPath</span><span class="token punctuation">,</span> <span class="token variable">$publicKeyPath</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token keyword">public</span> <span class="token keyword">function</span> <span class="token function-definition function">callAPI</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 生成签名</span> <span class="token variable">$signature</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">signature</span><span class="token operator">-></span><span class="token function">generateSignature</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 将签名添加到请求参数中</span> <span class="token variable">$params</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'signature'</span><span class="token punctuation">]</span> <span class="token operator">=</span> <span class="token variable">$signature</span><span class="token punctuation">;</span> <span class="token comment">// 发送API请求</span> <span class="token variable">$response</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token function">sendRequest</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 验证签名</span> <span class="token variable">$isValid</span> <span class="token operator">=</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">signature</span><span class="token operator">-></span><span class="token function">verifySignature</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">,</span> <span class="token variable">$response</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'signature'</span><span class="token punctuation">]</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 如果验证通过,则返回API响应数据</span> <span class="token keyword">if</span> <span class="token punctuation">(</span><span class="token variable">$isValid</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token keyword">return</span> <span class="token variable">$response</span><span class="token punctuation">[</span><span class="token string single-quoted-string">'data'</span><span class="token punctuation">]</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token keyword">else</span> <span class="token punctuation">{<!-- --></span> <span class="token keyword">throw</span> <span class="token keyword">new</span> <span class="token class-name">Exception</span><span class="token punctuation">(</span><span class="token string double-quoted-string">"Invalid signature"</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> <span class="token keyword">private</span> <span class="token keyword">function</span> <span class="token function-definition function">sendRequest</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 使用cURL库发送HTTP请求</span> <span class="token variable">$ch</span> <span class="token operator">=</span> <span class="token function">curl_init</span><span class="token punctuation">(</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">curl_setopt</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">,</span> <span class="token constant">CURLOPT_URL</span><span class="token punctuation">,</span> <span class="token variable">$this</span><span class="token operator">-></span><span class="token property">apiURL</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">curl_setopt</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">,</span> <span class="token constant">CURLOPT_POST</span><span class="token punctuation">,</span> <span class="token constant boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">curl_setopt</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">,</span> <span class="token constant">CURLOPT_POSTFIELDS</span><span class="token punctuation">,</span> <span class="token function">http_build_query</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">curl_setopt</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">,</span> <span class="token constant">CURLOPT_RETURNTRANSFER</span><span class="token punctuation">,</span> <span class="token constant boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token variable">$response</span> <span class="token operator">=</span> <span class="token function">curl_exec</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token function">curl_close</span><span class="token punctuation">(</span><span class="token variable">$ch</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 解析API响应数据</span> <span class="token keyword">return</span> <span class="token function">json_decode</span><span class="token punctuation">(</span><span class="token variable">$response</span><span class="token punctuation">,</span> <span class="token constant boolean">true</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token punctuation">}</span> <span class="token punctuation">}</span> |
SDK的使用示例:
1 |
<span class="token variable">$apiURL</span> <span class="token operator">=</span> <span class="token string single-quoted-string">'http://ssss.com/api.php'</span><span class="token punctuation">;</span> <span class="token variable">$privateKeyPath</span> <span class="token operator">=</span> <span class="token string single-quoted-string">'/path/to/private.key'</span><span class="token punctuation">;</span> <span class="token variable">$publicKeyPath</span> <span class="token operator">=</span> <span class="token string single-quoted-string">'/path/to/public.key'</span><span class="token punctuation">;</span> <span class="token comment">// 创建APIClient实例</span> <span class="token variable">$client</span> <span class="token operator">=</span> <span class="token keyword">new</span> <span class="token class-name">APIClient</span><span class="token punctuation">(</span><span class="token variable">$apiURL</span><span class="token punctuation">,</span> <span class="token variable">$privateKeyPath</span><span class="token punctuation">,</span> <span class="token variable">$publicKeyPath</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 准备API请求参数</span> <span class="token variable">$params</span> <span class="token operator">=</span> <span class="token keyword">array</span><span class="token punctuation">(</span> <span class="token string single-quoted-string">'param1'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'value1'</span><span class="token punctuation">,</span> <span class="token string single-quoted-string">'param2'</span> <span class="token operator">=></span> <span class="token string single-quoted-string">'value2'</span><span class="token punctuation">,</span> <span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token keyword">try</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 调用API,并获取响应结果</span> <span class="token variable">$result</span> <span class="token operator">=</span> <span class="token variable">$client</span><span class="token operator">-></span><span class="token function">callAPI</span><span class="token punctuation">(</span><span class="token variable">$params</span><span class="token punctuation">)</span><span class="token punctuation">;</span> <span class="token comment">// 处理API响应数据</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> <span class="token keyword">catch</span> <span class="token punctuation">(</span><span class="token class-name">Exception</span> <span class="token variable">$e</span><span class="token punctuation">)</span> <span class="token punctuation">{<!-- --></span> <span class="token comment">// 处理异常情况</span> <span class="token comment">// ...</span> <span class="token punctuation">}</span> |
🚀四、总结
本文介绍了如何使用PHP设计一套API签名验证的程序。通过生成密钥对、实现签名生成和验证函数以及使用SDK调用API,我们可以提高API请求的安全性,并确保请求以及响应数据的完整性。希望本文能对大家在API开发中对签名验证有一定的了解和帮助。
注:在实际的项目中实现方式可能因应用场景和需求的不同而有所差异,建议根据实际情况进行相应调整。