Module ngx_http_ssl_module

ngx_http_ssl_module模块为 HTTPS 提供必要的支持。

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

Note

此模块需要OpenSSL库。

Example Configuration

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

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

worker_processes auto;

http {

    ...

    server {
        listen              443 ssl;
        keepalive_timeout   70;

        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 on \| off;`
Default:	`ssl off;`
Context:	`http` , `server`

该指令在版本 1.15.0 中已作废。应该改为使用listen指令的ssl参数。

Syntax:	`ssl_buffer_size size;`
Default:	`ssl_buffer_size 16k;`
Context:	`http` , `server`

该指令出现在 1.5.9 版中。

设置用于发送数据的缓冲区的大小。

默认情况下，缓冲区大小为 16k，这对应于发送大响应时的最小开销。为了最大程度地缩短到第一个字节的时间，使用较小的值可能是有益的，例如：

ssl_buffer_size 4k;

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

为给定的虚拟服务器使用 PEM 格式的证书指定file。如果除主要证书之外还应指定中间证书，则应按以下顺序在同一文件中指定它们：首先是主要证书，然后是中间证书。 PEM 格式的密钥可以放置在同一文件中。

从 1.11.0 版开始，可以多次指定此伪指令以加载不同类型的证书，例如 RSA 和 ECDSA：

server {
    listen              443 ssl;
    server_name         example.com;

    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 或更高版本支持不同证书的单独certificate chains。对于较旧的版本，只能使用一个证书链。

从 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。

请记住，由于 HTTPS 协议对最大互操作性的限制，虚拟服务器应侦听不同的 IP 地址。

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

为给定的虚拟服务器使用 PEM 格式的密钥指定一个file。

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

可以指定值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:	`http` , `server`

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

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

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

Note

默认情况下，早期版本的 nginx 使用different密码。

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

如果启用了ssl_stapling，则以 PE 格式指定file并使用受信任的 CA 证书，用于verify客户端证书和 OCSP 响应。

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

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

该指令出现在版本 0.8.7 中。

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

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

该指令出现在版本 0.7.2 中。

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

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

Note

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

Syntax:	`ssl_early_data on \| off;`
Default:	`ssl_early_data off;`
Context:	`http` , `server`

该指令出现在 1.15.3 版中。

启用或禁用 TLS 1.3 early data。

Note

在早期数据内发送的请求必须遵守replay attacks。为了防止在应用程序层遭受此类攻击，应使用$ssl_early_data变量。

proxy_set_header Early-Data $ssl_early_data;

Note

使用 OpenSSL 1.1.1 或更高版本(1.15.4)和BoringSSL时支持该指令。

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

该指令出现在 1.1.0 和 1.0.6 版本中。

为 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_ocsp on \| off \| leaf;`
Default:	`ssl_ocsp off;`
Context:	`http` , `server`

该指令出现在 1.19.0 版中。

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

为了使 OCSP 验证有效，应将ssl_verify_client伪指令设置为on或optional。

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

Example:

ssl_verify_client on;
ssl_ocsp          on;
resolver          192.0.2.1;

Syntax:	`ssl_ocsp_cache off \| [shared:name:size];`
Default:	`ssl_ocsp_cache off;`
Context:	`http` , `server`

该指令出现在 1.19.0 版中。

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

off参数禁止使用缓存。

Syntax:	`ssl_ocsp_responder url;`
Default:	—
Context:	`http` , `server`

该指令出现在 1.19.0 版中。

覆盖在“ 授权信息访问”证书 extensions 中为validation客户端证书指定的 OCSP 响应程序的 URL。

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

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

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

该指令出现在版本 1.7.3 中。

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

Example:

http {
    ssl_password_file /etc/keys/global.pass;
    ...

    server {
        server_name www1.example.com;
        ssl_certificate_key /etc/keys/first.key;
    }

    server {
        server_name www2.example.com;

        # 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:	`http` , `server`

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

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

启用指定的协议。

Note

TLSv1.1和TLSv1.2参数(1.1.13、1.0.12)仅在使用 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:	`http` , `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:	`http` , `server`

该指令出现在 1.5.7 版中。

设置带有用于加密和解密 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:	`http` , `server`

该指令出现在 1.5.9 版中。

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

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

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

Syntax:	`ssl_stapling on \| off;`
Default:	`ssl_stapling off;`
Context:	`http` , `server`

该指令出现在版本 1.3.7 中。

由服务器启用或禁用装订 OCSP 响应。例：

ssl_stapling on;
resolver 192.0.2.1;

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

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

Syntax:	`ssl_stapling_file file;`
Default:	—
Context:	`http` , `server`

该指令出现在版本 1.3.7 中。

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

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

Syntax:	`ssl_stapling_responder url;`
Default:	—
Context:	`http` , `server`

该指令出现在版本 1.3.7 中。

覆盖在“ 授权信息访问”证书 extensions 中指定的 OCSP 响应程序的 URL。

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

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

Syntax:	`ssl_stapling_verify on \| off;`
Default:	`ssl_stapling_verify off;`
Context:	`http` , `server`

该指令出现在版本 1.3.7 中。

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

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

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

该指令出现在版本 1.3.7 中。

如果启用了ssl_stapling，则以 PE 格式指定file并使用受信任的 CA 证书，用于verify客户端证书和 OCSP 响应。

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

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

启用客户端证书的验证。验证结果存储在$ssl_client_verify变量中。

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

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

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

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

Error Processing

ngx_http_ssl_module模块支持几种非标准错误代码，可使用error_page伪指令用于重定向：

495
- 客户端证书验证期间发生错误；
496
- 客户未出示要求的证明；
497
- 常规请求已发送到 HTTPS 端口。

重定向在完全解析请求后发生，并且诸如$request_uri，$uri，$args之类的变量可用。

Embedded Variables

ngx_http_ssl_module模块支持嵌入式变量：

$ssl_cipher

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

$ssl_ciphers

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

AES128-SHA:AES256-SHA:0x00ff

Note

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

$ssl_client_escaped_cert

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

$ssl_client_cert

以 PEM 格式返回已构建的 SSL 连接的客户端证书，除第一行外，每行均以制表符开头。这旨在用于proxy_set_header指令中；

Note

不建议使用该变量，而应使用$ssl_client_escaped_cert变量。

$ssl_client_fingerprint

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

$ssl_client_i_dn

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

$ssl_client_i_dn_legacy

返回已构建的 SSL 连接的客户端证书的“发行人 DN”字符串；

Note

在 1.11.6 版之前，变量名称为$ssl_client_i_dn。

$ssl_client_raw_cert

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

$ssl_client_s_dn

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

$ssl_client_s_dn_legacy

返回已构建的 SSL 连接的客户端证书的“主题 DN”字符串；

Note

在 1.11.6 版之前，变量名称为$ssl_client_s_dn。

$ssl_client_serial

返回已构建的 SSL 连接的客户端证书的序列号；

$ssl_client_v_end

返回客户证书的结束日期(1.11.7)；

$ssl_client_v_remain

返回直到客户端证书过期的天数(1.11.7)；

$ssl_client_v_start

返回客户端证书的开始日期(1.11.7)；

$ssl_client_verify

如果没有证书，则返回客户端证书验证的结果：“ SUCCESS”，“ FAILED: reason”和“ NONE”；

Note

在 1.11.7 版之前，“ FAILED”结果不包含reason字符串。

$ssl_curves

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

0x001d:prime256v1:secp521r1:secp384r1

Note

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

Note

该变量仅适用于新会话。

$ssl_early_data

如果使用 TLS 1.3 early data并且握手未完成，则返回“ 1”，否则返回“”(1.15.3)。

$ssl_protocol

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

$ssl_server_name

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

$ssl_session_id

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

$ssl_session_reused

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

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