模块 ngx_mail_auth_http_module

Directives
     auth_http
     auth_http_header
     auth_http_pass_client_cert
     auth_http_timeout
Protocol

指令

句法：	`auth_http URL;`
默认：	—
语境：	`mail`,`server`

设置HTTP认证服务器的URL。该协议描述如下。

句法：	`auth_http_header header value;`
默认：	—
语境：	`mail`,`server`

将指定的标头附加到发送到身份验证服务器的请求。该标头可以用作共享密钥来验证请求是否来自 nginx。例如：

auth_http_header X-Auth-Key "secret_string";

句法：	`auth_http_pass_client_cert on \| off;`
默认：	auth_http_pass_client_cert off;
语境：	`mail`,`server`

该指令出现在版本 1.7.11 中。

将“Auth-SSL-Cert”标头和 PEM 格式（urlencoded）的客户端证书附加到发送到身份验证服务器的请求。

句法：	`auth_http_timeout time;`
默认：	auth_http_timeout 60s;
语境：	`mail`,`server`

设置与认证服务器通信的超时时间。

协议

HTTP协议用于与认证服务器进行通信。响应正文中的数据将被忽略，信息仅在标头中传递。

请求和响应的示例：

要求：

GET /auth HTTP/1.0
Host: localhost
Auth-Method: plain # plain/apop/cram-md5/external
Auth-User: user
Auth-Pass: password
Auth-Protocol: imap # imap/pop3/smtp
Auth-Login-Attempt: 1
Client-IP: 192.0.2.42
Client-Host: client.example.org

良好的回应：

HTTP/1.0 200 OK
Auth-Status: OK
Auth-Server: 198.51.100.1
Auth-Port: 143

不良反应：

HTTP/1.0 200 OK
Auth-Status: Invalid login or password
Auth-Wait: 3

如果没有“Auth-Wait”标头，将返回错误并关闭连接。当前的实现为每次身份验证尝试分配内存。仅在会话结束时释放内存。因此，必须限制单个会话中无效身份验证尝试的次数 - 服务器必须在 10-20 次尝试后在没有“Auth-Wait”标头的情况下进行响应（尝试次数在“Auth-Login-Attempt”标头中传递）。

当使用 APOP 或 CRAM-MD5 时，请求-响应将如下所示：

GET /auth HTTP/1.0
Host: localhost
Auth-Method: apop
Auth-User: user
Auth-Salt: <238188073.1163692009@mail.example.com>
Auth-Pass: auth_response
Auth-Protocol: imap
Auth-Login-Attempt: 1
Client-IP: 192.0.2.42
Client-Host: client.example.org

良好的回应：

HTTP/1.0 200 OK
Auth-Status: OK
Auth-Server: 198.51.100.1
Auth-Port: 143
Auth-Pass: plain-text-pass

如果响应中存在“Auth-User”标头，它将覆盖用于向后端进行身份验证的用户名。

对于 SMTP，响应还考虑“Auth-Error-Code”标头 — 如果存在，则在出现错误时将其用作响应代码。否则，535 5.7.0 代码将添加到“Auth-Status”标头中。

例如，如果从身份验证服务器收到以下响应：

HTTP/1.0 200 OK
Auth-Status: Temporary server problem, try again later
Auth-Error-Code: 451 4.3.0
Auth-Wait: 3

那么 SMTP 客户端将收到错误

451 4.3.0 Temporary server problem, try again later

如果代理 SMTP 不需要身份验证，则请求将如下所示：

GET /auth HTTP/1.0
Host: localhost
Auth-Method: none
Auth-User:
Auth-Pass:
Auth-Protocol: smtp
Auth-Login-Attempt: 1
Client-IP: 192.0.2.42
Client-Host: client.example.org
Auth-SMTP-Helo: client.example.org
Auth-SMTP-From: MAIL FROM: <>
Auth-SMTP-To: RCPT TO: <postmaster@mail.example.com>

对于 SSL/TLS 客户端连接（1.7.11），添加“Auth-SSL”标头，“Auth-SSL-Verify”将包含客户端证书验证的结果，如果启用：“ ” 、 “ SUCCESS”FAILED:reason和“ NONE” 如果证书不存在。

在 1.11.7 版本之前，“ FAILED”结果不包含reason字符串。

当存在客户端证书时，其详细信息将在以下请求标头中传递：“Auth-SSL-Subject”、“Auth-SSL-Issuer”、“Auth-SSL-Serial”和“Auth-SSL-Fingerprint”。如果启用了auth_http_pass_client_cert，证书本身将在“Auth-SSL-Cert”标头中传递。已建立连接的协议和密码在“Auth-SSL-Protocol”和“Auth-SSL-Cipher”标头中传递（1.21.2）。该请求将如下所示：

GET /auth HTTP/1.0
Host: localhost
Auth-Method: plain
Auth-User: user
Auth-Pass: password
Auth-Protocol: imap
Auth-Login-Attempt: 1
Client-IP: 192.0.2.42
Auth-SSL: on
Auth-SSL-Protocol: TLSv1.3
Auth-SSL-Cipher: TLS_AES_256_GCM_SHA384
Auth-SSL-Verify: SUCCESS
Auth-SSL-Subject: /CN=example.com
Auth-SSL-Issuer: /CN=example.com
Auth-SSL-Serial: C07AD56B846B5BFF
Auth-SSL-Fingerprint: 29d6a80a123d13355ed16b4b04605e29cb55a5ad

使用PROXY 协议时，其详细信息将在以下请求标头中传递：“Proxy-Protocol-Addr”、“Proxy-Protocol-Port”、“Proxy-Protocol-Server-Addr”和“Proxy-Protocol-Server” -端口”（1.19.8）。