Skip to main content
Version: 3.0.0-beta

jwt-auth

描述#

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

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

jwt-auth 插件可以与 HashiCorp Vault 集成,用于存储和获取密钥,并从 HashiCorp Vault 的 encrypted KV engine中获取 RSA 密匙对。你可以从下面的示例中了解更多信息。

属性#

Consumer 端:

名称类型必选项默认值有效值描述
keystringConsumer 的 access_key 必须是唯一的。如果不同 Consumer 使用了相同的 access_key ,将会出现请求匹配异常。
secretstring加密秘钥。如果未指定,后台将会自动生成。
public_keystringRSA 或 ECDSA 公钥, algorithm 属性选择 RS256ES256 算法时必选。
private_keystringRSA 或 ECDSA 私钥, algorithm 属性选择 RS256ES256 算法时必选。
algorithmstring"HS256"["HS256", "HS512", "RS256", "ES256"]加密算法。
expinteger86400[1,...]token 的超时时间。
base64_secretbooleanfalse当设置为 true 时,密钥为 base64 编码。
vaultobject是否使用 Vault 作为存储和检索密钥(HS256/HS512 的密钥或 RS256/ES256 的公钥和私钥)的方式。该插件默认使用 kv/apisix/consumer/<consumer name>/jwt-auth 路径进行密钥检索。
lifetime_grace_periodinteger0[0,...]定义生成 JWT 的服务器和验证 JWT 的服务器之间的时钟偏移。该值应该是零(0)或一个正整数。
IMPORTANT

如果你想要启用 Vault 集成,你需要在 config.yaml 配置文件中,更新你的 Vault 服务器配置、主机地址和访问令牌。

请参考默认配置文件 config-default.yaml 中的 Vault 属性下了解相关配置。

Route 端:

名称类型必选项默认值描述
headerstringauthorization设置我们从哪个 header 获取 token。
querystringjwt设置我们从哪个 query string 获取 token,优先级低于 header。
cookiestringjwt设置我们从哪个 cookie 获取 token,优先级低于 query。

接口#

该插件会增加 /apisix/plugin/jwt/sign 接口。

note

你需要通过 public-api 插件来暴露它。

启用插件#

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

首先,你可以通过 Admin API 创建一个 Consumer:

curl http://127.0.0.1:9180/apisix/admin/consumers \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -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: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"username": "kerouac",
"plugins": {
"jwt-auth": {
"key": "user-key",
"public_key": "-----BEGIN PUBLIC KEY-----\n……\n-----END PUBLIC KEY-----",
"private_key": "-----BEGIN RSA PRIVATE KEY-----\n……\n-----END RSA PRIVATE KEY-----",
"algorithm": "RS256"
}
}
}'

创建 Consumer 对象后,你可以创建 Route 进行验证:

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

与 HashiCorp Vault 集成使用#

HashiCorp Vault 提供集中式密钥管理解决方案,可与 APISIX 一起用于身份验证。

因此,如果你的企业经常更改 secret/keys(HS256/HS512 的密钥或 RS256 的 public_key 和 private_key)并且你不想每次都更新 APISIX 的 Consumer,或者你不想通过 Admin API(减少信息泄漏),你可以将 Vault 和 jwt-auth 插件一起使用。

note

当前版本的 Apache APISIX 期望存储在 Vault 中机密的密钥名称位于 secretpublic_keyprivate_key 之间。前一个用于 HS256/HS512 算法,后两个用于 RS256 算法。

在未来的版本中,该插件将支持引用自定义命名键。

如果你要使用 Vault,可以在配置中添加一个空的 Vault 对象。

例如,如果你在 Vault 中存储了一个 HS256 签名密钥,可以通过以下方式在 APISIX 中使用它:

curl http://127.0.0.1:9180/apisix/admin/consumers \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"username": "jack",
"plugins": {
"jwt-auth": {
"key": "key-1",
"vault": {}
}
}
}'

该插件将在提供的 Vault 路径(<vault.prefix>/consumer/jack/jwt-auth)中查找密钥 secret,并将其用于 JWT 身份验证。如果在同一路径中找不到密钥,插件会记录错误并且无法执行 JWT 验证。

note

vault.prefix 会在配置文件(conf/config.yaml)中根据启用 Vault kv secret engine 时选择的基本路径进行设置。

例如,如果设置了 vault secrets enable -path=foobar kv,就需要在 vault.prefix 中使用 foobar

如果在此路径中找不到密钥,插件将记录错误。

对于 RS256,公钥和私钥都应该存储在 Vault 中,可以通过以下方式配置:

curl http://127.0.0.1:9180/apisix/admin/consumers \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"username": "jack",
"plugins": {
"jwt-auth": {
"key": "rsa-keypair",
"algorithm": "RS256",
"vault": {}
}
}
}'

该插件将在提供的 Vault 键值对路径(<vault.prefix from conf.yaml>/consumer/jim/jwt-auth)中查找 public_keyprivate_key,并将其用于 JWT 身份认证。

如果在此路径中没有找到密钥,则认证失败,插件将记录错误。

你还可以在 Consumer 中配置 public_key 并使用存储在 Vault 中的 private_key

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

你还可以通过 APISIX Dashboard 的 Web 界面完成上述操作。

测试插件#

首先,你需要为签发 token 的 API 配置一个 Route,该路由将使用 public-api 插件。

curl http://127.0.0.1:9180/apisix/admin/routes/jas \
-H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uri": "/apisix/plugin/jwt/sign",
"plugins": {
"public-api": {}
}
}'

之后就可以通过调用它来获取 token 了。

  • 没有额外的 payload:
curl http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=user-key -i
HTTP/1.1 200 OK
Date: Wed, 24 Jul 2019 10:33:31 GMT
Content-Type: text/plain
Transfer-Encoding: chunked
Connection: keep-alive
Server: APISIX web server

eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTU2NDA1MDgxMXx.Us8zh_4VjJXF-TmR5f8cif8mBU7SuefPlpxhH0jbPVI
  • 有额外的 payload:
curl -G --data-urlencode 'payload={"uid":10000,"uname":"test"}' http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=user-key -i
HTTP/1.1 200 OK
Date: Wed, 21 Apr 2021 06:43:59 GMT
Content-Type: text/plain; charset=utf-8
Transfer-Encoding: chunked
Connection: keep-alive
Server: APISIX/2.4

eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1bmFtZSI6InRlc3QiLCJ1aWQiOjEwMDAwLCJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTYxOTA3MzgzOX0.jI9-Rpz1gc3u8Y6lZy8I43RXyCu0nSHANCvfn0YZUCY

现在你可以使用获取到的 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: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uri": "/index.html",
"id": 1,
"plugins": {},
"upstream": {
"type": "roundrobin",
"nodes": {
"127.0.0.1:1980": 1
}
}
}'