fixed typo's
[metaproxy-moved-to-github.git] / doc / auth_simple.xml
1 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" 
2     "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
3  <!ENTITY copyright SYSTEM "copyright.xml">
4 ]>
5 <!-- $Id: auth_simple.xml,v 1.7 2006-10-12 12:02:19 marc Exp $ -->
6 <refentry>
7  <refmeta>
8   <refentrytitle>auth_simple</refentrytitle>
9   <manvolnum>3mp</manvolnum>
10   <refmiscinfo>Metaproxy Module</refmiscinfo>
11  </refmeta>
12  
13  <refnamediv>
14   <refname>auth_simple</refname>
15   <refpurpose>simple authentication and authorization.</refpurpose>
16  </refnamediv>
17  
18  <refsect1><title>DESCRIPTION</title>
19   <para>
20    Simple authentication and authorization.  The configuration
21    specifies the name of a file that is the user register, which
22    lists <varname>username</varname>:<varname>password</varname>
23    pairs, one per line, colon separated. When a session begins, it
24    is rejected unless username and passsword are supplied, and match
25    a pair in the register.
26   </para>
27   <para>
28    ### discuss authorization phase
29   </para>
30  </refsect1>
31  
32  <refsect1><title>EXAMPLES</title>
33   <para>
34    A typical configuration looks like this:
35    <screen><![CDATA[
36     <filter type="auth_simple">
37      <userRegister>../etc/example.simple-auth</userRegister>
38      <targetRegister>../etc/example.target-auth</targetRegister>
39      <discardUnauthorisedTargets/>
40     </filter>
41 ]]>
42    </screen>
43    ### Show and describe example.target-auth
44   </para>
45  </refsect1> 
46  
47  <refsect1><title>SEE ALSO</title>
48   <para>
49    <citerefentry>
50     <refentrytitle>metaproxy</refentrytitle>
51     <manvolnum>1</manvolnum>
52    </citerefentry>
53   </para>
54  </refsect1>
55  
56  &copyright;
57 </refentry>
58
59 <!-- Keep this comment at the end of the file
60 Local variables:
61 mode: sgml
62 sgml-omittag:t
63 sgml-shorttag:t
64 sgml-minimize-attributes:nil
65 sgml-always-quote-attributes:t
66 sgml-indent-step:1
67 sgml-indent-data:t
68 sgml-parent-document:nil
69 sgml-local-catalogs: nil
70 sgml-namecase-general:t
71 End:
72 -->