Module ngx_stream_ssl_module

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

Example Configuration

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

将worker processes的数量设置为等于处理器的数量，
启用shared会话缓存，
禁用built-in会话缓存，
并可能增加会话lifetime(默认情况下为 5 分钟)：

worker_processes auto;

stream {

    ...

    server {
        listen              12345 ssl;

        ssl_protocols       TLSv1 TLSv1.1 TLSv1.2;
        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;

        ...
    }

Directives

Syntax:	`ssl_certificate file;`
Default:	—
Context:	`stream` , `server`

使用给定服务器的 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;

    ...
}

Note

仅 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)，后者从变量加载证书而不使用中间文件。请注意，对此语法的不当使用可能会带来安全隐患，例如将密钥数据写入error log。

Syntax:	`ssl_certificate_key file;`
Default:	—
Context:	`stream` , `server`

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

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

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

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

Syntax:	`ssl_ciphers ciphers;`
Default:	`ssl_ciphers HIGH:!aNULL:!MD5;`
Context:	`stream` , `server`

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

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

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

Syntax:	`ssl_client_certificate file;`
Default:	—
Context:	`stream` , `server`

该指令出现在 1.11.8 版本中。

使用用于verify客户端证书的 PEM 格式指定file具有受信任的 CA 证书。

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

Syntax:	`ssl_crl file;`
Default:	—
Context:	`stream` , `server`

该指令出现在 1.11.8 版本中。

使用用于verify客户端证书的 PEM 格式指定file带有吊销证书(CRL)。

Syntax:	`ssl_dhparam file;`
Default:	—
Context:	`stream` , `server`

为 DHE 密码指定一个带有 DH 参数的file。

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

Note

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

Syntax:	`ssl_ecdh_curve curve;`
Default:	`ssl_ecdh_curve auto;`
Context:	`stream` , `server`

为 ECDHE 密码指定curve。

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

ssl_ecdh_curve prime256v1:secp384r1;

特殊值auto(1.11.0)指示 nginx 在使用 OpenSSL 1.0.2 或更高版本或prime256v1(对于较旧的版本)时使用 OpenSSL 库中内置的列表。

Note

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

Syntax:	`ssl_handshake_timeout time;`
Default:	`ssl_handshake_timeout 60s;`
Context:	`stream` , `server`

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

Syntax:	`ssl_password_file file;`
Default:	—
Context:	`stream` , `server`

指定一个带有secret keys密码短语的file，其中每个密码短语都在单独的行上指定。加载密钥时依次尝试使用密码短语。

Example:

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;
    }
}

Syntax:	`ssl_prefer_server_ciphers on \| off;`
Default:	`ssl_prefer_server_ciphers off;`
Context:	`stream` , `server`

指定当使用 SSLv3 和 TLS 协议时，服务器密码应优先于客户端密码。

Syntax:	`ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];`
Default:	`ssl_protocols TLSv1 TLSv1.1 TLSv1.2;`
Context:	`stream` , `server`

启用指定的协议。

Note

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

Note

TLSv1.3参数(1.13.0)仅在使用支持 TLSv1.3 的 OpenSSL 1.1.1 时有效。

Syntax:	`ssl_session_cache off \| none \| [builtin[:size]] [shared:name:size];`
Default:	`ssl_session_cache none;`
Context:	`stream` , `server`

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

off
- 严格禁止使用会话缓存：nginx 明确告知客户端不得重复使用会话。
none
- 禁止使用会话缓存：nginx 告诉客户端会话可以被重用，但实际上并没有在缓存中存储会话参数。

builtin

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

shared

所有工作进程之间共享的缓存。缓存大小以字节为单位；一兆字节可以存储大约 4000 个会话。每个共享缓存应具有任意名称。具有相同名称的缓存可以在多个服务器中使用。

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

Syntax:	`ssl_session_ticket_key file;`
Default:	—
Context:	`stream` , `server`

设置带有用于加密和解密 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 字节密钥)进行加密。

Syntax:	`ssl_session_tickets on \| off;`
Default:	`ssl_session_tickets on;`
Context:	`stream` , `server`

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

Syntax:	`ssl_session_timeout time;`
Default:	`ssl_session_timeout 5m;`
Context:	`stream` , `server`

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

Syntax:	`ssl_trusted_certificate file;`
Default:	—
Context:	`stream` , `server`

该指令出现在 1.11.8 版本中。

使用用于verify客户端证书的 PEM 格式指定file具有受信任的 CA 证书。

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

Syntax:	`ssl_verify_client on \| off \| optional \| optional_no_ca;`
Default:	`ssl_verify_client off;`
Context:	`stream` , `server`

该指令出现在 1.11.8 版本中。

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

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

optional_no_ca参数请求客户端证书，但不需要由受信任的 CA 证书对其进行签名。这用于在 nginx 外部的服务执行实际证书验证的情况下使用。证书的内容可通过$ssl_client_cert变量访问。

Syntax:	`ssl_verify_depth number;`
Default:	`ssl_verify_depth 1;`
Context:	`stream` , `server`

该指令出现在 1.11.8 版本中。

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

Embedded Variables

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

$ssl_cipher

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

$ssl_ciphers

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

AES128-SHA:AES256-SHA:0x00ff

Note

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

$ssl_client_cert

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

$ssl_client_fingerprint

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

$ssl_client_i_dn

返回根据RFC 2253(1.11.8)构建的 SSL 连接的客户端证书的“发行人 DN”字符串；

$ssl_client_raw_cert

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

$ssl_client_s_dn

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

$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_curves

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

0x001d:prime256v1:secp521r1:secp384r1

Note

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

Note

该变量仅适用于新会话。

$ssl_protocol

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

$ssl_server_name

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

$ssl_session_id

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

$ssl_session_reused

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

Name	Nginx 中文文档
Version
Language
Badge
Last Updated	2021-07-07T12:48:29