changeset 2737:9986e1f25cd7

Improved pop3_auth, imap_auth, and smtp_auth descriptions. Notably, now it is outlined that plain text authentication methods are always enabled. Previously this was only documented in the pop3_auth directive description.
author Maxim Dounin <mdounin@mdounin.ru>
date Thu, 10 Jun 2021 18:34:55 +0300
parents 48004177276d
children d874ae125c3c
files xml/en/docs/mail/ngx_mail_imap_module.xml xml/en/docs/mail/ngx_mail_pop3_module.xml xml/en/docs/mail/ngx_mail_smtp_module.xml xml/ru/docs/mail/ngx_mail_imap_module.xml xml/ru/docs/mail/ngx_mail_pop3_module.xml xml/ru/docs/mail/ngx_mail_smtp_module.xml
diffstat 6 files changed, 68 insertions(+), 10 deletions(-) [+]
line wrap: on
line diff
--- a/xml/en/docs/mail/ngx_mail_imap_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/en/docs/mail/ngx_mail_imap_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_imap_module"
         link="/en/docs/mail/ngx_mail_imap_module.html"
         lang="en"
-        rev="6">
+        rev="7">
 
 <section id="directives" name="Directives">
 
@@ -27,6 +27,7 @@
 
 <tag-name><literal>plain</literal></tag-name>
 <tag-desc>
+<link url="https://tools.ietf.org/html/rfc3501">LOGIN</link>,
 <link url="https://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
 </tag-desc>
 
@@ -49,6 +50,16 @@
 </list>
 </para>
 
+<para>
+Plain text authentication methods
+(the <literal>LOGIN</literal> command, <literal>AUTH=PLAIN</literal>,
+and <literal>AUTH=LOGIN</literal>) are always enabled,
+though if the <literal>plain</literal> and <literal>login</literal> methods
+are not specified,
+<literal>AUTH=PLAIN</literal> and <literal>AUTH=LOGIN</literal>
+will not be automatically included in <link id="imap_capabilities"/>.
+</para>
+
 </directive>
 
 
--- a/xml/en/docs/mail/ngx_mail_pop3_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/en/docs/mail/ngx_mail_pop3_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_pop3_module"
         link="/en/docs/mail/ngx_mail_pop3_module.html"
         lang="en"
-        rev="4">
+        rev="5">
 
 <section id="directives" name="Directives">
 
@@ -29,8 +29,7 @@
 <tag-desc>
 <link url="https://tools.ietf.org/html/rfc1939">USER/PASS</link>,
 <link url="https://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>,
-<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>.
-It is not possible to disable these methods.
+<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>
 </tag-desc>
 
 <tag-name><literal>apop</literal></tag-name>
@@ -53,6 +52,15 @@
 </list>
 </para>
 
+<para>
+Plain text authentication methods
+(<literal>USER/PASS</literal>, <literal>AUTH PLAIN</literal>,
+and <literal>AUTH LOGIN</literal>) are always enabled,
+though if the <literal>plain</literal> method is not specified,
+<literal>AUTH PLAIN</literal> and <literal>AUTH LOGIN</literal>
+will not be automatically included in <link id="pop3_capabilities"/>.
+</para>
+
 </directive>
 
 
--- a/xml/en/docs/mail/ngx_mail_smtp_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/en/docs/mail/ngx_mail_smtp_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Module ngx_mail_smtp_module"
         link="/en/docs/mail/ngx_mail_smtp_module.html"
         lang="en"
-        rev="7">
+        rev="8">
 
 <section id="directives" name="Directives">
 
@@ -56,6 +56,16 @@
 </list>
 </para>
 
+<para>
+Plain text authentication methods
+(<literal>AUTH PLAIN</literal> and <literal>AUTH LOGIN</literal>)
+are always enabled,
+though if the <literal>plain</literal> and <literal>login</literal> methods
+are not specified,
+<literal>AUTH PLAIN</literal> and <literal>AUTH LOGIN</literal>
+will not be automatically included in <link id="smtp_capabilities"/>.
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/mail/ngx_mail_imap_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/ru/docs/mail/ngx_mail_imap_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_imap_module"
         link="/ru/docs/mail/ngx_mail_imap_module.html"
         lang="ru"
-        rev="6">
+        rev="7">
 
 <section id="directives" name="Директивы">
 
@@ -27,6 +27,7 @@
 
 <tag-name><literal>plain</literal></tag-name>
 <tag-desc>
+<link url="https://tools.ietf.org/html/rfc3501">LOGIN</link>,
 <link url="https://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
 </tag-desc>
 
@@ -49,6 +50,16 @@
 </list>
 </para>
 
+<para>
+Методы аутентификации с передачей пароля открытым текстом
+(команда <literal>LOGIN</literal>, <literal>AUTH=PLAIN</literal>
+и <literal>AUTH=LOGIN</literal>) включены всегда,
+однако если методы <literal>plain</literal> и <literal>login</literal>
+не указаны, то
+<literal>AUTH=PLAIN</literal> и <literal>AUTH=LOGIN</literal>
+не будут автоматически добавляться в <link id="imap_capabilities"/>.
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/mail/ngx_mail_pop3_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/ru/docs/mail/ngx_mail_pop3_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_pop3_module"
         link="/ru/docs/mail/ngx_mail_pop3_module.html"
         lang="ru"
-        rev="4">
+        rev="5">
 
 <section id="directives" name="Директивы">
 
@@ -29,8 +29,7 @@
 <tag-desc>
 <link url="https://tools.ietf.org/html/rfc1939">USER/PASS</link>,
 <link url="https://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>,
-<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>.
-Данные методы отключить нельзя.
+<link url="https://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>
 </tag-desc>
 
 <tag-name><literal>apop</literal></tag-name>
@@ -53,6 +52,15 @@
 </list>
 </para>
 
+<para>
+Методы аутентификации с передачей пароля открытым текстом
+(<literal>USER/PASS</literal>, <literal>AUTH PLAIN</literal>
+и <literal>AUTH LOGIN</literal>) включены всегда,
+однако если метод <literal>plain</literal> не указан, то
+<literal>AUTH PLAIN</literal> и <literal>AUTH LOGIN</literal>
+не будут автоматически добавляться в <link id="pop3_capabilities"/>.
+</para>
+
 </directive>
 
 
--- a/xml/ru/docs/mail/ngx_mail_smtp_module.xml	Thu Jun 10 18:34:32 2021 +0300
+++ b/xml/ru/docs/mail/ngx_mail_smtp_module.xml	Thu Jun 10 18:34:55 2021 +0300
@@ -10,7 +10,7 @@
 <module name="Модуль ngx_mail_smtp_module"
         link="/ru/docs/mail/ngx_mail_smtp_module.html"
         lang="ru"
-        rev="7">
+        rev="8">
 
 <section id="directives" name="Директивы">
 
@@ -56,6 +56,16 @@
 </list>
 </para>
 
+<para>
+Методы аутентификации с передачей пароля открытым текстом
+(<literal>AUTH PLAIN</literal> и <literal>AUTH LOGIN</literal>)
+включены всегда,
+однако если методы <literal>plain</literal> и <literal>login</literal>
+не указаны, то
+<literal>AUTH PLAIN</literal> и <literal>AUTH LOGIN</literal>
+не будут автоматически добавляться в <link id="smtp_capabilities"/>.
+</para>
+
 </directive>