模块 ngx_http_ssl_module

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

此模块默认不编译，应使用 —with-http_ssl_module 配置参数启用它。

此模块需要 OpenSSL 库。

为了减少处理器负载，建议执行以下操作：

• 将 工作进程 数设置为等于处理器数量，
• 启用 keep-alive 连接，
• 启用 共享 session 缓存，
• 禁用 内置 session 缓存，
• 并可能增加 session 生命周期（默认为 5 分钟）

worker_processes auto;

http {

    ...

    server {
        listen              443 ssl;
        keepalive_timeout   70;

        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;

        ...
    }

ssl off;

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

ssl_buffer_size 16k;

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

默认情况下，缓冲区大小为 16k，这在发送大响应时开销最小。为了最小化 Time To First Byte，使用较小的值可能更有益，例如

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），这会在不使用中间文件的情况下从变量加载证书。请注意，不当使用此语法可能会带来安全隐患，例如将秘密密钥数据写入 错误日志。

需要注意，由于 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;

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

指定启用的加密算法（ciphers）。加密算法采用 OpenSSL 库能理解的格式，例如

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

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

之前版本的 nginx 默认使用不同的加密算法。

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

启用或禁用 TLS 1.3 early data。

early data 中发送的请求容易受到重放攻击。为了在应用层防御此类攻击，应使用 $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;

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

off 参数禁止使用缓存。

覆盖“授权信息访问 (Authority Information Access)”证书扩展中指定的 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 协议时，应优先使用服务器的加密算法（ciphers）而非客户端的加密算法。

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

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

off

严格禁止使用 session 缓存：nginx 明确告知客户端 session 可能无法重用。

none

柔和地禁止使用 session 缓存：nginx 告知客户端 session 可以重用，但实际上并不在缓存中存储 session 参数。

builtin

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

shared

所有工作进程共享的缓存。缓存大小以字节指定；一兆字节可存储约 4000 个 session。每个共享缓存应具有任意名称。同名缓存可在多个虚拟服务器中使用。除非使用 ssl_session_ticket_key 指令显式配置，否则它也用于自动生成、存储和定期轮换 TLS session ticket 密钥（1.23.2）。

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

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

如果指定了多个密钥，只有第一个密钥用于加密 TLS session ticket。这允许配置密钥轮换，例如

ssl_session_ticket_key current.key;
ssl_session_ticket_key previous.key;

文件必须包含 80 或 48 字节的随机数据，可以使用以下命令创建

openssl rand 80 > ticket.key

根据文件大小，加密使用 AES256（用于 80 字节密钥，1.11.8）或 AES128（用于 48 字节密钥）。

ssl_session_tickets on;

启用或禁用通过 TLS session tickets 进行的 session 恢复。

ssl_session_timeout 5m;

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

ssl_stapling off;

启用或禁用服务器对 OCSP 响应的 stapling。示例

ssl_stapling on;
resolver 192.0.2.1;

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

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

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

文件应为 DER 格式，如通过 “openssl ocsp” 命令生成的那样。

覆盖“授权信息访问 (Authority Information Access)”证书扩展中指定的 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 参数（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 或更高版本时完全支持此变量。对于旧版本，此变量仅对新 session 可用，且仅列出已知加密算法。

$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 (issuer DN)”字符串（1.11.6）；

$ssl_client_i_dn_legacy

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

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

$ssl_client_raw_cert

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

$ssl_client_s_dn

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

$ssl_client_s_dn_legacy

返回已建立 SSL 连接的客户端证书的“主体 DN (subject 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 或更高版本时支持此变量。对于旧版本，此变量的值将为空字符串。

该变量仅对新 session 可用。

$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 连接的 session 标识符；

$ssl_session_reused

如果 SSL session 被重用，则返回“r”，否则返回“.”（1.5.11）。