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