跳到主要内容

jwt-auth

jwt-auth 插件支持使用 JSON Web Token (JWT) 作为机制，在客户端访问上游资源之前验证其身份。

启用后，JWT 凭据会配置在 消费者 上，客户端携带签名后的 Token 向 APISIX 标识自己。Token 可以包含在请求 URL 查询字符串、请求头或 Cookie 中。APISIX 随后将验证 Token，以决定允许或拒绝请求访问上游资源。

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

关于 X-Consumer-Username

使用 Ingress Controller 配置消费者时，消费者名称会生成为 namespace_consumername 格式。因此，X-Consumer-Username 请求头也会采用此格式，而不只是 consumername。

示例​

以下示例演示了如何在不同场景下使用 jwt-auth 插件。

在本地生成 JWT​

以下示例使用 OpenSSL 在本地生成 JWT。请在当前 Shell 中定义一次这些辅助函数：

base64url() {
  openssl base64 -A | tr '+/' '-_' | tr -d '='
}

sign_hs256() {
  local secret="$1"
  local payload="$2"
  local encoded_header encoded_payload signature

  encoded_header=$(printf '%s' '{"alg":"HS256","typ":"JWT"}' | base64url)
  encoded_payload=$(printf '%s' "$payload" | base64url)
  signature=$(printf '%s' "$encoded_header.$encoded_payload" | \
    openssl dgst -sha256 -hmac "$secret" -binary | base64url)

  printf '%s.%s.%s\n' "$encoded_header" "$encoded_payload" "$signature"
}

sign_rs256() {
  local private_key="$1"
  local payload="$2"
  local encoded_header encoded_payload signature

  encoded_header=$(printf '%s' '{"alg":"RS256","typ":"JWT"}' | base64url)
  encoded_payload=$(printf '%s' "$payload" | base64url)
  signature=$(printf '%s' "$encoded_header.$encoded_payload" | \
    openssl dgst -sha256 -sign "$private_key" | base64url)

  printf '%s.%s.%s\n' "$encoded_header" "$encoded_payload" "$signature"
}

为确保命令可重复执行，本地示例省略了过期声明。生产 Token 应使用较短的 exp 有效期。如果需要强制要求 exp 或 nbf 声明，请配置 claims_to_verify；列出的声明必须存在且有效。

使用 JWT 进行消费者认证​

以下示例演示了如何实现基于 JWT 的消费者密钥认证。

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_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_API_KEY}" \
  -d '{
    "id": "jwt-route",
    "uri": "/headers",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

使用为 jack 配置的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'jack-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')
export jwt_token

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

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

你应该收到类似于以下的 HTTP/1.1 200 OK 响应：

{
  "headers": {
    "Accept": "*/*", 
    "Authorization": "...",
    "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"
  }
}

使用错误的签名 Secret 生成一个结构有效的 Token，然后将其发送到路由：

invalid_jwt_token=$(sign_hs256 \
  'incorrect-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')

curl -i "http://127.0.0.1:9080/headers" -H "Authorization: $invalid_jwt_token"

你应该收到类似于以下的 HTTP/1.1 401 Unauthorized 响应：

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

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

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_KEY}" \
  -d '{
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "secret": "jack-hs256-secret-that-is-very-long"
      }
    }
  }'

创建一个启用 jwt-auth 插件的路由，并指定携带 Token 的请求参数：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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 配置的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'jack-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')
export jwt_token

在请求头中验证 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": "...",
    ...
  }, 
  ...
}

在查询字符串中验证 JWT​

发送带有查询字符串 JWT 的请求：

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

你应该收到类似于以下的 HTTP/1.1 200 OK 响应：

{
  "args": {
    "jwt-query": "..."
  }, 
  "headers": {
    "Accept": "*/*", 
    ...
  }, 
  "origin": "127.0.0.1, 183.17.233.107", 
  "url": "http://127.0.0.1/get?jwt-query=..."
}

发送带有 Cookie JWT 的请求：

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=...",
    ...
  }, 
  ...
}

在环境变量中管理密钥​

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

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

将密钥保存到环境变量：

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

如果你在 Docker 中运行 APISIX，你应该在启动容器时使用 -e 标志设置环境变量。

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_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_API_KEY}" \
  -d '{
    "id": "jwt-route",
    "uri": "/get",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

使用为 jack 配置的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'jack-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')
export jwt_token

发送带有请求头 JWT 的请求：

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

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

将 JWT Secret 存储在 HashiCorp Vault 中​

HashiCorp Vault 为 Secret 提供集中式外部存储。以下示例将 JWT 签名 Secret 存储在 Vault 中，而不是直接写入 jwt-auth 凭据，并从网关引用该 Secret。

信息

Vault 开发模式将数据存储在内存中，并使用 Root Token。此设置仅用于本地测试。在生产环境中，请运行生产级 Vault 部署，并仅向网关授予读取所需 Secret 路径的 Token。

将 GATEWAY_CONTAINER 设置为正在运行的 APISIX 或 API7 网关容器名称。创建专用 Docker 网络并将网关连接到该网络：

export GATEWAY_CONTAINER=replace-with-gateway-container-name

docker network create gateway-vault-net
docker network connect gateway-vault-net "$GATEWAY_CONTAINER"

在同一网络中启动 Vault 开发服务器：

docker run -d \
  --name gateway-vault \
  --network gateway-vault-net \
  --cap-add IPC_LOCK \
  -e VAULT_DEV_ROOT_TOKEN_ID=root \
  -e VAULT_DEV_LISTEN_ADDRESS=0.0.0.0:8200 \
  hashicorp/vault:1.21.4 \
  vault server -dev

网关的 Vault Secret Provider 从 Vault KV 版本 1读取数据。在 kv/ 路径启用 KV 版本 1 Secret 引擎：

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

你应该看到类似于以下的响应：

Success! Enabled the kv secrets engine at: kv/

将签名 Secret 存储在 kv/apisix/jack：

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

你应该看到类似于以下的响应：

Success! Data written to: kv/apisix/jack

创建包含 Vault 连接信息的网关 Secret 资源。目前 ADC 不会同步 Secret 资源，因此请通过 Admin API 创建该资源：

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

由于 Vault 容器与网关运行在同一 Docker 网络中，因此网关可以通过容器名称访问 Vault。

以下两种配置方式都需要该 Secret 资源。目前 ADC 不会同步 Secret 资源，但可以同步引用已有 Secret 资源的凭据。

创建消费者 jack：

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_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_API_KEY}" \
  -d '{
    "id": "jwt-route",
    "uri": "/get",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

在这两种方式中，引用都会使用 jwt Secret 资源读取 kv/apisix/jack 中的 jwt-secret 字段。

使用 Vault 中存储的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'vault-hs256-secret-that-is-very-long' \
  '{"key":"jwt-vault-key"}')
export jwt_token

发送带有请求头 Token 的请求：

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

你应该收到 HTTP/1.1 200 OK 响应。响应体应包含用于标识已认证消费者的请求头：

{
  "headers": {
    "X-Consumer-Username": "jack",
    "X-Credential-Identifier": "cred-jack-jwt-auth"
  }
}

使用 RS256 算法签署 JWT​

以下示例使用 RS256 签署和验证 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：

jwt_token=$(sign_rs256 jwt-rsa256-private.pem '{"key":"jack-key"}')
export jwt_token

在下面选择的配置方式中，将生成的 jwt-rsa256-public.pem 内容用于 public_key。

创建消费者 jack：

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

为消费者创建 jwt-auth 凭据并配置 RSA 密钥：

public_key=$(awk '{printf "%s\\n", $0}' jwt-rsa256-public.pem)

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d @- <<EOF
  {
    "id": "cred-jack-jwt-auth",
    "plugins": {
      "jwt-auth": {
        "key": "jack-key",
        "algorithm": "RS256",
        "public_key": "$public_key"
      }
    }
  }
EOF

❶ 将消费者密钥配置为 jack-key。

❷ 将 JWT 签名算法配置为 RS256。

❸ 配置 RSA 公钥。

创建一个启用 jwt-auth 插件的路由：

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

要进行验证，请向路由发送在 Authorization 请求头中携带 JWT 的请求：

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

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

将消费者自定义 ID 添加到请求头​

以下示例演示了如何将消费者自定义 ID 添加到已认证请求的 Consumer-Custom-Id 请求头中，以便按需实现额外逻辑。

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

curl "http://127.0.0.1:9180/apisix/admin/consumers" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_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_API_KEY}" \
  -d '{
    "id": "jwt-auth-route",
    "uri": "/anything",
    "plugins": {
      "jwt-auth": {}
    },
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "httpbin.org:80": 1
      }
    }
  }'

使用为 jack 配置的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'jack-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')
export jwt_token

要进行验证，请向路由发送在 Authorization 请求头中携带 JWT 的请求：

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

你应该看到类似于以下的 HTTP/1.1 200 OK 响应：

{
  "headers": {
    "Accept": "*/*", 
    "Authorization": "...",
    "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": "aic_jack",
    "X-Forwarded-Host": "127.0.0.1"
  },
  "url": "http://127.0.0.1/anything"
}

如果你想将更多消费者自定义请求头添加到已认证请求中，请参阅 attach-consumer-label 插件。

匿名消费者的速率限制​

以下示例演示了如何针对常规消费者和匿名消费者配置不同的速率限制策略，其中匿名消费者无需认证且配额较少。

创建常规消费者 jack 并配置 limit-count 插件，允许在 30 秒窗口内有 3 次配额：

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

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

curl "http://127.0.0.1:9180/apisix/admin/consumers/jack/credentials" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_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_API_KEY}" \
  -d '{
    "username": "anonymous",
    "plugins": {
      "limit-count": {
        "count": 1,
        "time_window": 30,
        "rejected_code": 429,
        "policy": "local"
      }
    }
  }'

创建路由并配置 jwt-auth 插件以接受匿名消费者 anonymous 绕过认证：

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

使用为 jack 配置的密钥和 Secret 在本地生成 JWT：

jwt_token=$(sign_hs256 \
  'jack-hs256-secret-that-is-very-long' \
  '{"key":"jack-key"}')
export jwt_token

要验证速率限制，请使用 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

发送五个匿名请求：

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

你应该看到以下响应，显示只有一个请求成功：

200:    1, 429:    4