seffeng/signature

PHP extension signature

v0.1.7 2024-06-07 02:47 UTC

Requires

• php: >=7.1.3

Requires (Dev)

• phpunit/phpunit: >=8.0

MIT

• seffeng

• php
• signature
• laravel
• yii
• lumen
• seffeng

README

安装

# 安装
$ composer require seffeng/signature

示例

# 示例
use Seffeng\Signature\Signature;
use Seffeng\Signature\Exceptions\SignatureException;

class SiteController extends Controller
{
    public function test()
    {
        try {
            $method = 'GET';
            $uri = '/text';
            $params = ['perPage' => 20];

            $options = [
                /**
                 // 调试模式[false-验证签名，true-不验证签名]
                 'debug'     => false,

                 // 签名使用的哈希算法
                 'algo'      => 'sha1',

                 // 签名验证超时时间
                 'timeout'   => 300,

                 // 接口版本
                 'version'   => '',

                 // 签名前缀[签名字符串前面拼接的字符]
                 'prefix'    => '',

                 // 签名连接符[签名字符串之间拼接的字符]
                 'connector' => '&',

                 // 签名后缀[签名字符串最后拼接的字符]
                 'suffix'    => '',

                 // 请求头app id 对应参数名[$header['Access-Key-Id']]
                 'headerAccessKeyId'     => 'Access-Key-Id',

                 // 请求头时间戳 对应参数名[$header['Timestamp']]
                 'headerTimestamp'       => 'Timestamp',

                 // 请求头Signature对应参数名[$header['Signature']]
                 'headerSignature'       => 'Signature',

                 // 请求头Signature对应标签[$header['Signature'] = "Signature $sign"]
                 'headerSignatureTag'    => 'Signature',

                 // 请求头Signature对应标签[$header['Version'] = 'version']
                 'headerVersion'         => 'Version',
                 */
            ];

            /**
             * 客户端使用签名
             */
            $client = new Signature('access-key-id', 'access-key-secret', $options);
            // $client->setVersion('v1');
            // $client->setAlgo('md5');
            $client->sign($method, $uri, $params);
            $headers = $client->getHeaders();
            print_r($headers);
            // 通过请求传递 $headers，如使用 GuzzleHttp
            // $httpClient = new Client(['base_uri' => 'http://domain.com']);
            // $request = $httpClient->get('/test', ['headers' => $headers, 'query' => $params]);

            /**
             * 服务端验证签名
             */
            $server = new Signature('access-key-id', 'access-key-secret', $options);
            $timestamp = 1600659800;
            $signature = 'Signature TN4kbBUDK7km3B0qjXrHhrtek4Q=';
            // $server->setAlgo('md5');
            // $server->setVersion('v1');
            // $server->setTimeout(60);
            $verify = $server->setTimestamp($timestamp)->verify($signature, $method, $uri, $params);
            var_dump($verify);
            if (!$verify) {
                throw new SignatureException('签名无效！');
            }
        } catch (SignatureException $e) {
            throw $e;
        } catch (\Exception $e) {
            throw $e;
        }
    }
}

备注

1、测试脚本 tests/SignatureTest.php 仅作为示例供参考。