comparison xml/en/docs/mail/ngx_mail_auth_http_module.xml @ 2757:96d6d66d36e4

Documented Auth-SSL-Protocol and Auth-SSL-Cipher mail auth headers.
author Sergey Kandaurov <pluknet@nginx.com>
date Wed, 18 Aug 2021 22:17:52 +0300
parents 468e6e14e5cc
children 7b7dbaa7d777
comparison
equal deleted inserted replaced
2756:7898e090ad72 2757:96d6d66d36e4
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd"> 8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9 9
10 <module name="Module ngx_mail_auth_http_module" 10 <module name="Module ngx_mail_auth_http_module"
11 link="/en/docs/mail/ngx_mail_auth_http_module.html" 11 link="/en/docs/mail/ngx_mail_auth_http_module.html"
12 lang="en" 12 lang="en"
13 rev="10"> 13 rev="11">
14 14
15 <section id="directives" name="Directives"> 15 <section id="directives" name="Directives">
16 16
17 <directive name="auth_http"> 17 <directive name="auth_http">
18 <syntax><value>URL</value></syntax> 18 <syntax><value>URL</value></syntax>
219 <header>Auth-SSL-Subject</header>, <header>Auth-SSL-Issuer</header>, 219 <header>Auth-SSL-Subject</header>, <header>Auth-SSL-Issuer</header>,
220 <header>Auth-SSL-Serial</header>, and <header>Auth-SSL-Fingerprint</header>. 220 <header>Auth-SSL-Serial</header>, and <header>Auth-SSL-Fingerprint</header>.
221 If <link id="auth_http_pass_client_cert"/> is enabled, 221 If <link id="auth_http_pass_client_cert"/> is enabled,
222 the certificate itself is passed in the 222 the certificate itself is passed in the
223 <header>Auth-SSL-Cert</header> header. 223 <header>Auth-SSL-Cert</header> header.
224 The protocol and cipher of the established connection
225 are passed in the <header>Auth-SSL-Protocol</header>
226 and <header>Auth-SSL-Cipher</header> headers (1.21.2).
224 The request will look as follows: 227 The request will look as follows:
225 <example> 228 <example>
226 GET /auth HTTP/1.0 229 GET /auth HTTP/1.0
227 Host: localhost 230 Host: localhost
228 Auth-Method: plain 231 Auth-Method: plain
230 Auth-Pass: password 233 Auth-Pass: password
231 Auth-Protocol: imap 234 Auth-Protocol: imap
232 Auth-Login-Attempt: 1 235 Auth-Login-Attempt: 1
233 Client-IP: 192.0.2.42 236 Client-IP: 192.0.2.42
234 Auth-SSL: on 237 Auth-SSL: on
238 Auth-SSL-Protocol: TLSv1.3
239 Auth-SSL-Cipher: TLS_AES_256_GCM_SHA384
235 Auth-SSL-Verify: SUCCESS 240 Auth-SSL-Verify: SUCCESS
236 Auth-SSL-Subject: /CN=example.com 241 Auth-SSL-Subject: /CN=example.com
237 Auth-SSL-Issuer: /CN=example.com 242 Auth-SSL-Issuer: /CN=example.com
238 Auth-SSL-Serial: C07AD56B846B5BFF 243 Auth-SSL-Serial: C07AD56B846B5BFF
239 Auth-SSL-Fingerprint: 29d6a80a123d13355ed16b4b04605e29cb55a5ad 244 Auth-SSL-Fingerprint: 29d6a80a123d13355ed16b4b04605e29cb55a5ad