Query Auth 开源项目教程-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00086/article/details/139949867

Query Auth 开源项目教程

query-auth Signature generation and validation for REST API query authentication 项目地址: https://gitcode.com/gh_mirrors/qu/query-auth

1. 项目介绍

Query Auth 是一个用于 REST API 查询认证的签名生成和验证库。它旨在帮助开发者在编写自己的 API 时，轻松实现请求签名的生成和验证功能。Query Auth 支持多种 HTTP 库和框架，如 Guzzle 和 Slim，并且提供了灵活的接口，允许开发者自定义请求适配器。

主要功能

请求签名生成：为客户端请求生成签名，确保请求的安全性。
请求验证：在服务器端验证请求的签名，防止未授权的访问。
API 密钥和秘密生成：提供 API 密钥和秘密的生成工具，简化密钥管理。
防止重放攻击：通过存储和验证签名，防止重放攻击。

2. 项目快速启动

安装

首先，确保你已经安装了 Composer。然后，在你的项目根目录下创建 composer.json 文件，并添加以下内容：

{
  "require": {
    "jeremykendall/query-auth": "*"
  }
}

接着，运行以下命令安装 Query Auth：

composer install

使用示例

请求签名生成

use GuzzleHttp\Client as GuzzleHttpClient;
use QueryAuth\Credentials\Credentials;
use QueryAuth\Factory;
use QueryAuth\Request\Adapter\Outgoing\GuzzleHttpRequestAdapter;

$factory = new Factory();
$requestSigner = $factory->newRequestSigner();
$credentials = new Credentials('your-api-key', 'your-api-secret');

// 创建一个 GET 请求并设置端点
$guzzle = new GuzzleHttpClient(['base_url' => 'http://api.example.com']);
$request = $guzzle->createRequest('GET', '/endpoint');

// 签名请求
$requestSigner->signRequest(new GuzzleHttpRequestAdapter($request), $credentials);

// 发送签名请求
$response = $guzzle->send($request);

请求验证

use QueryAuth\Credentials\Credentials;
use QueryAuth\Factory;
use QueryAuth\Request\Adapter\Incoming\SlimRequestAdapter;

$factory = new Factory();
$requestValidator = $factory->newRequestValidator();
$credentials = new Credentials('your-api-key', 'your-api-secret');

// 获取 Slim 请求（在 Slim 路由、钩子或中间件中）
$request = $app->request;

// $isValid 是一个布尔值
$isValid = $requestValidator->isValid(new SlimRequestAdapter($request), $credentials);