进阶 yourls.org 2026-11-19 17:39:56 · 1 阅读
第16章 YOURLS 无密码 API:签名令牌使用指南
无密码 API
YOURLS 支持传统方式的 API 调用,即传入用户名和密码参数(当然前提是你的安装是私有模式)。
如果担心直接发送账号密码有安全风险,也可以改用密钥签名令牌来调用 API。
签名令牌
你的密钥签名令牌是一个 32 位字符串,类似 4ea59aab37f6df0755a6da98ee5ca85d。
签名令牌是唯一的,与某个账户绑定,且只能用于 API 请求,不能用来登录你的 YOURLS。你可以在 YOURLS 的 Tools 页面找到它。
注意:在 Tools 页面看不到签名?很可能因为你的安装是公开模式。这种情况下本来就不需要账号密码来使用 YOURLS,自然也就没有替代账号密码的签名令牌。
如果你清楚自己在做什么,可以通过过滤器 auth_signature_length 和 auth_signature 自定义签名的长度甚至内容。
签名令牌的用法
在 API 请求中使用 signature 参数,例如:
https://yoursite/yourls-api.php?signature=4ea59aab37f6df0755a6da98ee5ca85d&action=...
限时签名令牌的用法
你可以生成只在短时间内有效的签名令牌(默认一小时)。
首先构造限时签名令牌:
$timestamp = time();
$signature = hash('sha256', $timestamp . '4ea59aab37f6df0755a6da98ee5ca85d' );
// $signature = "10c28ab4a8b1b6acf3bef1a3e3284f4984d... (64 chars)"
?>
$signature = hash('sha256', $timestamp . '4ea59aab37f6df0755a6da98ee5ca85d' );
// $signature = "10c28ab4a8b1b6acf3bef1a3e3284f4984d... (64 chars)"
?>
哈希算法必须是 sha256、sha384 或 sha512 之一,除非插件通过 allowed_hash_algos 过滤器明确允许其他算法。
现在请在 API 请求中使用 signature、timestamp 和 hash 参数。示例:
https://yoursite/yourls-api.php?timestamp=$timestamp&signature=$signature&hash=sha256&action=...
该 URL 的有效期限仅为 43200 秒(12 小时),即常量 YOURLS_NONCE_LIFE 的默认值。
若要修改此时长,请在 config.php 中添加以下代码:
define( 'YOURLS_NONCE_LIFE', number_of_seconds );
(注意:此修改也会影响 YOURLS 的所有内部链接,例如激活插件、删除短链接等链接)
注意:如果尝试使用当前环境不支持的哈希算法,将仅得到一个简单的认证错误,如同时间戳或签名不正确一样。
重置密钥签名令牌
如果因某种原因需要重置签名(例如,在使旧签名失效的同时生成新签名),只需修改 config.php 中的 YOURLS_COOKIEKEY 常量即可。
提示:您可以直接从 api.yourls.org/services/cookiekey/1.0/ 复制结果,以生成随机的唯一 cookie。