ngx_http_ssl_module 模块

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

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

此模块需要 OpenSSL 库。

示例配置

为了减少处理器负载,给出如下建议:

  • 设置工作进程的数量等于处理器的数量

  • 启用保持活动(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;
        ...
    }
}

指令

ssl 指令

语 法:ssl on | off;
默认值:ssl off;
上下文:http, server

该指令在 1.15.0 版中已过时。 应改用 listen 指令的 ssl 参数。

ssl_buffer_size 指令

语 法:ssl_buffer_size size;
默认值:ssl_buffer_size 16k;
上下文:http, server

该指令出现在 1.5.9 版中。

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

默认情况下,缓冲区大小为 16k,这对应于发送大响应时的最小开销。 要最小化第一个字节的时间,使用较小的值可能会有所帮助,例如:

ssl_buffer_size 4k;

ssl_certificate 指令

语 法:ssl_certificate file;
默认值:—
上下文:http, server

为给定的虚拟服务器指定一个带有 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 或更高版本时,可以在文件名中使用变量:

ssl_certificate     $ssl_server_name.crt;
ssl_certificate_key $ssl_server_name.key;

请注意,使用变量意味着将为每次 SSL 握手加载证书,这可能会对性能产生负面影响。

可以指定值 data:$variable 而不是文件 (1.15.10),它从变量加载证书而不使用中间文件。 请注意,此语法的不当使用可能会带来安全隐患,例如将密钥数据写入错误日志。

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

ssl_certificate_key 指令

语 法:ssl_certificate_key file;
默认值:—
上下文:http, server

为给定的虚拟服务器指定一个带有 PEM 格式的密钥的文件。

可以指定值 engine:name:id 而不是文件 (1.7.9),它从 OpenSSL 引擎名称加载具有指定 id 的密钥。

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

从 1.15.9 版开始,使用 OpenSSL 1.0.2 或更高版本时,可以在文件名中使用变量。

ssl_ciphers 指令

语 法:ssl_ciphers ciphers;
默认值:ssl_ciphers HIGH:!aNULL:!MD5;
上下文:http, server

指定启用的密码。密码以 OpenSSL 库理解的格式指定,例如:

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

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

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

ssl_client_certificate 指令

语 法:ssl_client_certificate file;
默认值:—
上下文:http, server

如果启用了 ssl_stapling,则指定具有 PEM 格式的可信 CA 证书的文件,用于验证客户端证书和 OCSP 响应。

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

ssl_conf_command 指令

语 法:ssl_conf_command command;
默认值:—
上下文:http, server

该指令出现在 1.19.4 版中。

设置任意 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 可能会导致意外行为。

ssl_crl 指令

语 法:ssl_crl file;
默认值:—
上下文:http, server

该指令出现在 0.8.7 版本中。

指定带有用于验证客户端证书的 PEM 格式的吊销证书 (CRL) 的文件。

ssl_dhparam 指令

语 法:ssl_dhparam file;
默认值:—
上下文:http, server

该指令出现在 0.7.2 版本中。

为 DHE 密码指定带有 DH 参数的文件。

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

在 1.11.0 版本之前,默认使用内置参数。

ssl_early_data 指令

语 法:ssl_early_data on | off;
默认值:ssl_early_data off;
上下文:http, server

该指令出现在 1.15.3 版中。

启用或禁用 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 指令

语 法:ssl_ecdh_curve curve;
默认值:ssl_ecdh_curve auto;
上下文:http, server

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

指定 ECDHE 密码的曲线。

使用 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 指令

语 法:ssl_ocsp on | off | leaf;
默认值:ssl_ocsp off;
上下文:http, server

该指令出现在 1.19.0 版中。

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

要使 OCSP 验证工作,ssl_verify_client 指令应设置为 on 或可选。

要解析 OCSP 响应者主机名,还应指定解析器指令。

例子:

ssl_verify_client on;
ssl_ocsp          on;
resolver          192.0.2.1;

ssl_ocsp_cache 指令

语 法:ssl_ocsp_cache off | [shared:name:size];
默认值:ssl_ocsp_cache off;
上下文:http, server

该指令出现在 1.19.0 版中。

设置用于存储 OCSP 验证的客户端证书状态的缓存的名称和大小。缓存在所有工作进程之间共享。同名缓存可用于多个虚拟服务器。

off 参数禁止使用缓存。

ssl_ocsp_responder 指令

语 法:ssl_ocsp_responder url;
默认值:—
上下文:http, server

该指令出现在 1.19.0 版中。

覆盖 “权威信息访问(Authority Information Access)” 证书扩展中指定的 OCSP 响应程序的 URL,以验证客户端证书。

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

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

ssl_password_file 指令

语 法:ssl_password_file file;
默认值:—
上下文:http, server

该指令出现在 1.7.3 版中。

指定一个带有密钥密码的文件,其中每个密码都在单独的行中指定。加载密钥时依次尝试密码短语。

例子:

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 指令

语 法:ssl_prefer_server_ciphers on | off;
默认值:ssl_prefer_server_ciphers off;
上下文:http, server

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

ssl_protocols 指令

语 法:ssl_protocols [SSLv2] [SSLv3] [TLSv1] [TLSv1.1] [TLSv1.2] [TLSv1.3];
默认值:ssl_protocols TLSv1 TLSv1.1 TLSv1.2;
上下文:http, server

启用指定的协议。

TLSv1.1 和 TLSv1.2 参数(1.1.13、1.0.12)仅在使用 OpenSSL 1.0.1 或更高版本时有效。

TLSv1.3 参数 (1.13.0) 仅在使用 OpenSSL 1.1.1 或更高版本时有效。

ssl_reject_handshake 指令

语 法:ssl_reject_handshake on | off;
默认值:ssl_reject_handshake off;
上下文:http, server

该指令出现在 1.19.4 版中。

如果启用,服务器块中的 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 指令

语 法:ssl_session_cache off | none | [builtin[:size]] [shared:name:size];
默认值:ssl_session_cache none;
上下文:http, server

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

  • off

严格禁止使用会话缓存:nginx 明确告诉客户端会话不能被重用。

  • none

不允许使用会话缓存:nginx 告诉客户端会话可以被重用,但实际上并不在缓存中存储会话参数。

  • builtin

一个内置于 OpenSSL 的缓存; 仅由一个工作进程使用。 缓存大小在会话中指定。 如果未给出大小,则等于 20480 个会话。 使用内置缓存可能会导致内存碎片。

  • shared

在所有工作进程之间共享的缓存。 缓存大小以字节为单位; 一兆字节可以存储大约 4000 个会话。 每个共享缓存都应该有一个任意名称。 同名缓存可用于多个虚拟服务器。

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

ssl_session_cache builtin:1000 shared:SSL:10m;

但是只使用没有内置缓存的共享缓存应该会更有效率。

ssl_session_ticket_key 指令

语 法:ssl_session_ticket_key file;
默认值:—
上下文:http, server

该指令出现在 1.5.7 版中。

使用用于加密和解密 TLS 会话票证的密钥设置文件。如果必须在多个服务器之间共享相同的密钥,则该指令是必需的。默认情况下,使用随机生成的密钥。

如果指定了多个密钥,则仅使用第一个密钥来加密 TLS 会话票证。 这允许配置密钥轮换,例如:

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 指令

语 法:ssl_session_tickets on | off;
默认值:ssl_session_tickets on;
上下文:http, server

该指令出现在 1.5.9 版中。

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

ssl_session_timeout 指令

语 法:ssl_session_timeout time;
默认值:ssl_session_timeout 5m;
上下文:http, server

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

ssl_stapling 指令

语 法:ssl_stapling on | off;
默认值:ssl_stapling off;
上下文:http, server

该指令出现在 1.3.7 版中。

启用或禁用服务器对 OCSP 响应的装订。例子:

ssl_stapling on;
resolver 192.0.2.1;

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

对于 OCSP 响应者主机名的解析,还应指定解析器指令。

ssl_stapling_file 指令

语 法:ssl_stapling_file file;
默认值:—
上下文:http, server

该指令出现在 1.3.7 版中。

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

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

ssl_stapling_responder 指令

语 法:ssl_stapling_responder url;
默认值:—
上下文:http, server

该指令出现在 1.3.7 版中。

覆盖 “权威信息访问(Authority Information Access)” 证书扩展中指定的 OCSP 响应者的 URL。

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

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

ssl_stapling_verify 指令

语 法:ssl_stapling_verify on | off;
默认值:ssl_stapling_verify off;
上下文:http, server

该指令出现在 1.3.7 版中。

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

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

ssl_trusted_certificate 指令

语 法:ssl_trusted_certificate file;
默认值:—
上下文:http, server

该指令出现在 1.3.7 版中。

如果启用了 ssl_stapling,则指定具有 PEM 格式的可信 CA 证书的文件,用于验证客户端证书和 OCSP 响应。

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

ssl_verify_client 指令

语 法:ssl_verify_client on | off | optional | optional_no_ca;
默认值:ssl_verify_client off;
上下文:http, server

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

可选参数 (0.8.7+) 请求客户端证书并验证证书是否存在。

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

ssl_verify_depth 指令

语 法:ssl_verify_depth number;
默认值:ssl_verify_depth 1;
上下文:http, server

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

错误处理

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 连接 (1.13.5) 返回 PEM 格式(urlencoded)的客户端证书;

$ssl_client_cert

为已建立的 SSL 连接返回 PEM 格式的客户端证书,除第一行之外的每一行都带有制表符; 这旨在用于 proxy_set_header 指令;

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

$ssl_client_fingerprint

为已建立的 SSL 连接(1.7.1)返回客户端证书的 SHA1 指纹;

$ssl_client_i_dn

根据 RFC 2253 (1.11.6) 为已建立的 SSL 连接返回客户端证书的 “issuer DN” 字符串;

$ssl_client_i_dn_legacy

为已建立的 SSL 连接返回客户端证书的 “issuer DN” 字符串;

在 1.11.6 版本之前,变量名称是 $ssl_client_i_dn。

$ssl_client_raw_cert

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

$ssl_client_s_dn

根据 RFC 2253 (1.11.6) 为已建立的 SSL 连接返回客户端证书的 “subject DN” 字符串;

$ssl_client_s_dn_legacy

为已建立的 SSL 连接返回客户端证书的 “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” 结果不包含原因字符串。

$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)。

说说我的看法
全部评论(
没有评论
关于
本网站专注于 Java、数据库(MySQL、Oracle)、Linux、软件架构及大数据等多领域技术知识分享。涵盖丰富的原创与精选技术文章,助力技术传播与交流。无论是技术新手渴望入门,还是资深开发者寻求进阶,这里都能为您提供深度见解与实用经验,让复杂编码变得轻松易懂,携手共赴技术提升新高度。如有侵权,请来信告知:hxstrive@outlook.com
公众号