Mercurial > hg > nginx-site

comparison xml/ru/docs/http/ngx_http_auth_request_module.xml @ 971:6316a7579448

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Documented the "ngx_http_auth_request" module.
author Vladimir Homutov <vl@nginx.com>
date Thu, 22 Aug 2013 17:23:42 +0400
parents
children 114b2933b2be
comparison
equal deleted inserted replaced
970:051de14a6e79 971:6316a7579448
1 <?xml version="1.0"?>
2
3 <!--
4 Copyright (C) Maxim Dounin
5 Copyright (C) Nginx, Inc.
6 -->
7
8 <!DOCTYPE module SYSTEM "../../../../dtd/module.dtd">
9
10 <module name="Модуль ngx_http_auth_request_module"
11 link="/ru/docs/http/ngx_http_auth_request_module.html"
12 lang="ru"
13 rev="1">
14
15 <section id="summary">
16
17 <para>
18 Модуль <literal>ngx_http_auth_request_module</literal> (1.5.4+) предоставляет
19 возможность авторизации клиента, основанной на результате подзапроса.
20 Если подзапрос возвращает код ответа 2xx, доступ разрешается.
21 Если 401 или 403 — доступ запрещается с соответствующим кодом ошибки.
22 Любой другой код ответа, возвращаемый подзапросом, считается ошибкой.
23 </para>
24
25 <para>
26 При ошибке 401 клиенту также передаётся заголовок
27 <header>WWW-Authenticate</header> из ответа подзапроса.
28 </para>
29
30 <para>
31 По умолчанию этот модуль не собирается, его сборку необходимо
32 разрешить с помощью конфигурационного параметра
33 <literal>--with-http_auth_request_module</literal>.
34 </para>
35
36 <para>
37 Модуль может быть
38 скомбинирован с другими модулями доступа, такими как
39 <link doc="ngx_http_access_module.xml">ngx_http_access_module</link> и
40 <link doc="ngx_http_auth_basic_module.xml">ngx_http_auth_basic_module</link>,
41 с помощью директивы <link doc="ngx_http_core_module.xml" id="satisfy"/>.
42 <note>
43 В данный момент директивы
44 <link doc="ngx_http_proxy_module.xml" id="proxy_cache"/> и
45 <link doc="ngx_http_proxy_module.xml" id="proxy_store"/>
46 (<link doc="ngx_http_fastcgi_module.xml" id="fastcgi_cache"/> и
47 <link doc="ngx_http_fastcgi_module.xml" id="fastcgi_store"/>)
48 невозможно использовать для обработки запросов, исходящих от модуля
49 <literal>ngx_http_auth_request_module</literal>.
50 </note>
51 </para>
52
53 </section>
54
55
56 <section id="example" name="Пример конфигурации">
57
58 <para>
59 <example>
60 location /private/ {
61 auth_request /auth;
62 ...
63 }
64
65 location = /auth {
66 proxy_pass ...
67 proxy_pass_request_body off;
68 proxy_set_header Content-Length "";
69 proxy_set_header X-Original-URI $request_uri;
70 }
71 </example>
72 </para>
73
74 </section>
75
76
77 <section id="directives" name="Директивы">
78
79 <directive name="auth_request">
80 <syntax><value>uri</value> | <literal>off</literal></syntax>
81 <default>off</default>
82 <context>http</context>
83 <context>server</context>
84 <context>location</context>
85
86 <para>
87 Включает авторизацию, основанную на результате выполнения подзапроса,
88 и задаёт URI, на который будет отправлен подзапрос.
89 </para>
90
91 </directive>
92
93
94 <directive name="auth_request_set">
95 <syntax><value>переменная</value> <value>значение</value></syntax>
96 <default/>
97 <context>http</context>
98 <context>server</context>
99 <context>location</context>
100
101 <para>
102 Устанавливает <value>переменную</value> в запросе в заданное
103 <value>значение</value> после завершения запроса авторизации.
104 Значение может содержать переменные из запроса авторизации,
105 например, <var>$upstream_http_*</var>.
106 </para>
107
108 </directive>
109
110 </section>
111
112 </module>