Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_auth_jwt_module.xml @ 1832:c30d3557ec68

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Translated the JWT module into Russian.
author Yaroslav Zhuravlev <yar@nginx.com>
date Tue, 25 Oct 2016 15:01:47 +0300
parents xml/en/docs/http/ngx_http_auth_jwt_module.xml@b5e416ace4bf
children a58b35cc0823
comparison
equal deleted inserted replaced
1831:b5e416ace4bf 1832:c30d3557ec68
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Nginx, Inc.
5 -->
6
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8
9 <module name="Модуль ngx_http_auth_jwt_module"
10 link="/ru/docs/http/ngx_http_auth_jwt_module.html"
11 lang="ru"
12 rev="2">
13
14 <section id="summary">
15
16 <para>
17 Модуль <literal>ngx_http_auth_jwt_module</literal> (1.11.3)
18 предоставляет возможность авторизации клиента с проверкой предоставляемого
19 <link url="https://tools.ietf.org/html/rfc7519">JSON Web Token</link> (JWT)
20 при помощи указанных ключей.
21 JWT claims должны быть зашифрованы в структуре
22 <link url="https://tools.ietf.org/html/rfc7515">JSON Web Signature</link> (JWS).
23 Модуль может использоваться для настройки аутентификации
24 <link url="http://openid.net/specs/openid-connect-core-1_0.html">OpenID Connect</link>.
25 </para>
26
27 <para>
28 Модуль может быть скомбинирован с
29 другими модулями доступа, такими как
30 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>,
31 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>
32 и
33 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link>
34 с помощью директивы <link doc="ngx_http_core_module.xml" id="satisfy"/>.
35 </para>
36
37 <para>
38 <note>
39 Модуль доступен как часть
40 <commercial_version>коммерческой подписки</commercial_version>.
41 </note>
42 </para>
43
44 </section>
45
46
47 <section id="example" name="Пример конфигурации">
48
49 <para>
50 <example>
51 location / {
52 auth_jwt "closed site";
53 auth_jwt_key_file conf/keys.json;
54 }
55 </example>
56 </para>
57
58 </section>
59
60
61 <section id="directives" name="Директивы">
62
63 <directive name="auth_jwt">
64 <syntax>
65 <value>строка</value>
66 [<literal>token=</literal><value>$переменная</value>] |
67 <literal>off</literal></syntax>
68 <default>off</default>
69 <context>http</context>
70 <context>server</context>
71 <context>location</context>
72
73 <para>
74 Включает проверку JSON Web Token.
75 Заданная <value>строка</value> используется в качестве <literal>realm</literal>.
76 В значении параметра допустимо использование переменных.
77 </para>
78
79 <para>
80 Необязательный параметр <literal>token</literal> задаёт переменную,
81 содержащую JSON Web Token.
82 По умолчанию JWT передаётся в заголовке <header>Authorization</header>
83 в качестве
84 <link url="https://tools.ietf.org/html/rfc6750">Bearer Token</link>.
85 JWT может также передаваться как кука или часть строки запроса:
86 <example>
87 auth_jwt "closed site" token=$cookie_auth_token;
88 </example>
89 </para>
90
91 <para>
92 Специальное значение <literal>off</literal> отменяет действие
93 унаследованной с предыдущего уровня конфигурации
94 директивы <literal>auth_jwt</literal>.
95 </para>
96
97 </directive>
98
99
100 <directive name="auth_jwt_key_file">
101 <syntax><value>файл</value></syntax>
102 <default/>
103 <context>http</context>
104 <context>server</context>
105 <context>location</context>
106
107 <para>
108 Задаёт <value>файл</value> в формате
109 <link url="https://tools.ietf.org/html/rfc7517#section-5">JSON Web Key Set</link>
110 для проверки подписи JWT.
111 В значении параметра допустимо использование переменных.
112 </para>
113
114 </directive>
115
116 </section>
117
118
119 <section id="variables" name="Встроенные переменные">
120
121 <para>
122 Модуль <literal>ngx_http_auth_jwt_module</literal>
123 поддерживает встроенные переменные.
124 </para>
125
126 <para>
127 Переменные, возвращающие
128 <link url="https://tools.ietf.org/html/rfc7519#section-4">JWT claims</link>:
129
130 <list type="tag" compact="yes">
131 <tag-name id="var_jwt_claim_aud"><var>$jwt_claim_aud</var></tag-name>
132 <tag-desc>
133 audience (аудитория)
134 </tag-desc>
135
136 <tag-name id="var_jwt_claim_email"><var>$jwt_claim_email</var></tag-name>
137 <tag-desc>
138 email
139 </tag-desc>
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>
202
203 </list>
204 </para>
205
206 </section>
207
208 </module>