Skip to main content
Version: Next

jwt-auth

描述#

jwt-auth 插件用于将 JWT 身份验证添加到 Service 或 Route 中。

通过 Consumer 将其密匙添加到查询字符串参数、请求头或 cookie 中用来验证其请求。

属性#

Consumer 端：

名称类型必选项默认值有效值描述
keystring是Consumer 的 access_key 必须是唯一的。如果不同 Consumer 使用了相同的 access_key ，将会出现请求匹配异常。
secretstring否加密秘钥。如果未指定，后台将会自动生成。该字段支持使用 APISIX Secret 资源，将值保存在 Secret Manager 中。
public_keystring否RSA 或 ECDSA 公钥， algorithm 属性选择 RS256 或 ES256 算法时必选。该字段支持使用 APISIX Secret 资源，将值保存在 Secret Manager 中。
algorithmstring否"HS256"["HS256", "HS512", "RS256", "ES256"]加密算法。
expinteger否86400[1,...]token 的超时时间。
base64_secretboolean否false当设置为 true 时，密钥为 base64 编码。
lifetime_grace_periodinteger否0[0,...]定义生成 JWT 的服务器和验证 JWT 的服务器之间的时钟偏移。该值应该是零（0）或一个正整数。

注意：schema 中还定义了 encrypt_fields = {"secret"}，这意味着该字段将会被加密存储在 etcd 中。具体参考 加密存储字段。

Route 端：

名称类型必选项默认值描述
headerstring否authorization设置我们从哪个 header 获取 token。
querystring否jwt设置我们从哪个 query string 获取 token，优先级低于 header。
cookiestring否jwt设置我们从哪个 cookie 获取 token，优先级低于 query。
hide_credentialsboolean否false该参数设置为 true 时，则不会将含有认证信息的 header\query\cookie 传递给 Upstream。
key_claim_namestring否key包含用户密钥（对应消费者的密钥属性）的 JWT 声明的名称。

您可以使用 HashiCorp Vault 实施 jwt-auth，以从其加密的 KV 引擎 使用 APISIX Secret 资源。

启用插件#

如果想要启用插件，就必须使用 JWT token 创建一个 Consumer 对象，并将 Route 配置为使用 JWT 身份验证。

首先，你可以通过 Admin API 创建一个 Consumer：

note

您可以这样从 config.yaml 中获取 admin_key 并存入环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')
curl http://127.0.0.1:9180/apisix/admin/consumers \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "username": "jack",
    "plugins": {
        "jwt-auth": {
            "key": "user-key",
            "secret": "my-secret-key"
        }
    }
}'
note

jwt-auth 默认使用 HS256 算法，如果使用 RS256 算法，需要指定算法，并配置公钥，示例如下：

curl http://127.0.0.1:9180/apisix/admin/consumers \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "username": "kerouac",
    "plugins": {
        "jwt-auth": {
            "key": "user-key",
            "public_key": "-----BEGIN PUBLIC KEY-----\n……\n-----END PUBLIC KEY-----",
            "algorithm": "RS256"
        }
    }
}'

创建 Consumer 对象后，你可以创建 Route 进行验证：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "plugins": {
        "jwt-auth": {}
    },
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'

测试插件#

首先你需要使用诸如 JWT.io's debugger 等工具或编程语言来生成一个 JWT token。

note

生成 JWT token 时，payload 中 key 字段是必要的，值为所要用到的凭证的 key; 且 exp 或 nbf 至少填写其中一个，值为 UNIX 时间戳。

示例：payload={"key": "user-key", "exp": 1727274983}

现在你可以使用获取到的 token 进行请求尝试

  • token 放到请求头中：
curl http://127.0.0.1:9080/index.html \-H 'Authorization: eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTU2NDA1MDgxMX0.Us8zh_4VjJXF-TmR5f8cif8mBU7SuefPlpxhH0jbPVI' -i
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 13175
...
Accept-Ranges: bytes
<!DOCTYPE html>
<html lang="cn">
...
  • 缺少 token
curl http://127.0.0.1:9080/index.html -i
HTTP/1.1 401 Unauthorized
...
{"message":"Missing JWT token in request"}
  • token 放到请求参数中：
curl http://127.0.0.1:9080/index.html?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTU2NDA1MDgxMX0.Us8zh_4VjJXF-TmR5f8cif8mBU7SuefPlpxhH0jbPVI -i
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 13175
...
Accept-Ranges: bytes

<!DOCTYPE html>
<html lang="cn">
...
  • token 放到 cookie 中：
curl http://127.0.0.1:9080/index.html --cookie jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTU2NDA1MDgxMX0.Us8zh_4VjJXF-TmR5f8cif8mBU7SuefPlpxhH0jbPVI -i
HTTP/1.1 200 OK
Content-Type: text/html
Content-Length: 13175
...
Accept-Ranges: bytes

<!DOCTYPE html>
<html lang="cn">
...

删除插件#

当你需要禁用 jwt-auth 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：

curl http://127.0.0.1:9180/apisix/admin/routes/1 \
-H "X-API-KEY: $admin_key" -X PUT -d '
{
    "methods": ["GET"],
    "uri": "/index.html",
    "id": 1,
    "plugins": {},
    "upstream": {
        "type": "roundrobin",
        "nodes": {
            "127.0.0.1:1980": 1
        }
    }
}'