/usr/share/doc/python-django-auth-ldap-doc/html/example.html is in python-django-auth-ldap-doc 1.4.0-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 | <!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">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
<title>Example Configuration — django-auth-ldap 1.4.0 documentation</title>
<link rel="stylesheet" href="_static/classic.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.4.0',
COLLAPSE_INDEX: false,
FILE_SUFFIX: '.html',
HAS_SOURCE: true,
SOURCELINK_SUFFIX: '.txt'
};
</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="next" title="Reference" href="reference.html" />
<link rel="prev" title="Performance" href="performance.html" />
</head>
<body>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
accesskey="I">index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference"
accesskey="N">next</a> |</li>
<li class="right" >
<a href="performance.html" title="Performance"
accesskey="P">previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-auth-ldap 1.4.0 documentation</a> »</li>
</ul>
</div>
<div class="document">
<div class="documentwrapper">
<div class="bodywrapper">
<div class="body" role="main">
<div class="section" id="example-configuration">
<h1>Example Configuration<a class="headerlink" href="#example-configuration" title="Permalink to this headline">¶</a></h1>
<p>Here is a complete example configuration from <code class="file docutils literal"><span class="pre">settings.py</span></code> that exercises
nearly all of the features. In this example, we’re authenticating against a
global pool of users in the directory, but we have a special area set aside for
Django groups (ou=django,ou=groups,dc=example,dc=com). Remember that most of
this is optional if you just need simple authentication. Some default settings
and arguments are included for completeness.</p>
<div class="highlight-python"><div class="highlight"><pre><span></span><span class="kn">import</span> <span class="nn">ldap</span>
<span class="kn">from</span> <span class="nn">django_auth_ldap.config</span> <span class="kn">import</span> <span class="n">LDAPSearch</span><span class="p">,</span> <span class="n">GroupOfNamesType</span>
<span class="c1"># Baseline configuration.</span>
<span class="n">AUTH_LDAP_SERVER_URI</span> <span class="o">=</span> <span class="s2">"ldap://ldap.example.com"</span>
<span class="n">AUTH_LDAP_BIND_DN</span> <span class="o">=</span> <span class="s2">"cn=django-agent,dc=example,dc=com"</span>
<span class="n">AUTH_LDAP_BIND_PASSWORD</span> <span class="o">=</span> <span class="s2">"phlebotinum"</span>
<span class="n">AUTH_LDAP_USER_SEARCH</span> <span class="o">=</span> <span class="n">LDAPSearch</span><span class="p">(</span><span class="s2">"ou=users,dc=example,dc=com"</span><span class="p">,</span>
<span class="n">ldap</span><span class="o">.</span><span class="n">SCOPE_SUBTREE</span><span class="p">,</span> <span class="s2">"(uid=</span><span class="si">%(user)s</span><span class="s2">)"</span><span class="p">)</span>
<span class="c1"># or perhaps:</span>
<span class="c1"># AUTH_LDAP_USER_DN_TEMPLATE = "uid=%(user)s,ou=users,dc=example,dc=com"</span>
<span class="c1"># Set up the basic group parameters.</span>
<span class="n">AUTH_LDAP_GROUP_SEARCH</span> <span class="o">=</span> <span class="n">LDAPSearch</span><span class="p">(</span><span class="s2">"ou=django,ou=groups,dc=example,dc=com"</span><span class="p">,</span>
<span class="n">ldap</span><span class="o">.</span><span class="n">SCOPE_SUBTREE</span><span class="p">,</span> <span class="s2">"(objectClass=groupOfNames)"</span>
<span class="p">)</span>
<span class="n">AUTH_LDAP_GROUP_TYPE</span> <span class="o">=</span> <span class="n">GroupOfNamesType</span><span class="p">(</span><span class="n">name_attr</span><span class="o">=</span><span class="s2">"cn"</span><span class="p">)</span>
<span class="c1"># Simple group restrictions</span>
<span class="n">AUTH_LDAP_REQUIRE_GROUP</span> <span class="o">=</span> <span class="s2">"cn=enabled,ou=django,ou=groups,dc=example,dc=com"</span>
<span class="n">AUTH_LDAP_DENY_GROUP</span> <span class="o">=</span> <span class="s2">"cn=disabled,ou=django,ou=groups,dc=example,dc=com"</span>
<span class="c1"># Populate the Django user from the LDAP directory.</span>
<span class="n">AUTH_LDAP_USER_ATTR_MAP</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"first_name"</span><span class="p">:</span> <span class="s2">"givenName"</span><span class="p">,</span>
<span class="s2">"last_name"</span><span class="p">:</span> <span class="s2">"sn"</span><span class="p">,</span>
<span class="s2">"email"</span><span class="p">:</span> <span class="s2">"mail"</span>
<span class="p">}</span>
<span class="n">AUTH_LDAP_USER_FLAGS_BY_GROUP</span> <span class="o">=</span> <span class="p">{</span>
<span class="s2">"is_active"</span><span class="p">:</span> <span class="s2">"cn=active,ou=django,ou=groups,dc=example,dc=com"</span><span class="p">,</span>
<span class="s2">"is_staff"</span><span class="p">:</span> <span class="s2">"cn=staff,ou=django,ou=groups,dc=example,dc=com"</span><span class="p">,</span>
<span class="s2">"is_superuser"</span><span class="p">:</span> <span class="s2">"cn=superuser,ou=django,ou=groups,dc=example,dc=com"</span>
<span class="p">}</span>
<span class="c1"># This is the default, but I like to be explicit.</span>
<span class="n">AUTH_LDAP_ALWAYS_UPDATE_USER</span> <span class="o">=</span> <span class="bp">True</span>
<span class="c1"># Use LDAP group membership to calculate group permissions.</span>
<span class="n">AUTH_LDAP_FIND_GROUP_PERMS</span> <span class="o">=</span> <span class="bp">True</span>
<span class="c1"># Cache group memberships for an hour to minimize LDAP traffic</span>
<span class="n">AUTH_LDAP_CACHE_GROUPS</span> <span class="o">=</span> <span class="bp">True</span>
<span class="n">AUTH_LDAP_GROUP_CACHE_TIMEOUT</span> <span class="o">=</span> <span class="mi">3600</span>
<span class="c1"># Keep ModelBackend around for per-user permissions and maybe a local</span>
<span class="c1"># superuser.</span>
<span class="n">AUTHENTICATION_BACKENDS</span> <span class="o">=</span> <span class="p">(</span>
<span class="s1">'django_auth_ldap.backend.LDAPBackend'</span><span class="p">,</span>
<span class="s1">'django.contrib.auth.backends.ModelBackend'</span><span class="p">,</span>
<span class="p">)</span>
</pre></div>
</div>
</div>
</div>
</div>
</div>
<div class="sphinxsidebar" role="navigation" aria-label="main navigation">
<div class="sphinxsidebarwrapper">
<h4>Previous topic</h4>
<p class="topless"><a href="performance.html"
title="previous chapter">Performance</a></p>
<h4>Next topic</h4>
<p class="topless"><a href="reference.html"
title="next chapter">Reference</a></p>
<div role="note" aria-label="source link">
<h3>This Page</h3>
<ul class="this-page-menu">
<li><a href="_sources/example.rst.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>
<div class="clearer"></div>
</div>
<div class="related" role="navigation" aria-label="related navigation">
<h3>Navigation</h3>
<ul>
<li class="right" style="margin-right: 10px">
<a href="genindex.html" title="General Index"
>index</a></li>
<li class="right" >
<a href="py-modindex.html" title="Python Module Index"
>modules</a> |</li>
<li class="right" >
<a href="reference.html" title="Reference"
>next</a> |</li>
<li class="right" >
<a href="performance.html" title="Performance"
>previous</a> |</li>
<li class="nav-item nav-item-0"><a href="index.html">django-auth-ldap 1.4.0 documentation</a> »</li>
</ul>
</div>
<div class="footer" role="contentinfo">
© Copyright 2018, Peter Sagerson.
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.6.7.
</div>
</body>
</html>
|