模块 ngx_stream_ssl_module

模块 （1.9.0） 为 Stream Proxy Server 提供必要的支持 SSL/TLS 协议。 默认情况下，此模块不是构建的，应使用 configuration 参数启用它。ngx_stream_ssl_module--with-stream_ssl_module

要减少处理器负载，建议

• 将工作进程数设置为等于处理器数，
• 启用共享会话缓存，
• 禁用内置会话缓存，
• 并可能延长会话生存期（默认情况下为 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/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;
}

指定 a 和 PEM 格式的证书 对于给定的服务器。 如果除了主证书之外还应指定中间证书 certificate，则应在以下的同一文件中指定它们 顺序：首先是主证书，然后是中间证书。 PEM 格式的密钥可以放在同一个文件中。file

从 1.11.0 版本开始， 此Directives可以多次指定 要加载不同类型的证书，例如 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 握手都会加载一个证书， 这可能会对性能产生负面影响。

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

使用 PEM 格式的密钥指定 a 对于给定的服务器。file

可以指定值 ：： 而不是 ， 它加载具有从 OpenSSL 引擎指定的密钥。enginenameidfileidname

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

从 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 证书 用于验证客户端证书和 OCSP 响应（如果启用了 ssl_stapling）。file

证书列表将发送给客户端。 如果不需要，则可以使用 ssl_trusted_certificate Directives。

设置任意 OpenSSL 配置命令。

使用 OpenSSL 1.0.2 或更高版本时，支持该Directives。

多个Directives 可以在同一级别上指定：ssl_conf_command

ssl_conf_command Options PrioritizeChaCha;
ssl_conf_command Ciphersuites TLS_CHACHA20_POLY1305_SHA256;

这些Directives继承自之前的配置级别 当且仅当没有Directives时 在当前级别上定义。ssl_conf_command

请注意，直接配置 OpenSSL 可能会导致意外行为。

指定具有已吊销证书 （CRL） 的 采用用于验证客户端证书的 PEM 格式。file

为 DHE 密码指定 with DH 参数。file

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

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

ssl_ecdh_curve auto;

为 ECDHE 密码指定 a。curve

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

ssl_ecdh_curve prime256v1:secp384r1;

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

在 1.11.0 版本之前， 默认情况下，将使用曲线。prime256v1

使用 OpenSSL 1.0.2 或更高版本时， 此Directives设置 Server 支持的曲线列表。 因此，为了使 ECDSA 证书正常工作， 包括证书中使用的曲线非常重要。

ssl_handshake_timeout 60s;

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

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

该Directives作为我们商业订阅的一部分提供。

ssl_ocsp off;

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

要使 OCSP 验证正常工作， ssl_verify_client Directives应设置为 或 。onoptional

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

例：

ssl_verify_client on;
ssl_ocsp          on;
resolver          192.0.2.1;

ssl_ocsp_cache off;

集 和 缓存 存储用于 OCSP 验证的客户端证书状态。 缓存在所有工作进程之间共享。 具有相同名称的缓存可以在多个虚拟服务器中使用。namesize

该参数禁止使用缓存。off

覆盖在 “权威 Information Access“证书扩展 用于验证客户端证书。

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

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

指定 a with passphrases for secret keys，其中每个密码都在单独的行上指定。 加载密钥时依次尝试密码。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.2 TLSv1.3;

启用指定的协议。

如果指定了该Directives 在服务器级别， 可以使用 default server 中的值。

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

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

默认情况下使用该参数 从 1.23.4 开始。TLSv1.3

ssl_reject_handshake off;

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

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

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 明确告诉客户端 session 不能被重用。

none

严格禁止使用 session cache： nginx 告诉客户端会话可以重用，但不会 实际上将会话参数存储在缓存中。

builtin

OpenSSL 中内置的缓存;仅由一个工作进程使用。 缓存大小在 sessions 中指定。 如果未给出 size，则等于 20480 个会话。 使用内置缓存可能会导致内存碎片。

shared

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

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

使用 secret 密钥设置 a 用于加密 以及解密 TLS 会话票证。 如果必须在 多个服务器。 默认情况下，使用随机生成的密钥。file

如果指定了多个键，则只有第一个键是 用于加密 TLS 会话票证。 这允许配置密钥轮换，例如：

ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;

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

openssl rand 80 > ticket.key

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

ssl_session_tickets on;

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

ssl_session_timeout 5m;

指定客户端可以重用 session 参数。

ssl_stapling off;

启用或禁用装订 的 OCSP 响应。 例：

ssl_stapling on;
resolver 192.0.2.1;

要使 OCSP 装订正常工作，服务器证书的证书 issuer 应该已知。 如果 ssl_certificate 文件 不包含中间证书， 服务器证书颁发者的证书应为 存在于 ssl_trusted_certificate 文件中。

对于 OCSP 响应程序主机名的解析， resolver Directives 还应指定。

设置后，装订的 OCSP 响应将取自 指定而不是查询 服务器证书中指定的 OCSP 响应方。file

该文件应采用 “” 命令。openssl ocsp

覆盖在 “权威 Information Access“证书扩展名。

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

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

ssl_stapling_verify off;

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

要使验证正常工作，服务器证书的证书 issuer、根证书和所有中间证书 应使用 ssl_trusted_certificate Directives配置为 trusted。

指定具有 PEM 格式的受信任 CA 证书 用于验证客户端证书和 OCSP 响应（如果启用了 ssl_stapling）。file

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

ssl_verify_client off;

启用客户端证书验证。 验证结果存储在 $ssl_client_verify 变量中。 客户端证书验证时出错时 或者客户未提供所需的证书， 连接已关闭。

该参数请求客户端 certificate 并验证证书是否存在。optional

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

ssl_verify_depth 1;

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

该模块支持变量 从 1.11.2 开始。ngx_stream_ssl_module

$ssl_alpn_protocol

返回 ALPN 在 SSL 握手期间选择的协议， 否则为空字符串 （1.21.4）;

$ssl_cipher

返回使用的密码的名称 对于已建立的 SSL 连接;

$ssl_ciphers

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

AES128-SHA:AES256-SHA:0x00ff

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

$ssl_client_cert

返回 PEM 格式的客户端证书 对于已建立的 SSL 连接，除第一行 以制表符 （1.11.8） 为前缀;

$ssl_client_fingerprint

返回客户端证书的 SHA1 指纹 对于已建立的 SSL 连接 （1.11.8）;

$ssl_client_i_dn

返回客户端证书的 “issuer DN” 字符串 对于根据 RFC 2253 （1.11.8） 建立的 SSL 连接;

$ssl_client_raw_cert

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

$ssl_client_s_dn

返回客户端证书的 “subject DN” 字符串 对于根据 RFC 2253 （1.11.8） 建立的 SSL 连接;

$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） 的结果： “”, “”, 以及 “”（如果证书不存在）;SUCCESSFAILED:reasonNONE

$ssl_curve

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

prime256v1

仅当使用 OpenSSL 版本 3.0 或更高版本时，才支持该变量。 对于旧版本，变量 value 将为空字符串。

$ssl_curves

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

0x001d:prime256v1:secp521r1:secp384r1

仅当使用 OpenSSL 版本 1.0.2 或更高版本时，才支持该变量。 对于旧版本，变量 value 将为空字符串。

该变量仅适用于新会话。

$ssl_protocol

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

$ssl_server_name

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

$ssl_session_id

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

$ssl_session_reused

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