模块 ngx_http_ssl_module

ngx_http_ssl_module 模块提供了 HTTPS 所需的支持。

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

此模块需要 OpenSSL 库。

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

• 将 工作进程数量设置为与处理器数量相同，
• 启用 保持活动连接，
• 启用 共享会话缓存，
• 禁用 内置会话缓存，
• 并可能增加会话 生存时间（默认为 5 分钟）。

worker_processes auto;

http {

    ...

    server {
        listen              443 ssl;
        keepalive_timeout   70;

        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;

        ...
    }

ssl off;

此指令在 1.15.0 版本中已弃用，并在 1.25.1 版本中删除。应改用 listen 指令的 ssl 参数。

ssl_buffer_size 16k;

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

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

ssl_buffer_size 4k;

指定包含给定虚拟服务器证书的 file，格式为 PEM。如果除了主证书之外还应指定中间证书，则应按以下顺序在同一文件中指定：主证书位于首位，然后是中间证书。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;

    ...
}

只有 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），它从变量中加载证书，而不使用中间文件。请注意，不当使用此语法可能会导致安全隐患，例如将密钥数据写入 错误日志。

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

指定包含给定虚拟服务器密钥的 file，格式为 PEM。

可以指定 engine:name:id 值而不是 file（1.7.9），它从指定的 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”命令查看完整列表。

nginx 的早期版本默认使用 不同的密码。

指定包含用于 验证客户端证书和 OCSP 响应的受信任 CA 证书的 file（格式为 PEM），如果启用了 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) 的 file（格式为 PEM）。

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

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

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

ssl_early_data off;

启用或禁用 TLS 1.3 早期数据。

在早期数据内发送的请求容易受到 重放攻击。为了在应用程序层防止此类攻击，应使用 $ssl_early_data 变量。

proxy_set_header Early-Data $ssl_early_data;

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

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 密钥的日志记录，并指定密钥日志文件的路径。密钥以与 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 验证的缓存的 name 和 size。缓存由所有工作进程共享。可以在多个虚拟服务器中使用名称相同的缓存。

off 参数禁止使用缓存。

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

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

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

指定包含 密钥密码的 file，每个密码都位于单独一行上。加载密钥时，将依次尝试密码。

示例

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

ssl_prefer_server_ciphers off;

指定在使用 SSLv3 和 TLS 协议时，应优先使用服务器密码而不是客户端密码。

ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3;

启用指定的协议。

如果指令在server级别指定，则可以使用默认服务器的值。详细信息在“虚拟服务器选择”部分提供。

TLSv1.1和TLSv1.2参数（1.1.13、1.0.12）仅在使用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

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

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

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

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指令配置为受信任的。

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

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

ssl_verify_client off;

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

optional参数（0.8.7+）请求客户端证书，如果存在则对其进行验证。

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

ssl_verify_depth 1;

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

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

495

客户端证书验证期间发生错误；

496

客户端未提供所需的证书；

497

已向HTTPS端口发送常规请求。

重定向发生在请求完全解析并且变量（如$request_uri、$uri、$args等）可用之后。

ngx_http_ssl_module模块支持嵌入变量

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

返回已建立的SSL连接的PEM格式（URL编码）的客户端证书（1.13.5）；

$ssl_client_cert

返回已建立的SSL连接的PEM格式的客户端证书，除了第一行外，每行前面都加上制表符；这用于proxy_set_header指令；

该变量已弃用，应改用$ssl_client_escaped_cert变量。

$ssl_client_fingerprint

返回已建立的SSL连接的客户端证书的SHA1指纹（1.7.1）；

$ssl_client_i_dn

根据RFC 2253返回已建立的SSL连接的客户端证书的“颁发者DN”字符串（1.11.6）；

$ssl_client_i_dn_legacy

返回已建立的SSL连接的客户端证书的“颁发者DN”字符串；

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

$ssl_client_raw_cert

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

$ssl_client_s_dn

根据RFC 2253返回已建立的SSL连接的客户端证书的“主体DN”字符串（1.11.6）；

$ssl_client_s_dn_legacy

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

在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”；

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

$ssl_curve

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

prime256v1

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

$ssl_curves

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

0x001d:prime256v1:secp521r1:secp384r1

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

该变量仅对新会话可用。

$ssl_early_data

如果使用TLS 1.3 早期数据并且握手未完成，则返回“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）。