模块 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;

为给定的虚拟服务器指定包含 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;

    ...
}

只有 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 默认使用不同的密码。

指定一个 file，其中包含 PEM 格式的可信 CA 证书，用于验证客户端证书和 OCSP 响应（如果启用了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 可能会导致意外行为。

指定一个 file，其中包含用于 验证客户端证书的 PEM 格式的已吊销证书 (CRL)。

指定一个 file，其中包含 DHE 密码的 DH 参数。

默认情况下，不设置任何参数，因此不会使用 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_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;

启用指定的协议。

如果在服务器级别指定该指令，则可以使用来自默认服务器的值。有关详细信息，请参阅“虚拟服务器选择”部分。

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;

如果启用，将在服务器块中拒绝 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 告诉客户端可以重用会话，但实际上不会将会话参数存储在缓存中。

内置

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

共享

所有工作进程之间共享的缓存。缓存大小以字节指定；一兆字节可存储约 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 响应，而不是查询服务器证书中指定的 OCSP 响应器。

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

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

仅支持“http://”OCSP 应答器

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

ssl_stapling_verify off;

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

要使验证正常工作，服务器证书颁发者的证书、根证书和所有中间证书都应使用 ssl_trusted_certificate 指令配置为受信任的。

指定一个 file，其中包含 PEM 格式的可信 CA 证书，用于验证客户端证书和 OCSP 响应（如果启用了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 格式客户端证书 (urlencoded) (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)。