# HG changeset patch # User Yaroslav Zhuravlev # Date 1666179235 -3600 # Node ID 44f3b52c0679f531d3532c4df411bd10205f813c # Parent 843bf979dcaabc2955ab31a838b8f6fdd5a489fd Documented the $proxy_protocol_tlv_ variable. diff -r 843bf979dcaa -r 44f3b52c0679 xml/en/docs/http/ngx_http_core_module.xml --- a/xml/en/docs/http/ngx_http_core_module.xml Fri Oct 21 12:20:28 2022 +0100 +++ b/xml/en/docs/http/ngx_http_core_module.xml Wed Oct 19 12:33:55 2022 +0100 @@ -10,7 +10,7 @@ + rev="101">
@@ -3228,6 +3228,111 @@ +$proxy_protocol_tlv_name + +TLV from the PROXY Protocol header (1.23.2). +The name can be a TLV type name or its numeric value. +In the latter case, the value is hexadecimal +and should be prefixed with 0x: + + +$proxy_protocol_tlv_alpn +$proxy_protocol_tlv_0x01 + +SSL TLVs can also be accessed by TLV type name +or its numeric value, +both prefixed by ssl_: + +$proxy_protocol_tlv_ssl_version +$proxy_protocol_tlv_ssl_0x21 + + + +The following TLV type names are supported: + + + +alpn (0x01)— +upper layer protocol used over the connection + + + +authority (0x02)— +host name value passed by the client + + + +unique_id (0x05)— +unique connection id + + + +netns (0x30)— +name of the namespace + + + +ssl (0x20)— +binary SSL TLV structure + + + + + + +The following SSL TLV type names are supported: + + + +ssl_version (0x21)— +SSL version used in client connection + + + +ssl_cn (0x22)— +SSL certificate Common Name + + + +ssl_cipher (0x23)— +name of the used cipher + + + +ssl_sig_alg (0x24)— +algorithm used to sign the certificate + + + +ssl_key_alg (0x25)— +public-key algorithm + + + + + + +Also, the following special SSL TLV type name is supported: + + + +ssl_verify— +client SSL certificate verification result, +0 if the client presented a certificate +and it was successfully verified, +non-zero otherwise. + + + + + + +The PROXY protocol must be previously enabled by setting the +proxy_protocol parameter +in the directive. + + + $query_string same as $args diff -r 843bf979dcaa -r 44f3b52c0679 xml/en/docs/stream/ngx_stream_core_module.xml --- a/xml/en/docs/stream/ngx_stream_core_module.xml Fri Oct 21 12:20:28 2022 +0100 +++ b/xml/en/docs/stream/ngx_stream_core_module.xml Wed Oct 19 12:33:55 2022 +0100 @@ -9,7 +9,7 @@ + rev="36">
@@ -587,6 +587,109 @@ +$proxy_protocol_tlv_name + +TLV from the PROXY Protocol header (1.23.2). +The name can be a TLV type name or its numeric value. +In the latter case, the value is hexadecimal +and should be prefixed with 0x: + + +$proxy_protocol_tlv_alpn +$proxy_protocol_tlv_0x01 + +SSL TLVs can also be accessed by TLV type name or its numeric value, +both prefixed by ssl_: + +$proxy_protocol_tlv_ssl_version +$proxy_protocol_tlv_ssl_0x21 + + + +The following TLV type names are supported: + + + +alpn (0x01)— +upper layer protocol used over the connection + + + +authority (0x02)— +host name value passed by the client + + + +unique_id (0x05)— +unique connection id + + + +netns (0x30)— +name of the namespace + + + +ssl (0x20)— +binary SSL TLV structure + + + + + + +The following SSL TLV type names are supported: + + + +ssl_version (0x21)— +SSL version used in client connection + + + +ssl_cn (0x22)— +SSL certificate Common Name + + + +ssl_cipher (0x23)— +name of the used cipher + + + +ssl_sig_alg (0x24)— +algorithm used to sign the certificate + + + +ssl_key_alg (0x25)— +public-key algorithm + + + + + + +Also, the following special SSL TLV type name is supported: + + + +ssl_verify— +client SSL certificate verification result, +zero if the client presented a certificate +and it was successfully verified, and non-zero otherwise + + + + + + +The PROXY protocol must be previously enabled by setting the +proxy_protocol parameter +in the directive. + + + $remote_addr client address diff -r 843bf979dcaa -r 44f3b52c0679 xml/ru/docs/http/ngx_http_core_module.xml --- a/xml/ru/docs/http/ngx_http_core_module.xml Fri Oct 21 12:20:28 2022 +0100 +++ b/xml/ru/docs/http/ngx_http_core_module.xml Wed Oct 19 12:33:55 2022 +0100 @@ -10,7 +10,7 @@ + rev="101">
@@ -3221,6 +3221,110 @@ +$proxy_protocol_tlv_имя + +TLV, полученный из заголовка протокола PROXY (1.23.2). +Имя может быть именем типа TLV или его числовым значением. +В последнем случае значение задаётся в шестнадцатеричном виде +и должно начинаться с 0x: + + +$proxy_protocol_tlv_alpn +$proxy_protocol_tlv_0x01 + +SSL TLV могут также быть доступны как по имени типа TLV, +так и по его числовому значению, +оба должны начинаться с ssl_: + +$proxy_protocol_tlv_ssl_version +$proxy_protocol_tlv_ssl_0x21 + + + +Поддерживаются следующие имена типов TLV: + + + +alpn (0x01)— +протокол более высокого уровня, используемый поверх соединения + + + +authority (0x02)— +значение имени хоста, передаваемое клиентом + + + +unique_id (0x05)— +уникальный идентификатор соединения + + + +netns (0x30)— +имя пространства имён + + + +ssl (0x20)— +структура SSL TLV в бинарном виде + + + + + + +Поддерживаются следующие имена типов SSL TLV: + + + +ssl_version (0x21)— +версия SSL, используемая в клиентском соединении + + + +ssl_cn (0x22)— +Common Name сертификата + + + +ssl_cipher (0x23)— +имя используемого шифра + + + +ssl_sig_alg (0x24)— +алгоритм, используемый для подписи сертификата + + + +ssl_key_alg (0x25)— +алгоритм публичного ключа + + + + + + +Также поддерживается следующее специальное имя типа SSL TLV: + + + +ssl_verify— +результат проверки клиентского сертификата: +0, если клиент предоставил сертификат +и он был успешно верифицирован, +либо ненулевое значение + + + + + + +Протокол PROXY должен быть предварительно включён при помощи установки +параметра proxy_protocol в директиве . + + + $query_string то же, что и $args diff -r 843bf979dcaa -r 44f3b52c0679 xml/ru/docs/stream/ngx_stream_core_module.xml --- a/xml/ru/docs/stream/ngx_stream_core_module.xml Fri Oct 21 12:20:28 2022 +0100 +++ b/xml/ru/docs/stream/ngx_stream_core_module.xml Wed Oct 19 12:33:55 2022 +0100 @@ -9,7 +9,7 @@ + rev="36">
@@ -591,6 +591,110 @@ +$proxy_protocol_tlv_имя + +TLV, полученный из заголовка протокола PROXY (1.23.2). +Имя может быть именем типа TLV или его числовым значением. +В последнем случае значение задаётся в шестнадцатеричном виде +и должно начинаться с 0x: + + +$proxy_protocol_tlv_alpn +$proxy_protocol_tlv_0x01 + +SSL TLV могут также быть доступны как по имени типа TLV, +так и по его числовому значению, +оба должны начинаться с ssl_: + +$proxy_protocol_tlv_ssl_version +$proxy_protocol_tlv_ssl_0x21 + + + +Поддерживаются следующие имена типов TLV: + + + +alpn (0x01)— +протокол более высокого уровня, используемый поверх соединения + + + +authority (0x02)— +значение имени хоста, передаваемое клиентом + + + +unique_id (0x05)— +уникальный идентификатор соединения + + + +netns (0x30)— +имя пространства имён + + + +ssl (0x20)— +структура SSL TLV в бинарном виде + + + + + + +Поддерживаются следующие имена типов SSL TLV: + + + +ssl_version (0x21)— +версия SSL, используемая в клиентском соединении + + + +ssl_cn (0x22)— +Common Name сертификата + + + +ssl_cipher (0x23)— +имя используемого шифра + + + +ssl_sig_alg (0x24)— +алгоритм, используемый для подписи сертификата + + + +ssl_key_alg (0x25)— +алгоритм публичного ключа + + + + + + +Также поддерживается следующее специальное имя типа SSL TLV: + + + +ssl_verify— +результат проверки клиентского сертификата: +0, если клиент предоставил сертификат +и он был успешно верифицирован, +либо ненулевое значение + + + + + + +Протокол PROXY должен быть предварительно включён при помощи установки +параметра proxy_protocol в директиве . + + + $remote_addr адрес клиента