Windows: use Boost 1.59, msvc 14.0
[metaproxy-moved-to-github.git] / doc / auth_simple.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
2     "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4  <!ENTITY % idcommon SYSTEM "common/common.ent">
5      %idcommon;
6 ]>
7 <refentry id="ref-auth_simple">
8  <refentryinfo>
9   <productname>Metaproxy</productname>
10   <orgname>Index Data</orgname>
11  </refentryinfo>
12
13  <refmeta>
14   <refentrytitle>auth_simple</refentrytitle>
15   <manvolnum>3mp</manvolnum>
16   <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
17  </refmeta>
18
19  <refnamediv>
20   <refname>auth_simple</refname>
21   <refpurpose>Metaproxy Simple Authentication And Authorization Module</refpurpose>
22  </refnamediv>
23
24  <refsect1><title>DESCRIPTION</title>
25   <para>
26    Simple authentication and authorization.  The configuration
27    specifies the name of a file that is the user register, which
28    lists <varname>username</varname>:<varname>password</varname>
29    pairs, one per line, colon separated. When a session begins, it
30    is rejected unless username and passsword are supplied, and match
31    a pair in the register.
32   </para>
33   <!-- TODO: discuss authorization phase -->
34  </refsect1>
35
36  <refsect1><title>SCHEMA</title>
37    <literallayout><xi:include
38                      xi:href="../xml/schema/filter_auth_simple.rnc"
39                      xi:parse="text"
40                      xmlns:xi="http://www.w3.org/2001/XInclude" />
41    </literallayout>
42  </refsect1>
43
44  <refsect1><title>EXAMPLES</title>
45   <para>
46    A typical configuration looks like this:
47    <screen><![CDATA[
48     <filter type="auth_simple">
49      <userRegister>../etc/example.simple-auth</userRegister>
50      <targetRegister>../etc/example.target-auth</targetRegister>
51      <discardUnauthorisedTargets/>
52     </filter>
53     ]]>
54    </screen>
55   </para>
56   <!-- Show and describe example.target-auth -->
57  </refsect1>
58
59  <refsect1><title>SEE ALSO</title>
60   <para>
61    <citerefentry>
62     <refentrytitle>metaproxy</refentrytitle>
63     <manvolnum>1</manvolnum>
64    </citerefentry>
65   </para>
66  </refsect1>
67
68  &copyright;
69 </refentry>
70
71 <!-- Keep this comment at the end of the file
72 Local variables:
73 mode: nxml
74 nxml-child-indent: 1
75 End:
76 -->