ngx_stream_ssl_module 模块

ngx_stream_ssl_module 模块 (1.9.0) 为流代理服务器提供使用 SSL/TLS 协议所需的必要支持。

默认情况下不构建此模块，应使用 --with-stream_ssl_module 配置参数启用它。

此模块需要 OpenSSL 库。

为了减少处理器负载，建议

• 将 worker processes 的数量设置为等于处理器数量，
• 启用 共享 会话缓存，
• 禁用 内置 会话缓存，
• 并可能增加会话的生命周期（默认为 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;
}

指定给定虚拟服务器的 PEM 格式证书的file。如果除了主证书之外还需要指定中间证书，则应按以下顺序在同一文件中指定：主证书在前，然后是中间证书。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)，这会从变量加载证书而无需使用中间文件。请注意，不恰当地使用此语法可能会带来安全隐患，例如将私钥数据写入错误日志。

应注意，由于 SSL/TLS 协议的限制，为了与不使用 SNI 的客户端实现最大互操作性，使用不同证书的虚拟服务器应监听不同的 IP 地址。

ssl_certificate_cache off;

定义一个缓存，用于存储使用变量指定的SSL 证书和私钥。

此指令有以下参数

max

设置缓存中的最大元素数量；当缓存溢出时，会移除最近最少使用的 (LRU) 元素；

inactive

定义一个时间，在此时间之后，如果元素在此期间未被访问，则会从缓存中移除；默认为 10 秒；

valid

定义一个时间，在此期间缓存中的元素被视为有效且可以重复使用；默认为 60 秒。超过此时间的证书将被重新加载或重新验证；

off

禁用缓存。

示例

ssl_certificate       $ssl_server_name.crt;
ssl_certificate_key   $ssl_server_name.key;
ssl_certificate_cache max=1000 inactive=20s valid=1m;

指定给定虚拟服务器的 PEM 格式私钥的file。

可以使用值 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_stapling 时验证 OCSP 响应。

证书列表将发送给客户端。如果不需要这样，可以使用 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 握手完成的超时时间。

启用客户端连接 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;

设置缓存的 name 和 size，该缓存存储用于 OCSP 验证的客户端证书状态。该缓存由所有 worker processes 共享。具有相同名称的缓存可以在多个虚拟服务器中使用。

off 参数禁止使用缓存。

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

仅支持“http://”OCSP 响应者

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

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

启用指定的协议。

如果在 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 内置的缓存；仅由一个 worker process 使用。缓存大小以会话数量指定。如果未指定大小，则等于 20480 个会话。使用内置缓存可能会导致内存碎片。

shared

所有 worker processes 共享的缓存。缓存大小以字节指定；一兆字节可以存储大约 4000 个会话。每个共享缓存都应有一个任意名称。具有相同名称的缓存可以在多个虚拟服务器中使用。它也用于自动生成、存储和定期轮换 TLS 会话票据密钥 (1.23.2)，除非使用 ssl_session_ticket_key 指令显式配置。

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

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

如果指定了多个密钥，则仅使用第一个密钥来加密 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;

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

ssl_stapling off;

启用或禁用服务器的 OCSP 响应绑定。示例

ssl_stapling on;
resolver 192.0.2.1;

为了使 OCSP 绑定正常工作，应知晓服务器证书颁发者的证书。如果 ssl_certificate 文件不包含中间证书，则服务器证书颁发者的证书应存在于 ssl_trusted_certificate 文件中。

为了解析 OCSP 响应者主机名，还应指定 resolver 指令。

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

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

覆盖证书扩展字段“授权信息访问”中指定的 OCSP 响应者 URL。

仅支持“http://”OCSP 响应者

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

ssl_stapling_verify off;

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

为了使验证生效，应使用 ssl_trusted_certificate 指令将服务器证书颁发者的证书、根证书和所有中间证书配置为可信。

指定一个file，其中包含 PEM 格式的可信 CA 证书，用于验证客户端证书以及在启用ssl_stapling 时验证 OCSP 响应。

与通过 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 格式客户端证书，除第一行外，每行前面都带有 tab 字符 (1.11.8)；

$ssl_client_fingerprint

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

$ssl_client_i_dn

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

$ssl_client_raw_cert

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

$ssl_client_s_dn

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