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.1 2006-03-16 13:20:05 adam Exp $ -->
   6 <refentry>
   7  <refmeta>
   8   <refentrytitle>auth_simple</refentrytitle>
   9   <manvolnum>3mp</manvolnum>
  10  </refmeta>
  11
  12  <refnamediv>
  13   <refname>auth_simple</refname>
  14   <refpurpose>Simple authentication and authorisation.</refpurpose>
  15  </refnamediv>
  16
  17  <refsect1><title>DESCRIPTION</title>
  18   <para>
  19    Simple authentication and authorisation.  The configuration
  20    specifies the name of a file that is the user register, which
  21    lists <varname>username</varname>:<varname>password</varname>
  22    pairs, one per line, colon separated. When a session begins, it
  23    is rejected unless username and passsword are supplied, and match
  24    a pair in the register.
  25   </para>
  26   <para>
  27    ### discuss authorisation phase
  28   </para>
  29  </refsect1>
  30
  31  <refsect1><title>EXAMPLES</title>
  32   <para>
  33    A typical configuration looks as likes:
  34    <screen><![CDATA[
  35     <filter type="auth_simple">
  36     <targetRegister>example.target-auth</targetRegister>
  37     <discardUnauthorisedTargets/>
  38    </filter>
  39 ]]>
  40    </screen>
  41    ### Show and describe examle.target-auth here ###
  42   </para>
  43  </refsect1>
  44
  45  <refsect1><title>SEE ALSO</title>
  46   <para>
  47    <citerefentry>
  48     <refentrytitle>metaproxy</refentrytitle>
  49     <manvolnum>1</manvolnum>
  50    </citerefentry>
  51   </para>
  52  </refsect1>
  53
  54  &copyright;
  55 </refentry>
  56
  57 <!-- Keep this comment at the end of the file
  58 Local variables:
  59 mode: sgml
  60 sgml-omittag:t
  61 sgml-shorttag:t
  62 sgml-minimize-attributes:nil
  63 sgml-always-quote-attributes:t
  64 sgml-indent-step:1
  65 sgml-indent-data:t
  66 sgml-parent-document:nil
  67 sgml-local-catalogs: nil
  68 sgml-namecase-general:t
  69 End:
  70 -->