changeset 641:ca72f350f6f0

mail: - Documented the "imap_auth" directive. - Replaced "authorization" with "authentication". - Changed PLAIN SASL mechanism references to RFC 4616.
author Ruslan Ermilov <ru@nginx.com>
date Thu, 16 Aug 2012 07:19:40 +0000
parents febc8a4ad739
children 040b76448b33
files xml/ru/docs/mail/ngx_mail_auth_http_module.xml xml/ru/docs/mail/ngx_mail_core_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_proxy_module.xml xml/ru/docs/mail/ngx_mail_smtp_module.xml
diffstat 6 files changed, 52 insertions(+), 18 deletions(-) [+]
line wrap: on
line diff
--- a/xml/ru/docs/mail/ngx_mail_auth_http_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_auth_http_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -21,7 +21,7 @@
 <context>server</context>
 
 <para>
-Задаёт URL HTTP-сервера авторизации.
+Задаёт URL HTTP-сервера аутентификации.
 Протокол описан ниже.
 </para>
 
@@ -35,7 +35,7 @@
 <context>server</context>
 
 <para>
-Позволяет добавить указанный заголовок к запросам на сервер авторизации.
+Позволяет добавить указанный заголовок к запросам на сервер аутентификации.
 Можно использовать в качестве shared secret для проверки,
 что запрос поступил от nginx.
 Например:
@@ -64,7 +64,7 @@
 <section id="protocol" name="Протокол">
 
 <para>
-Для общения с сервером авторизации используется HTTP.
+Для общения с сервером аутентификации используется HTTP.
 Данные в теле ответа игнорируются, информация передаётся только в заголовках.
 </para>
 
@@ -102,9 +102,9 @@
 <para>
 Если заголовка <header>Auth-Wait</header> нет,
 то после выдачи ошибки соединение будет закрыто.
-В текущей реализации на каждую попытку авторизации выделяется память,
+В текущей реализации на каждую попытку аутентификации выделяется память,
 которая освобождается только при завершении сессии.
-Поэтому число неудачных попыток авторизации в рамках одной сессии
+Поэтому число неудачных попыток аутентификации в рамках одной сессии
 должно быть ограничено — после 10-20 попыток (см. заголовок
 <header>Auth-Login-Attempt</header>) сервер должен выдать ответ
 без заголовка <header>Auth-Wait</header>.
@@ -142,7 +142,7 @@
 </para>
 
 <para>
-Например, если от сервера авторизации будет получен ответ:
+Например, если от сервера аутентификации будет получен ответ:
 <example>
 HTTP/1.0 200 OK
 Auth-Status: Temporary server problem, try again later
--- a/xml/ru/docs/mail/ngx_mail_core_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_core_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -161,7 +161,7 @@
 </listitem>
 
 <listitem>
-в salt при авторизации SASL-методом CRAM-MD5;
+в salt при аутентификации SASL-методом CRAM-MD5;
 </listitem>
 
 <listitem>
--- a/xml/ru/docs/mail/ngx_mail_imap_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_imap_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -14,6 +14,39 @@
 
 <section id="directives" name="Директивы">
 
+<directive name="imap_auth">
+<syntax><value>метод</value> ...</syntax>
+<default>plain</default>
+<context>mail</context>
+<context>server</context>
+
+<para>
+Задаёт разрешённые методы аутентификации IMAP-клиентов.
+Поддерживаемые методы:
+<list type="tag">
+
+<tag-name><literal>login</literal></tag-name>
+<tag-desc>
+<link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH=LOGIN</link>
+</tag-desc>
+
+<tag-name><literal>plain</literal></tag-name>
+<tag-desc>
+<link url="http://tools.ietf.org/html/rfc4616">AUTH=PLAIN</link>
+</tag-desc>
+
+<tag-name><literal>cram-md5</literal></tag-name>
+<tag-desc>
+<link url="http://tools.ietf.org/html/rfc2195">AUTH=CRAM-MD5</link>.
+Для работы этого метода пароль должен храниться в незашифрованном виде.
+</tag-desc>
+
+</list>
+</para>
+
+</directive>
+
+
 <directive name="imap_capabilities">
 <syntax><value>расширение</value> ...</syntax>
 <default>IMAP4 IMAP4rev1 UIDPLUS</default>
@@ -25,7 +58,8 @@
 <link url="http://tools.ietf.org/html/rfc3501">протокола IMAP</link>,
 выдаваемый клиенту по команде
 <literal>CAPABILITY</literal>.
-К этому списку автоматически добавляется
+К этому списку автоматически добавляются
+методы аутентификации, указанные в директиве <link id="imap_auth"/> и
 <link url="http://tools.ietf.org/html/rfc2595">STARTTLS</link>,
 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
 </para>
@@ -34,7 +68,7 @@
 В данной директиве имеет смысл указать расширения,
 поддерживаемые IMAP-бэкендами,
 на которые проксируются клиенты (если эти расширения относятся к командам,
-используемым после авторизации, когда nginx прозрачно проксирует подключение
+используемым после аутентификации, когда nginx прозрачно проксирует подключение
 клиента на бэкенд).
 </para>
 
--- a/xml/ru/docs/mail/ngx_mail_pop3_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_pop3_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -28,7 +28,7 @@
 <tag-name><literal>plain</literal></tag-name>
 <tag-desc>
 <link url="http://tools.ietf.org/html/rfc1939">USER/PASS</link>,
-<link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link>,
+<link url="http://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>,
 <link url="http://tools.ietf.org/html/draft-murchison-sasl-login-00">AUTH LOGIN</link>.
 Данные методы отключить нельзя.
 </tag-desc>
@@ -63,7 +63,7 @@
 выдаваемый клиенту по команде
 <literal>CAPA</literal>.
 К этому списку автоматически добавляются
-методы авторизации, указанные в директиве <link id="pop3_auth"/>
+методы аутентификации, указанные в директиве <link id="pop3_auth"/>
 (расширение <link url="http://tools.ietf.org/html/rfc2449">SASL</link>) и
 <link url="http://tools.ietf.org/html/rfc2595">STLS</link>,
 если включена директива <link doc="ngx_mail_ssl_module.xml" id="starttls"/>.
@@ -73,7 +73,7 @@
 В данной директиве имеет смысл указать расширения,
 поддерживаемые POP3-бэкендами,
 на которые проксируются клиенты (если эти расширения относятся к командам,
-используемым после авторизации, когда nginx прозрачно проксирует подключение
+используемым после аутентификации, когда nginx прозрачно проксирует подключение
 клиента на бэкенд).
 </para>
 
--- a/xml/ru/docs/mail/ngx_mail_proxy_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_proxy_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -52,11 +52,11 @@
 
 <para>
 Определяет, передавать ли клиенту сообщение об ошибке,
-полученное при авторизации на бэкенде.
+полученное при аутентификации на бэкенде.
 </para>
 
 <para>
-Обычно, если авторизация в nginx прошла успешно,
+Обычно, если аутентификация в nginx прошла успешно,
 бэкенд не может вернуть ошибку, и если она всё же есть,
 значит есть какая-то ошибка внутри системы.
 В таких случаях сообщение бэкенда может содержать информацию,
@@ -67,7 +67,7 @@
 <link url="http://www.stalker.com/CommuniGatePro/Alerts.html#Quota">переполнении
 ящика</link> или других событиях, периодически выдавая
 <link url="http://www.stalker.com/CommuniGatePro/POP.html#Alerts">ошибку
-авторизации</link>.
+аутентификации</link>.
 В этом случае директиву стоит включить.
 </para>
 
--- a/xml/ru/docs/mail/ngx_mail_smtp_module.xml	Thu Aug 16 07:05:00 2012 +0000
+++ b/xml/ru/docs/mail/ngx_mail_smtp_module.xml	Thu Aug 16 07:19:40 2012 +0000
@@ -34,7 +34,7 @@
 
 <tag-name><literal>plain</literal></tag-name>
 <tag-desc>
-<link url="http://tools.ietf.org/html/rfc2595">AUTH PLAIN</link>
+<link url="http://tools.ietf.org/html/rfc4616">AUTH PLAIN</link>
 </tag-desc>
 
 <tag-name><literal>cram-md5</literal></tag-name>
@@ -60,14 +60,14 @@
 выдаваемый клиенту в ответе на команду
 <literal>EHLO</literal>.
 К этому списку автоматически добавляются
-методы авторизации, указанные в директиве <link id="smtp_auth"/>.
+методы аутентификации, указанные в директиве <link id="smtp_auth"/>.
 </para>
 
 <para>
 В данной директиве имеет смысл указать расширения,
 поддерживаемые MTA,
 на который проксируются клиенты (если эти расширения относятся к командам,
-используемым после авторизации, когда nginx прозрачно проксирует подключение
+используемым после аутентификации, когда nginx прозрачно проксирует подключение
 клиента на бэкенд).
 </para>