changeset 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 7898e090ad72
children 96ed09ce33cb
files xml/en/docs/mail/ngx_mail_auth_http_module.xml xml/ru/docs/mail/ngx_mail_auth_http_module.xml
diffstat 2 files changed, 12 insertions(+), 2 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_auth_http_module.xml	Tue Aug 17 12:33:41 2021 +0300
+++ b/xml/en/docs/mail/ngx_mail_auth_http_module.xml	Wed Aug 18 22:17:52 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_auth_http_module"
         link="/en/docs/mail/ngx_mail_auth_http_module.html"
         lang="en"
-        rev="10">
+        rev="11">
 
 <section id="directives" name="Directives">
 
@@ -221,6 +221,9 @@
 If <link id="auth_http_pass_client_cert"/> is enabled,
 the certificate itself is passed in the
 <header>Auth-SSL-Cert</header> header.
+The protocol and cipher of the established connection
+are passed in the <header>Auth-SSL-Protocol</header>
+and <header>Auth-SSL-Cipher</header> headers (1.21.2).
 The request will look as follows:
 <example>
 GET /auth HTTP/1.0
@@ -232,6 +235,8 @@
 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
--- a/xml/ru/docs/mail/ngx_mail_auth_http_module.xml	Tue Aug 17 12:33:41 2021 +0300
+++ b/xml/ru/docs/mail/ngx_mail_auth_http_module.xml	Wed Aug 18 22:17:52 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_auth_http_module"
         link="/ru/docs/mail/ngx_mail_auth_http_module.html"
         lang="ru"
-        rev="10">
+        rev="11">
 
 <section id="directives" name="Директивы">
 
@@ -219,6 +219,9 @@
 Если директива <link id="auth_http_pass_client_cert"/> включена,
 сам сертификат передаётся в заголовке
 <header>Auth-SSL-Cert</header>.
+Протокол и шифр установленного соединения
+передаются в заголовках <header>Auth-SSL-Protocol</header>
+и <header>Auth-SSL-Cipher</header> (1.21.2).
 Запрос будет выглядеть так:
 <example>
 GET /auth HTTP/1.0
@@ -230,6 +233,8 @@
 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