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.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

指定给定服务器 PEM 格式证书所在的 file 文件。如果除了主证书外还需要指定中间证书,则应按以下顺序在同一个文件中指定:主证书在前,然后是中间证书。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 (1.15.10) 代替 file,这可以在不使用中间文件的情况下加载证书。请注意,不当使用此语法可能会带来安全隐患,例如将私钥数据写入 错误日志 (error log)

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

指定给定服务器 PEM 格式私钥所在的 file 文件。

可以使用值 engine:name:id (1.7.9) 代替 file,这可以从 OpenSSL 引擎 name 中加载具有指定 id 的私钥。

可以使用值 data:key (1.15.10) 代替 file,这可以在不使用中间文件的情况下加载私钥。请注意,不当使用此语法可能会带来安全隐患,例如将私钥数据写入 错误日志 (error log)

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

指定启用的加密套件 (ciphers)。这些加密套件以 OpenSSL 库理解的格式指定,例如

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

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

旧版本的 nginx 默认使用 不同 的加密套件。

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

此指令在 1.7.11 版本中出现。

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

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

语法 ssl_conf_command name value;
默认值
上下文 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 file;
默认值
上下文 mail, server

此指令在 1.7.11 版本中出现。

指定一个 file 文件,其中包含用于 验证 客户端证书的 PEM 格式的吊销证书列表 (CRL)。

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

此指令在 0.7.2 版本中出现。

指定一个 file 文件,其中包含 DHE 加密套件的 DH 参数。

默认不设置任何参数,因此 DHE 加密套件将不会被使用。

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

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

此指令在 1.7.3 版本中出现。

指定一个 file 文件,其中包含 私钥 的密码短语 (passphrases),每个密码短语单独占一行。加载密钥时会依次尝试这些密码短语。

示例

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.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[:size]] [shared:name:size];
默认值
ssl_session_cache none;
上下文 mail, server

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

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

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

ssl_session_cache builtin:1000 shared:SSL:10m;

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

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

此指令在 1.5.7 版本中出现。

设置一个 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 | 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 版本中出现。

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

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

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

此指令在 1.7.11 版本中出现。

启用客户端证书验证。验证结果在 身份验证 (authentication) 请求的“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 转换。