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

   1 <?xml version="1.0"?>\r
   2 <!DOCTYPE modulesynopsis SYSTEM "../style/modulesynopsis.dtd">\r
   3 <?xml-stylesheet type="text/xsl" href="../style/manual.en.xsl"?>\r
   4 <!-- $LastChangedRevision: 151408 $ -->\r
   5 \r
   6 <!--\r
   7  Copyright 2002-2005 The Apache Software Foundation or its licensors, as\r
   8  applicable.\r
   9 \r
  10  Licensed under the Apache License, Version 2.0 (the "License");\r
  11  you may not use this file except in compliance with the License.\r
  12  You may obtain a copy of the License at\r
  13 \r
  14      http://www.apache.org/licenses/LICENSE-2.0\r
  15 \r
  16  Unless required by applicable law or agreed to in writing, software\r
  17  distributed under the License is distributed on an "AS IS" BASIS,\r
  18  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\r
  19  See the License for the specific language governing permissions and\r
  20  limitations under the License.\r
  21 -->\r
  22 \r
  23 <modulesynopsis metafile="mod_authn_core.xml.meta">\r
  24 \r
  25 <name>mod_authn_core</name> \r
  26 <description>Core Authentication</description>\r
  27 <status>Base</status>\r
  28 <sourcefile>mod_authn_core.c</sourcefile>\r
  29 <identifier>authn_core_module</identifier>\r
  30 <compatibility>Available in Apache 2.3 and later</compatibility>\r
  31 \r
  32 <summary>\r
  33     <p>This module provides core authentication capabilities to \r
  34     allow or deny access to portions of the web site. \r
  35     <module>mod_authn_core</module> provides directives that are \r
  36     common to all authentication providers.</p>\r
  37 </summary>\r
  38 \r
  39 <directivesynopsis>\r
  40 <name>AuthName</name>\r
  41 <description>Authorization realm for use in HTTP\r
  42 authentication</description>\r
  43 <syntax>AuthName <var>auth-domain</var></syntax>\r
  44 <contextlist><context>directory</context><context>.htaccess</context>\r
  45 </contextlist>\r
  46 <override>AuthConfig</override>\r
  47 \r
  48 <usage>\r
  49     <p>This directive sets the name of the authorization realm for a\r
  50     directory. This realm is given to the client so that the user\r
  51     knows which username and password to send.\r
  52     <directive>AuthName</directive> takes a single argument; if the\r
  53     realm name contains spaces, it must be enclosed in quotation\r
  54     marks.  It must be accompanied by <directive\r
  55     module="mod_authn_core">AuthType</directive> and <directive\r
  56     module="mod_authz_core">Require</directive> directives, and directives such\r
  57     as <directive module="mod_authn_file">AuthUserFile</directive> and\r
  58     <directive module="mod_authz_groupfile">AuthGroupFile</directive> to\r
  59     work.</p>\r
  60 \r
  61    <p>For example:</p>\r
  62 \r
  63    <example>\r
  64      AuthName "Top Secret"\r
  65    </example>\r
  66 \r
  67     <p>The string provided for the <code>AuthName</code> is what will\r
  68     appear in the password dialog provided by most browsers.</p>\r
  69 </usage>\r
  70 <seealso><a\r
  71     href="../howto/auth.html">Authentication, Authorization, and\r
  72     Access Control</a></seealso>\r
  73 </directivesynopsis>\r
  74 \r
  75 <directivesynopsis>\r
  76 <name>AuthType</name>\r
  77 <description>Type of user authentication</description>\r
  78 <syntax>AuthType Basic|Digest</syntax>\r
  79 <contextlist><context>directory</context><context>.htaccess</context>\r
  80 </contextlist>\r
  81 <override>AuthConfig</override>\r
  82 \r
  83 <usage>\r
  84     <p>This directive selects the type of user authentication for a\r
  85     directory. The authentication types available are\r
  86     <code>Basic</code> (implemented by\r
  87     <module>mod_auth_basic</module>) and <code>Digest</code>\r
  88     (implemented by <module>mod_auth_digest</module>).</p>\r
  89 \r
  90     <p>To implement authentication, you must also use the <directive\r
  91     module="mod_authn_core">AuthName</directive> and <directive\r
  92     module="mod_authz_core">Require</directive> directives.  In addition, the\r
  93     server must have an authentication-provider module such as\r
  94     <module>mod_authn_file</module> and an authorization module such\r
  95     as <module>mod_authz_user</module>.</p>\r
  96 </usage> \r
  97 \r
  98 <seealso><a href="../howto/auth.html">Authentication, Authorization,\r
  99     and Access Control</a></seealso> \r
 100 </directivesynopsis>\r
 101 \r
 102 \r
 103 </modulesynopsis>\r