SSL#
Обеспечивает необходимую поддержку для работы прокси-сервера по протоколу SSL/TLS.
При сборке из исходного кода модуль не собирается по умолчанию; его необходимо
включить с помощью параметра сборки
‑‑with‑stream_ssl_module.
В пакетах и образах из наших репозиториев модуль включен в сборку.
Важно
Для этого модуля нужна библиотека OpenSSL.
Пример конфигурации#
Для уменьшения загрузки процессора рекомендуется
установить число рабочих процессов равным числу процессоров,
включить разделяемый кэш сессий,
выключить встроенный кэш сессий
и, возможно, увеличить время жизни сессии (по умолчанию 5 минут):
worker_processes auto;
stream {
#...
server {
listen 12345 ssl;
ssl_protocols 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#
Задает список поддерживаемых протоколов 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#
Указывает файл с сертификатом в формате 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#
Указывает файл с секретным ключом в формате PEM для данного виртуального сервера.
Важно
В имени файла можно использовать переменные при использовании OpenSSL 1.0.2 и выше.
Вместо файла можно указать значение "engine:имя:id", которое загружает
ключ с указанным id из OpenSSL engine с заданным именем.
Вместо файла также можно указать значение "data:$переменная", при
котором секретный ключ загружается из переменной без использования промежуточных
файлов. При этом следует учитывать, что ненадлежащее использование подобного
синтаксиса может быть небезопасно, например данные секретного ключа могут
попасть в лог ошибок.
ssl_ciphers#
Описывает разрешенные шифры. Шифры задаются в формате, поддерживаемом библиотекой OpenSSL, например:
ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
Полный список можно посмотреть с помощью команды "openssl ciphers".
ssl_client_certificate#
Задает файл с доверенными сертификатами CA в формате PEM, которые используются для проверки клиентских сертификатов и ответов OCSP, если включен ssl_stapling.
Список сертификатов будет отправляться клиентам. Если это нежелательно, можно воспользоваться директивой ssl_trusted_certificate.
ssl_conf_command#
Задает произвольные конфигурационные команды 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#
Указывает файл с отозванными сертификатами (CRL) в формате PEM, используемыми для проверки клиентских сертификатов.
ssl_dhparam#
Указывает файл с параметрами для DHE-шифров.
Осторожно
По умолчанию параметры не заданы, и соответственно DHE-шифры не будут использоваться.
ssl_ecdh_curve#
Задает кривую для 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#
|
|
По умолчанию |
|
stream, server |
Задает таймаут для завершения операции SSL-рукопожатия.
ssl_ocsp#
Включает проверку OCSP для цепочки клиентских сертификатов. Параметр
leaf включает проверку только клиентского сертификата.
Для работы проверки OCSP необходимо дополнительно установить значение директивы
ssl_verify_client в on или optional.
Для преобразования имени хоста OCSP-респондера в адрес необходимо дополнительно задать директиву resolver.
Пример:
ssl_verify_client on;
ssl_ocsp on;
resolver 127.0.0.53;
ssl_ocsp_cache#
|
|
По умолчанию |
|
http, server |
Задает имя и размер кэша, который хранит статус клиентских сертификатов для проверки OCSP-ответов. Кэш разделяется между всеми рабочими процессами. Кэш с одинаковым названием может использоваться в нескольких виртуальных серверах.
Параметр off запрещает использование кэша.
ssl_ocsp_responder#
Переопределяет URI OCSP-респондера, указанный в расширении сертификата "Authority Information Access" для проверки клиентских сертификатов.
Поддерживаются только OCSP-респондеры на основе http://:
ssl_ocsp_responder http://ocsp.example.com/;
ssl_ntls#
Добавлено в версии 1.2.0.
Включает серверную поддержку 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#
Задает файл с паролями от секретных ключей, где каждый пароль указан на отдельной строке. Пароли применяются по очереди в момент загрузки ключа.
Пример:
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#
|
|
По умолчанию |
|
stream, server |
При использовании протоколов SSLv3 и TLS устанавливает приоритет серверных шифров над клиентскими.
ssl_protocols#
|
|
По умолчанию |
|
stream, server |
Изменено в версии 1.2.0: Параметр TLSv1.3 добавлен к используемым по умолчанию.
Разрешает указанные протоколы.
Важно
Параметры TLSv1.1 и TLSv1.2 работают только при использовании OpenSSL 1.0.1 и выше.
Параметр TLSv1.3 работает только при использовании OpenSSL 1.1.1 и выше.
ssl_session_cache#
|
|
По умолчанию |
|
stream, server |
Задает тип и размеры кэшей для хранения параметров сессий. Тип кэша может быть следующим:
|
жесткое запрещение использования кэша сессий: Angie явно сообщает клиенту, что сессии не могут использоваться повторно. |
|
мягкое запрещение использования кэша сессий: Angie сообщает клиенту, что сессии могут использоваться повторно, но на самом деле не хранит параметры сессии в кэше. |
|
встроенный в OpenSSL кэш, используется в рамках только одного рабочего процесса. Размер кэша задается в сессиях. Если размер не задан, то он равен 20480 сессиям. Использование встроенного кэша может вести к фрагментации памяти. |
|
кэш, разделяемый между всеми рабочими процессами. Размер кэша задается в байтах, в 1 мегабайт может поместиться около 4000 сессий. У каждого разделяемого кэша должно быть произвольное название. Кэш с одинаковым названием может использоваться в нескольких серверах. Также он используется для автоматического создания, хранения и периодического обновления ключей TLS session tickets, если они не указаны явно с помощью директивы ssl_session_ticket_key. |
Можно использовать одновременно оба типа кэша, например:
ssl_session_cache builtin:1000 shared:SSL:10m;
однако использование только разделяемого кэша без встроенного должно быть более эффективным.
ssl_session_ticket_key#
Задает файл с секретным ключом, применяемым при шифровании и расшифровании 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#
|
|
По умолчанию |
|
stream, server |
Разрешает или запрещает возобновление сессий при помощи TLS session tickets.
ssl_session_timeout#
Задает время, в течение которого клиент может повторно использовать параметры сессии.
ssl_stapling#
Разрешает или запрещает прикрепление OCSP-ответов сервером. Пример:
ssl_stapling on;
resolver 127.0.0.53;
Для работы OCSP-прикрепления должен быть известен сертификат издателя сертификата сервера. Если в заданном директивой ssl_certificate файле не содержится промежуточных сертификатов, то сертификат издателя сертификата сервера следует поместить в файл, заданный директивой ssl_trusted_certificate.
Внимание
Для преобразования имени хоста OCSP-респондера в адрес необходимо дополнительно задать директиву resolver.
ssl_stapling_file#
Если значение задано, то вместо опроса OCSP-респондера, указанного в сертификате сервера, ответ берется из указанного файла.
Ответ должен быть в формате DER и может быть сгенерирован командой
openssl ocsp.
ssl_stapling_responder#
Переопределяет URI OCSP-респондера, указанный в расширении сертификата "Authority Information Access".
Поддерживаются только OCSP-респондеры на основе http://:
ssl_stapling_responder http://ocsp.example.com/;
ssl_stapling_verify#
Разрешает или запрещает проверку ответов OCSP сервером.
Для работоспособности проверки сертификат издателя сертификата сервера, корневой сертификат и все промежуточные сертификаты должны быть указаны как доверенные с помощью директивы ssl_trusted_certificate.
ssl_trusted_certificate#
Задает файл с доверенными сертификатами CA в формате PEM, которые используются для проверки клиентских сертификатов.
В отличие от ssl_client_certificate, список этих сертификатов не будет отправляться клиентам.
ssl_verify_client#
|
|
По умолчанию |
|
stream, server |
Разрешает проверку клиентских сертификатов. Результат проверки доступен через переменную $ssl_client_verify. Если при проверке клиентского сертификата произошла ошибка или клиент не предоставил требуемый сертификат, соединение закрывается.
|
запрашивает клиентский сертификат, и если сертификат был предоставлен, проверяет его |
|
запрашивает сертификат клиента, но не требует, чтобы он был подписан доверенным сертификатом CA. Это предназначено для случаев, когда фактическая проверка сертификата осуществляется внешним по отношению к Angie сервисом. |
ssl_verify_depth#
Устанавливает глубину проверки в цепочке клиентских сертификатов.
Встроенные переменные#
Модуль 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_cert_type#
принимает значения RSA, DSA, ECDSA, ED448,
ED25519, SM2, RSA-PSS или unknown в зависимости
от типа сертификата и ключа сервера.
$ssl_server_name#
возвращает имя сервера, запрошенное через SNI.
$ssl_session_id#
возвращает идентификатор сессии установленного SSL-соединения.
$ssl_session_reused#
возвращает r, если сессия была использована повторно, иначе ".".