Модуль stream_ssl

Содержание

Модуль `stream_ssl`#

Обеспечивает необходимую поддержку для работы прокси-сервера по протоколу SSL/TLS.

По умолчанию этот модуль не собирается; его сборку необходимо включить с помощью параметра конфигурации ‑‑with‑stream_ssl_module.

В пакетах из наших репозиториев модуль уже включен в сборку.

Важно

Для сборки и работы этого модуля нужна библиотека OpenSSL.

Пример конфигурации#

Для уменьшения загрузки процессора рекомендуется

установить число рабочих процессов равным числу процессоров,
включить разделяемый кэш сессий,
выключить встроенный кэш сессий
и, возможно, увеличить время жизни сессии (по умолчанию 5 минут):

worker_processes auto;

stream {

    #...

    server {
        listen              12345 ssl;

        ssl_protocols       TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
        ssl_ciphers         AES128-SHA:AES256-SHA:RC4-SHA:DES-CBC3-SHA:RC4-MD5;
        ssl_certificate     /usr/local/angie/conf/cert.pem;
        ssl_certificate_key /usr/local/angie/conf/cert.key;
        ssl_session_cache   shared:SSL:10m;
        ssl_session_timeout 10m;

    #    ...
    }

Директивы#

ssl_alpn#

Синтаксис:: ssl_alpn протокол …;
Умолчание:: —
Контекст:: stream, server

Задает список поддерживаемых протоколов ALPN. Один из протоколов должен быть согласован, если клиент использует ALPN:

map $ssl_alpn_protocol $proxy {
    h2                 127.0.0.1:8001;
    http/1.1           127.0.0.1:8002;
}

server {
    listen      12346;
    proxy_pass  $proxy;
    ssl_alpn    h2 http/1.1;
}

ssl_certificate#

Синтаксис:: ssl_certificate файл;
Умолчание:: —
Контекст:: stream, server

Указывает файл с сертификатом в формате PEM для данного сервера. Если вместе с основным сертификатом нужно указать промежуточные, то они должны находиться в этом же файле в следующем порядке — сначала основной сертификат, а затем промежуточные. В этом же файле может находиться секретный ключ в формате PEM.

Директива может быть указана несколько раз для загрузки сертификатов разных типов, например RSA и ECDSA:

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;

#    ...
}

Возможность задавать отдельные цепочки сертификатов для разных сертификатов есть только в OpenSSL 1.0.2 и выше. Для более старых версий следует указывать только одну цепочку сертификатов.

Важно

В имени файла можно использовать переменные при использовании OpenSSL 1.0.2 и выше:

ssl_certificate     $ssl_server_name.crt;
ssl_certificate_key $ssl_server_name.key;

При использовании переменных сертификат загружается при каждой операции SSL-рукопожатия, что может отрицательно влиять на производительность.

Вместо файла можно указать значение «data:$переменная», при котором сертификат загружается из переменной без использования промежуточных файлов.

Ненадлежащее использование подобного синтаксиса может быть небезопасно, например данные секретного ключа могут попасть в лог ошибок.

ssl_certificate_key#

Синтаксис:: ssl_certificate_key файл;
Умолчание:: —
Контекст:: stream, server

Указывает файл с секретным ключом в формате PEM для данного виртуального сервера.

Важно

В имени файла можно использовать переменные при использовании OpenSSL 1.0.2 и выше.

Вместо файла можно указать значение «engine:имя:id», которое загружает ключ с указанным id из OpenSSL engine с заданным именем.

Вместо файла также можно указать значение «data:$переменная», при котором секретный ключ загружается из переменной без использования промежуточных файлов. При этом следует учитывать, что ненадлежащее использование подобного синтаксиса может быть небезопасно, например данные секретного ключа могут попасть в лог ошибок.

ssl_ciphers#

Синтаксис:: ssl_ciphers шифры;
Умолчание:: ssl_ciphers HIGH:!aNULL:!MD5;
Контекст:: stream, server

Описывает разрешенные шифры. Шифры задаются в формате, поддерживаемом библиотекой OpenSSL, например:

ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;

Полный список можно посмотреть с помощью команды «openssl ciphers».

ssl_client_certificate#

Синтаксис:: ssl_client_certificate файл;
Умолчание:: —
Контекст:: stream, server

Указывает файл с доверенными сертификатами CA в формате PEM, которые используются для проверки клиентских сертификатов.

Список сертификатов будет отправляться клиентам. Если это нежелательно, можно воспользоваться директивой ssl_trusted_certificate.

ssl_conf_command#

Синтаксис:: ssl_conf_command имя значение;
Умолчание:: —
Контекст:: stream, server

Задает произвольные конфигурационные команды OpenSSL.

Важно

Директива поддерживается при использовании OpenSSL 1.0.2 и выше.

На одном уровне может быть указано несколько директив ssl_conf_command:

ssl_conf_command Options PrioritizeChaCha;
ssl_conf_command Ciphersuites TLS_CHACHA20_POLY1305_SHA256;

Директивы наследуются с предыдущего уровня конфигурации при условии, что на данном уровне не описаны свои директивы ssl_conf_command.

Осторожно

Изменение настроек OpenSSL напрямую может привести к неожиданному поведению.

ssl_crl#

Синтаксис:: ssl_crl файл;
Умолчание:: —
Контекст:: stream, server

Указывает файл с отозванными сертификатами (CRL) в формате PEM, используемыми для проверки клиентских сертификатов.

ssl_dhparam#

Синтаксис:: ssl_dhparam файл;
Умолчание:: —
Контекст:: stream, server

Указывает файл с параметрами для DHE-шифров.

Осторожно

По умолчанию параметры не заданы, и соответственно DHE-шифры не будут использоваться.

ssl_ecdh_curve#

Синтаксис:: ssl_ecdh_curve кривая;
Умолчание:: ssl_ecdh_curve auto;
Контекст:: stream, server

Задает кривую для ECDHE-шифров.

Важно

При использовании OpenSSL 1.0.2 и выше можно указывать несколько кривых, например:

ssl_ecdh_curve prime256v1:secp384r1;

Специальное значение auto соответствует встроенному в библиотеку OpenSSL списку кривых для OpenSSL 1.0.2 и выше, или prime256v1 для более старых версий.

Важно

При использовании OpenSSL 1.0.2 и выше директива задает список кривых, поддерживаемых сервером. Поэтому для работы ECDSA-сертификатов важно, чтобы список включал кривые, используемые в сертификатах.

ssl_handshake_timeout#

Синтаксис:: ssl_handshake_timeout время;
Умолчание:: ssl_handshake_timeout 60s;
Контекст:: stream, server

Задает таймаут для завершения операции SSL-рукопожатия.

ssl_ntls#

Добавлено в версии 1.2.0.

Синтаксис:: ssl_ntls on | off;
Умолчание:: ssl_ntls off;
Контекст:: stream, server

Включает серверную поддержку NTLS при использовании TLS библиотеки TongSuo

listen ... ssl;
ssl_ntls  on;

Важно

Angie необходимо собрать с использованием параметра конфигурации –with-ntls, с соответствующей SSL библиотекой с поддержкой NTLS

./configure --with-openssl=../Tongsuo-8.3.0 \
            --with-openssl-opt=enable-ntls  \
            --with-ntls

ssl_password_file#

Синтаксис:: ssl_password_file файл;
Умолчание:: —
Контекст:: stream, server

Задает файл с паролями от секретных ключей, где каждый пароль указан на отдельной строке. Пароли применяются по очереди в момент загрузки ключа.

Пример:

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;
    }
}

ssl_prefer_server_ciphers#

Синтаксис:: ssl_prefer_server_ciphers on | off;
Умолчание:: ssl_prefer_server_ciphers off;
Контекст:: stream, server

При использовании протоколов SSLv3 и TLS устанавливает приоритет серверных шифров над клиентскими.

ssl_protocols#

Синтаксис:: ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];
Умолчание:: ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;
Контекст:: stream, server

Изменено в версии 1.2.0: Параметр TLSv1.3 добавлен к используемым по умолчанию.

Разрешает указанные протоколы.

Важно

Параметры TLSv1.1 и TLSv1.2 работают только при использовании OpenSSL 1.0.1 и выше.

Параметр TLSv1.3 работает только при использовании OpenSSL 1.1.1 и выше.

ssl_session_cache#

Синтаксис:: ssl_session_cache off | none | [builtin[:размер]] [shared:название:размер];
Умолчание:: ssl_session_cache none;
Контекст:: stream, server

Задает тип и размеры кэшей для хранения параметров сессий. Тип кэша может быть следующим:

`off`	жесткое запрещение использования кэша сессий: Angie явно сообщает клиенту, что сессии не могут использоваться повторно.
`none`	мягкое запрещение использования кэша сессий: Angie сообщает клиенту, что сессии могут использоваться повторно, но на самом деле не хранит параметры сессии в кэше.
`builtin`	встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса. Размер кэша задается в сессиях. Если размер не задан, то он равен 20480 сессиям. Использование встроенного кэша может вести к фрагментации памяти.
`shared`	кэш, разделяемый между всеми рабочими процессами. Размер кэша задается в байтах, в 1 мегабайт может поместиться около 4000 сессий. У каждого разделяемого кэша должно быть произвольное название. Кэш с одинаковым названием может использоваться в нескольких серверах. Также он используется для автоматического создания, хранения и периодического обновления ключей TLS session tickets, если они не указаны явно с помощью директивы ssl_session_ticket_key.

Можно использовать одновременно оба типа кэша, например:

ssl_session_cache builtin:1000 shared:SSL:10m;

однако использование только разделяемого кэша без встроенного должно быть более эффективным.

ssl_session_ticket_key#

Синтаксис:: ssl_session_ticket_key файл;
Умолчание:: —
Контекст:: stream, server

Задает файл с секретным ключом, применяемым при шифровании и расшифровании TLS session tickets. Директива необходима, если один и тот же ключ нужно использовать на нескольких серверах. По умолчанию используется случайно сгенерированный ключ.

Если указано несколько ключей, то только первый ключ используется для шифрования TLS session tickets. Это позволяет настроить ротацию ключей, например:

ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;

Файл должен содержать 80 или 48 байт случайных данных и может быть создан следующей командой:

openssl rand 80 > ticket.key

В зависимости от размера файла для шифрования будет использоваться либо AES256 (для 80-байтных ключей), либо AES128 (для 48-байтных ключей).

ssl_session_tickets#

Синтаксис:: ssl_session_tickets on | off;
Умолчание:: ssl_session_tickets on;
Контекст:: stream, server

Разрешает или запрещает возобновление сессий при помощи TLS session tickets.

ssl_session_timeout#

Синтаксис:: ssl_session_timeout время;
Умолчание:: ssl_session_timeout 5m;
Контекст:: stream, server

Задает время, в течение которого клиент может повторно использовать параметры сессии.

ssl_trusted_certificate#

Синтаксис:: ssl_trusted_certificate файл;
Умолчание:: —
Контекст:: stream, server

Задает файл с доверенными сертификатами CA в формате PEM, которые используются для проверки клиентских сертификатов.

В отличие от ssl_client_certificate, список этих сертификатов не будет отправляться клиентам.

ssl_verify_client#

Синтаксис:: ssl_verify_client on | off | optional | optional_no_ca;
Умолчание:: ssl_verify_client off;
Контекст:: stream, server

Разрешает проверку клиентских сертификатов. Результат проверки доступен через переменную $ssl_client_verify. Если при проверке клиентского сертификата произошла ошибка или клиент не предоставил требуемый сертификат, соединение закрывается.

optional

запрашивает клиентский сертификат, и если сертификат был предоставлен, проверяет его

optional_no_ca

запрашивает сертификат клиента, но не требует, чтобы он был подписан доверенным сертификатом CA. Это предназначено для случаев, когда фактическая проверка сертификата осуществляется внешним по отношению к Angie сервисом.

ssl_verify_depth#

Синтаксис:: ssl_verify_depth число;
Умолчание:: ssl_verify_depth 1;
Контекст:: stream, server

Устанавливает глубину проверки в цепочке клиентских сертификатов.

Встроенные переменные#

Модуль stream_ssl поддерживает встроенные переменные:

`$ssl_alpn_protocol`#

возвращает протокол, выбранный при помощи ALPN во время SSL-рукопожатия, либо пустую строку.

`$ssl_cipher`#

возвращает название используемого шифра для установленного SSL-соединения.

`$ssl_ciphers`#

возвращает список шифров, поддерживаемых клиентом. Известные шифры указаны по имени, неизвестные указаны в шестнадцатеричном виде, например:

AES128-SHA:AES256-SHA:0x00ff

Важно

Переменная полностью поддерживается при использовании OpenSSL версии 1.0.2 и выше. При использовании более старых версий переменная доступна только для новых сессий и может содержать только известные шифры.

`$ssl_client_cert`#

возвращает клиентский сертификат для установленного SSL-соединения в формате PEM перед каждой строкой которого, кроме первой, вставляется символ табуляции.

`$ssl_client_fingerprint`#

возвращает SHA1-отпечаток клиентского сертификата для установленного SSL-соединения.

`$ssl_client_i_dn`#

возвращает строку «issuer DN» клиентского сертификата для установленного SSL-соединения согласно RFC 2253.

`$ssl_client_raw_cert`#

возвращает клиентский сертификат для установленного SSL-соединения в формате PEM.

`$ssl_client_s_dn`#

возвращает строку «subject DN» клиентского сертификата для установленного SSL-соединения согласно RFC 2253.

`$ssl_client_serial`#

возвращает серийный номер клиентского сертификата для установленного SSL-соединения.

`$ssl_client_v_end`#

возвращает дату окончания срока действия клиентского сертификата.

`$ssl_client_v_remain`#

возвращает число дней, оставшихся до истечения срока действия клиентского сертификата.

`$ssl_client_v_start`#

возвращает дату начала срока действия клиентского сертификата.

`$ssl_client_verify`#

возвращает результат проверки клиентского сертификата: SUCCESS, «FAILED:reason» и, если сертификат не был предоставлен, NONE.

`$ssl_curve`#

возвращает согласованную кривую, использованную для обмена ключами во время SSL-рукопожатия. Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде, например:

prime256v1

Важно

Переменная поддерживается при использовании OpenSSL версии 3.0 и выше. При использовании более старых версий значением переменной будет пустая строка.

`$ssl_curves`#

возвращает список кривых, поддерживаемых клиентом. Известные кривые указаны по имени, неизвестные указаны в шестнадцатеричном виде, например:

0x001d:prime256v1:secp521r1:secp384r1

Важно

Переменная поддерживается при использовании OpenSSL версии 1.0.2 и выше. При использовании более старых версий значением переменной будет пустая строка.

Переменная доступна только для новых сессий.

`$ssl_protocol`#

возвращает протокол установленного SSL-соединения.

`$ssl_server_name`#

возвращает имя сервера, запрошенное через SNI.

`$ssl_session_id`#

возвращает идентификатор сессии установленного SSL-соединения.

`$ssl_session_reused`#

возвращает r, если сессия была использована повторно, иначе «.».

Модуль stream_ssl

Содержание

Модуль stream_ssl#

Пример конфигурации#

Директивы#

ssl_alpn#

ssl_certificate#

ssl_certificate_key#

ssl_ciphers#

ssl_client_certificate#

ssl_conf_command#

ssl_crl#

ssl_dhparam#

ssl_ecdh_curve#

ssl_handshake_timeout#

ssl_ntls#

ssl_password_file#

ssl_prefer_server_ciphers#

ssl_protocols#

ssl_session_cache#

ssl_session_ticket_key#

ssl_session_tickets#

ssl_session_timeout#

ssl_trusted_certificate#

ssl_verify_client#

ssl_verify_depth#

Встроенные переменные#

$ssl_alpn_protocol#

$ssl_cipher#

$ssl_ciphers#

$ssl_client_cert#

$ssl_client_fingerprint#

$ssl_client_i_dn#

$ssl_client_raw_cert#

$ssl_client_s_dn#

$ssl_client_serial#

$ssl_client_v_end#

$ssl_client_v_remain#

$ssl_client_v_start#

$ssl_client_verify#

$ssl_curve#

$ssl_curves#

$ssl_protocol#

$ssl_server_name#

$ssl_session_id#

$ssl_session_reused#

Модуль `stream_ssl`#

`$ssl_alpn_protocol`#

`$ssl_cipher`#

`$ssl_ciphers`#

`$ssl_client_cert`#

`$ssl_client_fingerprint`#

`$ssl_client_i_dn`#

`$ssl_client_raw_cert`#

`$ssl_client_s_dn`#

`$ssl_client_serial`#

`$ssl_client_v_end`#

`$ssl_client_v_remain`#

`$ssl_client_v_start`#

`$ssl_client_verify`#

`$ssl_curve`#

`$ssl_curves`#

`$ssl_protocol`#

`$ssl_server_name`#

`$ssl_session_id`#

`$ssl_session_reused`#