模块 ngx_mail_ssl_module

示例配置
指令
     ssl
     ssl_certificate
     ssl_certificate_key
     ssl_ciphers
     ssl_client_certificate
     ssl_conf_command
     ssl_crl
     ssl_dhparam
     ssl_ecdh_curve
     ssl_password_file
     ssl_prefer_server_ciphers
     ssl_protocols
     ssl_session_cache
     ssl_session_ticket_key
     ssl_session_tickets
     ssl_session_timeout
     ssl_trusted_certificate
     ssl_verify_client
     ssl_verify_depth
     starttls

ngx_mail_ssl_module 模块为邮件代理服务器提供与 SSL/TLS 协议配合使用所需的必要支持。

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

此模块需要 OpenSSL 库。

示例配置

为了降低处理器负载,建议

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 on | off;
默认值
ssl off;
上下文 mail, server

此指令在 1.15.0 版本中已弃用,并在 1.25.1 版本中已删除。应改用 listen 指令的 ssl 参数。

语法 ssl_certificate file;
默认值
上下文 mail, server

指定一个 file,其中包含给定服务器的 PEM 格式证书。如果除了主证书之外还应指定中间证书,则应按以下顺序在同一文件中指定它们:首先是主证书,然后是中间证书。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:名称:id,而不是 文件 (1.7.9),它从 OpenSSL 引擎 名称 中加载具有指定 id 的密钥。

可以指定值 data:密钥,而不是 文件 (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),用于验证客户端证书。

语法 ssl_dhparam 文件;
默认值
上下文 mail, server

此指令出现在版本 0.7.2 中。

指定一个包含 DHE 密码的 DH 参数的文件

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

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

语法 ssl_ecdh_curve 曲线;
默认值
ssl_ecdh_curve auto;
上下文 mail, 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_password_file 文件;
默认值
上下文 mail, server

此指令出现在版本 1.7.3 中。

指定一个包含密钥密码的文件,其中每个密码都在单独一行上指定。加载密钥时会依次尝试密码。

示例

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 on | off;
默认值
ssl_prefer_server_ciphers off;
上下文 mail, server

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

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

启用指定的协议。

TLSv1.1TLSv1.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 off | none | [builtin[:大小]] [shared:名称:大小];
默认值
ssl_session_cache none;
上下文 mail, server

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

off
严格禁止使用会话缓存:nginx 明确告诉客户端不能重用会话。
none
轻度禁止使用会话缓存:nginx 告诉客户端可以重用会话,但实际上不会将会话参数存储在缓存中。
builtin
OpenSSL 中内置的缓存;仅由一个工作进程使用。缓存大小以会话数指定。如果未指定大小,则等于 20480 个会话。使用内置缓存可能会导致内存碎片化。
shared
所有工作进程共享的缓存。缓存大小以字节指定;一兆字节可以存储大约 4000 个会话。每个共享缓存都应该有一个任意名称。可以在多台服务器中使用具有相同名称的缓存。它还用于自动生成、存储和定期轮换 TLS 会话票证密钥 (1.23.2),除非使用 ssl_session_ticket_key 指令显式配置。

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

ssl_session_cache builtin:1000 shared:SSL:10m;

但是,仅使用共享缓存而不使用内置缓存应该更高效。

语法 ssl_session_ticket_key file;
默认值
上下文 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 on | off;
默认值
ssl_session_tickets on;
上下文 mail, server

此指令出现在 1.5.9 版中。

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

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

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

语法 ssl_trusted_certificate file;
默认值
上下文 mail, server

此指令出现在 1.7.11 版本中。

指定一个文件,其中包含 PEM 格式的可信 CA 证书,用于验证客户端证书。

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

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

此指令出现在 1.7.11 版本中。

启用对客户端证书的验证。验证结果将传递在 身份验证 请求的“Auth-SSL-Verify”标头中。

optional 参数请求客户端证书,并在证书存在时验证证书。

optional_no_ca 参数请求客户端证书,但不要求受信任的 CA 证书对其进行签名。当 nginx 外部服务执行实际证书验证时,此参数旨在用于此类情况。可以通过 发送 到身份验证服务器的请求访问证书内容。

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

此指令出现在 1.7.11 版本中。

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

语法 starttls on | off | only;
默认值
starttls off;
上下文 mail, server

on
允许对 POP3 使用 STLS 命令,对 IMAP 和 SMTP 使用 STARTTLS 命令;
off
禁止使用 STLSSTARTTLS 命令;
only
要求进行初步 TLS 过渡。