Mercurial > hg > nginx-site

comparison xml/en/docs/http/ngx_http_auth_jwt_module.xml @ 1925:a58b35cc0823

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 Wed, 08 Mar 2017 18:05:46 +0300
parents b5e416ace4bf
children fee7627f6a5a
comparison
equal deleted inserted replaced
1924:237a10fb98d2 1925:a58b35cc0823
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="2"> 12 rev="3">
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)
97 </para> 97 </para>
98 98
99 </directive> 99 </directive>
100 100
101 101
102 <directive name="auth_jwt_header_set">
103 <syntax><value>$variable</value> <value>name</value></syntax>
104 <default/>
105 <context>http</context>
106 <appeared-in>1.11.10</appeared-in>
107
108 <para>
109 Sets the <value>variable</value> to the given
110 JOSE header parameter <value>name</value>.
111 </para>
112
113 </directive>
114
115
116 <directive name="auth_jwt_claim_set">
117 <syntax><value>$variable</value> <value>name</value></syntax>
118 <default/>
119 <context>http</context>
120 <appeared-in>1.11.10</appeared-in>
121
122 <para>
123 Sets the <value>variable</value> to the given
124 JWT claim parameter <value>name</value>.
125 </para>
126
127 </directive>
128
129
102 <directive name="auth_jwt_key_file"> 130 <directive name="auth_jwt_key_file">
103 <syntax><value>file</value></syntax> 131 <syntax><value>file</value></syntax>
104 <default/> 132 <default/>
105 <context>http</context> 133 <context>http</context>
106 <context>server</context> 134 <context>server</context>
120 148
121 <section id="variables" name="Embedded Variables"> 149 <section id="variables" name="Embedded Variables">
122 150
123 <para> 151 <para>
124 The <literal>ngx_http_auth_jwt_module</literal> module 152 The <literal>ngx_http_auth_jwt_module</literal> module
125 supports embedded variables. 153 supports embedded variables:
126 </para> 154 </para>
127 155
128 <para> 156 <para>
129 Variables that return
130 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>:
131
132 <list type="tag" compact="yes"> 157 <list type="tag" compact="yes">
133 <tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name> 158 <tag-name id="var_jwt_header_"><var>$jwt_header_</var><value>name</value></tag-name>
134 <tag-desc> 159 <tag-desc>
135 audience 160 returns the value of a specified
161 <link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>
136 </tag-desc> 162 </tag-desc>
137 163
138 <tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name> 164 <tag-name id="var_jwt_claim_"><var>$jwt_claim_</var><value>name</value></tag-name>
139 <tag-desc> 165 <tag-desc>
140 email 166 returns the value of a specified
141 </tag-desc> 167 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claim</link>
142
143 <tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name>
144 <tag-desc>
145 expiration time
146 </tag-desc>
147
148 <tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name>
149 <tag-desc>
150 issued at
151 </tag-desc>
152
153 <tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name>
154 <tag-desc>
155 issuer
156 </tag-desc>
157
158 <tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name>
159 <tag-desc>
160 JWT ID
161 </tag-desc>
162
163 <tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name>
164 <tag-desc>
165 not-before
166 </tag-desc>
167
168 <tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name>
169 <tag-desc>
170 subject
171 </tag-desc>
172 </list>
173 </para>
174
175 <para>
176 Variables that return parameters of
177 <link url="https://tools.ietf.org/html/rfc7515#section-4">JOSE header</link>:
178
179 <list type="tag" compact="yes">
180 <tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name>
181 <tag-desc>
182 algorithm
183 </tag-desc>
184
185 <tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name>
186 <tag-desc>
187 content type
188 </tag-desc>
189
190 <tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name>
191 <tag-desc>
192 encryption algorithm
193 </tag-desc>
194
195 <tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name>
196 <tag-desc>
197 key ID
198 </tag-desc>
199
200 <tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name>
201 <tag-desc>
202 type
203 </tag-desc> 168 </tag-desc>
204 169
205 </list> 170 </list>
206 </para> 171 </para>
207 172