Mercurial > hg > nginx-site

comparison xml/ru/docs/stream/ngx_stream_core_module.xml @ 2903:44f3b52c0679

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
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
7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 7 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
8 8
9 <module name="Модуль ngx_stream_core_module" 9 <module name="Модуль ngx_stream_core_module"
10 link="/ru/docs/stream/ngx_stream_core_module.html" 10 link="/ru/docs/stream/ngx_stream_core_module.html"
11 lang="ru" 11 lang="ru"
12 rev="35"> 12 rev="36">
13 13
14 <section id="summary"> 14 <section id="summary">
15 15
16 <para> 16 <para>
17 Модуль <literal>ngx_stream_core_module</literal> 17 Модуль <literal>ngx_stream_core_module</literal>
589 Протокол PROXY должен быть предварительно включён при помощи установки 589 Протокол PROXY должен быть предварительно включён при помощи установки
590 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>. 590 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
591 </para> 591 </para>
592 </tag-desc> 592 </tag-desc>
593 593
594 <tag-name id="var_proxy_protocol_tlv_"><var>$proxy_protocol_tlv_</var><value>имя</value></tag-name>
595 <tag-desc>
596 TLV, полученный из заголовка протокола PROXY (1.23.2).
597 <literal>Имя</literal> может быть именем типа TLV или его числовым значением.
598 В последнем случае значение задаётся в шестнадцатеричном виде
599 и должно начинаться с <literal>0x</literal>:
600
601 <example>
602 $proxy_protocol_tlv_alpn
603 $proxy_protocol_tlv_0x01
604 </example>
605 SSL TLV могут также быть доступны как по имени типа TLV,
606 так и по его числовому значению,
607 оба должны начинаться с <literal>ssl_</literal>:
608 <example>
609 $proxy_protocol_tlv_ssl_version
610 $proxy_protocol_tlv_ssl_0x21
611 </example>
612
613 <para>
614 Поддерживаются следующие имена типов TLV:
615 <list type="bullet">
616
617 <listitem>
618 <literal>alpn</literal> (<literal>0x01</literal>)&mdash;
619 протокол более высокого уровня, используемый поверх соединения
620 </listitem>
621
622 <listitem>
623 <literal>authority</literal> (<literal>0x02</literal>)&mdash;
624 значение имени хоста, передаваемое клиентом
625 </listitem>
626
627 <listitem>
628 <literal>unique_id</literal> (<literal>0x05</literal>)&mdash;
629 уникальный идентификатор соединения
630 </listitem>
631
632 <listitem>
633 <literal>netns</literal> (<literal>0x30</literal>)&mdash;
634 имя пространства имён
635 </listitem>
636
637 <listitem>
638 <literal>ssl</literal> (<literal>0x20</literal>)&mdash;
639 структура SSL TLV в бинарном виде
640 </listitem>
641
642 </list>
643 </para>
644
645 <para>
646 Поддерживаются следующие имена типов SSL TLV:
647 <list type="bullet">
648
649 <listitem>
650 <literal>ssl_version</literal> (<literal>0x21</literal>)&mdash;
651 версия SSL, используемая в клиентском соединении
652 </listitem>
653
654 <listitem>
655 <literal>ssl_cn</literal> (<literal>0x22</literal>)&mdash;
656 Common Name сертификата
657 </listitem>
658
659 <listitem>
660 <literal>ssl_cipher</literal> (<literal>0x23</literal>)&mdash;
661 имя используемого шифра
662 </listitem>
663
664 <listitem>
665 <literal>ssl_sig_alg</literal> (<literal>0x24</literal>)&mdash;
666 алгоритм, используемый для подписи сертификата
667 </listitem>
668
669 <listitem>
670 <literal>ssl_key_alg</literal> (<literal>0x25</literal>)&mdash;
671 алгоритм публичного ключа
672 </listitem>
673
674 </list>
675 </para>
676
677 <para>
678 Также поддерживается следующее специальное имя типа SSL TLV:
679 <list type="bullet">
680
681 <listitem>
682 <literal>ssl_verify</literal>&mdash;
683 результат проверки клиентского сертификата:
684 <literal>0</literal>, если клиент предоставил сертификат
685 и он был успешно верифицирован,
686 либо ненулевое значение
687 </listitem>
688
689 </list>
690 </para>
691
692 <para>
693 Протокол PROXY должен быть предварительно включён при помощи установки
694 параметра <literal>proxy_protocol</literal> в директиве <link id="listen"/>.
695 </para>
696 </tag-desc>
697
594 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name> 698 <tag-name id="var_remote_addr"><var>$remote_addr</var></tag-name>
595 <tag-desc> 699 <tag-desc>
596 адрес клиента 700 адрес клиента
597 </tag-desc> 701 </tag-desc>
598 702