jwt-auth

目录

描述

jwt-auth 是一个认证插件，它需要与 consumer 一起配合才能工作。

添加 JWT Authentication 到一个 service 或 route。 然后 consumer 将其密钥添加到查询字符串参数、请求头或 cookie 中以验证其请求。

有关 JWT 的更多信息，可参考 JWT 查看更多信息。

jwt-auth 插件可以与 HashiCorp Vault 集成，用于存储和获取密钥，从其加密的 KV 引擎获取 RSA 密钥对。 阅读下面的 例子 来了解它如何工作。

属性

consumer 端配置：

名称类型必选项默认值有效值描述
keystring必须不同的 consumer 对象应有不同的值，它应当是唯一的。不同 consumer 使用了相同的 key ，将会出现请求匹配异常。
secretstring可选加密秘钥。如果您未指定，后台将会自动帮您生成。
public_keystring可选RSA 公钥， algorithm 属性选择 RS256 算法时必填
private_keystring可选RSA 私钥， algorithm 属性选择 RS256 算法时必填
algorithmstring可选“HS256”[“HS256”, “HS512”, “RS256”]加密算法
expinteger可选86400[1,…]token 的超时时间
base64_secretboolean可选false密钥是否为 base64 编码
vaultobject可选是否使用 Vault 作为存储和检索密钥（HS256/HS512 的密钥或 RS256 的公钥和私钥）的方式。该插件默认使用 kv/apisix/consumer/<consumer name>/jwt-auth 路径进行密钥检索

注意: 要启用 Vault 集成，首先访问 config.yaml，更新您的 Vault 服务器配置、主机地址和访问令牌。您可以在 config-default.yaml 中 vault 属性下查看 APISIX 的默认配置。

router 端配置：

名称类型必选项默认值有效值描述
headerstring可选authorization设置我们从哪个 header 获取 token。
querystring可选jwt设置我们从哪个 query string 获取 token，优先级低于header
cookiestring可选jwt设置我们从哪个 cookie 获取 token，优先级低于query

接口

插件会增加 /apisix/plugin/jwt/sign 这个接口，需要通过 public-api 插件来暴露它。

如何启用

  1. 创建一个 consumer 对象，并设置插件 jwt-auth 的值。
  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "username": "jack",
  4.     "plugins": {
  5.         "jwt-auth": {
  6.             "key": "user-key",
  7.             "secret": "my-secret-key"
  8.         }
  9.     }
  10. }'

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

  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "username": "kerouac",
  4.     "plugins": {
  5.         "jwt-auth": {
  6.             "key": "user-key",
  7.             "public_key": "-----BEGIN PUBLIC KEY-----\n……\n-----END PUBLIC KEY-----",
  8.             "private_key": "-----BEGIN RSA PRIVATE KEY-----\n……\n-----END RSA PRIVATE KEY-----",
  9.             "algorithm": "RS256"
  10.         }
  11.     }
  12. }'
  1. 创建 Route 或 Service 对象，并开启 jwt-auth 插件。
  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/index.html",
  5.     "plugins": {
  6.         "jwt-auth": {}
  7.     },
  8.     "upstream": {
  9.         "type": "roundrobin",
  10.         "nodes": {
  11.             "127.0.0.1:1980": 1
  12.         }
  13.     }
  14. }'

Vault 与 APISIX jwt-auth 插件集成的不同用例

Apache APISIX jwt-auth 插件可以被配置为从 Vault 存储中获取简单的文本密钥以及 RS256 公私密钥对。

注意：对于该集成支持的早期版本，该插件期望存储在 Vault 路径中的密钥名称为「secret，public_key，private_key」其中之一。在未来的版本中，我们将支持引用自定义命名键。

要启用 Vault 的兼容性，只需要在 jwt-auth 插件内添加空的 Vault 对象。

  1. 用在 Vault 储存的 HS256 签名密钥来进行 JWT 签名和认证。
  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "username": "jack",
  4.     "plugins": {
  5.         "jwt-auth": {
  6.             "key": "key-1",
  7.             "vault": {}
  8.         }
  9.     }
  10. }'

在这里，插件在 Consumer 配置中提到的 Consumer 用户 jack 的 Vault 路径（<vault.prefix from conf.yaml>/consumer/jack/jwt-auth）中查找密钥 secret，并使用它进行后续的签名和 JWT 验证。如果在该路径中没有找到密钥，该插件将记录一个错误，并且无法执行 JWT 验证。

  1. RS256 RSA 密钥对, 包括公钥和私钥都存粗在 Vault 中。
  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "username": "kowalski",
  4.     "plugins": {
  5.         "jwt-auth": {
  6.             "key": "rsa-keypair",
  7.             "algorithm": "RS256",
  8.             "vault": {}
  9.         }
  10.     }
  11. }'

该插件在 Vault 键值对路径（<vault.prefix from conf.yaml>/consumer/jim/jwt-auth）中为插件 Vault 配置中提到的用户 kowalski 查找 public_key 和 private_key。如果没有找到，认证失败。

如果你不确定如何将公钥和私钥存储到 Vault 键值对中，请使用这个命令。

  1. # 提供你当前目录包含的 "public.pem" 和 "private.pem" 文件
  2. $ vault kv put kv/apisix/consumer/jim/jwt-auth public_key=@public.pem private_key=@private.pem
  3. Success! Data written to: kv/apisix/consumer/jim/jwt-auth
  1. 公钥在 Consumer 配置中，而私钥在 Vault 中。
  1. curl http://127.0.0.1:9080/apisix/admin/consumers -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "username": "rico",
  4.     "plugins": {
  5.         "jwt-auth": {
  6.             "key": "user-key",
  7.             "algorithm": "RS256",
  8.             "public_key": "-----BEGIN PUBLIC KEY-----\n……\n-----END PUBLIC KEY-----"
  9.             "vault": {}
  10.         }
  11.     }
  12. }'

这个插件使用 Consumer 配置中的 RSA 公钥，并直接使用从 Vault 中获取的私钥。

你可以使用 APISIX Dashboard，通过 web 界面来完成上面的操作。

  1. 先增加一个 consumer：

create a consumer

然后在 consumer 页面中添加 jwt-auth 插件： enable jwt plugin

  1. 创建 Route 或 Service 对象，并开启 jwt-auth 插件：

enable jwt from route or service

测试插件

首先进行登录获取 jwt-auth token:

首先，你需要为签发 token 的 API 设置一个路由，它将使用 public-api 插件。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/jas -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/apisix/plugin/jwt/sign",
  4.     "plugins": {
  5.         "public-api": {}
  6.     }
  7. }'

之后，我们就可以调用它获取 token 了。

  • 没有额外的 payload:
  1. $ curl http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=user-key -i
  2. HTTP/1.1 200 OK
  3. Date: Wed, 24 Jul 2019 10:33:31 GMT
  4. Content-Type: text/plain
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server
  10. eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTU2NDA1MDgxMX0.Us8zh_4VjJXF-TmR5f8cif8mBU7SuefPlpxhH0jbPVI
  • 有额外的 payload:
  1. $ curl -G --data-urlencode 'payload={"uid":10000,"uname":"test"}' http://127.0.0.1:9080/apisix/plugin/jwt/sign?key=user-key -i
  2. HTTP/1.1 200 OK
  3. Date: Wed, 21 Apr 2021 06:43:59 GMT
  4. Content-Type: text/plain; charset=utf-8
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX/2.4
  10. eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJ1bmFtZSI6InRlc3QiLCJ1aWQiOjEwMDAwLCJrZXkiOiJ1c2VyLWtleSIsImV4cCI6MTYxOTA3MzgzOX0.jI9-Rpz1gc3u8Y6lZy8I43RXyCu0nSHANCvfn0YZUCY

使用获取到的 token 进行请求尝试

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

禁用插件

当你想去掉 jwt-auth 插件的时候，很简单，在插件的配置中把对应的 json 配置删除即可，无须重启服务，即刻生效：

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/index.html",
  5.     "id": 1,
  6.     "plugins": {},
  7.     "upstream": {
  8.         "type": "roundrobin",
  9.         "nodes": {
  10.             "127.0.0.1:1980": 1
  11.         }
  12.     }
  13. }'