doc/auth_simple.xml

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