1
<?xml version="1.0" encoding="ISO-8859-1"?>
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
3
<html xmlns="http://www.w3.org/1999/xhtml" lang="en" xml:lang="en"><head><!--
4
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
5
This file is generated from xml source: DO NOT EDIT
6
XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
8
<title>mod_auth_digest - Apache HTTP Server</title>
9
<link href="../style/css/manual.css" rel="stylesheet" media="all" type="text/css" title="Main stylesheet" />
10
<link href="../style/css/manual-loose-100pc.css" rel="alternate stylesheet" media="all" type="text/css" title="No Sidebar - Default font size" />
11
<link href="../style/css/manual-print.css" rel="stylesheet" media="print" type="text/css" />
12
<link href="../images/favicon.ico" rel="shortcut icon" /></head>
14
<div id="page-header">
15
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p>
16
<p class="apache">Apache HTTP Server Version 2.2</p>
17
<img alt="" src="../images/feather.gif" /></div>
18
<div class="up"><a href="./"><img title="<-" alt="<-" src="../images/left.gif" /></a></div>
20
<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.2</a> > <a href="./">Modules</a></div>
21
<div id="page-content">
22
<div id="preamble"><h1>Apache Module mod_auth_digest</h1>
24
<p><span>Available Languages: </span><a href="../en/mod/mod_auth_digest.html" title="English"> en </a> |
25
<a href="../ko/mod/mod_auth_digest.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
27
<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>User authentication using MD5
28
Digest Authentication.</td></tr>
29
<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
30
<tr><th><a href="module-dict.html#ModuleIdentifier">Module�Identifier:</a></th><td>auth_digest_module</td></tr>
31
<tr><th><a href="module-dict.html#SourceFile">Source�File:</a></th><td>mod_auth_digest.c</td></tr></table>
34
<p>This module implements HTTP Digest Authentication. However, it
35
has not been extensively tested and is therefore marked
38
<div id="quickview"><h3 class="directives">Directives</h3>
40
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestalgorithm">AuthDigestAlgorithm</a></li>
41
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestdomain">AuthDigestDomain</a></li>
42
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestnccheck">AuthDigestNcCheck</a></li>
43
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestnonceformat">AuthDigestNonceFormat</a></li>
44
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestnoncelifetime">AuthDigestNonceLifetime</a></li>
45
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestprovider">AuthDigestProvider</a></li>
46
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestqop">AuthDigestQop</a></li>
47
<li><img alt="" src="../images/down.gif" /> <a href="#authdigestshmemsize">AuthDigestShmemSize</a></li>
51
<li><img alt="" src="../images/down.gif" /> <a href="#using">Using Digest Authentication</a></li>
52
<li><img alt="" src="../images/down.gif" /> <a href="#msie">Working with MS Internet Explorer</a></li>
53
</ul><h3>See also</h3>
55
<li><code class="directive"><a href="../mod/core.html#authname">AuthName</a></code></li>
56
<li><code class="directive"><a href="../mod/core.html#authtype">AuthType</a></code></li>
57
<li><code class="directive"><a href="../mod/core.html#require">Require</a></code></li>
58
<li><code class="directive"><a href="../mod/core.html#satisfy">Satisfy</a></code></li>
59
<li><a href="../howto/auth.html">Authentication howto</a></li>
61
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
63
<h2><a name="using" id="using">Using Digest Authentication</a></h2>
65
<p>Using MD5 Digest authentication is very simple. Simply set
66
up authentication normally, using <code>AuthType Digest</code> and
67
<code class="directive"><a href="#authdigestprovider">AuthDigestProvider</a></code>
68
instead of the normal <code>AuthType Basic</code> and
69
<code class="directive"><a href="../mod/mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></code>.
70
Then add a <code class="directive"><a href="#authdigestdomain">AuthDigestDomain</a></code> directive containing at least the root
71
URI(s) for this protection space.</p>
73
<p>Appropriate user (text) files can be created using the
74
<code class="program"><a href="../programs/htdigest.html">htdigest</a></code> tool.</p>
76
<div class="example"><h3>Example:</h3><p><code>
77
<Location /private/><br />
80
AuthName "private area"<br />
81
AuthDigestDomain /private/ http://mirror.my.dom/private2/<br />
83
AuthDigestProvider file<br />
84
AuthUserFile /web/auth/.digest_pw<br />
85
Require valid-user<br />
90
<div class="note"><h3>Note</h3>
91
<p>Digest authentication is more secure than Basic authentication,
92
but only works with supporting browsers. As of September 2004, major
93
browsers that support digest authentication include <a href="http://www.w3.org/Amaya/">Amaya</a>, <a href="http://konqueror.kde.org/">Konqueror</a>, <a href="http://www.microsoft.com/windows/ie/">MS Internet Explorer</a>
94
for Mac OS X and Windows (although the Windows version fails when
95
used with a query string -- see "<a href="#msie">Working with MS
96
Internet Explorer</a>" below for a workaround), <a href="http://www.mozilla.org">Mozilla</a>, <a href="http://channels.netscape.com/ns/browsers/download.jsp">
97
Netscape</a> 7, <a href="http://www.opera.com/">Opera</a>, and <a href="http://www.apple.com/safari/">Safari</a>. <a href="http://lynx.isc.org/">lynx</a> does <strong>not</strong>
98
support digest authentication. Since digest authentication is not as
99
widely implemented as basic authentication, you should use it only
100
in environments where all users will have supporting browsers.</p>
102
</div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
103
<div class="section">
104
<h2><a name="msie" id="msie">Working with MS Internet Explorer</a></h2>
105
<p>The Digest authentication implementation in current Internet
106
Explorer for Windows implementations has known issues, namely that
107
<code>GET</code> requests with a query string are not RFC compliant.
108
There are a few ways to work around this issue.</p>
111
The first way is to use <code>POST</code> requests instead of
112
<code>GET</code> requests to pass data to your program. This method
113
is the simplest approach if your application can work with this
117
<p>Since version 2.0.51 Apache also provides a workaround in the
118
<code>AuthDigestEnableQueryStringHack</code> environment variable.
119
If <code>AuthDigestEnableQueryStringHack</code> is set for the
120
request, Apache will take steps to work around the MSIE bug and
121
remove the request URI from the digest comparison. Using this
122
method would look similar to the following.</p>
124
<div class="example"><h3>Using Digest Authentication with MSIE:</h3><p><code>
125
BrowserMatch "MSIE" AuthDigestEnableQueryStringHack=On
128
<p>See the <code class="directive"><a href="../mod/mod_setenvif.html#browsermatch">BrowserMatch</a></code>
129
directive for more details on conditionally setting environment
132
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
133
<div class="directive-section"><h2><a name="AuthDigestAlgorithm" id="AuthDigestAlgorithm">AuthDigestAlgorithm</a> <a name="authdigestalgorithm" id="authdigestalgorithm">Directive</a></h2>
134
<table class="directive">
135
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Selects the algorithm used to calculate the challenge and
136
response hashes in digest authentication</td></tr>
137
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestAlgorithm MD5|MD5-sess</code></td></tr>
138
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestAlgorithm MD5</code></td></tr>
139
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
140
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
141
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
142
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
144
<p>The <code class="directive">AuthDigestAlgorithm</code> directive
145
selects the algorithm used to calculate the challenge and response
149
<code>MD5-sess</code> is not correctly implemented yet.
154
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
155
<div class="directive-section"><h2><a name="AuthDigestDomain" id="AuthDigestDomain">AuthDigestDomain</a> <a name="authdigestdomain" id="authdigestdomain">Directive</a></h2>
156
<table class="directive">
157
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>URIs that are in the same protection space for digest
158
authentication</td></tr>
159
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestDomain <var>URI</var> [<var>URI</var>] ...</code></td></tr>
160
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
161
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
162
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
163
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
165
<p>The <code class="directive">AuthDigestDomain</code> directive allows
166
you to specify one or more URIs which are in the same protection
167
space (<em>i.e.</em> use the same realm and username/password info).
168
The specified URIs are prefixes; the client will assume
169
that all URIs "below" these are also protected by the same
170
username/password. The URIs may be either absolute URIs (<em>i.e.</em>
171
including a scheme, host, port, etc.) or relative URIs.</p>
173
<p>This directive <em>should</em> always be specified and
174
contain at least the (set of) root URI(s) for this space.
175
Omitting to do so will cause the client to send the
176
Authorization header for <em>every request</em> sent to this
177
server. Apart from increasing the size of the request, it may
178
also have a detrimental effect on performance if <code class="directive"><a href="#authdigestnccheck">AuthDigestNcCheck</a></code> is on.</p>
180
<p>The URIs specified can also point to different servers, in
181
which case clients (which understand this) will then share
182
username/password info across multiple servers without
183
prompting the user each time. </p>
186
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
187
<div class="directive-section"><h2><a name="AuthDigestNcCheck" id="AuthDigestNcCheck">AuthDigestNcCheck</a> <a name="authdigestnccheck" id="authdigestnccheck">Directive</a></h2>
188
<table class="directive">
189
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enables or disables checking of the nonce-count sent by the
191
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestNcCheck On|Off</code></td></tr>
192
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestNcCheck Off</code></td></tr>
193
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
194
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
195
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
203
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
204
<div class="directive-section"><h2><a name="AuthDigestNonceFormat" id="AuthDigestNonceFormat">AuthDigestNonceFormat</a> <a name="authdigestnonceformat" id="authdigestnonceformat">Directive</a></h2>
205
<table class="directive">
206
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines how the nonce is generated</td></tr>
207
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestNonceFormat <var>format</var></code></td></tr>
208
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
209
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
210
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
211
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
213
<div class="note">Not implemented yet.</div>
217
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
218
<div class="directive-section"><h2><a name="AuthDigestNonceLifetime" id="AuthDigestNonceLifetime">AuthDigestNonceLifetime</a> <a name="authdigestnoncelifetime" id="authdigestnoncelifetime">Directive</a></h2>
219
<table class="directive">
220
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>How long the server nonce is valid</td></tr>
221
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestNonceLifetime <var>seconds</var></code></td></tr>
222
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestNonceLifetime 300</code></td></tr>
223
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
224
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
225
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
226
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
228
<p>The <code class="directive">AuthDigestNonceLifetime</code> directive
229
controls how long the server nonce is valid. When the client
230
contacts the server using an expired nonce the server will send
231
back a 401 with <code>stale=true</code>. If <var>seconds</var> is
232
greater than 0 then it specifies the amount of time for which the
233
nonce is valid; this should probably never be set to less than 10
234
seconds. If <var>seconds</var> is less than 0 then the nonce never
239
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
240
<div class="directive-section"><h2><a name="AuthDigestProvider" id="AuthDigestProvider">AuthDigestProvider</a> <a name="authdigestprovider" id="authdigestprovider">Directive</a></h2>
241
<table class="directive">
242
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the authentication provider(s) for this location</td></tr>
243
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestProvider <var>provider-name</var>
244
[<var>provider-name</var>] ...</code></td></tr>
245
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestProvider file</code></td></tr>
246
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
247
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
248
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
249
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
251
<p>The <code class="directive">AuthDigestProvider</code> directive sets
252
which provider is used to authenticate the users for this location.
253
The default <code>file</code> provider is implemented
254
by the <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code> module. Make sure
255
that the chosen provider module is present in the server.</p>
257
<p>See <code class="module"><a href="../mod/mod_authn_dbm.html">mod_authn_dbm</a></code>, <code class="module"><a href="../mod/mod_authn_file.html">mod_authn_file</a></code>,
258
and <code class="module"><a href="../mod/mod_authn_dbd.html">mod_authn_dbd</a></code> for providers.</p>
261
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
262
<div class="directive-section"><h2><a name="AuthDigestQop" id="AuthDigestQop">AuthDigestQop</a> <a name="authdigestqop" id="authdigestqop">Directive</a></h2>
263
<table class="directive">
264
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Determines the quality-of-protection to use in digest
265
authentication</td></tr>
266
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestQop none|auth|auth-int [auth|auth-int]</code></td></tr>
267
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestQop auth</code></td></tr>
268
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr>
269
<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr>
270
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
271
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
273
<p>The <code class="directive">AuthDigestQop</code> directive determines
274
the <dfn>quality-of-protection</dfn> to use. <code>auth</code> will
275
only do authentication (username/password); <code>auth-int</code> is
276
authentication plus integrity checking (an MD5 hash of the entity
277
is also computed and checked); <code>none</code> will cause the module
278
to use the old RFC-2069 digest algorithm (which does not include
279
integrity checking). Both <code>auth</code> and <code>auth-int</code> may
280
be specified, in which the case the browser will choose which of
281
these to use. <code>none</code> should only be used if the browser for
282
some reason does not like the challenge it receives otherwise.</p>
285
<code>auth-int</code> is not implemented yet.
289
<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div>
290
<div class="directive-section"><h2><a name="AuthDigestShmemSize" id="AuthDigestShmemSize">AuthDigestShmemSize</a> <a name="authdigestshmemsize" id="authdigestshmemsize">Directive</a></h2>
291
<table class="directive">
292
<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The amount of shared memory to allocate for keeping track
294
<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthDigestShmemSize <var>size</var></code></td></tr>
295
<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthDigestShmemSize 1000</code></td></tr>
296
<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr>
297
<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Experimental</td></tr>
298
<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_digest</td></tr>
300
<p>The <code class="directive">AuthDigestShmemSize</code> directive defines
301
the amount of shared memory, that will be allocated at the server
302
startup for keeping track of clients. Note that the shared memory
303
segment cannot be set less than the space that is necessary for
304
tracking at least <em>one</em> client. This value is dependant on your
305
system. If you want to find out the exact value, you may simply
306
set <code class="directive">AuthDigestShmemSize</code> to the value of
307
<code>0</code> and read the error message after trying to start the
310
<p>The <var>size</var> is normally expressed in Bytes, but you
311
may let the number follow a <code>K</code> or an <code>M</code> to
312
express your value as KBytes or MBytes. For example, the following
313
directives are all equivalent:</p>
315
<div class="example"><p><code>
316
AuthDigestShmemSize 1048576<br />
317
AuthDigestShmemSize 1024K<br />
318
AuthDigestShmemSize 1M
323
<div class="bottomlang">
324
<p><span>Available Languages: </span><a href="../en/mod/mod_auth_digest.html" title="English"> en </a> |
325
<a href="../ko/mod/mod_auth_digest.html" hreflang="ko" rel="alternate" title="Korean"> ko </a></p>
326
</div><div id="footer">
327
<p class="apache">Copyright 2006 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>
328
<p class="menu"><a href="../mod/">Modules</a> | <a href="../mod/directives.html">Directives</a> | <a href="../faq/">FAQ</a> | <a href="../glossary.html">Glossary</a> | <a href="../sitemap.html">Sitemap</a></p></div>
b'\\ No newline at end of file'
added
removed
docs/manual/mod/mod_auth_digest.html.en
