模块 ngx_stream_ssl_module

ngx_stream_ssl_module 模块 (1.9.0) 为流代理服务器提供与 SSL/TLS 协议配合使用所需的必要支持。此模块默认情况下未构建，应使用 --with-stream_ssl_module 配置参数启用它。

为了降低处理器负载，建议

• 将 工作进程 的数量设置为与处理器的数量相等，
• 启用 共享 会话缓存，
• 禁用 内置 会话缓存，
• 并可能增加会话 生命周期（默认情况下为 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/nginx/conf/cert.pem;
        ssl_certificate_key /usr/local/nginx/conf/cert.key;
        ssl_session_cache   shared:SSL:10m;
        ssl_session_timeout 10m;

        ...
    }

指定受支持的 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;
}

指定一个 文件，其中包含给定服务器的 PEM 格式的证书。如果除了主证书之外还应指定中间证书，则应按以下顺序在同一文件中指定它们：主证书排在第一位，然后是中间证书。PEM 格式的密钥可以放在同一文件中。

从 1.11.0 版本开始，此指令可以指定多次以加载不同类型的证书，例如 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 或更高版本支持不同证书的单独证书链。对于较旧版本，只能使用一个证书链。

从 1.15.9 版本开始，在使用 OpenSSL 1.0.2 或更高版本时，可以在 文件 名称中使用变量

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

请注意，使用变量意味着将在每次 SSL 握手时加载证书，这可能会对性能产生负面影响。

可以指定值 data:$variable 而不是 文件 (1.15.10)，它从变量中加载证书而不使用中间文件。请注意，不当使用此语法可能会产生安全隐患，例如将密钥数据写入 错误日志。

指定一个 文件，其中包含给定服务器的 PEM 格式的密钥。

可以指定值 engine:name:id 而不是 file，后者从 OpenSSL 引擎 name 加载具有指定 id 的密钥。

可以指定值 data:$variable 而不是 file (1.15.10)，后者从变量加载密钥，而不使用中间文件。请注意，不当使用此语法可能会带来安全隐患，例如将密钥数据写入 错误日志。

从版本 1.15.9 开始，当使用 OpenSSL 1.0.2 或更高版本时，可以在 file 名称中使用变量。

ssl_ciphers HIGH:!aNULL:!MD5;

指定启用的密码。密码以 OpenSSL 库理解的格式指定，例如

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

可以使用“openssl ciphers”命令查看完整列表。

指定一个 file，其中包含 PEM 格式的可信 CA 证书，用于 验证 客户端证书。

证书列表将发送给客户端。如果不需要此操作，可以使用 ssl_trusted_certificate 指令。

设置任意的 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 可能会导致意外行为。

指定一个 file，其中包含 PEM 格式的已吊销证书 (CRL)，用于 验证 客户端证书。

指定一个 file，其中包含 DHE 密码的 DH 参数。

默认情况下，不设置任何参数，因此不会使用 DHE 密码。

在版本 1.11.0 之前，默认使用内置参数。

ssl_ecdh_curve auto;

指定 ECDHE 密码的 curve。

在使用 OpenSSL 1.0.2 或更高版本时，可以指定多个曲线（1.11.0），例如

ssl_ecdh_curve prime256v1:secp384r1;

特殊值 auto（1.11.0）指示 nginx 在使用 OpenSSL 1.0.2 或更高版本时使用内置于 OpenSSL 库中的列表，或在使用较低版本时使用 prime256v1。

在 1.11.0 版本之前，默认使用 prime256v1 曲线。

在使用 OpenSSL 1.0.2 或更高版本时，此指令设置服务器支持的曲线列表。因此，为了使 ECDSA 证书正常工作，必须包括证书中使用的曲线。

ssl_handshake_timeout 60s;

指定 SSL 握手完成的超时时间。

指定一个 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;

        # named pipe can also be used instead of a file
        ssl_password_file /etc/keys/fifo;
        ssl_certificate_key /etc/keys/second.key;
    }
}

ssl_prefer_server_ciphers off;

指定在使用 SSLv3 和 TLS 协议时，应优先使用服务器密码而不是客户端密码。

ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;

启用指定的协议。

TLSv1.1 和 TLSv1.2 参数仅在使用 OpenSSL 1.0.1 或更高版本时才有效。

TLSv1.3 参数（1.13.0）仅在使用 OpenSSL 1.1.1 或更高版本时才有效。

自 1.23.4 起，默认使用 TLSv1.3 参数。

ssl_session_cache none;

设置存储会话参数的缓存的类型和大小。缓存可以是以下任何类型

off

严格禁止使用会话缓存：nginx 明确告诉客户端不能重用会话。

none

轻度不允许使用会话缓存：nginx 告诉客户端可以重用会话，但实际上不会在缓存中存储会话参数。

builtin

内置于 OpenSSL 中的缓存；仅供一个工作进程使用。缓存大小以会话为单位指定。如果未指定大小，则等于 20480 个会话。使用内置缓存可能会导致内存碎片。

shared

所有工作进程之间共享的缓存。缓存大小以字节为单位指定；一兆字节可以存储大约 4000 个会话。每个共享缓存都应具有一个任意名称。可以在多台服务器中使用具有相同名称的缓存。它还用于自动生成、存储和定期轮换 TLS 会话票证密钥（1.23.2），除非使用 ssl_session_ticket_key 指令显式配置。

两种缓存类型可以同时使用，例如

ssl_session_cache builtin:1000 shared:SSL:10m;

但仅使用共享缓存而不使用内置缓存应该更高效。

设置用于加密和解密 TLS 会话票证的密钥的 file。如果必须在多台服务器之间共享同一个密钥，则此指令是必需的。默认情况下，使用随机生成的密钥。

如果指定了多个密钥，则仅使用第一个密钥来加密 TLS 会话票证。这允许配置密钥轮换，例如

ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;

file 必须包含 80 或 48 字节的随机数据，可以使用以下命令创建

openssl rand 80 > ticket.key

根据文件大小，加密使用 AES256（对于 80 字节密钥，1.11.8）或 AES128（对于 48 字节密钥）。

ssl_session_tickets on;

通过 TLS 会话票证启用或禁用会话恢复。

ssl_session_timeout 5m;

指定客户端可以重复使用会话参数的时间。

指定一个 file，其中包含 PEM 格式的可信 CA 证书，用于 验证 客户端证书。

与 ssl_client_certificate 设置的证书相反，这些证书的列表不会发送给客户端。

ssl_verify_client off;

启用客户端证书验证。验证结果存储在 $ssl_client_verify 变量中。如果在客户端证书验证期间发生错误或客户端未出示所需的证书，则连接将关闭。

optional 参数请求客户端证书，并在证书存在时对其进行验证。

optional_no_ca 参数请求客户端证书，但不要求它由受信任的 CA 证书签名。当 nginx 外部的服务执行实际证书验证时，此参数旨在用于此类情况。可以通过 $ssl_client_cert 变量访问证书的内容。

ssl_verify_depth 1;

设置客户端证书链中的验证深度。

ngx_stream_ssl_module 模块自 1.11.2 起支持变量。

$ssl_alpn_protocol

返回 SSL 握手期间 ALPN 选择的协议，否则返回空字符串 (1.21.4)；

$ssl_cipher

返回用于建立的 SSL 连接的密码名称；

$ssl_ciphers

返回客户端支持的密码列表 (1.11.7)。已知的密码按名称列出，未知的密码以十六进制显示，例如

AES128-SHA:AES256-SHA:0x00ff

仅在使用 OpenSSL 1.0.2 或更高版本时才完全支持该变量。对于较低版本，该变量仅适用于新会话，且仅列出已知密码。

$ssl_client_cert

返回已建立 SSL 连接的 PEM 格式客户端证书，除了第一行外，每一行都以制表符字符 (1.11.8) 开头；

$ssl_client_fingerprint

返回已建立 SSL 连接的客户端证书的 SHA1 指纹 (1.11.8)；

$ssl_client_i_dn

根据 RFC 2253 返回已建立 SSL 连接的客户端证书的“颁发者 DN”字符串 (1.11.8)；

$ssl_client_raw_cert

返回已建立 SSL 连接的 PEM 格式客户端证书 (1.11.8)；

$ssl_client_s_dn

根据 RFC 2253 返回已建立 SSL 连接的客户端证书的“主题 DN”字符串 (1.11.8)；

$ssl_client_serial

返回已建立 SSL 连接的客户端证书的序列号 (1.11.8)；

$ssl_client_v_end

返回客户端证书的结束日期 (1.11.8)；

$ssl_client_v_remain

返回客户端证书到期前的天数 (1.11.8)；

$ssl_client_v_start

返回客户端证书的开始日期 (1.11.8)；

$ssl_client_verify

返回客户端证书验证的结果 (1.11.8)：如果存在证书，则为“SUCCESS”、“FAILED:reason”和“NONE”；

$ssl_curve

返回用于 SSL 握手密钥交换过程的协商曲线 (1.21.5)。已知曲线按名称列出，未知曲线以十六进制显示，例如

prime256v1

仅在使用 OpenSSL 3.0 或更高版本时才支持该变量。对于较低版本，变量值将为空字符串。

$ssl_curves

返回客户端支持的曲线列表 (1.11.7)。已知曲线按名称列出，未知曲线以十六进制显示，例如

0x001d:prime256v1:secp521r1:secp384r1

仅在使用 OpenSSL 1.0.2 或更高版本时才支持该变量。对于较低版本，变量值将为空字符串。

该变量仅适用于新会话。

$ssl_protocol

返回已建立 SSL 连接的协议；

$ssl_server_name

返回通过 SNI 请求的服务器名称；

$ssl_session_id

返回已建立的 SSL 连接的会话标识符；

$ssl_session_reused

如果 SSL 会话被重复使用，则返回 “r”，否则返回 “.”。