<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" lang="">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Authenticating against Django’s user database from Apache — Django 1.8.19 documentation</title>
<link rel="stylesheet" href="../../../_static/default.css" type="text/css" />
<link rel="stylesheet" href="../../../_static/pygments.css" type="text/css" />
<script type="text/javascript">
var DOCUMENTATION_OPTIONS = {
URL_ROOT: '../../../',
VERSION: '1.8.19',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true
};
</script>
<script type="text/javascript" src="../../../_static/jquery.js"></script>
<script type="text/javascript" src="../../../_static/underscore.js"></script>
<script type="text/javascript" src="../../../_static/doctools.js"></script>
<link rel="index" title="Index" href="../../../genindex.html" />
<link rel="search" title="Search" href="../../../search.html" />
<link rel="top" title="Django 1.8.19 documentation" href="../../../contents.html" />
<link rel="up" title="How to deploy with WSGI" href="index.html" />
<link rel="next" title="How to use Django with Gunicorn" href="gunicorn.html" />
<link rel="prev" title="How to use Django with Apache and mod_wsgi" href="modwsgi.html" />
<script type="text/javascript" src="../../../templatebuiltins.js"></script>
<script type="text/javascript">
(function($) {
if (!django_template_builtins) {
// templatebuiltins.js missing, do nothing.
return;
}
$(document).ready(function() {
// Hyperlink Django template tags and filters
var base = "../../../ref/templates/builtins.html";
if (base == "#") {
// Special case for builtins.html itself
base = "";
}
// Tags are keywords, class '.k'
$("div.highlight\\-html\\+django span.k").each(function(i, elem) {
var tagname = $(elem).text();
if ($.inArray(tagname, django_template_builtins.ttags) != -1) {
var fragment = tagname.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + tagname + "</a>");
}
});
// Filters are functions, class '.nf'
$("div.highlight\\-html\\+django span.nf").each(function(i, elem) {
var filtername = $(elem).text();
if ($.inArray(filtername, django_template_builtins.tfilters) != -1) {
var fragment = filtername.replace(/_/, '-');
$(elem).html("<a href='" + base + "#" + fragment + "'>" + filtername + "</a>");
}
});
});
})(jQuery);
</script>
</head>
<body role="document">
<div class="document">
<div id="custom-doc" class="yui-t6">
<div id="hd">
<h1><a href="../../../index.html">Django 1.8.19 documentation</a></h1>
<div id="global-nav">
<a title="Home page" href="../../../index.html">Home</a> |
<a title="Table of contents" href="../../../contents.html">Table of contents</a> |
<a title="Global index" href="../../../genindex.html">Index</a> |
<a title="Module index" href="../../../py-modindex.html">Modules</a>
</div>
<div class="nav">
« <a href="modwsgi.html" title="How to use Django with Apache and mod_wsgi">previous</a>
|
<a href="../../index.html" title="&#8220;How-to&#8221; guides" accesskey="U">up</a>
|
<a href="gunicorn.html" title="How to use Django with Gunicorn">next</a> »</div>
</div>
<div id="bd">
<div id="yui-main">
<div class="yui-b">
<div class="yui-g" id="howto-deployment-wsgi-apache-auth">
<div class="section" id="s-authenticating-against-django-s-user-database-from-apache">
<span id="authenticating-against-django-s-user-database-from-apache"></span><h1>Authenticating against Django’s user database from Apache<a class="headerlink" href="#authenticating-against-django-s-user-database-from-apache" title="Permalink to this headline">¶</a></h1>
<p>Since keeping multiple authentication databases in sync is a common problem when
dealing with Apache, you can configure Apache to authenticate against Django’s
<a class="reference internal" href="../../../topics/auth/index.html"><span class="doc">authentication system</span></a> directly. This requires Apache
version >= 2.2 and mod_wsgi >= 2.0. For example, you could:</p>
<ul class="simple">
<li>Serve static/media files directly from Apache only to authenticated users.</li>
<li>Authenticate access to a <a class="reference external" href="http://subversion.tigris.org/">Subversion</a> repository against Django users with
a certain permission.</li>
<li>Allow certain users to connect to a WebDAV share created with <a class="reference external" href="http://httpd.apache.org/docs/2.2/mod/mod_dav.html">mod_dav</a>.</li>
</ul>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">If you have installed a <a class="reference internal" href="../../../topics/auth/customizing.html#auth-custom-user"><span class="std std-ref">custom User model</span></a> and
want to use this default auth handler, it must support an <code class="docutils literal"><span class="pre">is_active</span></code>
attribute. If you want to use group based authorization, your custom user
must have a relation named ‘groups’, referring to a related object that has
a ‘name’ field. You can also specify your own custom mod_wsgi
auth handler if your custom cannot conform to these requirements.</p>
</div>
<div class="section" id="s-authentication-with-mod-wsgi">
<span id="authentication-with-mod-wsgi"></span><h2>Authentication with mod_wsgi<a class="headerlink" href="#authentication-with-mod-wsgi" title="Permalink to this headline">¶</a></h2>
<div class="admonition note">
<p class="first admonition-title">Note</p>
<p class="last">The use of <code class="docutils literal"><span class="pre">WSGIApplicationGroup</span> <span class="pre">%{GLOBAL}</span></code> in the configurations below
presumes that your Apache instance is running only one Django application.
If you are running more than one Django application, please refer to the
<a class="reference external" href="https://code.google.com/p/modwsgi/wiki/ConfigurationGuidelines#Defining_Application_Groups">Defining Application Groups</a> section of the mod_wsgi docs for more
information about this setting.</p>
</div>
<p>Make sure that mod_wsgi is installed and activated and that you have
followed the steps to setup <a class="reference internal" href="modwsgi.html"><span class="doc">Apache with mod_wsgi</span></a>.</p>
<p>Next, edit your Apache configuration to add a location that you want
only authenticated users to be able to view:</p>
<div class="highlight-apache"><div class="highlight"><pre><span></span><span class="nb">WSGIScriptAlias</span> / <span class="sx">/path/to/mysite.com/mysite/wsgi.py</span>
<span class="nb">WSGIPythonPath</span> <span class="sx">/path/to/mysite.com</span>
<span class="nb">WSGIProcessGroup</span> %{GLOBAL}
<span class="nb">WSGIApplicationGroup</span> %{GLOBAL}
<span class="nt"><Location</span> <span class="s">"/secret"</span><span class="nt">></span>
<span class="nb">AuthType</span> Basic
<span class="nb">AuthName</span> <span class="s2">"Top Secret"</span>
<span class="nb">Require</span> valid-user
<span class="nb">AuthBasicProvider</span> wsgi
<span class="nb">WSGIAuthUserScript</span> <span class="sx">/path/to/mysite.com/mysite/wsgi.py</span>
<span class="nt"></Location></span>
</pre></div>
</div>
<p>The <code class="docutils literal"><span class="pre">WSGIAuthUserScript</span></code> directive tells mod_wsgi to execute the
<code class="docutils literal"><span class="pre">check_password</span></code> function in specified wsgi script, passing the user name and
password that it receives from the prompt. In this example, the
<code class="docutils literal"><span class="pre">WSGIAuthUserScript</span></code> is the same as the <code class="docutils literal"><span class="pre">WSGIScriptAlias</span></code> that defines your
application <a class="reference internal" href="index.html"><span class="doc">that is created by django-admin startproject</span></a>.</p>
<div class="admonition-using-apache-2-2-with-authentication admonition">
<p class="first admonition-title">Using Apache 2.2 with authentication</p>
<p>Make sure that <code class="docutils literal"><span class="pre">mod_auth_basic</span></code> and <code class="docutils literal"><span class="pre">mod_authz_user</span></code> are loaded.</p>
<p>These might be compiled statically into Apache, or you might need to use
LoadModule to load them dynamically in your <code class="docutils literal"><span class="pre">httpd.conf</span></code>:</p>
<div class="last highlight-apache"><div class="highlight"><pre><span></span><span class="nb">LoadModule</span> auth_basic_module modules/mod_auth_basic.so
<span class="nb">LoadModule</span> authz_user_module modules/mod_authz_user.so
</pre></div>
</div>
</div>
<p>Finally, edit your WSGI script <code class="docutils literal"><span class="pre">mysite.wsgi</span></code> to tie Apache’s authentication
to your site’s authentication mechanisms by importing the <code class="docutils literal"><span class="pre">check_password</span></code>
function:</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">os</span>
<span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s1">'DJANGO_SETTINGS_MODULE'</span><span class="p">]</span> <span class="o">=</span> <span class="s1">'mysite.settings'</span>
<span class="kn">from</span> <span class="nn">django.contrib.auth.handlers.modwsgi</span> <span class="k">import</span> <span class="n">check_password</span>
<span class="kn">from</span> <span class="nn">django.core.handlers.wsgi</span> <span class="k">import</span> <span class="n">WSGIHandler</span>
<span class="n">application</span> <span class="o">=</span> <span class="n">WSGIHandler</span><span class="p">()</span>
</pre></div>
</div>
<p>Requests beginning with <code class="docutils literal"><span class="pre">/secret/</span></code> will now require a user to authenticate.</p>
<p>The mod_wsgi <a class="reference external" href="http://code.google.com/p/modwsgi/wiki/AccessControlMechanisms">access control mechanisms documentation</a> provides additional
details and information about alternative methods of authentication.</p>
<div class="section" id="s-authorization-with-mod-wsgi-and-django-groups">
<span id="authorization-with-mod-wsgi-and-django-groups"></span><h3>Authorization with mod_wsgi and Django groups<a class="headerlink" href="#authorization-with-mod-wsgi-and-django-groups" title="Permalink to this headline">¶</a></h3>
<p>mod_wsgi also provides functionality to restrict a particular location to
members of a group.</p>
<p>In this case, the Apache configuration should look like this:</p>
<div class="highlight-apache"><div class="highlight"><pre><span></span><span class="nb">WSGIScriptAlias</span> / <span class="sx">/path/to/mysite.com/mysite/wsgi.py</span>
<span class="nb">WSGIProcessGroup</span> %{GLOBAL}
<span class="nb">WSGIApplicationGroup</span> %{GLOBAL}
<span class="nt"><Location</span> <span class="s">"/secret"</span><span class="nt">></span>
<span class="nb">AuthType</span> Basic
<span class="nb">AuthName</span> <span class="s2">"Top Secret"</span>
<span class="nb">AuthBasicProvider</span> wsgi
<span class="nb">WSGIAuthUserScript</span> <span class="sx">/path/to/mysite.com/mysite/wsgi.py</span>
<span class="nb">WSGIAuthGroupScript</span> <span class="sx">/path/to/mysite.com/mysite/wsgi.py</span>
<span class="nb">Require</span> <span class="k">group</span> secret-agents
<span class="nb">Require</span> valid-user
<span class="nt"></Location></span>
</pre></div>
</div>
<p>To support the <code class="docutils literal"><span class="pre">WSGIAuthGroupScript</span></code> directive, the same WSGI script
<code class="docutils literal"><span class="pre">mysite.wsgi</span></code> must also import the <code class="docutils literal"><span class="pre">groups_for_user</span></code> function which
returns a list groups the given user belongs to.</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">from</span> <span class="nn">django.contrib.auth.handlers.modwsgi</span> <span class="kn">import</span> <span class="n">check_password</span><span class="p">,</span> <span class="n">groups_for_user</span>
</pre></div>
</div>
<p>Requests for <code class="docutils literal"><span class="pre">/secret/</span></code> will now also require user to be a member of the
“secret-agents” group.</p>
</div>
</div>
</div>
</div>
</div>
</div>
<div class="yui-b" id="sidebar">
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h3><a href="../../../contents.html">Table Of Contents</a></h3>
<ul>
<li><a class="reference internal" href="#">Authenticating against Django’s user database from Apache</a><ul>
<li><a class="reference internal" href="#authentication-with-mod-wsgi">Authentication with mod_wsgi</a><ul>
<li><a class="reference internal" href="#authorization-with-mod-wsgi-and-django-groups">Authorization with mod_wsgi and Django groups</a></li>
</ul>
</li>
</ul>
</li>
</ul>
<h3>Browse</h3>
<ul>
<li>Prev: <a href="modwsgi.html">How to use Django with Apache and mod_wsgi</a></li>
<li>Next: <a href="gunicorn.html">How to use Django with Gunicorn</a></li>
</ul>
<h3>You are here:</h3>
<ul>
<li>
<a href="../../../index.html">Django 1.8.19 documentation</a>
<ul><li><a href="../../index.html">“How-to” guides</a>
<ul><li><a href="../index.html">Deploying Django</a>
<ul><li><a href="index.html">How to deploy with WSGI</a>
<ul><li>Authenticating against Django’s user database from Apache</li></ul>
</li></ul></li></ul></li></ul>
</li>
</ul>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="../../../_sources/howto/deployment/wsgi/apache-auth.txt"
rel="nofollow">Show Source</a></li>
</ul>
</div>
<div id="searchbox" style="display: none" role="search">
<h3>Quick search</h3>
<form class="search" action="../../../search.html" method="get">
<div><input type="text" name="q" /></div>
<div><input type="submit" value="Go" /></div>
<input type="hidden" name="check_keywords" value="yes" />
<input type="hidden" name="area" value="default" />
</form>
</div>
<script type="text/javascript">$('#searchbox').show(0);</script>
</div>
</div>
<h3>Last update:</h3>
<p class="topless">Mar 10, 2018</p>
</div>
</div>
<div id="ft">
<div class="nav">
« <a href="modwsgi.html" title="How to use Django with Apache and mod_wsgi">previous</a>
|
<a href="../../index.html" title="&#8220;How-to&#8221; guides" accesskey="U">up</a>
|
<a href="gunicorn.html" title="How to use Django with Gunicorn">next</a> »</div>
</div>
</div>
<div class="clearer"></div>
</div>
</body>
</html>
distrib
>
Mageia
>
6
>
armv7hl
>
media
>
core-updates
>
by-pkgid
>
65530c6176058f9b54858c3b4f6385e6
>
files
>
617
