Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 2082:fee7627f6a5a

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Mon, 11 Dec 2017 12:13:09 +0300
parents a58b35cc0823
children bdfbdf74fb3d
comparison
equal deleted inserted replaced
2081:f29bd40e9a62 2082:fee7627f6a5a
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Module ngx_http_auth_jwt_module" 9 <module name="Module ngx_http_auth_jwt_module"
10 link="/en/docs/http/ngx_http_auth_jwt_module.html" 10 link="/en/docs/http/ngx_http_auth_jwt_module.html"
11 lang="en" 11 lang="en"
12 rev="3"> 12 rev="4">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 The <literal>ngx_http_auth_jwt_module</literal> module (1.11.3) 17 The <literal>ngx_http_auth_jwt_module</literal> module (1.11.3)
35 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>, 35 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>,
36 via the <link doc="ngx_http_core_module.xml" id="satisfy"/> directive. 36 via the <link doc="ngx_http_core_module.xml" id="satisfy"/> directive.
37 </para> 37 </para>
38 38
39 <para> 39 <para>
40 The module supports the following cryptographic
41 <link url="https://tools.ietf.org/html/rfc7518#section-3.1">algorithms</link>:
42
43 <list type="bullet">
44
45 <listitem>
46 HS256, HS384, HS512
47 </listitem>
48
49 <listitem>
50 RS256, RS384, RS512
51 </listitem>
52
53 <listitem>
54 ES256, ES384, ES512
55 </listitem>
56
57 </list>
58
59 Prior to version 1.13.7,
60 only HS256, RS256, ES256 algorithms were supported.
61 </para>
62
63 <para>
40 <note> 64 <note>
41 This module is available as part of our 65 This module is available as part of our
42 <commercial_version>commercial subscription</commercial_version>. 66 <commercial_version>commercial subscription</commercial_version>.
43 </note> 67 </note>
44 </para> 68 </para>
98 122
99 </directive> 123 </directive>
100 124
101 125
102 <directive name="auth_jwt_header_set"> 126 <directive name="auth_jwt_header_set">
103 <syntax><value>$variable</value> <value>name</value></syntax> 127 <syntax><value>$variable</value> <value>name</value> ...</syntax>
104 <default/> 128 <default/>
105 <context>http</context> 129 <context>http</context>
106 <appeared-in>1.11.10</appeared-in> 130 <appeared-in>1.11.10</appeared-in>
107 131
108 <para> 132 <para>
109 Sets the <value>variable</value> to the given 133 Sets the <value>variable</value> to a JOSE header parameter
110 JOSE header parameter <value>name</value>. 134 identified by key names.
135 Name matching starts from the top level of the JSON tree.
136 For arrays, the variable keeps a list of array elements separated by commas.
137 <note>
138 Prior to version 1.13.7, only one key name could be specified,
139 and the result was undefined for arrays.
140 </note>
111 </para> 141 </para>
112 142
113 </directive> 143 </directive>
114 144
115 145
116 <directive name="auth_jwt_claim_set"> 146 <directive name="auth_jwt_claim_set">
117 <syntax><value>$variable</value> <value>name</value></syntax> 147 <syntax><value>$variable</value> <value>name</value> ...</syntax>
118 <default/> 148 <default/>
119 <context>http</context> 149 <context>http</context>
120 <appeared-in>1.11.10</appeared-in> 150 <appeared-in>1.11.10</appeared-in>
121 151
122 <para> 152 <para>
123 Sets the <value>variable</value> to the given 153 Sets the <value>variable</value> to a JWT claim parameter
124 JWT claim parameter <value>name</value>. 154 identified by key names.
155 Name matching starts from the top level of the JSON tree.
156 For arrays, the variable keeps a list of array elements separated by commas.
157 <example>
158 location / {
159 auth_jwt "closed site";
160 auth_jwt_key_file conf/keys.json;
161 auth_jwt_claim_set $email info e-mail;
162 auth_jwt_claim_set $job info "job title";
163 }
164 </example>
165 <note>
166 Prior to version 1.13.7, only one key name could be specified,
167 and the result was undefined for arrays.
168 </note>
125 </para> 169 </para>
126 170
127 </directive> 171 </directive>
128 172
129 173