Mercurial > hg > nginx-site
diff xml/ru/docs/stream/ngx_stream_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 |
line wrap: on
line diff
--- a/xml/ru/docs/stream/ngx_stream_core_module.xml +++ b/xml/ru/docs/stream/ngx_stream_core_module.xml @@ -9,7 +9,7 @@ <module name="Модуль ngx_stream_core_module" link="/ru/docs/stream/ngx_stream_core_module.html" lang="ru" - rev="35"> + rev="36"> <section id="summary"> @@ -591,6 +591,110 @@ resolver_timeout 5s; </para> </tag-desc> +<tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>имя</value></tag-name> +<tag-desc> +TLV, полученный из заголовка протокола PROXY (1.23.2). +<literal>Имя</literal> может быть именем типа TLV или его числовым значением. +В последнем случае значение задаётся в шестнадцатеричном виде +и должно начинаться с <literal>0x</literal>: + +<example> +$proxy_protocol_tlv_alpn +$proxy_protocol_tlv_0x01 +</example> +SSL TLV могут также быть доступны как по имени типа TLV, +так и по его числовому значению, +оба должны начинаться с <literal>ssl_</literal>: +<example> +$proxy_protocol_tlv_ssl_version +$proxy_protocol_tlv_ssl_0x21 +</example> + +<para> +Поддерживаются следующие имена типов TLV: +<list type="bullet"> + +<listitem> +<literal>alpn</literal> (<literal>0x01</literal>)— +протокол более высокого уровня, используемый поверх соединения +</listitem> + +<listitem> +<literal>authority</literal> (<literal>0x02</literal>)— +значение имени хоста, передаваемое клиентом +</listitem> + +<listitem> +<literal>unique_id</literal> (<literal>0x05</literal>)— +уникальный идентификатор соединения +</listitem> + +<listitem> +<literal>netns</literal> (<literal>0x30</literal>)— +имя пространства имён +</listitem> + +<listitem> +<literal>ssl</literal> (<literal>0x20</literal>)— +структура SSL TLV в бинарном виде +</listitem> + +</list> +</para> + +<para> +Поддерживаются следующие имена типов SSL TLV: +<list type="bullet"> + +<listitem> +<literal>ssl_version</literal> (<literal>0x21</literal>)— +версия SSL, используемая в клиентском соединении +</listitem> + +<listitem> +<literal>ssl_cn</literal> (<literal>0x22</literal>)— +Common Name сертификата +</listitem> + +<listitem> +<literal>ssl_cipher</literal> (<literal>0x23</literal>)— +имя используемого шифра +</listitem> + +<listitem> +<literal>ssl_sig_alg</literal> (<literal>0x24</literal>)— +алгоритм, используемый для подписи сертификата +</listitem> + +<listitem> +<literal>ssl_key_alg</literal> (<literal>0x25</literal>)— +алгоритм публичного ключа +</listitem> + +</list> +</para> + +<para> +Также поддерживается следующее специальное имя типа SSL TLV: +<list type="bullet"> + +<listitem> +<literal>ssl_verify</literal>— +результат проверки клиентского сертификата: +<literal>0</literal>, если клиент предоставил сертификат +и он был успешно верифицирован, +либо ненулевое значение +</listitem> + +</list> +</para> + +<para> +Протокол PROXY должен быть предварительно включён при помощи установки +параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>. +</para> +</tag-desc> + <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name> <tag-desc> адрес клиента