forked from shaba/openuds
147 lines
5.9 KiB
HTML
147 lines
5.9 KiB
HTML
<!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>Authenticator Modules — UDS 1.0 documentation</title>
|
|
|
|
<link rel="stylesheet" href="../../_static/sphinxdoc.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.0',
|
|
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>
|
|
<script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML"></script>
|
|
<link rel="top" title="UDS 1.0 documentation" href="../../index.html" />
|
|
<link rel="up" title="UDS Modules" href="../modules.html" />
|
|
<link rel="next" title="Authenticator Interface" href="auths/Authenticator.html" />
|
|
<link rel="prev" title="Service Exceptions" href="services/Exceptions.html" />
|
|
</head>
|
|
<body>
|
|
<div class="related">
|
|
<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="auths/Authenticator.html" title="Authenticator Interface"
|
|
accesskey="N">next</a> |</li>
|
|
<li class="right" >
|
|
<a href="services/Exceptions.html" title="Service Exceptions"
|
|
accesskey="P">previous</a> |</li>
|
|
<li><a href="../../index.html">UDS 1.0 documentation</a> »</li>
|
|
<li><a href="../index.html" >UDS’s core API</a> »</li>
|
|
<li><a href="../modules.html" accesskey="U">UDS Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="sphinxsidebar">
|
|
<div class="sphinxsidebarwrapper">
|
|
<h4>Previous topic</h4>
|
|
<p class="topless"><a href="services/Exceptions.html"
|
|
title="previous chapter">Service Exceptions</a></p>
|
|
<h4>Next topic</h4>
|
|
<p class="topless"><a href="auths/Authenticator.html"
|
|
title="next chapter">Authenticator Interface</a></p>
|
|
<h3>This Page</h3>
|
|
<ul class="this-page-menu">
|
|
<li><a href="../../_sources/api/modules/AuthenticatorModule.txt"
|
|
rel="nofollow">Show Source</a></li>
|
|
</ul>
|
|
<div id="searchbox" style="display: none">
|
|
<h3>Quick search</h3>
|
|
<form class="search" action="../../search.html" method="get">
|
|
<input type="text" name="q" />
|
|
<input type="submit" value="Go" />
|
|
<input type="hidden" name="check_keywords" value="yes" />
|
|
<input type="hidden" name="area" value="default" />
|
|
</form>
|
|
<p class="searchtip" style="font-size: 90%">
|
|
Enter search terms or a module, class or function name.
|
|
</p>
|
|
</div>
|
|
<script type="text/javascript">$('#searchbox').show(0);</script>
|
|
</div>
|
|
</div>
|
|
|
|
<div class="document">
|
|
<div class="documentwrapper">
|
|
<div class="bodywrapper">
|
|
<div class="body">
|
|
|
|
<div class="section" id="authenticator-modules">
|
|
<h1>Authenticator Modules<a class="headerlink" href="#authenticator-modules" title="Permalink to this headline">¶</a></h1>
|
|
<p>Authenticator modules are responsible of providing the user authentication
|
|
part inside UDS.</p>
|
|
<p>They are composed of a package where it is provided and, at least, the following
|
|
elements:</p>
|
|
<blockquote>
|
|
<div><ul class="simple">
|
|
<li>One icon for administration interface representation. Icon is png file of
|
|
16x16.</li>
|
|
<li>One class, derived from uds.core.auths.Authenticator, providing the needed
|
|
logic for that authenticator.</li>
|
|
<li>Registration of the class inside uds at package’s __init__.</li>
|
|
</ul>
|
|
</div></blockquote>
|
|
<p>All packages included inside uds.auths will automatically be imported, but
|
|
the authenticators needs to register as valid authenticators, and the best place
|
|
to do that is at the authenticator’s package __init__.</p>
|
|
<p>The best way to understand what you need to create your own authenticator,
|
|
is to look at <a class="reference internal" href="../../development/samples/samples.html"><em>modules samples</em></a></p>
|
|
<div class="toctree-wrapper compound">
|
|
<ul>
|
|
<li class="toctree-l1"><a class="reference internal" href="auths/Authenticator.html">Authenticator Interface</a><ul class="simple">
|
|
</ul>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
|
|
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clearer"></div>
|
|
</div>
|
|
<div class="related">
|
|
<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="auths/Authenticator.html" title="Authenticator Interface"
|
|
>next</a> |</li>
|
|
<li class="right" >
|
|
<a href="services/Exceptions.html" title="Service Exceptions"
|
|
>previous</a> |</li>
|
|
<li><a href="../../index.html">UDS 1.0 documentation</a> »</li>
|
|
<li><a href="../index.html" >UDS’s core API</a> »</li>
|
|
<li><a href="../modules.html" >UDS Modules</a> »</li>
|
|
</ul>
|
|
</div>
|
|
<div class="footer">
|
|
© Copyright 2012, Virtual Cable S.L.U..
|
|
Created using <a href="http://sphinx-doc.org/">Sphinx</a> 1.2.2.
|
|
</div>
|
|
</body>
|
|
</html> |