模块 ngx_mail_ssl_module
模块 ngx_mail_ssl_module
提供了与 SSL/TLS 协议配合工作的邮件代理服务器所需的支持。
此模块不是默认构建的,应该使用 --with-mail_ssl_module
配置参数启用它。
此模块需要 OpenSSL 库。
示例配置
为了减轻处理器负载,建议:
- 将 worker processes 的数量设置为处理器的数量,
- 启用 共享 会话缓存,
- 禁用 内置 会话缓存,
- 可能增加会话 生存期(默认为 5 分钟):
worker_processes auto; mail { ... server { listen 993 ssl; 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 |
---|---|
默认: |
ssl off; |
上下文: | mail , server |
此指令在版本 1.15.0 中已废弃,并在版本 1.25.1 中被移除。应改用 listen 指令的 ssl
参数。
语法: | ssl_certificate |
---|---|
默认: | — |
上下文: | mail , server |
指定给定服务器的 PEM 格式证书文件。如果除了主证书之外还应指定中间证书,则应按照以下顺序在同一文件中指定:首先是主证书,然后是中间证书。秘密密钥也可以放置在同一文件中。
自版本 1.11.0 起,可以多次指定此指令以加载不同类型的证书,例如 RSA 和 ECDSA:
server { listen 993 ssl; 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 或更高版本支持为不同证书加载单独的证书链。在旧版本中,只能使用一个证书链。
可以指定值 data
:certificate
替代 file
(1.15.10 版本),这将加载证书而无需使用中间文件。请注意,不当使用此语法可能会产生安全隐患,例如将秘密密钥数据写入 错误日志。
语法: | ssl_certificate_key |
---|---|
默认值: | — |
上下文: | mail , server |
指定给定服务器的 PEM 格式秘密密钥文件。
可以指定值 engine
:name
:id
替代 file
(1.7.9 版本),这将从 OpenSSL 引擎 name
加载具有指定 id
的秘密密钥。
可以指定值 data
:key
替代 file
(1.15.10 版本),这将加载秘密密钥而无需使用中间文件。请注意,不当使用此语法可能会产生安全隐患,例如将秘密密钥数据写入 错误日志。
语法: | ssl_ciphers |
---|---|
默认值: |
ssl_ciphers HIGH:!aNULL:!MD5; |
上下文: | mail , server |
指定已启用的密码套件。密码套件的格式由 OpenSSL 库理解,例如:
ssl_ciphers ALL:!aNULL:!EXPORT56:RC4+RSA:+HIGH:+MEDIUM:+LOW:+SSLv2:+EXP;
可以使用 “openssl ciphers
” 命令查看完整列表。
nginx 的旧版本默认使用了不同的密码套件。
语法: | ssl_client_certificate |
---|---|
默认值: | — |
上下文: | mail , server |
此指令出现在版本 1.7.11 中。
指定用于验证客户端证书的 PEM 格式信任的 CA 证书文件。
证书列表将发送给客户端。如果不希望这样做,可以使用 ssl_trusted_certificate 指令。
语法: | ssl_conf_command |
---|---|
默认: | — |
上下文: | mail , 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 |
---|---|
默认: | — |
上下文: | mail , server |
此指令出现在版本1.7.11中。
指定用于验证客户端证书的 PEM 格式撤销证书 (CRL) file
。
语法: | ssl_dhparam |
---|---|
默认: | — |
上下文: | mail , server |
此指令出现在版本0.7.2中。
指定用于 DHE 密码的 DH 参数文件file
。
默认情况下未设置任何参数,因此不会使用 DHE 密码。
在版本1.11.0之前,默认情况下使用内置参数。
语法: | ssl_ecdh_curve |
---|---|
默认: |
ssl_ecdh_curve auto; |
上下文: | mail , server |
此指令出现在版本1.1.0和1.0.6中。
指定用于 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_password_file |
---|---|
默认: | — |
上下文: | mail , server |
此指令出现在版本1.7.3中。
指定一个包含密钥密码的file
,其中每个密码在单独的一行上指定。在加载密钥时,逐个尝试密码。
示例:
mail { ssl_password_file /etc/keys/global.pass; ... server { server_name mail1.example.com; ssl_certificate_key /etc/keys/first.key; } server { server_name mail2.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 off; |
上下文: | mail , server |
指定在使用SSLv3和TLS协议时,应优先使用服务器密码。
语法: | ssl_protocols [ |
---|---|
默认: |
ssl_protocols TLSv1 TLSv1.1 TLSv1.2 TLSv1.3; |
上下文: | mail , 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_session_cache |
---|---|
默认: |
ssl_session_cache none; |
上下文: | mail , server |
设置存储会话参数的缓存类型和大小。缓存可以是以下任何一种类型:
-
off
- 严格禁止使用会话缓存:nginx明确告诉客户端不得重用会话。
-
none
- 轻轻地不允许使用会话缓存:nginx告诉客户端可以重用会话,但实际上不会将会话参数存储在缓存中。
-
builtin
- 内置于OpenSSL中的缓存;仅由一个工作进程使用。缓存大小以会话为单位指定。如果未指定大小,则默认为20480个会话。使用内置缓存可能会导致内存碎片化。
- 在所有工作进程之间共享的缓存。缓存大小以字节为单位指定;一兆字节可以存储约4000个会话。每个共享缓存都应具有任意名称。可以在多个服务器中使用具有相同名称的缓存。它还用于自动生成、存储和定期轮换TLS会话票据密钥(1.23.2),除非使用ssl_session_ticket_key指令进行显式配置。
两种缓存类型可以同时使用,例如:
ssl_session_cache builtin:1000 shared:SSL:10m;
但仅使用共享缓存而不使用内置缓存应更有效。
语法: | ssl_session_ticket_key |
---|---|
默认: | — |
上下文: | mail , server |
此指令出现在版本 1.5.7 中。
设置用于加密和解密 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 |
---|---|
默认: |
ssl_session_tickets on; |
上下文: | mail , server |
此指令出现在版本 1.5.9 中。
启用或禁用通过 TLS 会话票据 进行会话恢复。
语法: | ssl_session_timeout |
---|---|
默认: |
ssl_session_timeout 5m; |
上下文: | mail , server |
指定客户端可以重用会话参数的时间。
语法: | ssl_trusted_certificate |
---|---|
默认: | — |
上下文: | mail , server |
此指令出现在版本 1.7.11 中。
指定用于 验证 客户端证书的 PEM 格式的受信任 CA 证书的 file
。
与由 ssl_client_certificate 设置的证书不同,这些证书的列表不会发送给客户端。
语法: | ssl_verify_client |
---|---|
默认: |
ssl_verify_client off; |
上下文: | mail , server |
此指令出现在版本 1.7.11 中。
启用客户端证书的验证。验证结果在 认证 请求的 “Auth-SSL-Verify” 标头中传递。
参数 optional
请求客户端证书并在证书存在时验证它。
可选参数 optional_no_ca
请求客户端证书,但不要求其由受信任的 CA 证书签名。这用于在外部于 nginx 执行实际证书验证的情况下使用。证书的内容可通过发送至认证服务器的请求进行访问。
语法: | ssl_verify_depth |
---|---|
默认值: |
ssl_verify_depth 1; |
上下文: | mail , server |
此指令出现在版本 1.7.11 中。
设置客户端证书链中的验证深度。
语法: | starttls |
---|---|
默认值: |
starttls off; |
上下文: | mail , server |
-
on
-
允许使用 POP3 的
STLS
命令和 IMAP 和 SMTP 的STARTTLS
命令; -
off
-
拒绝使用
STLS
和STARTTLS
命令; -
only
- 要求预备的 TLS 过渡。