ngx_http_auth_jwt_module
ngx_http_auth_jwt_module模块
- 示例配置
- 指令
- auth_jwt
- auth_jwt_header_set
- auth_jwt_claim_set
- auth_jwt_key_file
- 嵌入式变量
所述ngx_http_auth_jwt_module模块（1.11.3）通过验证所提供的实现客户机授权JSON网络令牌使用指定键（JWT）。JWT声明必须以JSON Web签名（JWS）结构进行编码。该模块可用于OpenID Connect身份验证。
该模块可以与其他访问模块组合使用，例如ngx_http_access_module，ngx_http_auth_basic_module和ngx_http_auth_request_module。
此模块可作为我们商业订阅的一部分。
示例配置
location / {
auth_jwt "closed site";
auth_jwt_key_file conf/keys.json;
}
指令
| 句法： | auth_jwt string token = $ variable | 关闭; |
|---|---|
| 默认： | auth_jwt关闭; |
| 语境： | http，服务器，位置 |
启用JSON Web令牌的验证。指定string的用作a realm。参数值可以包含变量。
可选token参数指定包含JSON Web令牌的变量。默认情况下，JWT作为承载令牌传入“授权”头中。JWT也可以作为cookie或查询字符串的一部分传递：
auth_jwt "closed site" token=$cookie_auth_token;
特殊值关闭取消了从先前配置级别继承的auth_jwt指令的效果。
| 句法： | auth_jwt_header_set $变量名称; |
|---|---|
| 默认： | — |
| 语境： | HTTP |
将该variable参数设置为给定的JOSE标头参数name。
| 句法： | auth_jwt_claim_set $变量名称; |
|---|---|
| 默认： | — |
| 语境： | HTTP |
设置variable给定的JWT声明参数name。
| 句法： | auth_jwt_key_file文件; |
|---|---|
| 默认： | — |
| 语境： | http，服务器，位置 |
指定file在JSON网络密钥集用于验证JWT签名格式。参数值可以包含变量。
嵌入式变量
该ngx_http_auth_jwt_module模块支持嵌入式变量：
$ jwt_header_name返回指定的JOSE头的值$ jwt_claim_name返回指定的JWT声明的值
