模块 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 中删除。应该使用 listenssl指令的参数来代替。

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

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

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 来代替(1.7.9)，后者使用 OpenSSL 引擎file指定的密钥加载密钥。 idname

可以指定值 data:$variable 来代替file(1.15.10)，后者从变量加载密钥而不使用中间文件。请注意，不当使用此语法可能会产生安全隐患，例如将密钥数据写入 错误日志。

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

ssl_ciphers HIGH:!aNULL:!MD5;

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

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

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

以前版本的 nginx 默认 使用不同的密码。

指定file具有 PE​​M 格式的可信 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 可能会导致意外行为。

指定filePEM 格式的已撤销证书 (CRL)，用于验证 客户端证书。

指定fileDHE 密码的 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;

curve为 ECDHE 密码 指定 a 。

使用 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 响应程序主机名，还应指定 解析器指令。

例子：

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仅当使用 OpenSSL 1.1.1 或更高版本时，参数 (1.13.0) 才有效 。

TLSv1.3从 1.23.4 开始默认使用 该参数。

ssl_reject_handshake off;

如果启用，服务器块中的 SSL 握手将被拒绝。

例如，在以下配置中，服务器名称不是的 SSL 握手example.com将被拒绝：

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 MB 可以存储大约 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 响应程序主机名的解析，还应指定 解析器指令。

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

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

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

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

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

ssl_stapling_verify off;

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

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

指定file具有 PE​​M 格式的可信 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

返回 ALPN 在 SSL 握手期间选择的协议，否则返回空字符串 (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 (1.11.6) 返回已建立 SSL 连接的客户端证书的“颁发者 DN”字符串；

$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 (1.11.6) 返回已建立的 SSL 连接的客户端证书的“主题 DN”字符串；

$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

1如果使用 TLS 1.3早期数据且握手未完成，则 返回“ ”，否则返回“” (1.15.3)。

$ssl_protocol

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

$ssl_server_name

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

$ssl_session_id

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

$ssl_session_reused

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