mirror of
https://github.com/apache/httpd.git
synced 2025-04-18 22:24:07 +03:00
01055edef2
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1907148 13f79535-47bb-0310-9956-ffa450edef68
242 lines
16 KiB
XML
242 lines
16 KiB
XML
<?xml version="1.0" encoding="UTF-8"?>
|
||
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
|
||
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head>
|
||
<meta content="text/html; charset=UTF-8" http-equiv="Content-Type" />
|
||
<!--
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
This file is generated from xml source: DO NOT EDIT
|
||
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
|
||
-->
|
||
<title>mod_authn_dbd - Apache HTTP Server Version 2.5</title>
|
||
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
|
||
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
|
||
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" /><link rel="stylesheet" type="text/css" href="../style/css/prettify.css" />
|
||
<script src="../style/scripts/prettify.min.js" type="text/javascript">
|
||
</script>
|
||
|
||
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
|
||
<body>
|
||
<div id="page-header">
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
|
||
<p class="apache">Apache HTTP Server Version 2.5</p>
|
||
<img alt="" src="../images/feather.png" /></div>
|
||
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
|
||
<div id="path">
|
||
<a href="http://www.apache.org/">Apache</a> > <a href="http://httpd.apache.org/">HTTP Server</a> > <a href="http://httpd.apache.org/docs/">Documentation</a> > <a href="../">Version 2.5</a> > <a href="./">Modules</a></div>
|
||
<div id="page-content">
|
||
<div id="preamble"><h1>Apache Module mod_authn_dbd</h1>
|
||
<div class="toplang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbd.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_authn_dbd.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</div>
|
||
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using an SQL database</td></tr>
|
||
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>authn_dbd_module</td></tr>
|
||
<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_authn_dbd.c</td></tr></table>
|
||
<h3>Summary</h3>
|
||
|
||
<p>This module provides authentication front-ends such as
|
||
<code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code> and <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code>
|
||
to authenticate users by looking up users in SQL tables.
|
||
Similar functionality is provided by, for example,
|
||
<code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>.</p>
|
||
<p>This module relies on <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code> to specify
|
||
the backend database driver and connection parameters, and
|
||
manage the database connections.</p>
|
||
|
||
<p>When using <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
|
||
<code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>, this module is invoked via the
|
||
<code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code> or
|
||
<code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
|
||
with the <code>dbd</code> value.</p>
|
||
</div>
|
||
<div id="quickview"><h3>Topics</h3>
|
||
<ul id="topics">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#socache">Performance and Caching</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#example">Configuration Example</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#exposed">Exposing Login Information</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#security">Preventing SQL injections</a></li>
|
||
</ul><h3 class="directives">Directives</h3>
|
||
<ul id="toc">
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authdbduserpwquery">AuthDBDUserPWQuery</a></li>
|
||
<li><img alt="" src="../images/down.gif" /> <a href="#authdbduserrealmquery">AuthDBDUserRealmQuery</a></li>
|
||
</ul>
|
||
<h3>Bugfix checklist</h3><ul class="seealso"><li><a href="https://www.apache.org/dist/httpd/CHANGES_2.4">httpd changelog</a></li><li><a href="https://bz.apache.org/bugzilla/buglist.cgi?bug_status=__open__&list_id=144532&product=Apache%20httpd-2&query_format=specific&order=changeddate%20DESC%2Cpriority%2Cbug_severity&component=mod_authn_dbd">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_authn_dbd">Report a bug</a></li></ul><h3>See also</h3>
|
||
<ul class="seealso">
|
||
<li><code class="directive"><a href="../mod/mod_authn_core.html#authname">AuthName</a></code></li>
|
||
<li><code class="directive"><a href="../mod/mod_authn_core.html#authtype">AuthType</a></code></li>
|
||
<li>
|
||
<code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>
|
||
</li>
|
||
<li>
|
||
<code class="directive"><a href="../mod/mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></code>
|
||
</li>
|
||
<li><code class="directive"><a href="../mod/mod_dbd.html#dbdriver">DBDriver</a></code></li>
|
||
<li><code class="directive"><a href="../mod/mod_dbd.html#dbdparams">DBDParams</a></code></li>
|
||
<li><a href="../misc/password_encryptions.html">Password Formats</a></li>
|
||
<li><a href="#comments_section">Comments</a></li></ul></div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="socache" id="socache">Performance and Caching</a> <a title="Permanent link" href="#socache" class="permalink">¶</a></h2>
|
||
|
||
<p>Some users of DBD authentication in HTTPD 2.2/2.4 have reported that it
|
||
imposes a problematic load on the database. This is most likely where
|
||
an HTML page contains hundreds of objects (e.g. images, scripts, etc)
|
||
each of which requires authentication. Users affected (or concerned)
|
||
by this kind of problem should use <code class="module"><a href="../mod/mod_authn_socache.html">mod_authn_socache</a></code>
|
||
to cache credentials and take most of the load off the database.</p>
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="example" id="example">Configuration Example</a> <a title="Permanent link" href="#example" class="permalink">¶</a></h2>
|
||
|
||
<p>This simple example shows use of this module in the context of
|
||
the Authentication and DBD frameworks.</p>
|
||
<pre class="prettyprint lang-config"># mod_dbd configuration
|
||
# UPDATED to include authentication caching
|
||
DBDriver pgsql
|
||
DBDParams "dbname=apacheauth user=apache password=xxxxxx"
|
||
|
||
DBDMin 4
|
||
DBDKeep 8
|
||
DBDMax 20
|
||
DBDExptime 300
|
||
|
||
<Directory "/usr/www/myhost/private">
|
||
# mod_authn_core and mod_auth_basic configuration
|
||
# for mod_authn_dbd
|
||
AuthType Basic
|
||
AuthName "My Server"
|
||
|
||
# To cache credentials, put socache ahead of dbd here
|
||
AuthBasicProvider socache dbd
|
||
|
||
# Also required for caching: tell the cache to cache dbd lookups!
|
||
AuthnCacheProvideFor dbd
|
||
AuthnCacheContext my-server
|
||
|
||
# mod_authz_core configuration
|
||
Require valid-user
|
||
|
||
# mod_authn_dbd SQL query to authenticate a user
|
||
AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"
|
||
</Directory></pre>
|
||
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="exposed" id="exposed">Exposing Login Information</a> <a title="Permanent link" href="#exposed" class="permalink">¶</a></h2>
|
||
|
||
<p>
|
||
Whenever a query is made to the database server, all
|
||
column values in the first row returned by the query are placed in the
|
||
environment, using environment variables with the prefix "AUTHENTICATE_".
|
||
</p>
|
||
<p>If a database query for example returned the username, full name
|
||
and telephone number of a user, a CGI program will have access to
|
||
this information without the need to make a second independent database
|
||
query to gather this additional information.</p>
|
||
<p>This has the potential to dramatically simplify the coding and
|
||
configuration required in some web applications.
|
||
</p>
|
||
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="section">
|
||
<h2><a name="security" id="security">Preventing SQL injections</a> <a title="Permanent link" href="#security" class="permalink">¶</a></h2>
|
||
|
||
<p>Whether you need to care about SQL security depends on what DBD driver
|
||
and backend you use. With most drivers you don't have to do anything :
|
||
the statement is prepared by the database at startup, and user input is
|
||
used only as data. But you may need to untaint your input. At the time
|
||
of writing, the only driver that requires you to take care is FreeTDS.</p>
|
||
<p>Please read <code class="module"><a href="../mod/mod_dbd.html">mod_dbd</a></code> documentation for more information
|
||
about security on this scope.</p>
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="AuthDBDUserPWQuery" id="AuthDBDUserPWQuery">AuthDBDUserPWQuery</a> <a name="authdbduserpwquery" id="authdbduserpwquery">Directive</a> <a title="Permanent link" href="#authdbduserpwquery" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SQL query to look up a password for a user</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBDUserPWQuery <var>query</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbd</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">AuthDBDUserPWQuery</code> specifies an
|
||
SQL query to look up a password for a specified user. The user's ID
|
||
will be passed as a single string parameter when the SQL query is
|
||
executed. It may be referenced within the query statement using
|
||
a <code>%s</code> format specifier.</p>
|
||
<pre class="prettyprint lang-config">AuthDBDUserPWQuery "SELECT password FROM authn WHERE user = %s"</pre>
|
||
|
||
<p>The first column value of the first row returned by the query
|
||
statement should be a string containing the encrypted password.
|
||
Subsequent rows will be ignored. If no rows are returned, the user
|
||
will not be authenticated through <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>.</p>
|
||
<p>Any additional column values in the first row returned by
|
||
the query statement will be stored as environment variables with
|
||
names of the form <code>AUTHENTICATE_<var>COLUMN</var></code>.
|
||
</p>
|
||
<p>The encrypted password format depends on which authentication
|
||
frontend (e.g. <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
|
||
<code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>) is being used. See <a href="../misc/password_encryptions.html">Password Formats</a> for
|
||
more information.</p>
|
||
|
||
</div>
|
||
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
|
||
<div class="directive-section"><h2><a name="AuthDBDUserRealmQuery" id="AuthDBDUserRealmQuery">AuthDBDUserRealmQuery</a> <a name="authdbduserrealmquery" id="authdbduserrealmquery">Directive</a> <a title="Permanent link" href="#authdbduserrealmquery" class="permalink">¶</a></h2>
|
||
<table class="directive">
|
||
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>SQL query to look up a password hash for a user and realm.
|
||
</td></tr>
|
||
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDBDUserRealmQuery <var>query</var></code></td></tr>
|
||
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory</td></tr>
|
||
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Extension</td></tr>
|
||
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_authn_dbd</td></tr>
|
||
</table>
|
||
<p>The <code class="directive">AuthDBDUserRealmQuery</code> specifies an
|
||
SQL query to look up a password for a specified user and realm in a
|
||
digest authentication process.
|
||
The user's ID and the realm, in that order, will be passed as string
|
||
parameters when the SQL query is executed. They may be referenced
|
||
within the query statement using <code>%s</code> format specifiers.</p>
|
||
<pre class="prettyprint lang-config">AuthDBDUserRealmQuery "SELECT password FROM authn WHERE user = %s AND realm = %s"</pre>
|
||
|
||
<p>The first column value of the first row returned by the query
|
||
statement should be a string containing the encrypted password.
|
||
Subsequent rows will be ignored. If no rows are returned, the user
|
||
will not be authenticated through <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code>.</p>
|
||
<p>Any additional column values in the first row returned by
|
||
the query statement will be stored as environment variables with
|
||
names of the form <code>AUTHENTICATE_<var>COLUMN</var></code>.
|
||
</p>
|
||
<p>The encrypted password format depends on which authentication
|
||
frontend (e.g. <code class="module"><a href="../mod/mod_auth_basic.html">mod_auth_basic</a></code> or
|
||
<code class="module"><a href="../mod/mod_auth_digest.html">mod_auth_digest</a></code>) is being used. See <a href="../misc/password_encryptions.html">Password Formats</a> for
|
||
more information.</p>
|
||
|
||
</div>
|
||
</div>
|
||
<div class="bottomlang">
|
||
<p><span>Available Languages: </span><a href="../en/mod/mod_authn_dbd.html" title="English"> en </a> |
|
||
<a href="../fr/mod/mod_authn_dbd.html" hreflang="fr" rel="alternate" title="Français"> fr </a></p>
|
||
</div><div class="top"><a href="#page-header"><img src="../images/up.gif" alt="top" /></a></div><div class="section"><h2><a id="comments_section" name="comments_section">Comments</a></h2><div class="warning"><strong>Notice:</strong><br />This is not a Q&A section. Comments placed here should be pointed towards suggestions on improving the documentation or server, and may be removed by our moderators if they are either implemented or considered invalid/off-topic. Questions on how to manage the Apache HTTP Server should be directed at either our IRC channel, #httpd, on Libera.chat, or sent to our <a href="https://httpd.apache.org/lists.html">mailing lists</a>.</div>
|
||
<script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
var comments_shortname = 'httpd';
|
||
var comments_identifier = 'http://httpd.apache.org/docs/trunk/mod/mod_authn_dbd.html';
|
||
(function(w, d) {
|
||
if (w.location.hostname.toLowerCase() == "httpd.apache.org") {
|
||
d.write('<div id="comments_thread"><\/div>');
|
||
var s = d.createElement('script');
|
||
s.type = 'text/javascript';
|
||
s.async = true;
|
||
s.src = 'https://comments.apache.org/show_comments.lua?site=' + comments_shortname + '&page=' + comments_identifier;
|
||
(d.getElementsByTagName('head')[0] || d.getElementsByTagName('body')[0]).appendChild(s);
|
||
}
|
||
else {
|
||
d.write('<div id="comments_thread">Comments are disabled for this page at the moment.<\/div>');
|
||
}
|
||
})(window, document);
|
||
//--><!]]></script></div><div id="footer">
|
||
<p class="apache">Copyright 2023 The Apache Software Foundation.<br />Licensed under the <a href="http://www.apache.org/licenses/LICENSE-2.0">Apache License, Version 2.0</a>.</p>
|
||
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/quickreference.html">Directives</a> | <a href="http://wiki.apache.org/httpd/FAQ">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div><script type="text/javascript"><!--//--><![CDATA[//><!--
|
||
if (typeof(prettyPrint) !== 'undefined') {
|
||
prettyPrint();
|
||
}
|
||
//--><!]]></script>
|
||
</body></html> |