Skip to main content
Version: Next

jwt-auth

描述#

jwt-auth 插件支持使用 JSON Web Token（JWT） 作为客户端在访问上游资源之前进行身份验证的机制。

启用后，该插件会暴露一个端点，供 消费者 创建 JWT 凭据。该过程会生成一个令牌，客户端请求应携带该令牌以向 APISIX 标识自身。令牌可以包含在请求 URL 查询字符串、请求头或 Cookie 中。APISIX 随后会验证该令牌，以判断是否允许或拒绝请求访问上游资源。

当消费者成功通过身份验证后，APISIX 会在将请求代理到上游服务之前，向请求添加额外的请求头，例如 X-Consumer-Username、X-Credential-Identifier 以及其他已配置的消费者自定义请求头。上游服务可据此区分消费者并根据需要实现额外逻辑。若某个值不可用，则不会添加对应的请求头。

属性#

以下属性可用于消费者或凭据上的配置。

名称类型必选项默认值有效值描述
keystring是非空用于标识消费者凭据的唯一键。
secretstring否非空算法为对称算法时，用于签名和验证 JWT 的共享密钥。使用 HS256、HS384 或 HS512 算法时必填。该字段支持使用 APISIX Secret 资源将值保存在 Secret Manager 中。
public_keystring否由所配置非对称算法使用的公钥（PEM 格式）。当 algorithm 为 RS256、ES256、RS384、RS512、ES384、ES512、PS256、PS384、PS512 或 EdDSA 时必填。该字段支持使用 APISIX Secret 资源将值保存在 Secret Manager 中。
algorithmstring否HS256HS256、HS384、HS512、RS256、RS384、RS512、ES256、ES384、ES512、PS256、PS384、PS512、EdDSA加密算法。
expinteger否86400>=1令牌的过期时间，单位为秒。若不使用 APISIX 签发 JWT，则该参数会被忽略，签发时应在 payload 中指定过期时间。
base64_secretboolean否false若密钥经过 base64 编码，则设为 true。
lifetime_grace_periodinteger否0>=0宽限期，单位为秒。用于处理生成 JWT 的服务器与验证 JWT 的服务器之间的时钟偏差。

注意：Schema 中同时定义了 encrypt_fields = {"secret"}，这意味着该字段将在 etcd 中加密存储。详见加密存储字段。

以下属性可用于路由或服务上的配置。

名称类型必选项默认值有效值描述
headerstring否authorization用于获取令牌的请求头。
querystring否jwt用于获取令牌的查询字符串。优先级低于 header。
cookiestring否jwt用于获取令牌的 Cookie。优先级低于 query。
hide_credentialsboolean否false若为 true，则不将携带 JWT 的 header、query 或 cookie 传递给上游服务。
anonymous_consumerstring否匿名消费者名称。配置后，允许匿名用户绕过身份验证。
claims_to_verifyarray[string]否["exp", "nbf"]exp 和 nbf 的组合指定需要验证的 JWT 声明，以确保令牌在其允许的时间范围内使用。注意，这不是要求 payload 中必须存在的声明，而是在声明存在时进行验证。
store_in_ctxboolean否false若为 true，则将 JWT payload 存储在请求上下文变量 ctx.jwt_auth_payload 中，以便在同一请求中在 jwt-auth 之后执行的插件获取和使用 payload 信息。
realmstring否jwt身份验证失败时，在 WWW-Authenticate 响应头中包含的 realm 值。
key_claim_namestring否keyJWT payload 中用于标识关联密钥的声明，例如 iss。

你可以将 jwt-auth 与 HashiCorp Vault 结合使用，通过 APISIX Secret 资源从其加密 KV 引擎中存储和获取密钥及 RSA 密钥对。

示例#

以下示例展示了如何针对不同场景使用 jwt-auth 插件。

note

你可以通过以下命令从 conf/config.yaml 中获取 admin_key 并保存到环境变量：

admin_key=$(yq '.deployment.admin.admin_key[0].key' conf/config.yaml | sed 's/"//g')

使用 JWT 进行消费者身份验证#

以下示例演示如何为消费者实现 JWT 密钥身份验证。

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack"
  }'

为消费者创建 jwt-auth 凭据：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "jack-hs256-secret-that-is-very-long"
      }
    }
  }'

创建带有 jwt-auth 插件的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-route",
    "uri": "/headers",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

如需为 jack 签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 jack-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU

携带 JWT 在 Authorization 请求头中向路由发送请求：

curl -i "http://127.0.0.1:9080/headers" -H "Authorization: ${jwt_token}"

你应收到类似如下的 HTTP/1.1 200 OK 响应：

{
  "headers": {
    "Accept": "*/*",
    "Authorization": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjY2NDk2NDAsImtleSI6ImphY2sta2V5In0.kdhumNWrZFxjUvYzWLt4lFr546PNsr9TXuf0Az5opoM",
    "Host": "127.0.0.1",
    "User-Agent": "curl/8.6.0",
    "X-Amzn-Trace-Id": "Root=1-66ea951a-4d740d724bd2a44f174d4daf",
    "X-Consumer-Username": "jack",
    "X-Credential-Identifier": "cred-jack-jwt-auth",
    "X-Forwarded-Host": "127.0.0.1"
  }
}

发送携带无效令牌的请求：

curl -i "http://127.0.0.1:9080/headers" -H "Authorization: eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJleHAiOjE3MjY2NDk2NDAsImtleSI6ImphY2sta2V5In0.kdhumNWrZFxjU_random_random"

你应收到类似如下的 HTTP/1.1 401 Unauthorized 响应：

{"message":"failed to verify jwt"}

在请求头、查询字符串或 Cookie 中携带 JWT#

以下示例演示如何从指定的请求头、查询字符串和 Cookie 中获取 JWT。

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack"
  }'

为消费者创建 jwt-auth 凭据：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "jack-hs256-secret-that-is-very-long"
      }
    }
  }'

创建带有 jwt-auth 插件的路由，并指定携带令牌的请求参数：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-route",
    "uri": "/get",
    "plugins": {
      "jwt-auth": {
        "header": "jwt-auth-header",
        "query": "jwt-query",
        "cookie": "jwt-cookie"
      }
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

如需为 jack 签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 jack-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU

通过请求头中的 JWT 验证#

携带 JWT 在请求头中发送请求：

curl -i "http://127.0.0.1:9080/get" -H "jwt-auth-header: ${jwt_token}"

你应收到类似如下的 HTTP/1.1 200 OK 响应：

{
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Host": "127.0.0.1",
    "Jwt-Auth-Header": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU",
    ...
  },
  ...
}

通过查询字符串中的 JWT 验证#

携带 JWT 在查询字符串中发送请求：

curl -i "http://127.0.0.1:9080/get?jwt-query=${jwt_token}"

你应收到类似如下的 HTTP/1.1 200 OK 响应：

{
  "args": {
    "jwt-query": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU"
  },
  "headers": {
    "Accept": "*/*",
    ...
  },
  "origin": "127.0.0.1, 183.17.233.107",
  "url": "http://127.0.0.1/get?jwt-query=eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTY5NTEyOTA0NH0.EiktFX7di_tBbspbjmqDKoWAD9JG39Wo_CAQ1LZ9voQ"
}

通过 Cookie 中的 JWT 验证#

携带 JWT 在 Cookie 中发送请求：

curl -i "http://127.0.0.1:9080/get" --cookie jwt-cookie=${jwt_token}

你应收到类似如下的 HTTP/1.1 200 OK 响应：

{
  "args": {},
  "headers": {
    "Accept": "*/*",
    "Cookie": "jwt-cookie=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU",
    ...
  },
  ...
}

在环境变量中管理密钥#

以下示例演示如何将 jwt-auth 消费者密钥保存到环境变量，并在配置中引用。

APISIX 支持通过 NGINX env 指令引用系统和用户配置的环境变量。

将密钥保存到环境变量。若在 Docker 中运行 APISIX，需在启动容器时使用 -e 标志设置环境变量。

export JACK_JWT_SECRET=jack-hs256-secret-that-is-very-long

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack"
  }'

为消费者创建 jwt-auth 凭据，并引用环境变量：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "$env://JACK_JWT_SECRET"
      }
    }
  }'

创建启用了 jwt-auth 的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-route",
    "uri": "/get",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

如需为 jack 签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 jack-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU

携带 JWT 在请求头中发送请求：

curl -i "http://127.0.0.1:9080/get" -H "Authorization: ${jwt_token}"

你应收到 HTTP/1.1 200 OK 响应。

在 Secret Manager 中管理密钥#

以下示例演示如何在 HashiCorp Vault 中管理 jwt-auth 消费者密钥，并在插件配置中引用。

在 Docker 中启动 Vault 开发服务器：

docker run -d \
  --name vault \
  -p 8200:8200 \
  --cap-add IPC_LOCK \
  -e VAULT_DEV_ROOT_TOKEN_ID=root \
  -e VAULT_DEV_LISTEN_ADDRESS=0.0.0.0:8200 \
  vault:1.9.0 \
  vault server -dev

APISIX 目前支持 Vault KV 引擎第 1 版。在 Vault 中启用它：

docker exec -i vault sh -c "VAULT_TOKEN='root' VAULT_ADDR='http://0.0.0.0:8200' vault secrets enable -path=kv -version=1 kv"

你应收到类似如下的响应：

Success! Enabled the kv secrets engine at: kv/

创建 Secret 并配置 Vault 地址及其他连接信息，请根据实际情况调整 Vault 地址：

curl "http://127.0.0.1:9180/apisix/admin/secrets/vault/jwt" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "uri": "http://127.0.0.1:8200",
    "prefix": "kv/apisix",
    "token": "root"
  }'

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack"
  }'

为消费者创建 jwt-auth 凭据，并引用 Secret：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jwt-vault-key",
        "secret": "$secret://vault/jwt/jack/jwt-secret"
      }
    }
  }'

创建启用了 jwt-auth 的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-route",
    "uri": "/get",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

在 Vault 中设置 jwt-auth 密钥值为 vault-hs256-secret-that-is-very-long：

docker exec -i vault sh -c "VAULT_TOKEN='root' VAULT_ADDR='http://0.0.0.0:8200' vault kv put kv/apisix/jack jwt-secret=vault-hs256-secret-that-is-very-long"

你应收到类似如下的响应：

Success! Data written to: kv/apisix/jack

如需签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 vault-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jwt-vault-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jwt-vault-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqd3QtdmF1bHQta2V5IiwibmJmIjoxNzI5MTMyMjcxfQ.i2pLj7QcQvnlSjB7iV5V522tIV43boQRtee7L0rwlkQ

携带令牌在请求头中发送请求：

curl -i "http://127.0.0.1:9080/get" -H "Authorization: ${jwt_token}"

你应收到 HTTP/1.1 200 OK 响应。

使用 RS256 算法签名 JWT#

以下示例演示如何使用 RS256 等非对称算法对 JWT 进行签名和验证。你将使用 openssl 生成 RSA 密钥对，并使用 JWT.io 生成 JWT，以便更好地理解 JWT 的组成。

生成 2048 位 RSA 私钥并提取对应的 PEM 格式公钥：

openssl genrsa -out jwt-rsa256-private.pem 2048
openssl rsa -in jwt-rsa256-private.pem -pubout -out jwt-rsa256-public.pem

你应在当前工作目录中看到生成的 jwt-rsa256-private.pem 和 jwt-rsa256-public.pem 文件。

访问 JWT.io 的 JWT 编码器并执行以下步骤：

  • 将算法填写为 RS256。
  • 将私钥内容复制粘贴到 SIGN JWT: PRIVATE KEY 部分。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.K-I13em84kAcyH1jfIJl7ls_4jlwg1GzEzo5_xrDu-3wt3Xa3irS6naUsWpxX-a-hmcZZxRa9zqunqQjUP4kvn5e3xg2f_KyCR-_ZbwqYEPk3bXeFV1l4iypv6z5L7W1Niharun-dpMU03b1Tz64vhFx6UwxNL5UIZ7bunDAo_BXZ7Xe8rFhNHvIHyBFsDEXIBgx8lNYMq8QJk3iKxZhZZ5Om7lgYjOOKRgew4WkhBAY0v1AkO77nTlvSK0OEeeiwhkROyntggyx-S-U222ykMQ6mBLxkP4Cq5qHwXD8AUcLk5mhEij-3QhboYnt7yhKeZ3wDSpcjDvvL2aasC25ng

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack"
  }'

为消费者创建 jwt-auth 凭据，并配置 RSA 密钥。公钥的起始行与结束行之后需要添加换行符，例如 -----BEGIN PUBLIC KEY-----\n......\n-----END PUBLIC KEY-----，密钥内容可以直接拼接。

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "algorithm": "RS256",
        "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAoTxe7ZPycrEP0SK4OBA2\n0OUQsDN9gSFSHVvx/t++nZNrFxzZnV6q6/TRsihNXUIgwaOu5icFlIcxPL9Mf9UJ\na5/XCQExp1TxpuSmjkhIFAJ/x5zXrC8SGTztP3SjkhYnQO9PKVXI6ljwgakVCfpl\numuTYqI+ev7e45NdK8gJoJxPp8bPMdf8/nHfLXZuqhO/btrDg1x+j7frDNrEw+6B\nCK2SsuypmYN+LwHfaH4Of7MQFk3LNIxyBz0mdbsKJBzp360rbWnQeauWtDymZxLT\nATRNBVyl3nCNsURRTkc7eyknLaDt2N5xTIoUGHTUFYSdE68QWmukYMVGcEHEEPkp\naQIDAQAB\n-----END PUBLIC KEY-----"
      }
    }
  }'

创建带有 jwt-auth 插件的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-route",
    "uri": "/headers",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

验证时，携带 JWT 在 Authorization 请求头中向路由发送请求：

curl -i "http://127.0.0.1:9080/headers" -H "Authorization: ${jwt_token}"

你应收到 HTTP/1.1 200 OK 响应。

在请求头中添加消费者自定义 ID#

以下示例演示如何在已验证请求的 X-Consumer-Custom-ID 请求头中附加消费者自定义 ID，以便根据需要实现额外逻辑。

以下示例演示了如何在 `X-Consumer-Custom-Id` 标头中将消费者自定义 ID 附加到已验证的请求，该 ID 可用于根据需要实现其他逻辑。

创建带有自定义 ID 标签的消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack",
    "labels": {
      "custom_id": "495aec6a"
    }
  }'

为消费者创建 jwt-auth 凭据：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "jack-hs256-secret-that-is-very-long"
      }
    }
  }'

创建带有 jwt-auth 的路由：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-auth-route",
    "uri": "/anything",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

如需为 jack 签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 jack-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU

验证时，携带 JWT 在 Authorization 请求头中向路由发送请求：

curl -i "http://127.0.0.1:9080/headers" -H "Authorization: ${jwt_token}"

你应看到类似如下的 HTTP/1.1 200 OK 响应：

{
  "headers": {
    "Accept": "*/*",
    "Authorization": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU",
    "Host": "127.0.0.1",
    "User-Agent": "curl/8.6.0",
    "X-Amzn-Trace-Id": "Root=1-6873b19d-329331db76e5e7194c942b47",
    "X-Consumer-Custom-Id": "495aec6a",
    "X-Consumer-Username": "jack",
    "X-Credential-Identifier": "cred-jack-jwt-auth",
    "X-Forwarded-Host": "127.0.0.1"
  }
}

使用匿名消费者进行限速#

以下示例演示如何为普通消费者和匿名消费者配置不同的限速策略，其中匿名消费者无需身份验证，但配额较少。

创建普通消费者 jack，并配置 limit-count 插件，允许在 30 秒窗口内最多请求 3 次：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "jack",
    "plugins": {
      "limit-count": {
        "count": 3,
        "time_window": 30,
        "rejected_code": 429
      }
    }
  }'

为消费者 jack 创建 jwt-auth 凭据：

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "jack-hs256-secret-that-is-very-long"
      }
    }
  }'

创建匿名用户 anonymous，并配置 limit-count 插件，允许在 30 秒窗口内最多请求 1 次：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "username": "anonymous",
    "plugins": {
      "limit-count": {
        "count": 1,
        "time_window": 30,
        "rejected_code": 429
      }
    }
  }'

创建路由，并配置 jwt-auth 插件允许匿名消费者 anonymous 绕过身份验证：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${admin_key}" \
  -d '{
    "id": "jwt-auth-route",
    "uri": "/anything",
    "plugins": {
      "jwt-auth": {
        "anonymous_consumer": "anonymous"
      }
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

如需为 jack 签发 JWT，可以使用 JWT.io 的 JWT 编码器或其他工具。若使用 JWT.io 的 JWT 编码器，请执行以下步骤：

  • 将算法填写为 HS256。
  • 在 Valid secret 部分将密钥更新为 jack-hs256-secret-that-is-very-long。
  • 在 payload 中填入消费者密钥 jack-key，并以 UNIX 时间戳格式添加 exp 或 nbf。

payload 应类似如下所示：

{
  "key": "jack-key",
  "nbf": 1729132271
}

复制生成的 JWT 并保存到变量：

export jwt_token=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJqYWNrLWtleSIsIm5iZiI6MTcyOTEzMjI3MX0.UEPXy5jpid624T1XpfjM0PLY73LZPjV3Qt8yZ92kVuU

验证限速效果，连续发送 5 次携带 jack JWT 的请求：

resp=$(seq 5 | xargs -I{} curl "http://127.0.0.1:9080/anything" -H "Authorization: ${jwt_token}" -o /dev/null -s -w "%{http_code}\n") && \
  count_200=$(echo "$resp" | grep "200" | wc -l) && \
  count_429=$(echo "$resp" | grep "429" | wc -l) && \
  echo "200": $count_200, "429": $count_429

你应看到如下响应，说明 5 次请求中有 3 次成功（状态码 200），其余被拒绝（状态码 429）：

200:    3, 429:    2

发送 5 次匿名请求：

resp=$(seq 5 | xargs -I{} curl "http://127.0.0.1:9080/anything" -o /dev/null -s -w "%{http_code}\n") && \
  count_200=$(echo "$resp" | grep "200" | wc -l) && \
  count_429=$(echo "$resp" | grep "429" | wc -l) && \
  echo "200": $count_200, "429": $count_429

你应看到如下响应，说明只有 1 次请求成功：

200:    1, 429:    4