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.3 2006-03-27 13:44:07 adam 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 authorisation.</refpurpose>
  16  </refnamediv>
  17
  18  <refsect1><title>DESCRIPTION</title>
  19   <para>
  20    Simple authentication and authorisation.  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 authorisation phase
  29   </para>
  30  </refsect1>
  31
  32  <refsect1><title>EXAMPLES</title>
  33   <para>
  34    A typical configuration looks as likes:
  35    <screen><![CDATA[
  36     <filter type="auth_simple">
  37      <targetRegister>example.target-auth</targetRegister>
  38      <discardUnauthorisedTargets/>
  39     </filter>
  40 ]]>
  41    </screen>
  42    ### Show and describe examle.target-auth here ###
  43   </para>
  44  </refsect1>
  45
  46  <refsect1><title>SEE ALSO</title>
  47   <para>
  48    <citerefentry>
  49     <refentrytitle>metaproxy</refentrytitle>
  50     <manvolnum>1</manvolnum>
  51    </citerefentry>
  52   </para>
  53  </refsect1>
  54
  55  &copyright;
  56 </refentry>
  57
  58 <!-- Keep this comment at the end of the file
  59 Local variables:
  60 mode: sgml
  61 sgml-omittag:t
  62 sgml-shorttag:t
  63 sgml-minimize-attributes:nil
  64 sgml-always-quote-attributes:t
  65 sgml-indent-step:1
  66 sgml-indent-data:t
  67 sgml-parent-document:nil
  68 sgml-local-catalogs: nil
  69 sgml-namecase-general:t
  70 End:
  71 -->