Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 2142:ca7568f67dee

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Sorted directives alphabetically.
author Ruslan Ermilov <ru@nginx.com>
date Tue, 10 Apr 2018 18:39:34 +0300
parents f6e578b1b02d
children 231cad90a823
comparison
equal deleted inserted replaced
2141:10751277a8ad 2142:ca7568f67dee
117 117
118 <para> 118 <para>
119 The special value <literal>off</literal> cancels the effect 119 The special value <literal>off</literal> cancels the effect
120 of the <literal>auth_jwt</literal> directive 120 of the <literal>auth_jwt</literal> directive
121 inherited from the previous configuration level. 121 inherited from the previous configuration level.
122 </para>
123
124 </directive>
125
126
127 <directive name="auth_jwt_header_set">
128 <syntax><value>$variable</value> <value>name</value> ...</syntax>
129 <default/>
130 <context>http</context>
131 <appeared-in>1.11.10</appeared-in>
132
133 <para>
134 Sets the <value>variable</value> to a JOSE header parameter
135 identified by key names.
136 Name matching starts from the top level of the JSON tree.
137 For arrays, the variable keeps a list of array elements separated by commas.
138 <note>
139 Prior to version 1.13.7, only one key name could be specified,
140 and the result was undefined for arrays.
141 </note>
142 </para> 122 </para>
143 123
144 </directive> 124 </directive>
145 125
146 126
170 </para> 150 </para>
171 151
172 </directive> 152 </directive>
173 153
174 154
155 <directive name="auth_jwt_header_set">
156 <syntax><value>$variable</value> <value>name</value> ...</syntax>
157 <default/>
158 <context>http</context>
159 <appeared-in>1.11.10</appeared-in>
160
161 <para>
162 Sets the <value>variable</value> to a JOSE header parameter
163 identified by key names.
164 Name matching starts from the top level of the JSON tree.
165 For arrays, the variable keeps a list of array elements separated by commas.
166 <note>
167 Prior to version 1.13.7, only one key name could be specified,
168 and the result was undefined for arrays.
169 </note>
170 </para>
171
172 </directive>
173
174
175 <directive name="auth_jwt_key_file">
176 <syntax><value>file</value></syntax>
177 <default/>
178 <context>http</context>
179 <context>server</context>
180 <context>location</context>
181 <context>limit_except</context>
182
183 <para>
184 Specifies a <value>file</value> in
185 <link url="https://tools.ietf.org/html/rfc7517#section-5">JSON Web Key Set</link>
186 format for validating JWT signature.
187 Parameter value can contain variables.
188 </para>
189
190 </directive>
191
192
175 <directive name="auth_jwt_leeway"> 193 <directive name="auth_jwt_leeway">
176 <syntax><value>time</value></syntax> 194 <syntax><value>time</value></syntax>
177 <default>0s</default> 195 <default>0s</default>
178 <context>http</context> 196 <context>http</context>
179 <context>server</context> 197 <context>server</context>
189 JWT claims. 207 JWT claims.
190 </para> 208 </para>
191 209
192 </directive> 210 </directive>
193 211
194
195 <directive name="auth_jwt_key_file">
196 <syntax><value>file</value></syntax>
197 <default/>
198 <context>http</context>
199 <context>server</context>
200 <context>location</context>
201 <context>limit_except</context>
202
203 <para>
204 Specifies a <value>file</value> in
205 <link url="https://tools.ietf.org/html/rfc7517#section-5">JSON Web Key Set</link>
206 format for validating JWT signature.
207 Parameter value can contain variables.
208 </para>
209
210 </directive>
211
212 </section> 212 </section>
213 213
214 214
215 <section id="variables" name="Embedded Variables"> 215 <section id="variables" name="Embedded Variables">
216 216