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

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="Модуль 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="3"> 12 rev="4">
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)
30 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link>, 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> 31 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>
32 и 32 и
33 <link doc="ngx_http_auth_request_module.xml">ngx_http_auth_request_module</link> 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"/>. 34 с помощью директивы <link doc="ngx_http_core_module.xml" id="satisfy"/>.
35 </para>
36
37 <para>
38 Модуль поддерживает следующие криптографические
39 <link url="https://tools.ietf.org/html/rfc7518#section-3.1">алгоритмы</link>:
40
41 <list type="bullet">
42
43 <listitem>
44 HS256, HS384, HS512
45 </listitem>
46
47 <listitem>
48 RS256, RS384, RS512
49 </listitem>
50
51 <listitem>
52 ES256, ES384, ES512
53 </listitem>
54
55 </list>
56
57 До версии 1.13.7
58 поддерживались только алгоритмы HS256, RS256 и RS256.
35 </para> 59 </para>
36 60
37 <para> 61 <para>
38 <note> 62 <note>
39 Модуль доступен как часть 63 Модуль доступен как часть
96 120
97 </directive> 121 </directive>
98 122
99 123
100 <directive name="auth_jwt_header_set"> 124 <directive name="auth_jwt_header_set">
101 <syntax><value>$переменная</value> <value>имя</value></syntax> 125 <syntax><value>$переменная</value> <value>имя</value> ...</syntax>
102 <default/> 126 <default/>
103 <context>http</context> 127 <context>http</context>
104 <appeared-in>1.11.10</appeared-in> 128 <appeared-in>1.11.10</appeared-in>
105 129
106 <para> 130 <para>
107 Устанавливает <value>переменную</value> в заданное 131 Устанавливает <value>переменную</value> в параметр заголовка JOSE,
108 <value>имя</value> параметра заголовка JOSE. 132 определяемый именами ключей.
133 Сопоставление имён начинается с верхнего уровня дерева JSON.
134 Для массива переменная хранит список его элементов, разделяемых запятыми.
135 <note>
136 До версии 1.13.7 можно было указать лишь одно имя,
137 результат для массивов был не определён.
138 </note>
109 </para> 139 </para>
110 140
111 </directive> 141 </directive>
112 142
113 143
114 <directive name="auth_jwt_claim_set"> 144 <directive name="auth_jwt_claim_set">
115 <syntax><value>$переменная</value> <value>имя</value></syntax> 145 <syntax><value>$переменная</value> <value>имя</value> ...</syntax>
116 <default/> 146 <default/>
117 <context>http</context> 147 <context>http</context>
118 <appeared-in>1.11.10</appeared-in> 148 <appeared-in>1.11.10</appeared-in>
119 149
120 <para> 150 <para>
121 Устанавливает <value>переменную</value> в заданное 151 Устанавливает <value>переменную</value> в параметр JWT claim,
122 <value>имя</value> параметра JWT claim. 152 определяемый именами ключей.
153 Сопоставление имён начинается с верхнего уровня дерева JSON.
154 Для массива переменная хранит список его элементов, разделяемых запятыми.
155 <example>
156 location / {
157 auth_jwt "closed site";
158 auth_jwt_key_file conf/keys.json;
159 auth_jwt_claim_set $email info e-mail;
160 auth_jwt_claim_set $job info "job title";
161 }
162 </example>
163 <note>
164 До версии 1.13.7 можно было указать лишь одно имя,
165 результат для массивов был не определён.
166 </note>
123 </para> 167 </para>
124 168
125 </directive> 169 </directive>
126 170
127 171