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