模块 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:$变量 而不是 文件 (1.15.10)，这将从变量加载证书，而无需使用中间文件。请注意，不恰当地使用此语法可能会带来安全隐患，例如将密钥数据写入 错误日志。

指定包含给定服务器密钥的 文件，密钥格式为 PEM。

可以指定 engine:名称:ID 而不是 文件，这将从指定的 OpenSSL 引擎 名称 加载具有指定 ID 的密钥。

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

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

ssl_ciphers HIGH:!aNULL:!MD5;

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

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

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

指定包含用于 验证 客户端证书和 OCSP 响应的受信任 CA 证书的 文件，前提是启用了 ssl_stapling。

证书列表将发送给客户端。如果不需要此功能，则可以使用 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 可能会导致意外行为。

指定包含用于 验证 客户端证书的吊销证书 (CRL) 的 文件，证书格式为 PEM。

指定包含用于 DHE 密码的 DH 参数的 文件。

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

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

ssl_ecdh_curve auto;

指定用于 ECDHE 密码的 曲线。

在使用 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 握手完成的超时时间。

启用客户端连接 SSL 密钥的日志记录，并指定密钥日志文件的路径。密钥以与 Wireshark 兼容的 SSLKEYLOGFILE 格式记录。

此指令作为我们 商业订阅 的一部分提供。

ssl_ocsp off;

启用客户端证书链的 OCSP 验证。leaf 参数仅启用客户端证书的验证。

要使 OCSP 验证正常工作，应将 ssl_verify_client 指令设置为 on 或 optional。

要解析 OCSP 响应程序主机名，还应指定 resolver 指令。

示例

ssl_verify_client on;
ssl_ocsp          on;
resolver          192.0.2.1;

ssl_ocsp_cache off;

设置用于存储客户端证书状态以进行 OCSP 验证的缓存的 名称 和 大小。缓存由所有工作进程共享。多个虚拟服务器可以使用相同名称的缓存。

off 参数禁止使用缓存。

覆盖证书扩展名“授权信息访问”中指定的 OCSP 响应程序的 URL，用于 验证 客户端证书。

仅支持“http://” OCSP 响应程序。

ssl_ocsp_responder http://ocsp.example.com/;

指定包含 密钥 密码的 文件，每个密码单独一行。加载密钥时，将依次尝试密码。

示例

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;

启用指定的协议。

如果在 server 级别指定此指令，则可以使用默认服务器中的值。

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

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

从 1.23.4 版本开始，默认使用 TLSv1.3 参数。

ssl_reject_handshake off;

如果启用，则将拒绝 server 块中的 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

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

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

ssl_session_cache builtin:1000 shared:SSL:10m;

但仅使用共享缓存而不使用内置缓存会更有效率。

设置一个包含用于加密和解密 TLS 会话票据的密钥的文件。如果多个服务器需要共享同一个密钥，则此指令是必需的。默认情况下，会使用随机生成的密钥。

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

ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;

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

openssl rand 80 > ticket.key

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

ssl_session_tickets on;

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

ssl_session_timeout 5m;

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

ssl_stapling off;

启用或禁用服务器的 OCSP 响应订书钉。示例

ssl_stapling on;
resolver 192.0.2.1;

要使 OCSP 订书钉正常工作，服务器证书颁发机构的证书应已知。如果 ssl_certificate 文件不包含中间证书，则服务器证书颁发机构的证书应存在于 ssl_trusted_certificate 文件中。

要解析 OCSP 响应程序主机名，还应指定 resolver 指令。

设置后，订书钉的 OCSP 响应将从指定的文件文件中获取，而不是查询服务器证书中指定的 OCSP 响应程序。

该文件应采用 DER 格式，由“openssl ocsp”命令生成。

覆盖“授权信息访问”证书扩展中指定的 OCSP 响应程序的网址。

仅支持“http://” OCSP 响应程序。

ssl_stapling_responder http://ocsp.example.com/;

ssl_stapling_verify off;

启用或禁用服务器对 OCSP 响应的验证。

要使验证正常工作，服务器证书颁发机构的证书、根证书和所有中间证书应使用 ssl_trusted_certificate 指令配置为受信任的。

指定包含用于 验证 客户端证书和 OCSP 响应的受信任 CA 证书的 文件，前提是启用了 ssl_stapling。

与 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:原因”以及如果证书不存在则返回“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”，否则返回“.”。