Mercurial > hg > nginx-site
view xml/ru/docs/stream/ngx_stream_ssl_module.xml @ 2583:cd97adddd757
Documented Query String in njs Reference.
author | Yaroslav Zhuravlev <yar@nginx.com> |
---|---|
date | Tue, 11 Aug 2020 12:35:32 +0100 |
parents | c60a8a15010c |
children | d8bf37d20449 |
line wrap: on
line source
<?xml version="1.0"?> <!-- Copyright (C) Nginx, Inc. --> <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> <module name="Модуль ngx_stream_ssl_module" link="/ru/docs/stream/ngx_stream_ssl_module.html" lang="ru" rev="22"> <section id="summary"> <para> Модуль <literal>ngx_stream_ssl_module</literal> (1.9.0) обеспечивает необходимую поддержку для работы прокси-сервера по протоколу SSL/TLS. По умолчанию этот модуль не собирается, его сборку необходимо разрешить с помощью конфигурационного параметра <literal>--with-stream_ssl_module</literal>. </para> </section> <section id="example" name="Пример конфигурации"> <para> Для уменьшения загрузки процессора рекомендуется <list type="bullet"> <listitem> установить число <link doc="../ngx_core_module.xml" id="worker_processes">рабочих процессов</link> равным числу процессоров, </listitem> <listitem> включить <link id="ssl_session_cache_shared">разделяемый</link> кэш сессий, </listitem> <listitem> выключить <link id="ssl_session_cache_builtin">встроенный</link> кэш сессий </listitem> <listitem> и, возможно, увеличить <link id="ssl_session_timeout">время жизни</link> сессии (по умолчанию 5 минут): </listitem> </list> <example> <emphasis>worker_processes auto;</emphasis> stream { ... server { listen 12345 ssl; ssl_protocols TLSv1 TLSv1.1 TLSv1.2; ssl_ciphers AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5; ssl_certificate /usr/local/nginx/conf/cert.pem; ssl_certificate_key /usr/local/nginx/conf/cert.key; <emphasis>ssl_session_cache shared:SSL:10m;</emphasis> <emphasis>ssl_session_timeout 10m;</emphasis> ... } </example> </para> </section> <section id="directives" name="Директивы"> <directive name="ssl_certificate"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <para> Указывает <value>файл</value> с сертификатом в формате PEM для данного сервера. Если вместе с основным сертификатом нужно указать промежуточные, то они должны находиться в этом же файле в следующем порядке — сначала основной сертификат, а затем промежуточные. В этом же файле может находиться секретный ключ в формате PEM. </para> <para> Начиная с версии 1.11.0 эта директива может быть указана несколько раз для загрузки сертификатов разных типов, например RSA и ECDSA: <example> server { listen 12345 ssl; ssl_certificate example.com.rsa.crt; ssl_certificate_key example.com.rsa.key; ssl_certificate example.com.ecdsa.crt; ssl_certificate_key example.com.ecdsa.key; ... } </example> <note> Возможность задавать отдельные цепочки сертификатов для разных сертификатов есть только в OpenSSL 1.0.2 и выше. Для более старых версий следует указывать только одну цепочку сертификатов. </note> </para> <para> Начиная с версии 1.15.9 в имени файла можно использовать переменные при использовании OpenSSL 1.0.2 и выше: <example> ssl_certificate $ssl_server_name.crt; ssl_certificate_key $ssl_server_name.key; </example> Однако нужно учитывать, что при использовании переменных сертификат загружается при каждой операции SSL handshake, что может отрицательно влиять на производительность. </para> <para id="ssl_certificate_data"> Вместо <value>файла</value> можно указать значение <literal>data</literal>:<value>$переменная</value> (1.15.10), при котором сертификат загружается из переменной без использования промежуточных файлов. При этом следует учитывать, что ненадлежащее использование подобного синтаксиса может быть небезопасно, например данные секретного ключа могут попасть в <link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>. </para> </directive> <directive name="ssl_certificate_key"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <para> Указывает <value>файл</value> с секретным ключом в формате PEM для данного сервера. </para> <para> Вместо <value>файла</value> можно указать значение <literal>engine</literal>:<value>имя</value>:<value>id</value>, которое загружает ключ с указанным <value>id</value> из OpenSSL engine с заданным <value>именем</value>. </para> <para id="ssl_certificate_key_data"> Вместо <value>файла</value> можно указать значение <literal>data</literal>:<value>$переменная</value> (1.15.10), при котором секретный ключ загружается из переменной без использования промежуточных файлов. При этом следует учитывать, что ненадлежащее использование подобного синтаксиса может быть небезопасно, например данные секретного ключа могут попасть в <link doc="../ngx_core_module.xml" id="error_log">лог ошибок</link>. </para> <para> Начиная с версии 1.15.9 в имени файла можно использовать переменные при использовании OpenSSL 1.0.2 и выше. </para> </directive> <directive name="ssl_ciphers"> <syntax><value>шифры</value></syntax> <default>HIGH:!aNULL:!MD5</default> <context>stream</context> <context>server</context> <para> Описывает разрешённые шифры. Шифры задаются в формате, поддерживаемом библиотекой OpenSSL, например: <example> ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP; </example> </para> <para> Полный список можно посмотреть с помощью команды “<command>openssl ciphers</command>”. </para> </directive> <directive name="ssl_client_certificate"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <appeared-in>1.11.8</appeared-in> <para> Указывает <value>файл</value> с доверенными сертификатами CA в формате PEM, которые используются для <link id="ssl_verify_client">проверки</link> клиентских сертификатов. </para> <para> Список сертификатов будет отправляться клиентам. Если это нежелательно, можно воспользоваться директивой <link id="ssl_trusted_certificate"/>. </para> </directive> <directive name="ssl_crl"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <appeared-in>1.11.8</appeared-in> <para> Указывает <value>файл</value> с отозванными сертификатами (CRL) в формате PEM, используемыми для <link id="ssl_verify_client">проверки</link> клиентских сертификатов. </para> </directive> <directive name="ssl_dhparam"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <para> Указывает <value>файл</value> с параметрами для DHE-шифров. </para> <para> По умолчанию параметры не заданы, и соответственно DHE-шифры не будут использоваться. <note> До версии 1.11.0 по умолчанию использовались встроенные параметры. </note> </para> </directive> <directive name="ssl_ecdh_curve"> <syntax><value>кривая</value></syntax> <default>auto</default> <context>stream</context> <context>server</context> <para> Задаёт <value>кривую</value> для ECDHE-шифров. </para> <para> При использовании OpenSSL 1.0.2 и выше можно указывать несколько кривых (1.11.0), например: <example> ssl_ecdh_curve prime256v1:secp384r1; </example> </para> <para> Специальное значение <literal>auto</literal> (1.11.0) соответствует встроенному в библиотеку OpenSSL списку кривых для OpenSSL 1.0.2 и выше, или <literal>prime256v1</literal> для более старых версий. </para> <para> <note> До версии 1.11.0 по умолчанию использовалась кривая <literal>prime256v1</literal>. </note> </para> </directive> <directive name="ssl_handshake_timeout"> <syntax><value>время</value></syntax> <default>60s</default> <context>stream</context> <context>server</context> <para> Задаёт таймаут для завершения операции SSL handshake. </para> </directive> <directive name="ssl_password_file"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <para> Задаёт <value>файл</value> с паролями от <link id="ssl_certificate_key">секретных ключей</link>, где каждый пароль указан на отдельной строке. Пароли применяются по очереди в момент загрузки ключа. </para> <para> Пример: <example> stream { ssl_password_file /etc/keys/global.pass; ... server { listen 127.0.0.1:12345; ssl_certificate_key /etc/keys/first.key; } server { listen 127.0.0.1:12346; # вместо файла можно указать именованный канал ssl_password_file /etc/keys/fifo; ssl_certificate_key /etc/keys/second.key; } } </example> </para> </directive> <directive name="ssl_prefer_server_ciphers"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>off</default> <context>stream</context> <context>server</context> <para> Указывает, чтобы при использовании протоколов SSLv3 и TLS серверные шифры были более приоритетны, чем клиентские. </para> </directive> <directive name="ssl_protocols"> <syntax> [<literal>SSLv2</literal>] [<literal>SSLv3</literal>] [<literal>TLSv1</literal>] [<literal>TLSv1.1</literal>] [<literal>TLSv1.2</literal>] [<literal>TLSv1.3</literal>]</syntax> <default>TLSv1 TLSv1.1 TLSv1.2</default> <context>stream</context> <context>server</context> <para> Разрешает указанные протоколы. <note> Параметры <literal>TLSv1.1</literal> и <literal>TLSv1.2</literal> работают только при использовании OpenSSL 1.0.1 и выше. </note> <note> Параметр <literal>TLSv1.3</literal> (1.13.0) работает только при использовании OpenSSL 1.1.1, собранной с поддержкой TLSv1.3. </note> </para> </directive> <directive name="ssl_session_cache"> <syntax> <literal>off</literal> | <literal>none</literal> | [<literal>builtin</literal>[:<value>размер</value>]] [<literal>shared</literal>:<value>название</value>:<value>размер</value>]</syntax> <default>none</default> <context>stream</context> <context>server</context> <para> Задаёт тип и размеры кэшей для хранения параметров сессий. Тип кэша может быть следующим: <list type="tag"> <tag-name><literal>off</literal></tag-name> <tag-desc> жёсткое запрещение использования кэша сессий: nginx явно сообщает клиенту, что сессии не могут использоваться повторно. </tag-desc> <tag-name><literal>none</literal></tag-name> <tag-desc> мягкое запрещение использования кэша сессий: nginx сообщает клиенту, что сессии могут использоваться повторно, но на самом деле не хранит параметры сессии в кэше. </tag-desc> <tag-name id="ssl_session_cache_builtin"><literal>builtin</literal></tag-name> <tag-desc> встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса. Размер кэша задаётся в сессиях. Если размер не задан, то он равен 20480 сессиям. Использование встроенного кэша может вести к фрагментации памяти. </tag-desc> <tag-name id="ssl_session_cache_shared"><literal>shared</literal></tag-name> <tag-desc> кэш, разделяемый между всеми рабочими процессами. Размер кэша задаётся в байтах, в 1 мегабайт может поместиться около 4000 сессий. У каждого разделяемого кэша должно быть произвольное название. Кэш с одинаковым названием может использоваться в нескольких серверах. </tag-desc> </list> </para> <para> Можно использовать одновременно оба типа кэша, например: <example> ssl_session_cache builtin:1000 shared:SSL:10m; </example> однако использование только разделяемого кэша без встроенного должно быть более эффективным. </para> </directive> <directive name="ssl_session_ticket_key"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <para> Задаёт <value>файл</value> с секретным ключом, применяемым при шифровании и расшифровании TLS session tickets. Директива необходима, если один и тот же ключ нужно использовать на нескольких серверах. По умолчанию используется случайно сгенерированный ключ. </para> <para> Если указано несколько ключей, то только первый ключ используется для шифрования TLS session tickets. Это позволяет настроить ротацию ключей, например: <example> ssl_session_ticket_key current.key; ssl_session_ticket_key previous.key; </example> </para> <para> <value>Файл</value> должен содержать 80 или 48 байт случайных данных и может быть создан следующей командой: <example> openssl rand 80 > ticket.key </example> В зависимости от размера файла для шифрования будет использоваться либо AES256 (для 80-байтных ключей, 1.11.8), либо AES128 (для 48-байтных ключей). </para> </directive> <directive name="ssl_session_tickets"> <syntax><literal>on</literal> | <literal>off</literal></syntax> <default>on</default> <context>stream</context> <context>server</context> <para> Разрешает или запрещает возобновление сессий при помощи <link url="https://tools.ietf.org/html/rfc5077">TLS session tickets</link>. </para> </directive> <directive name="ssl_session_timeout"> <syntax><value>время</value></syntax> <default>5m</default> <context>stream</context> <context>server</context> <para> Задаёт время, в течение которого клиент может повторно использовать параметры сессии. </para> </directive> <directive name="ssl_trusted_certificate"> <syntax><value>файл</value></syntax> <default/> <context>stream</context> <context>server</context> <appeared-in>1.11.8</appeared-in> <para> Задаёт <value>файл</value> с доверенными сертификатами CA в формате PEM, которые используются для <link id="ssl_verify_client">проверки</link> клиентских сертификатов. </para> <para> В отличие от <link id="ssl_client_certificate"/>, список этих сертификатов не будет отправляться клиентам. </para> </directive> <directive name="ssl_verify_client"> <syntax> <literal>on</literal> | <literal>off</literal> | <literal>optional</literal> | <literal>optional_no_ca</literal></syntax> <default>off</default> <context>stream</context> <context>server</context> <appeared-in>1.11.8</appeared-in> <para> Разрешает проверку клиентских сертификатов. Результат проверки доступен через переменную <link id="var_ssl_client_verify">$ssl_client_verify</link>. Если при проверке клиентского сертификата произошла ошибка или клиент не предоставил требуемый сертификат, соединение закрывается. </para> <para> Параметр <literal>optional</literal> запрашивает клиентский сертификат, и если сертификат был предоставлен, проверяет его. </para> <para> Параметр <literal>optional_no_ca</literal> запрашивает сертификат клиента, но не требует, чтобы он был подписан доверенным сертификатом CA. Это предназначено для случаев, когда фактическая проверка сертификата осуществляется внешним по отношению к nginx’у сервисом. Содержимое сертификата доступно через переменную <link id="var_ssl_client_cert">$ssl_client_cert</link>. </para> </directive> <directive name="ssl_verify_depth"> <syntax><value>число</value></syntax> <default>1</default> <context>stream</context> <context>server</context> <appeared-in>1.11.8</appeared-in> <para> Устанавливает глубину проверки в цепочке клиентских сертификатов. </para> </directive> </section> <section id="variables" name="Встроенные переменные"> <para> Модуль <literal>ngx_stream_ssl_module</literal> поддерживает переменные начиная с версии 1.11.2. <list type="tag"> <tag-name id="var_ssl_cipher"><var>$ssl_cipher</var></tag-name> <tag-desc> возвращает название используемого шифра для установленного SSL-соединения; </tag-desc> <tag-name id="var_ssl_ciphers"><var>$ssl_ciphers</var></tag-name> <tag-desc> возвращает список шифров, поддерживаемых клиентом (1.11.7). Известные шифры указаны по имени, неизвестные указаны в шестнадцатеричном виде, например: <example> AES128-SHA:AES256-SHA:0x00ff </example> <note> Переменная полностью поддерживается при использовании OpenSSL версии 1.0.2 и выше. При использовании более старых версий переменная доступна только для новых сессий и может содержать только известные шифры. </note> </tag-desc> <tag-name id="var_ssl_client_cert"><var>$ssl_client_cert</var></tag-name> <tag-desc> возвращает клиентский сертификат для установленного SSL-соединения в формате PEM перед каждой строкой которого, кроме первой, вставляется символ табуляции(1.11.8); </tag-desc> <tag-name id="var_ssl_client_fingerprint"><var>$ssl_client_fingerprint</var></tag-name> <tag-desc> возвращает SHA1-отпечаток клиентского сертификата для установленного SSL-соединения (1.11.8); </tag-desc> <tag-name id="var_ssl_client_i_dn"><var>$ssl_client_i_dn</var></tag-name> <tag-desc> возвращает строку “issuer DN” клиентского сертификата для установленного SSL-соединения согласно <link url="https://tools.ietf.org/html/rfc2253">RFC 2253</link> (1.11.8); </tag-desc> <tag-name id="var_ssl_client_raw_cert"><var>$ssl_client_raw_cert</var> </tag-name> <tag-desc> возвращает клиентский сертификат для установленного SSL-соединения в формате PEM (1.11.8); </tag-desc> <tag-name id="var_ssl_client_s_dn"><var>$ssl_client_s_dn</var></tag-name> <tag-desc> возвращает строку “subject DN” клиентского сертификата для установленного SSL-соединения согласно <link url="https://tools.ietf.org/html/rfc2253">RFC 2253</link> (1.11.8); </tag-desc> <tag-name id="var_ssl_client_serial"><var>$ssl_client_serial</var></tag-name> <tag-desc> возвращает серийный номер клиентского сертификата для установленного SSL-соединения (1.11.8); </tag-desc> <tag-name id="var_ssl_client_v_end"><var>$ssl_client_v_end</var></tag-name> <tag-desc> возвращает дату окончания срока действия клиентского сертификата (1.11.8); </tag-desc> <tag-name id="var_ssl_client_v_remain"><var>$ssl_client_v_remain</var></tag-name> <tag-desc> возвращает число дней, оставшихся до истечения срока действия клиентского сертификата (1.11.8); </tag-desc> <tag-name id="var_ssl_client_v_start"><var>$ssl_client_v_start</var></tag-name> <tag-desc> возвращает дату начала срока действия клиентского сертификата (1.11.8); </tag-desc> <tag-name id="var_ssl_client_verify"><var>$ssl_client_verify</var></tag-name> <tag-desc> возвращает результат проверки клиентского сертификата (1.11.8): “<literal>SUCCESS</literal>”, “<literal>FAILED:</literal><value>reason</value>” и, если сертификат не был предоставлен, “<literal>NONE</literal>”; </tag-desc> <tag-name id="var_ssl_curves"><var>$ssl_curves</var></tag-name> <tag-desc> возвращает список кривых, поддерживаемых клиентом (1.11.7). Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде, например: <example> 0x001d:prime256v1:secp521r1:secp384r1 </example> <note> Переменная поддерживается при использовании OpenSSL версии 1.0.2 и выше. При использовании более старых версий значением переменной будет пустая строка. </note> <note> Переменная доступна только для новых сессий. </note> </tag-desc> <tag-name id="var_ssl_protocol"><var>$ssl_protocol</var></tag-name> <tag-desc> возвращает протокол установленного SSL-соединения; </tag-desc> <tag-name id="var_ssl_server_name"><var>$ssl_server_name</var></tag-name> <tag-desc> возвращает имя сервера, запрошенное через <link url="http://en.wikipedia.org/wiki/Server_Name_Indication">SNI</link>; </tag-desc> <tag-name id="var_ssl_session_id"><var>$ssl_session_id</var></tag-name> <tag-desc> возвращает идентификатор сессии установленного SSL-соединения; </tag-desc> <tag-name id="var_ssl_session_reused"><var>$ssl_session_reused</var></tag-name> <tag-desc> возвращает “<literal>r</literal>”, если сессия была использована повторно, иначе “<literal>.</literal>”. </tag-desc> </list> </para> </section> </module>