-<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN"
- "http://www.oasis-open.org/docbook/xml/4.1/docbookx.dtd" [
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook V4.4//EN"
+ "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
<!ENTITY copyright SYSTEM "copyright.xml">
+ <!ENTITY % idcommon SYSTEM "common/common.ent">
+ %idcommon;
]>
-<!-- $Id: auth_simple.xml,v 1.2 2006-03-27 13:41:40 adam Exp $ -->
-<refentry>
+<refentry id="ref-auth_simple">
+ <refentryinfo>
+ <productname>Metaproxy</productname>
+ <info><orgname>Index Data</orgname></info>
+ </refentryinfo>
+
<refmeta>
<refentrytitle>auth_simple</refentrytitle>
<manvolnum>3mp</manvolnum>
- <refmiscinfo>Metaproxy Module</refmiscinfo>
+ <refmiscinfo class="manual">Metaproxy Module</refmiscinfo>
</refmeta>
-
+
<refnamediv>
<refname>auth_simple</refname>
- <refpurpose>simple authentication and authorisation.</refpurpose>
+ <refpurpose>Metaproxy Simple Authentication And Authorization Module</refpurpose>
</refnamediv>
-
+
<refsect1><title>DESCRIPTION</title>
<para>
- Simple authentication and authorisation. The configuration
+ Simple authentication and authorization. The configuration
specifies the name of a file that is the user register, which
lists <varname>username</varname>:<varname>password</varname>
pairs, one per line, colon separated. When a session begins, it
is rejected unless username and passsword are supplied, and match
a pair in the register.
</para>
- <para>
- ### discuss authorisation phase
- </para>
+ <!-- TODO: discuss authorization phase -->
</refsect1>
-
+
+ <refsect1><title>SCHEMA</title>
+ <literallayout><xi:include
+ xi:href="../xml/schema/filter_auth_simple.rnc"
+ xi:parse="text"
+ xmlns:xi="http://www.w3.org/2001/XInclude" />
+ </literallayout>
+ </refsect1>
+
<refsect1><title>EXAMPLES</title>
<para>
- A typical configuration looks as likes:
+ A typical configuration looks like this:
<screen><![CDATA[
<filter type="auth_simple">
- <targetRegister>example.target-auth</targetRegister>
- <discardUnauthorisedTargets/>
- </filter>
-]]>
+ <userRegister>../etc/example.simple-auth</userRegister>
+ <targetRegister>../etc/example.target-auth</targetRegister>
+ <discardUnauthorisedTargets/>
+ </filter>
+ ]]>
</screen>
- ### Show and describe examle.target-auth here ###
</para>
- </refsect1>
-
+ <!-- Show and describe example.target-auth -->
+ </refsect1>
+
<refsect1><title>SEE ALSO</title>
<para>
<citerefentry>
</citerefentry>
</para>
</refsect1>
-
+
©right;
</refentry>
<!-- Keep this comment at the end of the file
Local variables:
-mode: sgml
-sgml-omittag:t
-sgml-shorttag:t
-sgml-minimize-attributes:nil
-sgml-always-quote-attributes:t
-sgml-indent-step:1
-sgml-indent-data:t
-sgml-parent-document:nil
-sgml-local-catalogs: nil
-sgml-namecase-general:t
+mode: nxml
+nxml-child-indent: 1
End:
-->