[PATCH] Documented XOAUTH2 and OAUTHBEARER authentication methods

Tue, 04 Jun 2024 08:36:11 -0700 

# HG changeset patch
# User Maxim Dounin <mdou...@mdounin.ru>
# Date 1717515321 -10800
#      Tue Jun 04 18:35:21 2024 +0300
# Node ID 7b7dbaa7d777cd8cacaebb177d76559f84736b94
# Parent  f7c8eeeaeafe54cabde349154d234272180f9044
Documented XOAUTH2 and OAUTHBEARER authentication methods.

diff --git a/xml/en/docs/mail/ngx_mail_auth_http_module.xml 
b/xml/en/docs/mail/ngx_mail_auth_http_module.xml
--- a/xml/en/docs/mail/ngx_mail_auth_http_module.xml
+++ b/xml/en/docs/mail/ngx_mail_auth_http_module.xml
@@ -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="11">
+        rev="12">
 
 <section id="directives" name="Directives">
 
@@ -203,6 +203,18 @@ Auth-SMTP-To: RCPT TO: &lt;postmaster@ma
 </para>
 
 <para>
+For the XOAUTH2 and OAUTHBEARER authentication methods (1.27.1),
+the <header>Auth-Error-SASL</header> header
+could be used to return an error response
+in the form of an additional base64-encoded SASL challenge
+(<link
+url="https://developers.google.com/gmail/imap/xoauth2-protocol#error_response";
+>XOAUTH2</link>,
+<link url="https://datatracker.ietf.org/doc/html/rfc7628#section-3.2.2";
+>OAUTHBEARER</link>).
+</para>
+
+<para>
 For the SSL/TLS client connection (1.7.11),
 the <header>Auth-SSL</header> header is added, and
 <header>Auth-SSL-Verify</header> will contain
diff --git a/xml/en/docs/mail/ngx_mail_imap_module.xml 
b/xml/en/docs/mail/ngx_mail_imap_module.xml
--- a/xml/en/docs/mail/ngx_mail_imap_module.xml
+++ b/xml/en/docs/mail/ngx_mail_imap_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_imap_module"
         link="/en/docs/mail/ngx_mail_imap_module.html"
         lang="en"
-        rev="7">
+        rev="8">
 
 <section id="directives" name="Directives">
 
@@ -47,6 +47,18 @@ In order for this method to work, the pa
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH=EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH=XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH=OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 </list>
 </para>
 
diff --git a/xml/en/docs/mail/ngx_mail_pop3_module.xml 
b/xml/en/docs/mail/ngx_mail_pop3_module.xml
--- a/xml/en/docs/mail/ngx_mail_pop3_module.xml
+++ b/xml/en/docs/mail/ngx_mail_pop3_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_pop3_module"
         link="/en/docs/mail/ngx_mail_pop3_module.html"
         lang="en"
-        rev="5">
+        rev="6">
 
 <section id="directives" name="Directives">
 
@@ -49,6 +49,18 @@ In order for this method to work, the pa
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 </list>
 </para>
 
diff --git a/xml/en/docs/mail/ngx_mail_smtp_module.xml 
b/xml/en/docs/mail/ngx_mail_smtp_module.xml
--- a/xml/en/docs/mail/ngx_mail_smtp_module.xml
+++ b/xml/en/docs/mail/ngx_mail_smtp_module.xml
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_smtp_module"
         link="/en/docs/mail/ngx_mail_smtp_module.html"
         lang="en"
-        rev="8">
+        rev="9">
 
 <section id="directives" name="Directives">
 
@@ -48,6 +48,18 @@ In order for this method to work, the pa
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 <tag-name><literal>none</literal></tag-name>
 <tag-desc>
 Authentication is not required.
diff --git a/xml/ru/docs/mail/ngx_mail_auth_http_module.xml 
b/xml/ru/docs/mail/ngx_mail_auth_http_module.xml
--- a/xml/ru/docs/mail/ngx_mail_auth_http_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_auth_http_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_auth_http_module"
         link="/ru/docs/mail/ngx_mail_auth_http_module.html"
         lang="ru"
-        rev="11">
+        rev="12">
 
 <section id="directives" name="Директивы">
 
@@ -201,6 +201,18 @@ Auth-SMTP-To: RCPT TO: &lt;postmaster@ma
 </para>
 
 <para>
+Для методов аутентификации XOAUTH2 and OAUTHBEARER (1.27.1)
+в заголовке <header>Auth-Error-SASL</header>
+можно вернуть информацию об ошибке
+в форме дополнительного SASL challenge в base64
+(<link
+url="https://developers.google.com/gmail/imap/xoauth2-protocol#error_response";
+>XOAUTH2</link>,
+<link url="https://datatracker.ietf.org/doc/html/rfc7628#section-3.2.2";
+>OAUTHBEARER</link>).
+</para>
+
+<para>
 Для клиентского соединения по протоколу SSL/TLS (1.7.11)
 добавляется заголовок <header>Auth-SSL</header>, и если директива
 <link doc="ngx_mail_ssl_module.xml" id="ssl_verify_client"/> включена,
diff --git a/xml/ru/docs/mail/ngx_mail_imap_module.xml 
b/xml/ru/docs/mail/ngx_mail_imap_module.xml
--- a/xml/ru/docs/mail/ngx_mail_imap_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_imap_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_imap_module"
         link="/ru/docs/mail/ngx_mail_imap_module.html"
         lang="ru"
-        rev="7">
+        rev="8">
 
 <section id="directives" name="Директивы">
 
@@ -47,6 +47,18 @@
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH=EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH=XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH=OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 </list>
 </para>
 
diff --git a/xml/ru/docs/mail/ngx_mail_pop3_module.xml 
b/xml/ru/docs/mail/ngx_mail_pop3_module.xml
--- a/xml/ru/docs/mail/ngx_mail_pop3_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_pop3_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_pop3_module"
         link="/ru/docs/mail/ngx_mail_pop3_module.html"
         lang="ru"
-        rev="5">
+        rev="6">
 
 <section id="directives" name="Директивы">
 
@@ -49,6 +49,18 @@
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 </list>
 </para>
 
diff --git a/xml/ru/docs/mail/ngx_mail_smtp_module.xml 
b/xml/ru/docs/mail/ngx_mail_smtp_module.xml
--- a/xml/ru/docs/mail/ngx_mail_smtp_module.xml
+++ b/xml/ru/docs/mail/ngx_mail_smtp_module.xml
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_smtp_module"
         link="/ru/docs/mail/ngx_mail_smtp_module.html"
         lang="ru"
-        rev="8">
+        rev="9">
 
 <section id="directives" name="Директивы">
 
@@ -48,6 +48,18 @@ SMTP-клиентов.
 <link url="https://datatracker.ietf.org/doc/html/rfc4422";>AUTH EXTERNAL</link> 
(1.11.6).
 </tag-desc>
 
+<tag-name><literal>xoauth2</literal></tag-name>
+<tag-desc>
+<link url="https://developers.google.com/gmail/imap/xoauth2-protocol";
+>AUTH XOAUTH2</link> (1.27.1).
+</tag-desc>
+
+<tag-name><literal>oauthbearer</literal></tag-name>
+<tag-desc>
+<link url="https://datatracker.ietf.org/doc/html/rfc7628";
+>AUTH OAUTHBEARER</link> (1.27.1).
+</tag-desc>
+
 <tag-name><literal>none</literal></tag-name>
 <tag-desc>
 Аутентификация не требуется.

Reply via email to