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

Updated docs for the upcoming NGINX Plus release.
author Ruslan Ermilov <ru@nginx.com>
date Wed, 08 Mar 2017 18:05:46 +0300
parents c30d3557ec68
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="Модуль ngx_http_auth_jwt_module" 9 <module name="Модуль ngx_http_auth_jwt_module"
10 link="/ru/docs/http/ngx_http_auth_jwt_module.html" 10 link="/ru/docs/http/ngx_http_auth_jwt_module.html"
11 lang="ru" 11 lang="ru"
12 rev="2"> 12 rev="3">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 Модуль <literal>ngx_http_auth_jwt_module</literal> (1.11.3) 17 Модуль <literal>ngx_http_auth_jwt_module</literal> (1.11.3)
95 </para> 95 </para>
96 96
97 </directive> 97 </directive>
98 98
99 99
100 <directive name="auth_jwt_header_set">
101 <syntax><value>$переменная</value> <value>имя</value></syntax>
102 <default/>
103 <context>http</context>
104 <appeared-in>1.11.10</appeared-in>
105
106 <para>
107 Устанавливает <value>переменную</value> в заданное
108 <value>имя</value> параметра заголовка JOSE.
109 </para>
110
111 </directive>
112
113
114 <directive name="auth_jwt_claim_set">
115 <syntax><value>$переменная</value> <value>имя</value></syntax>
116 <default/>
117 <context>http</context>
118 <appeared-in>1.11.10</appeared-in>
119
120 <para>
121 Устанавливает <value>переменную</value> в заданное
122 <value>имя</value> параметра JWT claim.
123 </para>
124
125 </directive>
126
127
100 <directive name="auth_jwt_key_file"> 128 <directive name="auth_jwt_key_file">
101 <syntax><value>файл</value></syntax> 129 <syntax><value>файл</value></syntax>
102 <default/> 130 <default/>
103 <context>http</context> 131 <context>http</context>
104 <context>server</context> 132 <context>server</context>
118 146
119 <section id="variables" name="Встроенные переменные"> 147 <section id="variables" name="Встроенные переменные">
120 148
121 <para> 149 <para>
122 Модуль <literal>ngx_http_auth_jwt_module</literal> 150 Модуль <literal>ngx_http_auth_jwt_module</literal>
123 поддерживает встроенные переменные. 151 поддерживает встроенные переменные:
124 </para> 152 </para>
125 153
126 <para> 154 <para>
127 Переменные, возвращающие
128 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>:
129
130 <list type="tag" compact="yes"> 155 <list type="tag" compact="yes">
131 <tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name> 156 <tag-name id="var_jwt_header_"><var>$jwt_header_</var><value>имя</value></tag-name>
132 <tag-desc> 157 <tag-desc>
133 audience (аудитория) 158 возвращает значение указанного
159 <link url="https://tools.ietf.org/html/rfc7515#section-4">заголовка JOSE</link>
134 </tag-desc> 160 </tag-desc>
135 161
136 <tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name> 162 <tag-name id="var_jwt_claim_"><var>$jwt_claim_</var><value>имя</value></tag-name>
137 <tag-desc> 163 <tag-desc>
138 email 164 возвращает значение указанной
139 </tag-desc> 165 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claim</link>
140
141 <tag-name id="var_jwt_claim_exp"><var>$jwt_claim_exp</var></tag-name>
142 <tag-desc>
143 expiration time (время окончания действия)
144 </tag-desc>
145
146 <tag-name id="var_jwt_claim_iat"><var>$jwt_claim_iat</var></tag-name>
147 <tag-desc>
148 issued at (когда выдан)
149 </tag-desc>
150
151 <tag-name id="var_jwt_claim_iss"><var>$jwt_claim_iss</var></tag-name>
152 <tag-desc>
153 issuer (издатель)
154 </tag-desc>
155
156 <tag-name id="var_jwt_claim_jti"><var>$jwt_claim_jti</var></tag-name>
157 <tag-desc>
158 JWT ID (идентификатор JWT)
159 </tag-desc>
160
161 <tag-name id="var_jwt_claim_nbf"><var>$jwt_claim_nbf</var></tag-name>
162 <tag-desc>
163 not-before (не ранее, чем)
164 </tag-desc>
165
166 <tag-name id="var_jwt_claim_sub"><var>$jwt_claim_sub</var></tag-name>
167 <tag-desc>
168 subject (субъект)
169 </tag-desc>
170 </list>
171 </para>
172
173 <para>
174 Переменные, возвращающие параметры
175 <link url="https://tools.ietf.org/html/rfc7515#section-4">заголовка JOSE</link>:
176
177 <list type="tag" compact="yes">
178 <tag-name id="var_jwt_header_alg"><var>$jwt_header_alg</var></tag-name>
179 <tag-desc>
180 algorithm (алгоритм)
181 </tag-desc>
182
183 <tag-name id="var_jwt_header_cty"><var>$jwt_header_cty</var></tag-name>
184 <tag-desc>
185 content type (тип содержимого)
186 </tag-desc>
187
188 <tag-name id="var_jwt_header_enc"><var>$jwt_header_enc</var></tag-name>
189 <tag-desc>
190 encryption algorithm (алгоритм шифрования)
191 </tag-desc>
192
193 <tag-name id="var_jwt_header_kid"><var>$jwt_header_kid</var></tag-name>
194 <tag-desc>
195 key ID (идентификатор ключа)
196 </tag-desc>
197
198 <tag-name id="var_jwt_header_typ"><var>$jwt_header_typ</var></tag-name>
199 <tag-desc>
200 type (тип)
201 </tag-desc> 166 </tag-desc>
202 167
203 </list> 168 </list>
204 </para> 169 </para>
205 170