邮件模块#

实现邮件代理:Angie 处理来自 IMAP、POP3 和 SMTP 客户端的连接,一旦外部身份验证服务器接受某个客户端并为其选定后端,就把该客户端的会话转发到该后端。本节的其他模块分别提供协议支持、与身份验证服务器的交互、SSL/TLS 以及代理设置。

当 从源代码构建 时,该模块默认不会被构建;必须通过 构建选项 --with-mail 启用它。

在来自 我们的软件仓库 的包和镜像中,该模块已包含在 构建中。

相关指南

工作原理#

Angie 位于邮件客户端和后端之间,分四步处理每个会话:

  1. 客户端连接的是 Angie,而不是后端。Angie 自己发送问候语、应答功能查询、执行 STARTTLS,并通过 imap_auth、pop3_auth 或 smtp_auth 指令所设方法之一接收客户端的凭据。

  2. Angie 将凭据放在 HTTP 请求头中,传给由 auth_http 指令设置的身份验证服务器。未经身份验证就发送邮件的 SMTP 客户端,会在发出 RCPT TO 命令后触发该请求。

  3. 身份验证服务器接受或拒绝该客户端。接受时,身份验证服务器在 Auth-Server 和 Auth-Port 响应头中返回后端的 IP 地址和端口,还可以返回用于登录后端的用户名和密码。

  4. Angie 与后端建立 TCP 连接(不使用 TLS),并代表客户端登录:IMAP 使用 LOGIN 命令,POP3 使用 USER 和 PASS 命令。对于 SMTP 后端,如果启用了 xclient 指令(默认即启用),Angie 会用 XCLIENT 命令传递客户端的信息;如果启用了 proxy_smtp_auth 指令,还会用 AUTH PLAIN 向后端进行身份验证。此后,Angie 在客户端和后端之间转发数据。

mail 块中没有 proxy_pass 或上游服务器组:Angie 只能从身份验证服务器的响应中得知该把会话代理到哪里。因此,mail 块中的每个 server 都需要 auth_http,哪怕它接受不经身份验证的 SMTP 邮件。请求头和响应头在 Auth HTTP 模块中说明。

配置示例#

最小配置把 IMAP 和 POP3 会话都代理到位于 192.0.2.10 的同一个后端。身份验证服务器是同一个 Angie 中的一个 location:它接受所有客户端,把密码检查留给后端,这种做法适合默认启用的明文登录方法。请将 mail 块放在 angie.conf 的顶层,将 map 和 server 块放在现有的 http 块内:

mail {
    auth_http                127.0.0.1:9000/mail-auth;
    proxy_pass_error_message on;

    server {
        listen   143;
        protocol imap;
    }

    server {
        listen   110;
        protocol pop3;
    }
}

http {
    map $http_auth_protocol $mail_backend_port {
        imap 143;
        pop3 110;
    }

    server {
        listen 127.0.0.1:9000;

        location = /mail-auth {
            add_header Auth-Status OK;
            add_header Auth-Server 192.0.2.10;
            add_header Auth-Port   $mail_backend_port;

            return 204;
        }
    }
}

由于密码由后端检查,因此启用了 proxy_pass_error_message:密码错误的客户端会收到后端的错误应答,而不是内部错误,随后 Angie 关闭连接。身份验证服务器收到的客户端密码是未加密的,所以它应监听本地地址或其他可信地址。

更完整的配置还代理 SMTP,并启用更多认证方法。该配置中的身份验证服务器(此处是一个 CGI 脚本)必须自行检查 APOP 和 CRAM-MD5 摘要,并在 Auth-Pass 中返回用户的密码,详见 Auth HTTP 模块:

worker_processes auto;

error_log /var/log/angie/error.log info;

events {
    worker_connections  1024;
}

mail {
    server_name       mail.example.com;
    auth_http         localhost:9000/cgi-bin/auth.cgi;

    imap_capabilities IMAP4rev1 UIDPLUS IDLE LITERAL+ QUOTA;

    pop3_auth         plain apop cram-md5;
    pop3_capabilities LAST TOP USER PIPELINING UIDL;

    smtp_auth         login plain cram-md5;
    smtp_capabilities "SIZE 10485760" ENHANCEDSTATUSCODES 8BITMIME DSN;
    xclient           off;

    server {
        listen   25;
        protocol smtp;
    }
    server {
        listen   110;
        protocol pop3;
        proxy_pass_error_message on;
    }
    server {
        listen   143;
        protocol imap;
    }
    server {
        listen   587;
        protocol smtp;
    }
}

指令#

error_log_user_tag#

Added in version 1.12.0.

语法

error_log_user_tag value;

默认值

—

上下文

mail, server

为服务器处理的每个会话的 error_log 记录附加一个标签。 与其 http 和 stream 对应指令不同, value 是静态字符串,不能包含变量。可以多次指定该指令以添加多个标签。 当且仅当当前级别上没有定义 error_log_user_tag 指令时, 这些指令才会从上一配置级别继承。

标签仅在使用 format=json 的 error_log 目标中以 tags 列表的形式出现;filter=tag: 在任何格式下都可以匹配它们。

listen#

语法

listen address[:port] [ssl] [proxy_protocol] [backlog=number] [rcvbuf=size] [sndbuf=size] [bind] [ipv6only=on | off] [multipath] [so_keepalive=on | off | [keepidle]:[keepintvl]:[keepcnt]];

默认值

—

上下文

server

设置服务器将接受连接的套接字的 address 和 port。可以只指定 port,Angie 将监听所有可用的 IPv4 接口(如果启用,还包括 IPv6)。address 也可以是主机名,例如:

listen 127.0.0.1:110;
listen *:110;
listen 110;     # 与 *:110 相同
listen localhost:110;

IPv6 地址用方括号指定:

listen [::1]:110;
listen [::]:110;

UNIX 域套接字使用 unix: 前缀指定:

listen unix:/var/run/angie.sock;

备注

不同的服务器必须监听不同的 address:port 对。

ssl

指定在此端口上接受的所有连接都应在 SSL 模式下工作。

proxy_protocol

指定在此端口上接受的所有连接都应使用 PROXY 协议。获取的信息将传递给 身份验证服务器,并可用于 更改客户端地址。

listen 指令可以有几个与套接字相关的系统调用特定的附加参数。

backlog=number

在 listen() 调用中设置 backlog 参数,该参数限制待处理连接队列的最大长度。默认情况下,在 FreeBSD、DragonFly BSD 和 macOS 上 backlog 设置为 -1,在其他平台上设置为 511。

rcvbuf=size

为监听套接字设置接收缓冲区大小(SO_RCVBUF 选项)。

sndbuf=size

为监听套接字设置发送缓冲区大小(SO_SNDBUF 选项)。

bind

为给定的 address:port 对单独调用 bind()。不带此参数时,如果多个 listen 指令共用同一端口但地址不同,且其中一个监听该端口上的所有地址,Angie 只对通配符套接字调用 bind(),并通过 getsockname() 确定接受连接的地址。如果使用了 backlog、rcvbuf、sndbuf、ipv6only、multipath 或 so_keepalive 参数,则始终会单独调用 bind()。

ipv6only=on | off

确定(通过 IPV6_V6ONLY 套接字选项)监听通配符地址 [::] 的 IPv6 套接字是只接受 IPv6 连接还是同时接受 IPv6 和 IPv4 连接。此参数默认开启。它只能在启动时设置一次。

multipath

启用通过 Multipath TCP (MPTCP)接受连接, 在 Linux 内核 5.6 及更高版本中支持。

so_keepalive=on | off | [keepidle]:[keepintvl]:[keepcnt]

为监听套接字配置"TCP keepalive"行为。

''

如果省略此参数,则套接字将使用操作系统的设置

on

为套接字开启 SO_KEEPALIVE 选项

off

为套接字关闭 SO_KEEPALIVE 选项

某些操作系统支持使用 TCP_KEEPIDLE、TCP_KEEPINTVL 和 TCP_KEEPCNT 套接字选项在每个套接字的基础上设置 TCP keepalive 参数。在这些系统上(目前包括 Linux、NetBSD、DragonFly、FreeBSD 和 macOS),可以使用 keepidle、keepintvl 和 keepcnt 参数进行配置。可以省略一个或两个参数,在这种情况下,相应套接字选项的系统默认设置将生效。在 macOS 上,keepidle 参数设置的是 TCP_KEEPALIVE 套接字选项,而不是 TCP_KEEPIDLE。

例如,

so_keepalive=30m::10

将空闲超时(TCP_KEEPIDLE)设置为 30 分钟,将探测间隔(TCP_KEEPINTVL)保留为系统默认值,并将探测次数(TCP_KEEPCNT)设置为 10 次探测。

mail#

语法

mail { ... }

默认值

—

上下文

main

提供配置文件上下文,在其中指定邮件代理指令。

max_commands#

语法

max_commands number;

默认值

max_commands 1000;

上下文

mail, server

设置身份验证期间发出的最大命令数,以增强对 DoS 攻击的防护。

max_errors#

语法

max_errors number;

默认值

max_errors 5;

上下文

mail, server

设置协议错误的次数,超过此次数后将关闭连接。

protocol#

语法

protocol imap | pop3 | smtp;

默认值

—

上下文

server

设置代理服务器的协议。支持的协议有 IMAP、POP3 和 SMTP。

如果未设置该指令,可以根据 listen 指令中指定的知名端口自动检测协议:

imap: 143, 993
pop3: 110, 995
smtp: 25, 587, 465

当 从源代码构建 时,可以使用 --without-mail_imap_module、--without-mail_pop3_module 和 --without-mail_smtp_module 构建选项 禁用不需要的协议。

resolver#

语法

resolver [address ...] [conf [=file]] [valid=time] [ipv4=on | off] [ipv6=on | off] [status_zone=zone] | off;

默认值

resolver off;

上下文

mail, server

配置用于查找 SMTP 客户端主机名的名称服务器。Angie 将该主机名通过 Client-Host 请求头 传递给身份验证服务器,并通过 XCLIENT 命令传递给 SMTP 后端。例如:

resolver 127.0.0.53 [::1]:5353;

地址可以指定为域名或 IP 地址,带有可选端口。如果未指定端口,则使用端口 53。名称服务器以轮询方式查询。

除 resolver off; 形式外,必须至少指定一个 DNS 服务器地址或 conf 参数。

除了显式的服务器地址外,该指令还识别以下参数:

off

禁用客户端主机名解析,并取消继承的指令值

conf [=file]

从指定文件读取 DNS 服务器地址,如果未指定文件, 则从 /etc/resolv.conf 读取

该文件可以包含 nameserver 行,其格式与系统解析器使用的格式相同:

nameserver 127.0.1.4
nameserver 127.0.1.5

从文件读取的地址会添加到指令中显式指定的任何地址中,然后所有这些地址一起以轮询方式查询。如果文件不存在、无法读取或未列出任何地址,且未显式配置任何地址,则 Angie 回退到默认服务器 127.0.0.1:53。

运行期间,当文件发生变化时,Angie 会重新读取该文件,并更新 DNS 服务器集合。

备注

建议使用本地可信解析器,例如 127.0.0.53 (systemd-resolved),而非 公共解析器(如 8.8.8.8)。公共解析器会将 DNS 查询暴露给第三方, 并增加缓存投毒攻击的风险。

备注

指令值会被嵌套块继承, 并且可以在嵌套块中根据需要进行覆盖。 在单个块内,该指令只能指定一次; 重复指定属于配置错误。

查找客户端主机名时,Angie 会在每个 DNS 答案的 TTL 有效期内对其进行缓存。可选的 valid 参数可覆盖该有效期:

valid

可选 参数,允许覆盖缓存条目的有效期

resolver 127.0.0.53 [::1]:5353 valid=30s;

默认情况下,Angie 在解析时会同时查找 IPv4 和 IPv6 地址。

ipv4=off

禁用 IPv4 地址查找

ipv6=off

禁用 IPv6 地址查找

status_zone

可选 参数,在指定区域中启用 DNS 服务器请求和响应信息的收集

小技巧

为了防止 DNS 欺骗,建议在安全可靠的受信任本地网络中配置 DNS 服务器。

小技巧

在 Docker 中运行时,使用其内部 DNS 服务器地址,例如 127.0.0.11。

resolver_timeout#

语法

resolver_timeout 时间;

默认值

resolver_timeout 30s;

上下文

mail, server

设置名称解析的超时时间,例如:

resolver_timeout 5s;

server#

语法

server { ... }

默认值

—

上下文

mail

设置服务器的配置。

server_name#

语法

server_name name;

默认值

server_name hostname;

上下文

mail, server

设置服务器名称,用于:

  • POP3/SMTP 服务器的初始问候语;

  • SASL CRAM-MD5 认证期间的盐值;

  • 连接到 SMTP 后端时的 EHLO 命令,如果启用了 XCLIENT 命令的传递。

如果未指定该指令,则使用机器的主机名。

timeout#

语法

timeout 时间;

默认值

timeout 60s;

上下文

mail, server

设置开始代理到后端之前使用的超时时间。