comparison xml/ru/docs/http/ngx_http_core_module.xml @ 2903:44f3b52c0679

Documented the $proxy_protocol_tlv_ variable.
author Yaroslav Zhuravlev <yar@nginx.com>
date Wed, 19 Oct 2022 12:33:55 +0100
parents e06cf66a9f63
children 7ebe15d6c68d
comparison
equal deleted inserted replaced
2902:843bf979dcaa 2903:44f3b52c0679
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Модуль ngx_http_core_module" 10 <module name="Модуль ngx_http_core_module"
11 link="/ru/docs/http/ngx_http_core_module.html" 11 link="/ru/docs/http/ngx_http_core_module.html"
12 lang="ru" 12 lang="ru"
13 rev="100"> 13 rev="101">
14 14
15 <section id="directives" name="Директивы"> 15 <section id="directives" name="Директивы">
16 16
17 <directive name="absolute_redirect"> 17 <directive name="absolute_redirect">
18 <syntax><literal>on</literal> | <literal>off</literal></syntax> 18 <syntax><literal>on</literal> | <literal>off</literal></syntax>
3219 Протокол PROXY должен быть предварительно включён при помощи установки 3219 Протокол PROXY должен быть предварительно включён при помощи установки
3220 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>. 3220 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
3221 </para> 3221 </para>
3222 </tag-desc> 3222 </tag-desc>
3223 3223
3224 <tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>имя</value></tag-name>
3225 <tag-desc>
3226 TLV, полученный из заголовка протокола PROXY (1.23.2).
3227 <literal>Имя</literal> может быть именем типа TLV или его числовым значением.
3228 В последнем случае значение задаётся в шестнадцатеричном виде
3229 и должно начинаться с <literal>0x</literal>:
3230
3231 <example>
3232 $proxy_protocol_tlv_alpn
3233 $proxy_protocol_tlv_0x01
3234 </example>
3235 SSL TLV могут также быть доступны как по имени типа TLV,
3236 так и по его числовому значению,
3237 оба должны начинаться с <literal>ssl_</literal>:
3238 <example>
3239 $proxy_protocol_tlv_ssl_version
3240 $proxy_protocol_tlv_ssl_0x21
3241 </example>
3242
3243 <para>
3244 Поддерживаются следующие имена типов TLV:
3245 <list type="bullet">
3246
3247 <listitem>
3248 <literal>alpn</literal> (<literal>0x01</literal>)&mdash;
3249 протокол более высокого уровня, используемый поверх соединения
3250 </listitem>
3251
3252 <listitem>
3253 <literal>authority</literal> (<literal>0x02</literal>)&mdash;
3254 значение имени хоста, передаваемое клиентом
3255 </listitem>
3256
3257 <listitem>
3258 <literal>unique_id</literal> (<literal>0x05</literal>)&mdash;
3259 уникальный идентификатор соединения
3260 </listitem>
3261
3262 <listitem>
3263 <literal>netns</literal> (<literal>0x30</literal>)&mdash;
3264 имя пространства имён
3265 </listitem>
3266
3267 <listitem>
3268 <literal>ssl</literal> (<literal>0x20</literal>)&mdash;
3269 структура SSL TLV в бинарном виде
3270 </listitem>
3271
3272 </list>
3273 </para>
3274
3275 <para>
3276 Поддерживаются следующие имена типов SSL TLV:
3277 <list type="bullet">
3278
3279 <listitem>
3280 <literal>ssl_version</literal> (<literal>0x21</literal>)&mdash;
3281 версия SSL, используемая в клиентском соединении
3282 </listitem>
3283
3284 <listitem>
3285 <literal>ssl_cn</literal> (<literal>0x22</literal>)&mdash;
3286 Common Name сертификата
3287 </listitem>
3288
3289 <listitem>
3290 <literal>ssl_cipher</literal> (<literal>0x23</literal>)&mdash;
3291 имя используемого шифра
3292 </listitem>
3293
3294 <listitem>
3295 <literal>ssl_sig_alg</literal> (<literal>0x24</literal>)&mdash;
3296 алгоритм, используемый для подписи сертификата
3297 </listitem>
3298
3299 <listitem>
3300 <literal>ssl_key_alg</literal> (<literal>0x25</literal>)&mdash;
3301 алгоритм публичного ключа
3302 </listitem>
3303
3304 </list>
3305 </para>
3306
3307 <para>
3308 Также поддерживается следующее специальное имя типа SSL TLV:
3309 <list type="bullet">
3310
3311 <listitem>
3312 <literal>ssl_verify</literal>&mdash;
3313 результат проверки клиентского сертификата:
3314 <literal>0</literal>, если клиент предоставил сертификат
3315 и он был успешно верифицирован,
3316 либо ненулевое значение
3317 </listitem>
3318
3319 </list>
3320 </para>
3321
3322 <para>
3323 Протокол PROXY должен быть предварительно включён при помощи установки
3324 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
3325 </para>
3326 </tag-desc>
3327
3224 <tag-name id="var_query_string"><var>$query_string</var></tag-name> 3328 <tag-name id="var_query_string"><var>$query_string</var></tag-name>
3225 <tag-desc> 3329 <tag-desc>
3226 то же, что и <var>$args</var> 3330 то же, что и <var>$args</var>
3227 </tag-desc> 3331 </tag-desc>
3228 3332