模块 ngx_stream_ssl_module

模块 ngx_stream_ssl_module（1.9.0 版本）提供了流代理服务器与 SSL/TLS 协议配合工作所需的支持。该模块默认未构建，需要使用 --with-stream_ssl_module 配置参数启用。

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

• 将 worker processes 数量设置为处理器数量相等，
• 启用 共享 会话缓存，
• 禁用 内置 会话缓存，
• 可能增加会话 生命周期（默认为 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 或更高版本时，可以在 file 名称中使用变量：

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

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

可以指定值 data:$variable 来代替 file (1.15.10)，它会从变量加载证书而不使用中间文件。请注意，不恰当地使用此语法可能会导致安全问题，例如将密钥数据写入错误日志。

指定给定服务器的 PEM 格式的密钥文件。

可以在 file 之外指定值 engine:name:id，它会从 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”命令查看完整列表。

指定用于验证客户端证书的 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可能导致意外行为。

指定用于验证客户端证书的PEM格式的已吊销证书（CRL）文件。

指定用于DHE密码的DH参数的file。

默认情况下，不设置参数，因此不会使用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 握手完成的超时时间。

指定一个包含每个密码短语的 文件，每个短语占据一行，用于密钥的解密。在加载密钥时，逐个尝试这些密码短语。

示例：

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 或更高版本时有效。

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

ssl_reject_handshake off;

如果启用，则在服务器块中拒绝 SSL 握手。

例如，在以下配置中，除了 example.com 之外的服务器名称的 SSL 握手将被拒绝：

server {
    listen               443 ssl default_server;
    ssl_reject_handshake on;
}

server {
    listen              443 ssl;
    server_name         example.com;
    ssl_certificate     example.com.crt;
    ssl_certificate_key example.com.key;
}

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;

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

指定包含PEM格式的受信任CA证书的file，用于验证客户端证书。

与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

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

$ssl_client_raw_cert

返回已建立的SSL连接的PEM格式的客户端证书（1.11.8）;

$ssl_client_s_dn

返回已建立的SSL连接的客户端证书的“主题 DN”字符串，根据 RFC 2253（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”，否则返回“.”。