diff options
| author | Graham Leggett <minfrin@apache.org> | 2023-04-25 17:52:58 +0000 |
|---|---|---|
| committer | Graham Leggett <minfrin@apache.org> | 2023-04-25 17:52:58 +0000 |
| commit | 409508c6dbd16d84a06b89c2a884644266888c89 (patch) | |
| tree | 4ecb679d05ad0ff2aaab9584f45795e49c33beb1 | |
| parent | d8246a15d78d3f51acc19ef8a826c7e34f1f8406 (diff) | |
| download | httpd-409508c6dbd16d84a06b89c2a884644266888c89.tar.gz | |
Regenerate docs.
git-svn-id: https://svn.apache.org/repos/asf/httpd/httpd/trunk@1909412 13f79535-47bb-0310-9956-ffa450edef68
24 files changed, 1008 insertions, 155 deletions
diff --git a/docs/manual/developer/new_api_2_6.html.en.utf8 b/docs/manual/developer/new_api_2_6.html.en.utf8 index e9efb390f8..ad3c614680 100644 --- a/docs/manual/developer/new_api_2_6.html.en.utf8 +++ b/docs/manual/developer/new_api_2_6.html.en.utf8 @@ -62,6 +62,22 @@ <p>Introduces a new API to fill me in.</p> + <h3><a name="http_request" id="http_request">http_request (changed)</a></h3> + + <ul> + <li>New autht_provider API</li> + <li>New <code>token_checker</code> hook to handle authentication based on + mechanisms other than username and password.</li> + <li>New function <code>ap_hook_check_autht</code>, as an addition to + <code>ap_hook_check_authn</code> and <code>ap_hook_check_authz</code>.</li> + </ul> + + + <h3><a name="mod_auth" id="mod_auth">mod_auth (changed)</a></h3> + + <p>Adds an additional provider framework for autht - token authentication.</p> + + </div><div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> <div class="section"> <h2><a name="upgrading" id="upgrading">Specific information on upgrading modules from 2.4</a> <a title="Permanent link" href="#upgrading" class="permalink">¶</a></h2> diff --git a/docs/manual/mod/allmodules.xml b/docs/manual/mod/allmodules.xml index fb0599b4f8..0a9d8b752b 100644 --- a/docs/manual/mod/allmodules.xml +++ b/docs/manual/mod/allmodules.xml @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml</modulefile> <modulefile>mod_auth_basic.xml</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/allmodules.xml.de b/docs/manual/mod/allmodules.xml.de index 88b0200fc2..a006ef32e6 100644 --- a/docs/manual/mod/allmodules.xml.de +++ b/docs/manual/mod/allmodules.xml.de @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml</modulefile> <modulefile>mod_auth_basic.xml</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/allmodules.xml.es b/docs/manual/mod/allmodules.xml.es index 162959f4f9..adbf12bc0c 100644 --- a/docs/manual/mod/allmodules.xml.es +++ b/docs/manual/mod/allmodules.xml.es @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml.es</modulefile> <modulefile>mod_asis.xml.es</modulefile> <modulefile>mod_auth_basic.xml.es</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/allmodules.xml.fr b/docs/manual/mod/allmodules.xml.fr index eec64c1307..96eb4eec3f 100644 --- a/docs/manual/mod/allmodules.xml.fr +++ b/docs/manual/mod/allmodules.xml.fr @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml.fr</modulefile> <modulefile>mod_asis.xml.fr</modulefile> <modulefile>mod_auth_basic.xml.fr</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml.fr</modulefile> <modulefile>mod_auth_form.xml.fr</modulefile> <modulefile>mod_authn_anon.xml.fr</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml.fr</modulefile> <modulefile>mod_authnz_fcgi.xml.fr</modulefile> <modulefile>mod_authnz_ldap.xml.fr</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml.fr</modulefile> <modulefile>mod_authz_dbd.xml.fr</modulefile> <modulefile>mod_authz_dbm.xml.fr</modulefile> diff --git a/docs/manual/mod/allmodules.xml.ja b/docs/manual/mod/allmodules.xml.ja index 0bf76503fe..41e672e09f 100644 --- a/docs/manual/mod/allmodules.xml.ja +++ b/docs/manual/mod/allmodules.xml.ja @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml.ja</modulefile> <modulefile>mod_auth_basic.xml.ja</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml.ja</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/allmodules.xml.ko b/docs/manual/mod/allmodules.xml.ko index 56518322f4..e48a33dcd6 100644 --- a/docs/manual/mod/allmodules.xml.ko +++ b/docs/manual/mod/allmodules.xml.ko @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml.ko</modulefile> <modulefile>mod_auth_basic.xml.ko</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml.ko</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml.ko</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml.ko</modulefile> diff --git a/docs/manual/mod/allmodules.xml.tr b/docs/manual/mod/allmodules.xml.tr index 73964e6954..803b945361 100644 --- a/docs/manual/mod/allmodules.xml.tr +++ b/docs/manual/mod/allmodules.xml.tr @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml</modulefile> <modulefile>mod_auth_basic.xml</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/allmodules.xml.zh-cn b/docs/manual/mod/allmodules.xml.zh-cn index fb0599b4f8..0a9d8b752b 100644 --- a/docs/manual/mod/allmodules.xml.zh-cn +++ b/docs/manual/mod/allmodules.xml.zh-cn @@ -10,6 +10,7 @@ <modulefile>mod_allowmethods.xml</modulefile> <modulefile>mod_asis.xml</modulefile> <modulefile>mod_auth_basic.xml</modulefile> + <modulefile>mod_auth_bearer.xml</modulefile> <modulefile>mod_auth_digest.xml</modulefile> <modulefile>mod_auth_form.xml</modulefile> <modulefile>mod_authn_anon.xml</modulefile> @@ -20,6 +21,8 @@ <modulefile>mod_authn_socache.xml</modulefile> <modulefile>mod_authnz_fcgi.xml</modulefile> <modulefile>mod_authnz_ldap.xml</modulefile> + <modulefile>mod_autht_core.xml</modulefile> + <modulefile>mod_autht_jwt.xml</modulefile> <modulefile>mod_authz_core.xml</modulefile> <modulefile>mod_authz_dbd.xml</modulefile> <modulefile>mod_authz_dbm.xml</modulefile> diff --git a/docs/manual/mod/directives.html.en.utf8 b/docs/manual/mod/directives.html.en.utf8 index 27ef9fca4d..04022ee416 100644 --- a/docs/manual/mod/directives.html.en.utf8 +++ b/docs/manual/mod/directives.html.en.utf8 @@ -91,6 +91,9 @@ <li><a href="mod_auth_basic.html#authbasicfake">AuthBasicFake</a></li> <li><a href="mod_auth_basic.html#authbasicprovider">AuthBasicProvider</a></li> <li><a href="mod_auth_basic.html#authbasicusedigestalgorithm">AuthBasicUseDigestAlgorithm</a></li> +<li><a href="mod_auth_bearer.html#authbearerauthoritative">AuthBearerAuthoritative</a></li> +<li><a href="mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></li> +<li><a href="mod_auth_bearer.html#authbearerproxy">AuthBearerProxy</a></li> <li><a href="mod_authn_dbd.html#authdbduserpwquery">AuthDBDUserPWQuery</a></li> <li><a href="mod_authn_dbd.html#authdbduserrealmquery">AuthDBDUserRealmQuery</a></li> <li><a href="mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></li> @@ -149,6 +152,11 @@ <li><a href="mod_authn_core.html#authnprovideralias"><AuthnProviderAlias></a></li> <li><a href="mod_authnz_fcgi.html#authnzfcgicheckauthnprovider">AuthnzFcgiCheckAuthnProvider</a></li> <li><a href="mod_authnz_fcgi.html#authnzfcgidefineprovider">AuthnzFcgiDefineProvider</a></li> +<li><a href="mod_autht_jwt.html#authtjwtclaim">AuthtJwtClaim</a></li> +<li><a href="mod_autht_jwt.html#authtjwtdriver">AuthtJwtDriver</a></li> +<li><a href="mod_autht_jwt.html#authtjwtsign">AuthtJwtSign</a></li> +<li><a href="mod_autht_jwt.html#authtjwtverify">AuthtJwtVerify</a></li> +<li><a href="mod_autht_core.html#authtprovideralias"><AuthtProviderAlias></a></li> <li><a href="mod_authn_core.html#authtype">AuthType</a></li> <li><a href="mod_authn_file.html#authuserfile">AuthUserFile</a></li> <li><a href="mod_authz_dbd.html#authzdbdlogintoreferer">AuthzDBDLoginToReferer</a></li> diff --git a/docs/manual/mod/index.html.en.utf8 b/docs/manual/mod/index.html.en.utf8 index 6839615d65..e662100088 100644 --- a/docs/manual/mod/index.html.en.utf8 +++ b/docs/manual/mod/index.html.en.utf8 @@ -80,6 +80,7 @@ address)</dd> <dt><a href="mod_asis.html">mod_asis</a></dt><dd>Sends files that contain their own HTTP headers</dd> <dt><a href="mod_auth_basic.html">mod_auth_basic</a></dt><dd>Basic HTTP authentication</dd> +<dt><a href="mod_auth_bearer.html">mod_auth_bearer</a></dt><dd>Bearer HTTP authentication</dd> <dt><a href="mod_auth_digest.html">mod_auth_digest</a></dt><dd>User authentication using MD5 Digest Authentication</dd> <dt><a href="mod_auth_form.html">mod_auth_form</a></dt><dd>Form authentication</dd> @@ -95,6 +96,8 @@ the load on backends</dd> httpd authentication and authorization</dd> <dt><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></dt><dd>Allows an LDAP directory to be used to store the database for HTTP Basic authentication.</dd> +<dt><a href="mod_autht_core.html">mod_autht_core</a></dt><dd>Core Token Handling</dd> +<dt><a href="mod_autht_jwt.html">mod_autht_jwt</a></dt><dd>Token authentication using JWT tokens</dd> <dt><a href="mod_authz_core.html">mod_authz_core</a></dt><dd>Core Authorization</dd> <dt><a href="mod_authz_dbd.html">mod_authz_dbd</a></dt><dd>Group Authorization and Login using SQL</dd> <dt><a href="mod_authz_dbm.html">mod_authz_dbm</a></dt><dd>Group authorization using DBM files</dd> diff --git a/docs/manual/mod/mod_auth_bearer.html b/docs/manual/mod/mod_auth_bearer.html new file mode 100644 index 0000000000..ea07223e33 --- /dev/null +++ b/docs/manual/mod/mod_auth_bearer.html @@ -0,0 +1,5 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: mod_auth_bearer.html.en.utf8 +Content-Language: en +Content-type: text/html; charset=UTF-8 diff --git a/docs/manual/mod/mod_auth_bearer.html.en.utf8 b/docs/manual/mod/mod_auth_bearer.html.en.utf8 new file mode 100644 index 0000000000..94d2e415e6 --- /dev/null +++ b/docs/manual/mod/mod_auth_bearer.html.en.utf8 @@ -0,0 +1,189 @@ +<?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_auth_bearer - 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_auth_bearer</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_auth_bearer.html" title="English"> en </a></p> +</div> +<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Bearer HTTP authentication</td></tr> +<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>auth_bearer_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_auth_bearer.c</td></tr></table> +<h3>Summary</h3> + + <p>This module allows the use of HTTP Bearer Authentication to + restrict access by passing the bearer token to the given providers. + This module should be combined with at least one token module + such as <code class="module"><a href="../mod/mod_autht_jwt.html">mod_autht_jwt</a></code> and one authorization + module such as <code class="module"><a href="../mod/mod_authz_user.html">mod_authz_user</a></code>.</p> +</div> +<div id="quickview"><h3 class="directives">Directives</h3> +<ul id="toc"> +<li><img alt="" src="../images/down.gif" /> <a href="#authbearerauthoritative">AuthBearerAuthoritative</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#authbearerprovider">AuthBearerProvider</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#authbearerproxy">AuthBearerProxy</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_auth_bearer">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_auth_bearer">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_authz_core.html#require">Require</a></code></li> +<li><a href="../howto/auth.html">Authentication howto</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="directive-section"><h2><a name="AuthBearerAuthoritative" id="AuthBearerAuthoritative">AuthBearerAuthoritative</a> <a name="authbearerauthoritative" id="authbearerauthoritative">Directive</a> <a title="Permanent link" href="#authbearerauthoritative" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets whether token verification is passed to lower level +modules</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBearerAuthoritative On|Off</code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBearerAuthoritative On</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_bearer</td></tr> +</table> + <p>Normally, each token verification module listed in <code class="directive"><a href="#authbearerprovider">AuthBearerProvider</a></code> will attempt + to verify the token, and if the token is not found to be valid, + access will be denied. Setting the + <code class="directive">AuthBearerAuthoritative</code> directive explicitly + to <code>Off</code> allows for token verification to be passed on to + other non-provider-based modules if the token is not recognised. + This should only be necessary when combining + <code class="module"><a href="../mod/mod_auth_bearer.html">mod_auth_bearer</a></code> with third-party modules that are not + configured with the + <code class="directive"><a href="#authbearerprovider">AuthBearerProvider</a></code> + directive. When using such modules, the order of processing + is determined in the modules' source code and is not configurable.</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="AuthBearerProvider" id="AuthBearerProvider">AuthBearerProvider</a> <a name="authbearerprovider" id="authbearerprovider">Directive</a> <a title="Permanent link" href="#authbearerprovider" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the authentication provider(s) for this location</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBearerProvider <var>provider-name</var> +[<var>provider-name</var>] ...</code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>AuthBearerProvider file</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_bearer</td></tr> +</table> + <p>The <code class="directive">AuthBearerProvider</code> directive sets + which provider is used to verify tokens for this location. + The default <code>jwt</code> provider is implemented + by the <code class="module"><a href="../mod/mod_autht_jwt.html">mod_autht_jwt</a></code> module. Make sure + that the chosen provider module is present in the server.</p> + <div class="example"><h3>Example</h3><pre class="prettyprint lang-config"><Location "/secure"> + AuthType bearer + AuthName "private area" + AuthBearerProvider jwt + AuthtJwtVerify hs256 file "/www/etc/jwt.secret" + Require valid-user +</Location></pre> +</div> + <p>Providers are queried in order until a provider finds a match + for the requested token. This usually means that the token has been + correctly signed, or that the token has not expired.</p> + + <p>The first implemented provider is <code class="module"><a href="../mod/mod_autht_jwt.html">mod_autht_jwt</a></code>.</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="AuthBearerProxy" id="AuthBearerProxy">AuthBearerProxy</a> <a name="authbearerproxy" id="authbearerproxy">Directive</a> <a title="Permanent link" href="#authbearerproxy" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Pass a bearer authentication token over a proxy connection +generated using the given expression</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthBearerProxy off|<var>expression</var></code></td></tr> +<tr><th><a href="directive-dict.html#Default">Default:</a></th><td><code>none</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_auth_bearer</td></tr> +<tr><th><a href="directive-dict.html#Compatibility">Compatibility:</a></th><td>Apache HTTP Server 2.5.1 and later</td></tr> +</table> + <p>The expression specified is passed as a bearer token in the + Authorization header, which is passed to the server or service + behind the webserver. The expression is interpreted using the + <a href="../expr.html">expression parser</a>, which allows the + token to be set based on request parameters.</p> + + <div class="note"> + The Authorization header added by this directive is <em>not</em> + input into any authentication or authorization within the local + server. It is designed to be passed along to upstream servers. + </div> + + <p>In this example, we pass a fixed token to a backend server.</p> + + <div class="example"><h3>Fixed Example</h3><pre class="prettyprint lang-config"><Location "/demo"> + AuthBearerProxy my-fixed-token +</Location></pre> +</div> + + <p>In this example, we pass the query string as the token to the + backend server.</p> + + <div class="example"><h3>Query String Example</h3><pre class="prettyprint lang-config"><Location "/secure"> + AuthBearerProxy "%{QUERY_STRING}" +</Location></pre> +</div> + + <div class="example"><h3>Exclusion Example</h3><pre class="prettyprint lang-config"><Location "/public"> + AuthBearerProxy off +</Location></pre> +</div> + + +</div> +</div> +<div class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_auth_bearer.html" title="English"> en </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_auth_bearer.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>
\ No newline at end of file diff --git a/docs/manual/mod/mod_auth_bearer.xml.meta b/docs/manual/mod/mod_auth_bearer.xml.meta new file mode 100644 index 0000000000..62409d37bd --- /dev/null +++ b/docs/manual/mod/mod_auth_bearer.xml.meta @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- GENERATED FROM XML: DO NOT EDIT --> + +<metafile reference="mod_auth_bearer.xml"> + <basename>mod_auth_bearer</basename> + <path>/mod/</path> + <relpath>..</relpath> + + <variants> + <variant>en</variant> + </variants> +</metafile> diff --git a/docs/manual/mod/mod_autht_core.html b/docs/manual/mod/mod_autht_core.html new file mode 100644 index 0000000000..4b5c368ef1 --- /dev/null +++ b/docs/manual/mod/mod_autht_core.html @@ -0,0 +1,5 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: mod_autht_core.html.en.utf8 +Content-Language: en +Content-type: text/html; charset=UTF-8 diff --git a/docs/manual/mod/mod_autht_core.html.en b/docs/manual/mod/mod_autht_core.html.en new file mode 100644 index 0000000000..11afc8e71f --- /dev/null +++ b/docs/manual/mod/mod_autht_core.html.en @@ -0,0 +1,143 @@ +<?xml version="1.0" encoding="ISO-8859-1"?> +<!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=ISO-8859-1" http-equiv="Content-Type" /> +<!-- + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + This file is generated from xml source: DO NOT EDIT + XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX + --> +<title>mod_autht_core - 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_autht_core</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_core.html" title="English"> en </a></p> +</div> +<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Token Handling</td></tr> +<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>autht_core_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_autht_core.c</td></tr> +<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr></table> +<h3>Summary</h3> + + <p>This module provides core token handling capabilities to + allow or deny access to portions of the web site. + <code class="module"><a href="../mod/mod_autht_core.html">mod_autht_core</a></code> provides directives that are + common to all token providers.</p> +</div> +<div id="quickview"><h3>Topics</h3> +<ul id="topics"> +<li><img alt="" src="../images/down.gif" /> <a href="#authtalias">Creating Token Provider Aliases</a></li> +</ul><h3 class="directives">Directives</h3> +<ul id="toc"> +<li><img alt="" src="../images/down.gif" /> <a href="#authtprovideralias"><AuthtProviderAlias></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_autht_core">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_autht_core">Report a bug</a></li></ul><h3>See also</h3> +<ul class="seealso"> +<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="authtalias" id="authtalias">Creating Token Provider Aliases</a> <a title="Permanent link" href="#authtalias" class="permalink">¶</a></h2> + + <p>Extended token providers can be created within the configuration + file and assigned an alias name. The alias providers can then be + referenced through the + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code> + directive in the same way as a base token provider. Besides the + ability to create and alias an extended provider, it also allows + the same extended token provider to be reference by multiple + locations.</p> + + <h3><a name="example" id="example">Examples</a></h3> + + <p>This example checks for JWT token signatures in two different + secret files.</p> + + <div class="example"><h3>Checking multiple sources for JWT tokens</h3><pre class="prettyprint lang-config"># Check here first +<AuthtProviderAlias jwt jwt1> + AuthtJwtVerify hs256 file "/www/conf/realm1.secret" +</AuthtProviderAlias> + +# Then check here +<AuthtProviderAlias jwt jwt2> + AuthtJwtVerify hs256 file "/www/conf/realm2.secret" +</AuthtProviderAlias> + +<Directory "/var/web/pages/secure"> + AuthBearerProvider jwt1 jwt2 + + AuthType Basic + AuthName "Protected Area" + Require valid-user +</Directory></pre> +</div> + + + +</div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="directive-section"><h2><a name="AuthtProviderAlias" id="AuthtProviderAlias"><AuthtProviderAlias></a> <a name="authtprovideralias" id="authtprovideralias">Directive</a> <a title="Permanent link" href="#authtprovideralias" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that represent an +extension of a base token provider and referenced by the specified +alias</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><AuthtProviderAlias <var>baseProvider Alias</var>> +... </AuthtProviderAlias></code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_core</td></tr> +</table> + <p><code><AuthtProviderAlias></code> and + <code></AuthtProviderAlias></code> are used to enclose a group of + authentication directives that can be referenced by the alias name + using the + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code>.</p> + + <div class="note">This directive has no affect on authentication or authorization, + even for modules that provide both authentication and authorization + in addition to token handling.</div> + +</div> +</div> +<div class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_core.html" title="English"> en </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 Freenode, 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_autht_core.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 2020 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>
\ No newline at end of file diff --git a/docs/manual/mod/mod_autht_core.html.en.utf8 b/docs/manual/mod/mod_autht_core.html.en.utf8 new file mode 100644 index 0000000000..1407c85ad0 --- /dev/null +++ b/docs/manual/mod/mod_autht_core.html.en.utf8 @@ -0,0 +1,143 @@ +<?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_autht_core - 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_autht_core</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_core.html" title="English"> en </a></p> +</div> +<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Core Token Handling</td></tr> +<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>autht_core_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_autht_core.c</td></tr> +<tr><th><a href="module-dict.html#Compatibility">Compatibility:</a></th><td>Available in Apache 2.5 and later</td></tr></table> +<h3>Summary</h3> + + <p>This module provides core token handling capabilities to + allow or deny access to portions of the web site. + <code class="module"><a href="../mod/mod_autht_core.html">mod_autht_core</a></code> provides directives that are + common to all token providers.</p> +</div> +<div id="quickview"><h3>Topics</h3> +<ul id="topics"> +<li><img alt="" src="../images/down.gif" /> <a href="#authtalias">Creating Token Provider Aliases</a></li> +</ul><h3 class="directives">Directives</h3> +<ul id="toc"> +<li><img alt="" src="../images/down.gif" /> <a href="#authtprovideralias"><AuthtProviderAlias></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_autht_core">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_autht_core">Report a bug</a></li></ul><h3>See also</h3> +<ul class="seealso"> +<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="authtalias" id="authtalias">Creating Token Provider Aliases</a> <a title="Permanent link" href="#authtalias" class="permalink">¶</a></h2> + + <p>Extended token providers can be created within the configuration + file and assigned an alias name. The alias providers can then be + referenced through the + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code> + directive in the same way as a base token provider. Besides the + ability to create and alias an extended provider, it also allows + the same extended token provider to be reference by multiple + locations.</p> + + <h3><a name="example" id="example">Examples</a></h3> + + <p>This example checks for JWT token signatures in two different + secret files.</p> + + <div class="example"><h3>Checking multiple sources for JWT tokens</h3><pre class="prettyprint lang-config"># Check here first +<AuthtProviderAlias jwt jwt1> + AuthtJwtVerify hs256 file "/www/conf/realm1.secret" +</AuthtProviderAlias> + +# Then check here +<AuthtProviderAlias jwt jwt2> + AuthtJwtVerify hs256 file "/www/conf/realm2.secret" +</AuthtProviderAlias> + +<Directory "/var/web/pages/secure"> + AuthBearerProvider jwt1 jwt2 + + AuthType Basic + AuthName "Protected Area" + Require valid-user +</Directory></pre> +</div> + + + +</div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="directive-section"><h2><a name="AuthtProviderAlias" id="AuthtProviderAlias"><AuthtProviderAlias></a> <a name="authtprovideralias" id="authtprovideralias">Directive</a> <a title="Permanent link" href="#authtprovideralias" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Enclose a group of directives that represent an +extension of a base token provider and referenced by the specified +alias</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code><AuthtProviderAlias <var>baseProvider Alias</var>> +... </AuthtProviderAlias></code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_core</td></tr> +</table> + <p><code><AuthtProviderAlias></code> and + <code></AuthtProviderAlias></code> are used to enclose a group of + authentication directives that can be referenced by the alias name + using the + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code>.</p> + + <div class="note">This directive has no affect on authentication or authorization, + even for modules that provide both authentication and authorization + in addition to token handling.</div> + +</div> +</div> +<div class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_core.html" title="English"> en </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_autht_core.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>
\ No newline at end of file diff --git a/docs/manual/mod/mod_autht_core.xml.meta b/docs/manual/mod/mod_autht_core.xml.meta new file mode 100644 index 0000000000..ace04e4500 --- /dev/null +++ b/docs/manual/mod/mod_autht_core.xml.meta @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- GENERATED FROM XML: DO NOT EDIT --> + +<metafile reference="mod_autht_core.xml"> + <basename>mod_autht_core</basename> + <path>/mod/</path> + <relpath>..</relpath> + + <variants> + <variant>en</variant> + </variants> +</metafile> diff --git a/docs/manual/mod/mod_autht_jwt.html b/docs/manual/mod/mod_autht_jwt.html new file mode 100644 index 0000000000..89d70e2780 --- /dev/null +++ b/docs/manual/mod/mod_autht_jwt.html @@ -0,0 +1,5 @@ +# GENERATED FROM XML -- DO NOT EDIT + +URI: mod_autht_jwt.html.en.utf8 +Content-Language: en +Content-type: text/html; charset=UTF-8 diff --git a/docs/manual/mod/mod_autht_jwt.html.en.utf8 b/docs/manual/mod/mod_autht_jwt.html.en.utf8 new file mode 100644 index 0000000000..4df50ae85d --- /dev/null +++ b/docs/manual/mod/mod_autht_jwt.html.en.utf8 @@ -0,0 +1,240 @@ +<?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_autht_jwt - 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_autht_jwt</h1> +<div class="toplang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_jwt.html" title="English"> en </a></p> +</div> +<table class="module"><tr><th><a href="module-dict.html#Description">Description:</a></th><td>Token authentication using JWT tokens</td></tr> +<tr><th><a href="module-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="module-dict.html#ModuleIdentifier">Module Identifier:</a></th><td>autht_jwt_module</td></tr> +<tr><th><a href="module-dict.html#SourceFile">Source File:</a></th><td>mod_autht_jwt.c</td></tr></table> +<h3>Summary</h3> + + <p>This module provides token parsing front-ends such as + <code class="module"><a href="../mod/mod_auth_bearer.html">mod_auth_bearer</a></code> the ability to authenticate users + by verifying a JWT token as described in + <a href="http://www.ietf.org/rfc/rfc7519.txt">RFC 7519</a>.</p> + + <p>A JWT token is read from the <var>Authorization</var> header + with an <var>auth-scheme</var> of <var>Bearer</var>.</p> + + <p>When using <code class="module"><a href="../mod/mod_auth_bearer.html">mod_auth_bearer</a></code> this module is invoked + via the + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code> + with the <code>jwt</code> value.</p> + + <p>This module can also be used standalone to generate JWT tokens + for passing to a backend server or service. Claims are embedded within + a token, which is then optionally signed, and passed using the + <var>Authorization</var> header as a <var>Bearer</var> token.</p> +</div> +<div id="quickview"><h3 class="directives">Directives</h3> +<ul id="toc"> +<li><img alt="" src="../images/down.gif" /> <a href="#authtjwtclaim">AuthtJwtClaim</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#authtjwtdriver">AuthtJwtDriver</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#authtjwtsign">AuthtJwtSign</a></li> +<li><img alt="" src="../images/down.gif" /> <a href="#authtjwtverify">AuthtJwtVerify</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_autht_jwt">Known issues</a></li><li><a href="https://bz.apache.org/bugzilla/enter_bug.cgi?product=Apache%20httpd-2&component=mod_autht_jwt">Report a bug</a></li></ul><h3>See also</h3> +<ul class="seealso"> +<li> + <code class="directive"><a href="../mod/mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></code> +</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="directive-section"><h2><a name="AuthtJwtClaim" id="AuthtJwtClaim">AuthtJwtClaim</a> <a name="authtjwtclaim" id="authtjwtclaim">Directive</a> <a title="Permanent link" href="#authtjwtclaim" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Set a claim with the given name and expression, or unset the claim with the given name</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthtJwtVerify <var>[set|unset]</var> <var>name</var> [<var>value</var>]</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_jwt</td></tr> +</table> + <p>The <code class="directive">AuthtJwtClaim</code> directive adds and/or removes + claims from token being passed to the backend server or service.</p> + + <p>When a claim is set, the value of the claim is the result of an expression. The + expression may include parameters from a digital certificate, or the name of the + user that has been authenticated to Apache httpd.</p> + + <div class="example"><h3>Pass Remote User Example</h3><pre class="prettyprint lang-config"><Location "/secure"> + AuthtJwtClaim set sub %{REMOTE_USER} + AuthtJwtSign hs256 file "/www/conf/jwt.secret" +</Location></pre> +</div> + + <p>When a claim is unset, the claim previously set is removed from the token.</p> + + <div class="example"><h3>Unset Claim Example</h3><pre class="prettyprint lang-config">AuthtJwtClaim set my-claim present +<Location "/secure"> + AuthtJwtClaim set sub %{REMOTE_USER} + AuthtJwtClaim unset my-claim + AuthtJwtSign hs256 file "/www/conf/jwt.secret" +</Location></pre> +</div> + + +</div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="directive-section"><h2><a name="AuthtJwtDriver" id="AuthtJwtDriver">AuthtJwtDriver</a> <a name="authtjwtdriver" id="authtjwtdriver">Directive</a> <a title="Permanent link" href="#authtjwtdriver" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>Sets the name of the underlying crypto driver to +use</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthtJwtDriver <var>name</var> <var>[param[=value]]</var></code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>server config, virtual host</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_jwt</td></tr> +</table> + <p>The <code class="directive">AuthtJwtDriver</code> directive specifies the name of + the crypto driver to be used for signing and verification. If not specified, + the driver defaults to the recommended driver compiled into APR-util.</p> + + <p>Follow the instructions in the + <code class="directive"><a href="../mod/mod_session_crypto.html#sessioncryptodriver">SessionCryptoDriver</a></code> to + set up the driver.</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="AuthtJwtSign" id="AuthtJwtSign">AuthtJwtSign</a> <a name="authtjwtsign" id="authtjwtsign">Directive</a> <a title="Permanent link" href="#authtjwtsign" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The JWS signing algorithm and passphrase/key to sign an outgoing +JWT token</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthtJwtSign <var>algorithm</var> [<var>type</var> <var>param</var>]</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_jwt</td></tr> +</table> + <p>The <code class="directive">AuthtJwtSign</code> directive specifies the algorithm + and secret used to sign outgoing bearer tokens passed to a server or service.</p> + + <p>If the algorithm type <var>none</var> is selected, the token is not + protected. Use only when the client is trusted, and the channel is protected + through other means, such as mutually authenticated TLS, or unix domain sockets.</p> + + <p>Set the claims to be sent in the token using the + <code class="directive"><a href="#authtjwtclaim">AuthtJwtClaim</a></code> directive. The + <var>sub</var> claim is used to pass the remote user.</p> + + <div class="example"><h3>No Verification Example</h3><pre class="prettyprint lang-config"><Location "/mutual-tls-secured"> + AuthtJwtClaim set sub %{REMOTE_USER} + AuthtJwtSign none +</Location></pre> +</div> + + <p>If the algorithm type <var>HS256</var> is used, the algorithm is set to + <var>HMAC-SHA256</var>, and the secret is set within the <var>file</var> specified + as the third parameter. The contents of the bearer token is still visible, and so + the channel must still be protected from evesdropping through TLS.</p> + + <div class="example"><h3>Verification Example</h3><pre class="prettyprint lang-config"><Location "/secure"> + AuthtJwtClaim set sub %{REMOTE_USER} + AuthtJwtSign hs256 file "/www/conf/jwt.secret" +</Location></pre> +</div> + + +</div> +<div class="top"><a href="#page-header"><img alt="top" src="../images/up.gif" /></a></div> +<div class="directive-section"><h2><a name="AuthtJwtVerify" id="AuthtJwtVerify">AuthtJwtVerify</a> <a name="authtjwtverify" id="authtjwtverify">Directive</a> <a title="Permanent link" href="#authtjwtverify" class="permalink">¶</a></h2> +<table class="directive"> +<tr><th><a href="directive-dict.html#Description">Description:</a></th><td>The JWS signing algorithm and passphrase/key to verify an incoming +JWT token</td></tr> +<tr><th><a href="directive-dict.html#Syntax">Syntax:</a></th><td><code>AuthtJwtVerify <var>algorithm</var> [<var>type</var> <var>param</var>]</code></td></tr> +<tr><th><a href="directive-dict.html#Context">Context:</a></th><td>directory, .htaccess</td></tr> +<tr><th><a href="directive-dict.html#Override">Override:</a></th><td>AuthConfig</td></tr> +<tr><th><a href="directive-dict.html#Status">Status:</a></th><td>Base</td></tr> +<tr><th><a href="directive-dict.html#Module">Module:</a></th><td>mod_autht_jwt</td></tr> +</table> + <p>The <code class="directive">AuthtJwtVerify</code> directive specifies the algorithm + and secret used to verify incoming bearer tokens.</p> + + <p>If the algorithm type <var>none</var> is selected, the token is not + protected, and will be accepted as is. Use only when the client is trusted, and the + channel is protected through other means, such as mutually authenticated TLS, or + unix domain sockets.</p> + + <p>If present, the <var>sub</var> claim is assigned to REMOTE_USER.</p> + + <div class="example"><h3>No Verification Example</h3><pre class="prettyprint lang-config"><Location "/mutual-tls-secured"> + AuthType bearer + AuthName example-name + AuthBearerProvider jwt + AuthtJwtVerify none + Require valid-user +</Location></pre> +</div> + + <p>If the algorithm type <var>HS256</var> is used, the algorithm is set to + <var>HMAC-SHA256</var>, and the secret is set within the <var>file</var> specified + as the third parameter. The contents of the bearer token is still visible, and so + the channel must still be protected from evesdropping through TLS.</p> + + <p>If the signature is verified, and if present, the <var>sub</var> claim is + assigned to REMOTE_USER.</p> + + <div class="example"><h3>Verification Example</h3><pre class="prettyprint lang-config"><Location "/secure"> + AuthType bearer + AuthName example-name + AuthBearerProvider jwt + AuthtJwtVerify hs256 file "/www/conf/jwt.secret" + Require valid-user +</Location></pre> +</div> + + +</div> +</div> +<div class="bottomlang"> +<p><span>Available Languages: </span><a href="../en/mod/mod_autht_jwt.html" title="English"> en </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_autht_jwt.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>
\ No newline at end of file diff --git a/docs/manual/mod/mod_autht_jwt.xml.meta b/docs/manual/mod/mod_autht_jwt.xml.meta new file mode 100644 index 0000000000..9300473006 --- /dev/null +++ b/docs/manual/mod/mod_autht_jwt.xml.meta @@ -0,0 +1,12 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!-- GENERATED FROM XML: DO NOT EDIT --> + +<metafile reference="mod_autht_jwt.xml"> + <basename>mod_autht_jwt</basename> + <path>/mod/</path> + <relpath>..</relpath> + + <variants> + <variant>en</variant> + </variants> +</metafile> diff --git a/docs/manual/mod/overrides.html.en.utf8 b/docs/manual/mod/overrides.html.en.utf8 index abcb863e5c..7ed258356c 100644 --- a/docs/manual/mod/overrides.html.en.utf8 +++ b/docs/manual/mod/overrides.html.en.utf8 @@ -259,120 +259,136 @@ username and password</td></tr> <tr><td colspan="2" class="descr">Check passwords against the authentication providers as if Digest Authentication was in force instead of Basic Authentication. </td></tr> -<tr class="odd"><td><a href="mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></td><td class="module"><a href="mod_authz_dbm.html">mod_authz_dbm</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Sets the name of the database file containing the list +<tr class="odd"><td><a href="mod_auth_bearer.html#authbearerauthoritative">AuthBearerAuthoritative</a></td><td class="module"><a href="mod_auth_bearer.html">mod_auth_bearer</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Sets whether token verification is passed to lower level +modules</td></tr> +<tr><td><a href="mod_auth_bearer.html#authbearerprovider">AuthBearerProvider</a></td><td class="module"><a href="mod_auth_bearer.html">mod_auth_bearer</a></td></tr> +<tr><td colspan="2" class="descr">Sets the authentication provider(s) for this location</td></tr> +<tr class="odd"><td><a href="mod_auth_bearer.html#authbearerproxy">AuthBearerProxy</a></td><td class="module"><a href="mod_auth_bearer.html">mod_auth_bearer</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Pass a bearer authentication token over a proxy connection +generated using the given expression</td></tr> +<tr><td><a href="mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile</a></td><td class="module"><a href="mod_authz_dbm.html">mod_authz_dbm</a></td></tr> +<tr><td colspan="2" class="descr">Sets the name of the database file containing the list of user groups for authorization</td></tr> -<tr><td><a href="mod_authn_dbm.html#authdbmtype">AuthDBMType</a></td><td class="module"><a href="mod_authn_dbm.html">mod_authn_dbm</a></td></tr> -<tr><td colspan="2" class="descr">Sets the type of database file that is used to +<tr class="odd"><td><a href="mod_authn_dbm.html#authdbmtype">AuthDBMType</a></td><td class="module"><a href="mod_authn_dbm.html">mod_authn_dbm</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Sets the type of database file that is used to store passwords</td></tr> -<tr class="odd"><td><a href="mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></td><td class="module"><a href="mod_authn_dbm.html">mod_authn_dbm</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Sets the name of a database file containing the list of users and +<tr><td><a href="mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile</a></td><td class="module"><a href="mod_authn_dbm.html">mod_authn_dbm</a></td></tr> +<tr><td colspan="2" class="descr">Sets the name of a database file containing the list of users and passwords for authentication</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestalgorithm">AuthDigestAlgorithm</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr><td colspan="2" class="descr">Selects the algorithm used to calculate the challenge and +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestalgorithm">AuthDigestAlgorithm</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Selects the algorithm used to calculate the challenge and response hashes in digest authentication</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestdomain">AuthDigestDomain</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">URIs that are in the same protection space for digest +<tr><td><a href="mod_auth_digest.html#authdigestdomain">AuthDigestDomain</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr><td colspan="2" class="descr">URIs that are in the same protection space for digest authentication</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestnonceformat">AuthDigestNonceFormat</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr><td colspan="2" class="descr">Determines how the nonce is generated</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestnoncelifetime">AuthDigestNonceLifetime</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">How long the server nonce is valid</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr><td colspan="2" class="descr">Sets the authentication provider(s) for this location</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestqop">AuthDigestQop</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Determines the quality-of-protection to use in digest +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestnonceformat">AuthDigestNonceFormat</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Determines how the nonce is generated</td></tr> +<tr><td><a href="mod_auth_digest.html#authdigestnoncelifetime">AuthDigestNonceLifetime</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr><td colspan="2" class="descr">How long the server nonce is valid</td></tr> +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestprovider">AuthDigestProvider</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Sets the authentication provider(s) for this location</td></tr> +<tr><td><a href="mod_auth_digest.html#authdigestqop">AuthDigestQop</a></td><td class="module"><a href="mod_auth_digest.html">mod_auth_digest</a></td></tr> +<tr><td colspan="2" class="descr">Determines the quality-of-protection to use in digest authentication</td></tr> -<tr><td><a href="mod_auth_form.html#authformauthoritative">AuthFormAuthoritative</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">Sets whether authorization and authentication are passed to +<tr class="odd"><td><a href="mod_auth_form.html#authformauthoritative">AuthFormAuthoritative</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Sets whether authorization and authentication are passed to lower level modules</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformbody">AuthFormBody</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying the body of the request to attempt on successful login</td></tr> -<tr><td><a href="mod_auth_form.html#authformdisablenostore">AuthFormDisableNoStore</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">Disable the CacheControl no-store header on the login page</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformfakebasicauth">AuthFormFakeBasicAuth</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Fake a Basic Authentication header</td></tr> -<tr><td><a href="mod_auth_form.html#authformlocation">AuthFormLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">The name of a form field carrying a URL to redirect to on successful login</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformloginrequiredlocation">AuthFormLoginRequiredLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">The URL of the page to be redirected to should login be required</td></tr> -<tr><td><a href="mod_auth_form.html#authformloginsuccesslocation">AuthFormLoginSuccessLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">The URL of the page to be redirected to should login be successful</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformlogoutlocation">AuthFormLogoutLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">The URL to redirect to after a user has logged out</td></tr> -<tr><td><a href="mod_auth_form.html#authformmethod">AuthFormMethod</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">The name of a form field carrying the method of the request to attempt on successful login</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformmimetype">AuthFormMimetype</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying the mimetype of the body of the request to attempt on successful login</td></tr> -<tr><td><a href="mod_auth_form.html#authformpassword">AuthFormPassword</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">The name of a form field carrying the login password</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformprovider">AuthFormProvider</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Sets the authentication provider(s) for this location</td></tr> -<tr><td><a href="mod_auth_form.html#authformsitepassphrase">AuthFormSitePassphrase</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr><td colspan="2" class="descr">Bypass authentication checks for high traffic sites</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformusername">AuthFormUsername</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying the login username</td></tr> -<tr><td><a href="mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></td><td class="module"><a href="mod_authz_groupfile.html">mod_authz_groupfile</a></td></tr> -<tr><td colspan="2" class="descr">Sets the name of a text file containing the list +<tr><td><a href="mod_auth_form.html#authformbody">AuthFormBody</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">The name of a form field carrying the body of the request to attempt on successful login</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformdisablenostore">AuthFormDisableNoStore</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Disable the CacheControl no-store header on the login page</td></tr> +<tr><td><a href="mod_auth_form.html#authformfakebasicauth">AuthFormFakeBasicAuth</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">Fake a Basic Authentication header</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformlocation">AuthFormLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying a URL to redirect to on successful login</td></tr> +<tr><td><a href="mod_auth_form.html#authformloginrequiredlocation">AuthFormLoginRequiredLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">The URL of the page to be redirected to should login be required</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformloginsuccesslocation">AuthFormLoginSuccessLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">The URL of the page to be redirected to should login be successful</td></tr> +<tr><td><a href="mod_auth_form.html#authformlogoutlocation">AuthFormLogoutLocation</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">The URL to redirect to after a user has logged out</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformmethod">AuthFormMethod</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying the method of the request to attempt on successful login</td></tr> +<tr><td><a href="mod_auth_form.html#authformmimetype">AuthFormMimetype</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">The name of a form field carrying the mimetype of the body of the request to attempt on successful login</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformpassword">AuthFormPassword</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">The name of a form field carrying the login password</td></tr> +<tr><td><a href="mod_auth_form.html#authformprovider">AuthFormProvider</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">Sets the authentication provider(s) for this location</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformsitepassphrase">AuthFormSitePassphrase</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Bypass authentication checks for high traffic sites</td></tr> +<tr><td><a href="mod_auth_form.html#authformusername">AuthFormUsername</a></td><td class="module"><a href="mod_auth_form.html">mod_auth_form</a></td></tr> +<tr><td colspan="2" class="descr">The name of a form field carrying the login username</td></tr> +<tr class="odd"><td><a href="mod_authz_groupfile.html#authgroupfile">AuthGroupFile</a></td><td class="module"><a href="mod_authz_groupfile.html">mod_authz_groupfile</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Sets the name of a text file containing the list of user groups for authorization</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapauthorizeprefix">AuthLDAPAuthorizePrefix</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Specifies the prefix for environment variables set during +<tr><td><a href="mod_authnz_ldap.html#authldapauthorizeprefix">AuthLDAPAuthorizePrefix</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Specifies the prefix for environment variables set during authorization</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapbindauthoritative">AuthLDAPBindAuthoritative</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbinddn">AuthLDAPBindDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Optional DN to use in binding to the LDAP server</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapbindpassword">AuthLDAPBindPassword</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Password used in conjunction with the bind DN</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapcompareasuser">AuthLDAPCompareAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Use the authenticated user's credentials to perform authorization comparisons</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Use the LDAP server to compare the DNs</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapdereferencealiases">AuthLDAPDereferenceAliases</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">When will the module de-reference aliases</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapgroupattribute">AuthLDAPGroupAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">LDAP attributes used to identify the user members of +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbindauthoritative">AuthLDAPBindAuthoritative</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapbinddn">AuthLDAPBindDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Optional DN to use in binding to the LDAP server</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbindpassword">AuthLDAPBindPassword</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Password used in conjunction with the bind DN</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapcompareasuser">AuthLDAPCompareAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Use the authenticated user's credentials to perform authorization comparisons</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapcomparednonserver">AuthLDAPCompareDNOnServer</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Use the LDAP server to compare the DNs</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapdereferencealiases">AuthLDAPDereferenceAliases</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">When will the module de-reference aliases</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapgroupattribute">AuthLDAPGroupAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">LDAP attributes used to identify the user members of groups.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Use the DN of the client username when checking for +<tr><td><a href="mod_authnz_ldap.html#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Use the DN of the client username when checking for group membership</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapinitialbindasuser">AuthLDAPInitialBindAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Determines if the server does the initial DN lookup using the basic authentication users' +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapinitialbindasuser">AuthLDAPInitialBindAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Determines if the server does the initial DN lookup using the basic authentication users' own username, instead of anonymously or with hard-coded credentials for the server</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapinitialbindpattern">AuthLDAPInitialBindPattern</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Specifies the transformation of the basic authentication username to be used when binding to the LDAP server +<tr><td><a href="mod_authnz_ldap.html#authldapinitialbindpattern">AuthLDAPInitialBindPattern</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Specifies the transformation of the basic authentication username to be used when binding to the LDAP server to perform a DN lookup</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapmaxsubgroupdepth">AuthLDAPMaxSubGroupDepth</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Specifies the maximum sub-group nesting depth that will be +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapmaxsubgroupdepth">AuthLDAPMaxSubGroupDepth</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Specifies the maximum sub-group nesting depth that will be evaluated before the user search is discontinued.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapremoteuserattribute">AuthLDAPRemoteUserAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Use the value of the attribute returned during the user +<tr><td><a href="mod_authnz_ldap.html#authldapremoteuserattribute">AuthLDAPRemoteUserAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Use the value of the attribute returned during the user query to set the REMOTE_USER environment variable</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Use the DN of the client username to set the REMOTE_USER +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Use the DN of the client username to set the REMOTE_USER environment variable</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsearchasuser">AuthLDAPSearchAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Use the authenticated user's credentials to perform authorization searches</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapsubgroupattribute">AuthLDAPSubGroupAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">Specifies the attribute labels, one value per +<tr><td><a href="mod_authnz_ldap.html#authldapsearchasuser">AuthLDAPSearchAsUser</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Use the authenticated user's credentials to perform authorization searches</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsubgroupattribute">AuthLDAPSubGroupAttribute</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Specifies the attribute labels, one value per directive line, used to distinguish the members of the current group that are groups.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsubgroupclass">AuthLDAPSubGroupClass</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Specifies which LDAP objectClass values identify directory +<tr><td><a href="mod_authnz_ldap.html#authldapsubgroupclass">AuthLDAPSubGroupClass</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr><td colspan="2" class="descr">Specifies which LDAP objectClass values identify directory objects that are groups during sub-group processing.</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapurl">AuthLDAPURL</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> -<tr><td colspan="2" class="descr">URL specifying the LDAP search parameters</td></tr> -<tr class="odd"><td><a href="mod_authz_core.html#authmerging">AuthMerging</a></td><td class="module"><a href="mod_authz_core.html">mod_authz_core</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Controls the manner in which each configuration section's +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapurl">AuthLDAPURL</a></td><td class="module"><a href="mod_authnz_ldap.html">mod_authnz_ldap</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">URL specifying the LDAP search parameters</td></tr> +<tr><td><a href="mod_authz_core.html#authmerging">AuthMerging</a></td><td class="module"><a href="mod_authz_core.html">mod_authz_core</a></td></tr> +<tr><td colspan="2" class="descr">Controls the manner in which each configuration section's authorization logic is combined with that of preceding configuration sections.</td></tr> -<tr><td><a href="mod_authn_core.html#authname">AuthName</a></td><td class="module"><a href="mod_authn_core.html">mod_authn_core</a></td></tr> -<tr><td colspan="2" class="descr">Authorization realm for use in HTTP +<tr class="odd"><td><a href="mod_authn_core.html#authname">AuthName</a></td><td class="module"><a href="mod_authn_core.html">mod_authn_core</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Authorization realm for use in HTTP authentication</td></tr> -<tr class="odd"><td><a href="mod_authn_socache.html#authncacheprovidefor">AuthnCacheProvideFor</a></td><td class="module"><a href="mod_authn_socache.html">mod_authn_socache</a></td></tr> -<tr class="odd"><td colspan="2" class="descr">Specify which authn provider(s) to cache for</td></tr> -<tr><td><a href="mod_authn_socache.html#authncachetimeout">AuthnCacheTimeout</a></td><td class="module"><a href="mod_authn_socache.html">mod_authn_socache</a></td></tr> -<tr><td colspan="2" class="descr">Set a timeout for cache entries</td></tr> +<tr><td><a href="mod_authn_socache.html#authncacheprovidefor">AuthnCacheProvideFor</a></td><td class="module"><a href="mod_authn_socache.html">mod_authn_socache</a></td></tr> +<tr><td colspan="2" class="descr">Specify which authn provider(s) to cache for</td></tr> +<tr class="odd"><td><a href="mod_authn_socache.html#authncachetimeout">AuthnCacheTimeout</a></td><td class="module"><a href="mod_authn_socache.html">mod_authn_socache</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">Set a timeout for cache entries</td></tr> +<tr><td><a href="mod_autht_jwt.html#authtjwtclaim">AuthtJwtClaim</a></td><td class="module"><a href="mod_autht_jwt.html">mod_autht_jwt</a></td></tr> +<tr><td colspan="2" class="descr">Set a claim with the given name and expression, or unset the claim with the given name</td></tr> +<tr class="odd"><td><a href="mod_autht_jwt.html#authtjwtsign">AuthtJwtSign</a></td><td class="module"><a href="mod_autht_jwt.html">mod_autht_jwt</a></td></tr> +<tr class="odd"><td colspan="2" class="descr">The JWS signing algorithm and passphrase/key to sign an outgoing +JWT token</td></tr> +<tr><td><a href="mod_autht_jwt.html#authtjwtverify">AuthtJwtVerify</a></td><td class="module"><a href="mod_autht_jwt.html">mod_autht_jwt</a></td></tr> +<tr><td colspan="2" class="descr">The JWS signing algorithm and passphrase/key to verify an incoming +JWT token</td></tr> <tr class="odd"><td><a href="mod_authn_core.html#authtype">AuthType</a></td><td class="module"><a href="mod_authn_core.html">mod_authn_core</a></td></tr> <tr class="odd"><td colspan="2" class="descr">Type of user authentication</td></tr> <tr><td><a href="mod_authn_file.html#authuserfile">AuthUserFile</a></td><td class="module"><a href="mod_authn_file.html">mod_authn_file</a></td></tr> diff --git a/docs/manual/mod/quickreference.html.en.utf8 b/docs/manual/mod/quickreference.html.en.utf8 index 67c3d55a98..02763b4196 100644 --- a/docs/manual/mod/quickreference.html.en.utf8 +++ b/docs/manual/mod/quickreference.html.en.utf8 @@ -158,98 +158,115 @@ username and password</td></tr> <tr class="odd"><td><a href="mod_auth_basic.html#authbasicusedigestalgorithm">AuthBasicUseDigestAlgorithm MD5|Off</a></td><td> Off </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Check passwords against the authentication providers as if Digest Authentication was in force instead of Basic Authentication. </td></tr> -<tr><td><a href="mod_authn_dbd.html#authdbduserpwquery">AuthDBDUserPWQuery <var>query</var></a></td><td></td><td>d</td><td>E</td></tr><tr><td class="descr" colspan="4">SQL query to look up a password for a user</td></tr> -<tr class="odd"><td><a href="mod_authn_dbd.html#authdbduserrealmquery">AuthDBDUserRealmQuery <var>query</var></a></td><td></td><td>d</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">SQL query to look up a password hash for a user and realm. +<tr><td><a href="mod_auth_bearer.html#authbearerauthoritative">AuthBearerAuthoritative On|Off</a></td><td> On </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets whether token verification is passed to lower level +modules</td></tr> +<tr class="odd"><td><a href="mod_auth_bearer.html#authbearerprovider">AuthBearerProvider <var>provider-name</var> +[<var>provider-name</var>] ...</a></td><td> file </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the authentication provider(s) for this location</td></tr> +<tr><td><a href="mod_auth_bearer.html#authbearerproxy">AuthBearerProxy off|<var>expression</var></a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Pass a bearer authentication token over a proxy connection +generated using the given expression</td></tr> +<tr class="odd"><td><a href="mod_authn_dbd.html#authdbduserpwquery">AuthDBDUserPWQuery <var>query</var></a></td><td></td><td>d</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">SQL query to look up a password for a user</td></tr> +<tr><td><a href="mod_authn_dbd.html#authdbduserrealmquery">AuthDBDUserRealmQuery <var>query</var></a></td><td></td><td>d</td><td>E</td></tr><tr><td class="descr" colspan="4">SQL query to look up a password hash for a user and realm. </td></tr> -<tr><td><a href="mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile <var>file-path</var></a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Sets the name of the database file containing the list +<tr class="odd"><td><a href="mod_authz_dbm.html#authdbmgroupfile">AuthDBMGroupFile <var>file-path</var></a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the name of the database file containing the list of user groups for authorization</td></tr> -<tr class="odd"><td><a href="mod_authn_dbm.html#authdbmtype">AuthDBMType default|SDBM|GDBM|NDBM|DB</a></td><td> default </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the type of database file that is used to +<tr><td><a href="mod_authn_dbm.html#authdbmtype">AuthDBMType default|SDBM|GDBM|NDBM|DB</a></td><td> default </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Sets the type of database file that is used to store passwords</td></tr> -<tr><td><a href="mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile <var>file-path</var></a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Sets the name of a database file containing the list of users and +<tr class="odd"><td><a href="mod_authn_dbm.html#authdbmuserfile">AuthDBMUserFile <var>file-path</var></a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the name of a database file containing the list of users and passwords for authentication</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestalgorithm">AuthDigestAlgorithm MD5|MD5-sess</a></td><td> MD5 </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Selects the algorithm used to calculate the challenge and +<tr><td><a href="mod_auth_digest.html#authdigestalgorithm">AuthDigestAlgorithm MD5|MD5-sess</a></td><td> MD5 </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Selects the algorithm used to calculate the challenge and response hashes in digest authentication</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestdomain">AuthDigestDomain <var>URI</var> [<var>URI</var>] ...</a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">URIs that are in the same protection space for digest +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestdomain">AuthDigestDomain <var>URI</var> [<var>URI</var>] ...</a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">URIs that are in the same protection space for digest authentication</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestnccheck">AuthDigestNcCheck On|Off</a></td><td> Off </td><td>s</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enables or disables checking of the nonce-count sent by the +<tr><td><a href="mod_auth_digest.html#authdigestnccheck">AuthDigestNcCheck On|Off</a></td><td> Off </td><td>s</td><td>E</td></tr><tr><td class="descr" colspan="4">Enables or disables checking of the nonce-count sent by the server</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestnonceformat">AuthDigestNonceFormat <var>format</var></a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Determines how the nonce is generated</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestnoncelifetime">AuthDigestNonceLifetime <var>seconds</var></a></td><td> 300 </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">How long the server nonce is valid</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestprovider">AuthDigestProvider <var>provider-name</var> -[<var>provider-name</var>] ...</a></td><td> file </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Sets the authentication provider(s) for this location</td></tr> -<tr class="odd"><td><a href="mod_auth_digest.html#authdigestqop">AuthDigestQop none|auth|auth-int [auth|auth-int]</a></td><td> auth </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Determines the quality-of-protection to use in digest +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestnonceformat">AuthDigestNonceFormat <var>format</var></a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Determines how the nonce is generated</td></tr> +<tr><td><a href="mod_auth_digest.html#authdigestnoncelifetime">AuthDigestNonceLifetime <var>seconds</var></a></td><td> 300 </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">How long the server nonce is valid</td></tr> +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestprovider">AuthDigestProvider <var>provider-name</var> +[<var>provider-name</var>] ...</a></td><td> file </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the authentication provider(s) for this location</td></tr> +<tr><td><a href="mod_auth_digest.html#authdigestqop">AuthDigestQop none|auth|auth-int [auth|auth-int]</a></td><td> auth </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Determines the quality-of-protection to use in digest authentication</td></tr> -<tr><td><a href="mod_auth_digest.html#authdigestshmemsize">AuthDigestShmemSize <var>size</var></a></td><td> 1000 </td><td>s</td><td>E</td></tr><tr><td class="descr" colspan="4">The amount of shared memory to allocate for keeping track +<tr class="odd"><td><a href="mod_auth_digest.html#authdigestshmemsize">AuthDigestShmemSize <var>size</var></a></td><td> 1000 </td><td>s</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">The amount of shared memory to allocate for keeping track of clients</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformauthoritative">AuthFormAuthoritative On|Off</a></td><td> On </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets whether authorization and authentication are passed to +<tr><td><a href="mod_auth_form.html#authformauthoritative">AuthFormAuthoritative On|Off</a></td><td> On </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets whether authorization and authentication are passed to lower level modules</td></tr> -<tr><td><a href="mod_auth_form.html#authformbody">AuthFormBody <var>fieldname</var></a></td><td> httpd_body </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying the body of the request to attempt on successful login</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformdisablenostore">AuthFormDisableNoStore On|Off</a></td><td> Off </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Disable the CacheControl no-store header on the login page</td></tr> -<tr><td><a href="mod_auth_form.html#authformfakebasicauth">AuthFormFakeBasicAuth On|Off</a></td><td> Off </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">Fake a Basic Authentication header</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformlocation">AuthFormLocation <var>fieldname</var></a></td><td> httpd_location </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying a URL to redirect to on successful login</td></tr> -<tr><td><a href="mod_auth_form.html#authformloginrequiredlocation">AuthFormLoginRequiredLocation <var>url</var></a></td><td></td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The URL of the page to be redirected to should login be required</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformloginsuccesslocation">AuthFormLoginSuccessLocation <var>url</var></a></td><td></td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The URL of the page to be redirected to should login be successful</td></tr> -<tr><td><a href="mod_auth_form.html#authformlogoutlocation">AuthFormLogoutLocation <var>uri</var></a></td><td></td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The URL to redirect to after a user has logged out</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformmethod">AuthFormMethod <var>fieldname</var></a></td><td> httpd_method </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying the method of the request to attempt on successful login</td></tr> -<tr><td><a href="mod_auth_form.html#authformmimetype">AuthFormMimetype <var>fieldname</var></a></td><td> httpd_mimetype </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying the mimetype of the body of the request to attempt on successful login</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformpassword">AuthFormPassword <var>fieldname</var></a></td><td> httpd_password </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying the login password</td></tr> -<tr><td><a href="mod_auth_form.html#authformprovider">AuthFormProvider <var>provider-name</var> -[<var>provider-name</var>] ...</a></td><td> file </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets the authentication provider(s) for this location</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformsitepassphrase">AuthFormSitePassphrase <var>secret</var></a></td><td></td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Bypass authentication checks for high traffic sites</td></tr> -<tr><td><a href="mod_auth_form.html#authformsize">AuthFormSize <var>size</var></a></td><td> 8192 </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The largest size of the form in bytes that will be parsed for the login details</td></tr> -<tr class="odd"><td><a href="mod_auth_form.html#authformusername">AuthFormUsername <var>fieldname</var></a></td><td> httpd_username </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying the login username</td></tr> -<tr><td><a href="mod_authz_groupfile.html#authgroupfile">AuthGroupFile <var>file-path</var></a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets the name of a text file containing the list +<tr class="odd"><td><a href="mod_auth_form.html#authformbody">AuthFormBody <var>fieldname</var></a></td><td> httpd_body </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying the body of the request to attempt on successful login</td></tr> +<tr><td><a href="mod_auth_form.html#authformdisablenostore">AuthFormDisableNoStore On|Off</a></td><td> Off </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">Disable the CacheControl no-store header on the login page</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformfakebasicauth">AuthFormFakeBasicAuth On|Off</a></td><td> Off </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Fake a Basic Authentication header</td></tr> +<tr><td><a href="mod_auth_form.html#authformlocation">AuthFormLocation <var>fieldname</var></a></td><td> httpd_location </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying a URL to redirect to on successful login</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformloginrequiredlocation">AuthFormLoginRequiredLocation <var>url</var></a></td><td></td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The URL of the page to be redirected to should login be required</td></tr> +<tr><td><a href="mod_auth_form.html#authformloginsuccesslocation">AuthFormLoginSuccessLocation <var>url</var></a></td><td></td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The URL of the page to be redirected to should login be successful</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformlogoutlocation">AuthFormLogoutLocation <var>uri</var></a></td><td></td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The URL to redirect to after a user has logged out</td></tr> +<tr><td><a href="mod_auth_form.html#authformmethod">AuthFormMethod <var>fieldname</var></a></td><td> httpd_method </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying the method of the request to attempt on successful login</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformmimetype">AuthFormMimetype <var>fieldname</var></a></td><td> httpd_mimetype </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The name of a form field carrying the mimetype of the body of the request to attempt on successful login</td></tr> +<tr><td><a href="mod_auth_form.html#authformpassword">AuthFormPassword <var>fieldname</var></a></td><td> httpd_password </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying the login password</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformprovider">AuthFormProvider <var>provider-name</var> +[<var>provider-name</var>] ...</a></td><td> file </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the authentication provider(s) for this location</td></tr> +<tr><td><a href="mod_auth_form.html#authformsitepassphrase">AuthFormSitePassphrase <var>secret</var></a></td><td></td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">Bypass authentication checks for high traffic sites</td></tr> +<tr class="odd"><td><a href="mod_auth_form.html#authformsize">AuthFormSize <var>size</var></a></td><td> 8192 </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The largest size of the form in bytes that will be parsed for the login details</td></tr> +<tr><td><a href="mod_auth_form.html#authformusername">AuthFormUsername <var>fieldname</var></a></td><td> httpd_username </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">The name of a form field carrying the login username</td></tr> +<tr class="odd"><td><a href="mod_authz_groupfile.html#authgroupfile">AuthGroupFile <var>file-path</var></a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the name of a text file containing the list of user groups for authorization</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapauthorizeprefix">AuthLDAPAuthorizePrefix <em>prefix</em></a></td><td> AUTHORIZE_ </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies the prefix for environment variables set during +<tr><td><a href="mod_authnz_ldap.html#authldapauthorizeprefix">AuthLDAPAuthorizePrefix <em>prefix</em></a></td><td> AUTHORIZE_ </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Specifies the prefix for environment variables set during authorization</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapbindauthoritative">AuthLDAPBindAuthoritative off|on</a></td><td> on </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbinddn">AuthLDAPBindDN <em>distinguished-name</em></a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Optional DN to use in binding to the LDAP server</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapbindpassword">AuthLDAPBindPassword <em>password</em></a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Password used in conjunction with the bind DN</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapcharsetconfig">AuthLDAPCharsetConfig <em>file-path</em></a></td><td></td><td>s</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Language to charset conversion configuration file</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapcompareasuser">AuthLDAPCompareAsUser on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the authenticated user's credentials to perform authorization comparisons</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapcomparednonserver">AuthLDAPCompareDNOnServer on|off</a></td><td> on </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the LDAP server to compare the DNs</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapdereferencealiases">AuthLDAPDereferenceAliases never|searching|finding|always</a></td><td> always </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">When will the module de-reference aliases</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapgroupattribute">AuthLDAPGroupAttribute <em>attribute</em></a></td><td> member uniqueMember +</td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">LDAP attributes used to identify the user members of +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbindauthoritative">AuthLDAPBindAuthoritative off|on</a></td><td> on </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Determines if other authentication providers are used when a user can be mapped to a DN but the server cannot successfully bind with the user's credentials.</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapbinddn">AuthLDAPBindDN <em>distinguished-name</em></a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Optional DN to use in binding to the LDAP server</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapbindpassword">AuthLDAPBindPassword <em>password</em></a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Password used in conjunction with the bind DN</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapcharsetconfig">AuthLDAPCharsetConfig <em>file-path</em></a></td><td></td><td>s</td><td>E</td></tr><tr><td class="descr" colspan="4">Language to charset conversion configuration file</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapcompareasuser">AuthLDAPCompareAsUser on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the authenticated user's credentials to perform authorization comparisons</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapcomparednonserver">AuthLDAPCompareDNOnServer on|off</a></td><td> on </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the LDAP server to compare the DNs</td></tr> +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapdereferencealiases">AuthLDAPDereferenceAliases never|searching|finding|always</a></td><td> always </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">When will the module de-reference aliases</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapgroupattribute">AuthLDAPGroupAttribute <em>attribute</em></a></td><td> member uniqueMember +</td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">LDAP attributes used to identify the user members of groups.</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN on|off</a></td><td> on </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the DN of the client username when checking for +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapgroupattributeisdn">AuthLDAPGroupAttributeIsDN on|off</a></td><td> on </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the DN of the client username when checking for group membership</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapinitialbindasuser">AuthLDAPInitialBindAsUser off|on</a></td><td> off </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Determines if the server does the initial DN lookup using the basic authentication users' +<tr><td><a href="mod_authnz_ldap.html#authldapinitialbindasuser">AuthLDAPInitialBindAsUser off|on</a></td><td> off </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Determines if the server does the initial DN lookup using the basic authentication users' own username, instead of anonymously or with hard-coded credentials for the server</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapinitialbindpattern">AuthLDAPInitialBindPattern <em><var>regex</var> <var>substitution</var></em></a></td><td> (.*) $1 (remote use +</td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Specifies the transformation of the basic authentication username to be used when binding to the LDAP server +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapinitialbindpattern">AuthLDAPInitialBindPattern <em><var>regex</var> <var>substitution</var></em></a></td><td> (.*) $1 (remote use +</td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies the transformation of the basic authentication username to be used when binding to the LDAP server to perform a DN lookup</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapmaxsubgroupdepth">AuthLDAPMaxSubGroupDepth <var>Number</var></a></td><td> 0 </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies the maximum sub-group nesting depth that will be +<tr><td><a href="mod_authnz_ldap.html#authldapmaxsubgroupdepth">AuthLDAPMaxSubGroupDepth <var>Number</var></a></td><td> 0 </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Specifies the maximum sub-group nesting depth that will be evaluated before the user search is discontinued.</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapremoteuserattribute">AuthLDAPRemoteUserAttribute uid</a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the value of the attribute returned during the user +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapremoteuserattribute">AuthLDAPRemoteUserAttribute uid</a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the value of the attribute returned during the user query to set the REMOTE_USER environment variable</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the DN of the client username to set the REMOTE_USER +<tr><td><a href="mod_authnz_ldap.html#authldapremoteuserisdn">AuthLDAPRemoteUserIsDN on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the DN of the client username to set the REMOTE_USER environment variable</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapsearchasuser">AuthLDAPSearchAsUser on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Use the authenticated user's credentials to perform authorization searches</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsubgroupattribute">AuthLDAPSubGroupAttribute <em>attribute</em></a></td><td> member uniqueMember +</td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies the attribute labels, one value per +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsearchasuser">AuthLDAPSearchAsUser on|off</a></td><td> off </td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Use the authenticated user's credentials to perform authorization searches</td></tr> +<tr><td><a href="mod_authnz_ldap.html#authldapsubgroupattribute">AuthLDAPSubGroupAttribute <em>attribute</em></a></td><td> member uniqueMember +</td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Specifies the attribute labels, one value per directive line, used to distinguish the members of the current group that are groups.</td></tr> -<tr><td><a href="mod_authnz_ldap.html#authldapsubgroupclass">AuthLDAPSubGroupClass <em>LdapObjectClass</em></a></td><td> groupOfNames groupO +</td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">Specifies which LDAP objectClass values identify directory +<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapsubgroupclass">AuthLDAPSubGroupClass <em>LdapObjectClass</em></a></td><td> groupOfNames groupO +</td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Specifies which LDAP objectClass values identify directory objects that are groups during sub-group processing.</td></tr> -<tr class="odd"><td><a href="mod_authnz_ldap.html#authldapurl">AuthLDAPURL <em>url</em> [NONE|SSL|TLS|STARTTLS]</a></td><td></td><td>dh</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">URL specifying the LDAP search parameters</td></tr> -<tr><td><a href="mod_authz_core.html#authmerging">AuthMerging Off | And | Or</a></td><td> Off </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Controls the manner in which each configuration section's +<tr><td><a href="mod_authnz_ldap.html#authldapurl">AuthLDAPURL <em>url</em> [NONE|SSL|TLS|STARTTLS]</a></td><td></td><td>dh</td><td>E</td></tr><tr><td class="descr" colspan="4">URL specifying the LDAP search parameters</td></tr> +<tr class="odd"><td><a href="mod_authz_core.html#authmerging">AuthMerging Off | And | Or</a></td><td> Off </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Controls the manner in which each configuration section's authorization logic is combined with that of preceding configuration sections.</td></tr> -<tr class="odd"><td><a href="mod_authn_core.html#authname">AuthName <var>auth-domain</var></a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Authorization realm for use in HTTP +<tr><td><a href="mod_authn_core.html#authname">AuthName <var>auth-domain</var></a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Authorization realm for use in HTTP authentication</td></tr> -<tr><td><a href="mod_authn_socache.html#authncachecontext">AuthnCacheContext directory|server|<var>custom-string</var></a></td><td> directory </td><td>d</td><td>B</td></tr><tr><td class="descr" colspan="4">Specify a context string for use in the cache key</td></tr> -<tr class="odd"><td><a href="mod_authn_socache.html#authncacheenable">AuthnCacheEnable</a></td><td></td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Enable Authn caching configured anywhere</td></tr> -<tr><td><a href="mod_authn_socache.html#authncacheprovidefor">AuthnCacheProvideFor <var>authn-provider</var> [...]</a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Specify which authn provider(s) to cache for</td></tr> -<tr class="odd"><td><a href="mod_authn_socache.html#authncachesocache">AuthnCacheSOCache <var>provider-name[:provider-args]</var></a></td><td></td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Select socache backend provider to use</td></tr> -<tr><td><a href="mod_authn_socache.html#authncachetimeout">AuthnCacheTimeout <var>timeout</var> (seconds)</a></td><td> 300 (5 minutes) </td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Set a timeout for cache entries</td></tr> -<tr class="odd"><td><a href="mod_authn_core.html#authnprovideralias"><AuthnProviderAlias <var>baseProvider Alias</var>> -... </AuthnProviderAlias></a></td><td></td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Enclose a group of directives that represent an +<tr class="odd"><td><a href="mod_authn_socache.html#authncachecontext">AuthnCacheContext directory|server|<var>custom-string</var></a></td><td> directory </td><td>d</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Specify a context string for use in the cache key</td></tr> +<tr><td><a href="mod_authn_socache.html#authncacheenable">AuthnCacheEnable</a></td><td></td><td>s</td><td>B</td></tr><tr><td class="descr" colspan="4">Enable Authn caching configured anywhere</td></tr> +<tr class="odd"><td><a href="mod_authn_socache.html#authncacheprovidefor">AuthnCacheProvideFor <var>authn-provider</var> [...]</a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Specify which authn provider(s) to cache for</td></tr> +<tr><td><a href="mod_authn_socache.html#authncachesocache">AuthnCacheSOCache <var>provider-name[:provider-args]</var></a></td><td></td><td>s</td><td>B</td></tr><tr><td class="descr" colspan="4">Select socache backend provider to use</td></tr> +<tr class="odd"><td><a href="mod_authn_socache.html#authncachetimeout">AuthnCacheTimeout <var>timeout</var> (seconds)</a></td><td> 300 (5 minutes) </td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Set a timeout for cache entries</td></tr> +<tr><td><a href="mod_authn_core.html#authnprovideralias"><AuthnProviderAlias <var>baseProvider Alias</var>> +... </AuthnProviderAlias></a></td><td></td><td>s</td><td>B</td></tr><tr><td class="descr" colspan="4">Enclose a group of directives that represent an extension of a base authentication provider and referenced by the specified alias</td></tr> -<tr><td><a href="mod_authnz_fcgi.html#authnzfcgicheckauthnprovider">AuthnzFcgiCheckAuthnProvider <em>provider-name</em>|<code>None</code> -<em>option</em> ...</a></td><td></td><td>d</td><td>E</td></tr><tr><td class="descr" colspan="4">Enables a FastCGI application to handle the check_authn +<tr class="odd"><td><a href="mod_authnz_fcgi.html#authnzfcgicheckauthnprovider">AuthnzFcgiCheckAuthnProvider <em>provider-name</em>|<code>None</code> +<em>option</em> ...</a></td><td></td><td>d</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Enables a FastCGI application to handle the check_authn authentication hook.</td></tr> -<tr class="odd"><td><a href="mod_authnz_fcgi.html#authnzfcgidefineprovider">AuthnzFcgiDefineProvider <em>type</em> <em>provider-name</em> -<em>backend-address</em></a></td><td></td><td>s</td><td>E</td></tr><tr class="odd"><td class="descr" colspan="4">Defines a FastCGI application as a provider for +<tr><td><a href="mod_authnz_fcgi.html#authnzfcgidefineprovider">AuthnzFcgiDefineProvider <em>type</em> <em>provider-name</em> +<em>backend-address</em></a></td><td></td><td>s</td><td>E</td></tr><tr><td class="descr" colspan="4">Defines a FastCGI application as a provider for authentication and/or authorization</td></tr> +<tr class="odd"><td><a href="mod_autht_jwt.html#authtjwtclaim">AuthtJwtVerify <var>[set|unset]</var> <var>name</var> [<var>value</var>]</a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Set a claim with the given name and expression, or unset the claim with the given name</td></tr> +<tr><td><a href="mod_autht_jwt.html#authtjwtdriver">AuthtJwtDriver <var>name</var> <var>[param[=value]]</var></a></td><td></td><td>sv</td><td>B</td></tr><tr><td class="descr" colspan="4">Sets the name of the underlying crypto driver to +use</td></tr> +<tr class="odd"><td><a href="mod_autht_jwt.html#authtjwtsign">AuthtJwtSign <var>algorithm</var> [<var>type</var> <var>param</var>]</a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">The JWS signing algorithm and passphrase/key to sign an outgoing +JWT token</td></tr> +<tr><td><a href="mod_autht_jwt.html#authtjwtverify">AuthtJwtVerify <var>algorithm</var> [<var>type</var> <var>param</var>]</a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">The JWS signing algorithm and passphrase/key to verify an incoming +JWT token</td></tr> +<tr class="odd"><td><a href="mod_autht_core.html#authtprovideralias"><AuthtProviderAlias <var>baseProvider Alias</var>> +... </AuthtProviderAlias></a></td><td></td><td>s</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Enclose a group of directives that represent an +extension of a base token provider and referenced by the specified +alias</td></tr> <tr><td><a href="mod_authn_core.html#authtype">AuthType None|Basic|Digest|Form</a></td><td></td><td>dh</td><td>B</td></tr><tr><td class="descr" colspan="4">Type of user authentication</td></tr> <tr class="odd"><td><a href="mod_authn_file.html#authuserfile">AuthUserFile <var>file-path</var></a></td><td></td><td>dh</td><td>B</td></tr><tr class="odd"><td class="descr" colspan="4">Sets the name of a text file containing the list of users and passwords for authentication</td></tr> diff --git a/docs/manual/sitemap.html.en.utf8 b/docs/manual/sitemap.html.en.utf8 index 59004a5d21..c234eeb4c5 100644 --- a/docs/manual/sitemap.html.en.utf8 +++ b/docs/manual/sitemap.html.en.utf8 @@ -200,6 +200,7 @@ log_server_status</a></li> <li><a href="mod/mod_allowmethods.html">Apache Module mod_allowmethods</a></li> <li><a href="mod/mod_asis.html">Apache Module mod_asis</a></li> <li><a href="mod/mod_auth_basic.html">Apache Module mod_auth_basic</a></li> +<li><a href="mod/mod_auth_bearer.html">Apache Module mod_auth_bearer</a></li> <li><a href="mod/mod_auth_digest.html">Apache Module mod_auth_digest</a></li> <li><a href="mod/mod_auth_form.html">Apache Module mod_auth_form</a></li> <li><a href="mod/mod_authn_anon.html">Apache Module mod_authn_anon</a></li> @@ -210,6 +211,8 @@ log_server_status</a></li> <li><a href="mod/mod_authn_socache.html">Apache Module mod_authn_socache</a></li> <li><a href="mod/mod_authnz_fcgi.html">Apache Module mod_authnz_fcgi</a></li> <li><a href="mod/mod_authnz_ldap.html">Apache Module mod_authnz_ldap</a></li> +<li><a href="mod/mod_autht_core.html">Apache Module mod_autht_core</a></li> +<li><a href="mod/mod_autht_jwt.html">Apache Module mod_autht_jwt</a></li> <li><a href="mod/mod_authz_core.html">Apache Module mod_authz_core</a></li> <li><a href="mod/mod_authz_dbd.html">Apache Module mod_authz_dbd</a></li> <li><a href="mod/mod_authz_dbm.html">Apache Module mod_authz_dbm</a></li> |