granicus.if.org Git - apache/blob - docs/manual/mod/mod_authn_alias.xml

   1 <?xml version="1.0"?>
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>
   4 <!-- $LastChangedRevision$ -->
   5
   6 <!--
   7  Copyright 2002-2005 The Apache Software Foundation or its licensors, as
   8  applicable.
   9
  10  Licensed under the Apache License, Version 2.0 (the "License");
  11  you may not use this file except in compliance with the License.
  12  You may obtain a copy of the License at
  13
  14      http://www.apache.org/licenses/LICENSE-2.0
  15
  16  Unless required by applicable law or agreed to in writing, software
  17  distributed under the License is distributed on an "AS IS" BASIS,
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  19  See the License for the specific language governing permissions and
  20  limitations under the License.
  21 -->
  22
  23 <modulesynopsis metafile="mod_authn_alias.xml.meta">
  24
  25 <name>mod_authn_alias</name>
  26 <description>Provides the ability to create extended authentication
  27     providers based on actual providers</description>
  28 <status>Extension</status>
  29 <sourcefile>mod_authn_alias.c</sourcefile>
  30 <identifier>authn_alias_module</identifier>
  31 <compatibility>Available in Apache 2.1 and later</compatibility>
  32
  33 <summary>
  34     <p>This module allows extended authentication providers to be created
  35     within the configuration file and assigned an alias name.  The alias
  36     providers can then be referenced through the directives
  37     <directive module="mod_auth_basic">AuthBasicProvider</directive> or
  38     <directive module="mod_auth_digest">AuthDigestProvider</directive> in
  39     the same way as a base authentication provider.  Besides the ability
  40     to create and alias an extended provider, it also allows the same
  41     extended authentication provider to be reference by multiple
  42     locations.</p>
  43
  44 </summary>
  45
  46 <section id="example"><title>Example</title>
  47     <p>The example below creates two different ldap authentication
  48     provider aliases based on the ldap provider.  This allows
  49     a single authenticated location can be serviced by multiple
  50     ldap hosts:</p>
  51
  52     <example><title>Example</title>
  53       LoadModule authn_alias_module modules/mod_authn_alias.so<br /><br />
  54       &lt;AuthnProviderAlias ldap ldap-alias1&gt;<br />
  55       <indent>
  56          AuthLDAPBindDN cn=youruser,o=ctx<br />
  57          AuthLDAPBindPassword yourpassword<br />
  58          AuthLDAPURL ldap://ldap.host/o=ctx<br />
  59       </indent>
  60       &lt;/AuthnProviderAlias&gt;<br /><br />
  61       &lt;AuthnProviderAlias ldap ldap-other-alias&gt;<br />
  62       <indent>
  63          AuthLDAPBindDN cn=yourotheruser,o=dev<br />
  64          AuthLDAPBindPassword yourotherpassword<br />
  65          AuthLDAPURL ldap://other.ldap.host/o=dev?cn<br />
  66       </indent>
  67       &lt;/AuthnProviderAlias&gt;<br /><br />
  68
  69       Alias /secure /webpages/secure<br />
  70       &lt;Directory /webpages/secure&gt;<br />
  71       <indent>
  72          Order deny,allow<br />
  73          Allow from all<br /><br />
  74
  75          AuthBasicProvider ldap-other-alias  ldap-alias1<br /><br />
  76
  77          AuthType Basic<br />
  78          AuthName LDAP_Protected_Place<br />
  79          require valid-user<br />
  80       </indent>
  81       &lt;/Directory&gt;<br />
  82     </example>
  83 </section>
  84
  85 <directivesynopsis type="section">
  86 <name>AuthnProviderAlias</name>
  87 <description>Enclose a group of directives that represent an
  88 extension of a base authentication provider and referenced by
  89 the specified alias</description>
  90 <syntax>&lt;AuthnProviderAlias <var>baseProvider Alias</var>&gt;
  91 ... &lt;/AuthnProviderAlias&gt;</syntax>
  92 <contextlist><context>server config</context><context>virtual host</context>
  93 </contextlist>
  94
  95 <usage>
  96     <p><directive type="section">AuthnProviderAlias</directive> and
  97     <code>&lt;/AuthnProviderAlias&gt;</code> are used to enclose a group of
  98     authentication directives that can be referenced by the alias name
  99     using one of the directives <directive module="mod_auth_basic">
 100     AuthBasicProvider</directive> or <directive module="mod_auth_digest">
 101     AuthDigestProvider</directive>.</p>
 102
 103 </usage>
 104 </directivesynopsis>
 105
 106 </modulesynopsis>