<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> <html> <head> <link rel="STYLESHEET" href="modpython.css" type='text/css' /> <link rel="first" href="modpython.html" title='Mod_python Manual' /> <link rel='contents' href='contents.html' title="Contents" /> <link rel='index' href='genindex.html' title='Index' /> <link rel='last' href='about.html' title='About this document...' /> <link rel='help' href='about.html' title='About this document...' /> <link rel="next" href="dir-handlers-auzh.html" /> <link rel="prev" href="dir-handlers-ach.html" /> <link rel="parent" href="dir-handlers.html" /> <link rel="next" href="dir-handlers-auzh.html" /> <meta name='aesop' content='information' /> <title>5.1.7 PythonAuthenHandler</title> </head> <body> <DIV CLASS="navigation"> <div id='top-navigation-panel' xml:id='top-navigation-panel'> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="5.1.6 PythonAccessHandler" href="dir-handlers-ach.html"><img src='previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="5.1 Request Handlers" href="dir-handlers.html"><img src='up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="5.1.8 PythonAuthzHandler" href="dir-handlers-auzh.html"><img src='next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Mod_python Manual</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" href="contents.html"><img src='contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><img src='blank.png' border='0' height='32' alt='' width='32' /></td> <td class='online-navigation'><a rel="index" title="Index" href="genindex.html"><img src='index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="dir-handlers-ach.html">5.1.6 PythonAccessHandler</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="dir-handlers.html">5.1 Request Handlers</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="dir-handlers-auzh.html">5.1.8 PythonAuthzHandler</A> </div> <hr /></div> </DIV> <!--End of Navigation Panel--> <H2><A NAME="SECTION007170000000000000000"></A><A NAME="dir-handlers-auh"></A> <a id='l2h-274' xml:id='l2h-274'></a> <BR> 5.1.7 PythonAuthenHandler </H2> <P> <strong><em class="citetitle"><a href="http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Syntax" title="Syntax:" >Syntax:</a></em></strong> <em>Python*Handler Syntax</em> <BR><em class="citetitle"><a href="http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Context" title="Context:" >Context:</a></em> server config, virtual host, directory, htaccess <BR><em class="citetitle"><a href="http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Override" title="Override:" >Override:</a></em> not None <BR><em class="citetitle"><a href="http://httpd.apache.org/docs-2.0/mod/directive-dict.html#Module" title="Module:" >Module:</a></em> mod_python.c <P> This routine is called to check the authentication information sent with the request (such as looking up the user in a database and verifying that the [encrypted] password sent matches the one in the database). <P> Where multiple handlers are specified, if any handler in the sequence returns a value other than <code>apache.DECLINED</code>, then execution of all subsequent handlers for this phase are aborted. <P> To obtain the username, use <code>req.user</code>. To obtain the password entered by the user, use the <code>req.get_basic_auth_pw()</code> function. <P> A return of <code>apache.OK</code> means the authentication succeeded. A return of <code>apache.HTTP_UNAUTHORIZED</code> with most browser will bring up the password dialog box again. A return of <code>apache.HTTP_FORBIDDEN</code> will usually show the error on the browser and not bring up the password dialog <code>again. HTTP_FORBIDDEN</code> should be used when authentication succeeded, but the user is not permitted to access a particular URL. <P> An example authentication handler might look like this: <P> <div class="verbatim"><pre> def authenhandler(req): pw = req.get_basic_auth_pw() user = req.user if user == "spam" and pw == "eggs": return apache.OK else: return apache.HTTP_UNAUTHORIZED </pre></div> <P> <div class="note"><b class="label">Note:</b> <code>req.get_basic_auth_pw()</code> must be called prior to using the <code>req.user</code> value. Apache makes no attempt to decode the authentication information unless <code>req.get_basic_auth_pw()</code> is called. </div> <P> <DIV CLASS="navigation"> <div class='online-navigation'> <p></p><hr /> <table align="center" width="100%" cellpadding="0" cellspacing="2"> <tr> <td class='online-navigation'><a rel="prev" title="5.1.6 PythonAccessHandler" href="dir-handlers-ach.html"><img src='previous.png' border='0' height='32' alt='Previous Page' width='32' /></A></td> <td class='online-navigation'><a rel="parent" title="5.1 Request Handlers" href="dir-handlers.html"><img src='up.png' border='0' height='32' alt='Up One Level' width='32' /></A></td> <td class='online-navigation'><a rel="next" title="5.1.8 PythonAuthzHandler" href="dir-handlers-auzh.html"><img src='next.png' border='0' height='32' alt='Next Page' width='32' /></A></td> <td align="center" width="100%">Mod_python Manual</td> <td class='online-navigation'><a rel="contents" title="Table of Contents" href="contents.html"><img src='contents.png' border='0' height='32' alt='Contents' width='32' /></A></td> <td class='online-navigation'><img src='blank.png' border='0' height='32' alt='' width='32' /></td> <td class='online-navigation'><a rel="index" title="Index" href="genindex.html"><img src='index.png' border='0' height='32' alt='Index' width='32' /></A></td> </tr></table> <div class='online-navigation'> <b class="navlabel">Previous:</b> <a class="sectref" rel="prev" href="dir-handlers-ach.html">5.1.6 PythonAccessHandler</A> <b class="navlabel">Up:</b> <a class="sectref" rel="parent" href="dir-handlers.html">5.1 Request Handlers</A> <b class="navlabel">Next:</b> <a class="sectref" rel="next" href="dir-handlers-auzh.html">5.1.8 PythonAuthzHandler</A> </div> </div> <hr /> <span class="release-info">Release 3.3.1, documentation updated on January 29, 2007.</span> </DIV> <!--End of Navigation Panel--> </BODY> </HTML>