Skip to content

Commit 7033165

Browse files
pitbulkpitbulk
committed
Add class and method documentation
1 parent 548e1ff commit 7033165

41 files changed

Lines changed: 20730 additions & 0 deletions

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

‎docs/saml2/.buildinfo‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
# Sphinx build info version 1
2+
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3+
config: e10660514f5c62e16e90878c60a15170
4+
tags: fbb0d17656682115ca4d033fb2f83ba1

‎docs/saml2/_modules/index.html‎

Lines changed: 101 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,101 @@
1+
2+
3+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5+
6+
7+
<html xmlns="http://www.w3.org/1999/xhtml">
8+
<head>
9+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10+
11+
<title>Overview: module code &mdash; OneLogin SAML Python library classes and methods</title>
12+
13+
<link rel="stylesheet" href="../_static/default.css" type="text/css" />
14+
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
15+
16+
<script type="text/javascript">
17+
var DOCUMENTATION_OPTIONS = {
18+
URL_ROOT: '../',
19+
VERSION: '',
20+
COLLAPSE_INDEX: false,
21+
FILE_SUFFIX: '.html',
22+
HAS_SOURCE: true
23+
};
24+
</script>
25+
<script type="text/javascript" src="../_static/jquery.js"></script>
26+
<script type="text/javascript" src="../_static/underscore.js"></script>
27+
<script type="text/javascript" src="../_static/doctools.js"></script>
28+
<link rel="top" title="OneLogin SAML Python library classes and methods" href="../index.html" />
29+
</head>
30+
<body>
31+
<div class="related">
32+
<h3>Navigation</h3>
33+
<ul>
34+
<li class="right" style="margin-right: 10px">
35+
<a href="../genindex.html" title="General Index"
36+
accesskey="I">index</a></li>
37+
<li class="right" >
38+
<a href="../py-modindex.html" title="Python Class Index"
39+
>modules</a> |</li>
40+
<li><a href="../index.html">OneLogin SAML Python library classes and methods</a> &raquo;</li>
41+
</ul>
42+
</div>
43+
44+
<div class="document">
45+
<div class="documentwrapper">
46+
<div class="bodywrapper">
47+
<div class="body">
48+
49+
<h1>All modules for which code is available</h1>
50+
<ul><li><a href="saml2/auth.html">saml2.auth</a></li>
51+
<li><a href="saml2/authn_request.html">saml2.authn_request</a></li>
52+
<li><a href="saml2/constants.html">saml2.constants</a></li>
53+
<li><a href="saml2/errors.html">saml2.errors</a></li>
54+
<li><a href="saml2/logout_request.html">saml2.logout_request</a></li>
55+
<li><a href="saml2/logout_response.html">saml2.logout_response</a></li>
56+
<li><a href="saml2/metadata.html">saml2.metadata</a></li>
57+
<li><a href="saml2/response.html">saml2.response</a></li>
58+
<li><a href="saml2/settings.html">saml2.settings</a></li>
59+
<li><a href="saml2/utils.html">saml2.utils</a></li>
60+
</ul>
61+
62+
</div>
63+
</div>
64+
</div>
65+
<div class="sphinxsidebar">
66+
<div class="sphinxsidebarwrapper">
67+
<div id="searchbox" style="display: none">
68+
<h3>Quick search</h3>
69+
<form class="search" action="../search.html" method="get">
70+
<input type="text" name="q" />
71+
<input type="submit" value="Go" />
72+
<input type="hidden" name="check_keywords" value="yes" />
73+
<input type="hidden" name="area" value="default" />
74+
</form>
75+
<p class="searchtip" style="font-size: 90%">
76+
Enter search terms or a module, class or function name.
77+
</p>
78+
</div>
79+
<script type="text/javascript">$('#searchbox').show(0);</script>
80+
</div>
81+
</div>
82+
<div class="clearer"></div>
83+
</div>
84+
<div class="related">
85+
<h3>Navigation</h3>
86+
<ul>
87+
<li class="right" style="margin-right: 10px">
88+
<a href="../genindex.html" title="General Index"
89+
>index</a></li>
90+
<li class="right" >
91+
<a href="../py-modindex.html" title="Python Class Index"
92+
>modules</a> |</li>
93+
<li><a href="../index.html">OneLogin SAML Python library classes and methods</a> &raquo;</li>
94+
</ul>
95+
</div>
96+
<div class="footer">
97+
&copy; Copyright 2014, OneLogin Inc..
98+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
99+
</div>
100+
</body>
101+
</html>

‎docs/saml2/_modules/saml2/auth.html‎

Lines changed: 457 additions & 0 deletions
Large diffs are not rendered by default.

‎docs/saml2/_modules/saml2/authn_request.html‎

Lines changed: 176 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,176 @@
1+
2+
3+
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
4+
"http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
5+
6+
7+
<html xmlns="http://www.w3.org/1999/xhtml">
8+
<head>
9+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
10+
11+
<title>saml2.authn_request &mdash; OneLogin SAML Python library classes and methods</title>
12+
13+
<link rel="stylesheet" href="../../_static/default.css" type="text/css" />
14+
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
15+
16+
<script type="text/javascript">
17+
var DOCUMENTATION_OPTIONS = {
18+
URL_ROOT: '../../',
19+
VERSION: '',
20+
COLLAPSE_INDEX: false,
21+
FILE_SUFFIX: '.html',
22+
HAS_SOURCE: true
23+
};
24+
</script>
25+
<script type="text/javascript" src="../../_static/jquery.js"></script>
26+
<script type="text/javascript" src="../../_static/underscore.js"></script>
27+
<script type="text/javascript" src="../../_static/doctools.js"></script>
28+
<link rel="top" title="OneLogin SAML Python library classes and methods" href="../../index.html" />
29+
<link rel="up" title="Class code" href="../index.html" />
30+
</head>
31+
<body>
32+
<div class="related">
33+
<h3>Navigation</h3>
34+
<ul>
35+
<li class="right" style="margin-right: 10px">
36+
<a href="../../genindex.html" title="General Index"
37+
accesskey="I">index</a></li>
38+
<li class="right" >
39+
<a href="../../py-modindex.html" title="Python Class Index"
40+
>modules</a> |</li>
41+
<li><a href="../../index.html">OneLogin SAML Python library classes and methods</a> &raquo;</li>
42+
<li><a href="../index.html" accesskey="U">Class code</a> &raquo;</li>
43+
</ul>
44+
</div>
45+
46+
<div class="document">
47+
<div class="documentwrapper">
48+
<div class="bodywrapper">
49+
<div class="body">
50+
51+
<h1>Source code for saml2.authn_request</h1><div class="highlight"><pre>
52+
<span class="c"># -*- coding: utf-8 -*-</span>
53+
54+
<span class="c"># Copyright (c) 2014, OneLogin, Inc.</span>
55+
<span class="c"># All rights reserved.</span>
56+
57+
<span class="kn">from</span> <span class="nn">base64</span> <span class="kn">import</span> <span class="n">b64encode</span>
58+
<span class="kn">from</span> <span class="nn">datetime</span> <span class="kn">import</span> <span class="n">datetime</span>
59+
<span class="kn">from</span> <span class="nn">zlib</span> <span class="kn">import</span> <span class="n">compress</span>
60+
61+
<span class="kn">from</span> <span class="nn">saml2.utils</span> <span class="kn">import</span> <span class="n">OneLogin_Saml2_Utils</span>
62+
<span class="kn">from</span> <span class="nn">saml2.constants</span> <span class="kn">import</span> <span class="n">OneLogin_Saml2_Constants</span>
63+
64+
65+
<div class="viewcode-block" id="OneLogin_Saml2_Authn_Request"><a class="viewcode-back" href="../../saml2.html#saml2.authn_request.OneLogin_Saml2_Authn_Request">[docs]</a><span class="k">class</span> <span class="nc">OneLogin_Saml2_Authn_Request</span><span class="p">:</span>
66+
67+
<span class="k">def</span> <span class="nf">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">settings</span><span class="p">):</span>
68+
<span class="sd">&quot;&quot;&quot;</span>
69+
<span class="sd"> Constructs the AuthnRequest object.</span>
70+
71+
<span class="sd"> Arguments are:</span>
72+
<span class="sd"> * (OneLogin_Saml2_Settings) settings. Setting data</span>
73+
<span class="sd"> &quot;&quot;&quot;</span>
74+
<span class="bp">self</span><span class="o">.</span><span class="n">__settings</span> <span class="o">=</span> <span class="n">settings</span>
75+
76+
<span class="n">sp_data</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_sp_data</span><span class="p">()</span>
77+
<span class="n">security</span> <span class="o">=</span> <span class="bp">self</span><span class="o">.</span><span class="n">__settings</span><span class="o">.</span><span class="n">get_security_data</span><span class="p">()</span>
78+
79+
<span class="n">uid</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">generate_unique_id</span><span class="p">()</span>
80+
<span class="n">issue_instant</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Utils</span><span class="o">.</span><span class="n">parse_time_to_SAML</span><span class="p">(</span>
81+
<span class="nb">int</span><span class="p">(</span><span class="n">datetime</span><span class="o">.</span><span class="n">now</span><span class="p">()</span><span class="o">.</span><span class="n">strftime</span><span class="p">(</span><span class="s">&quot;</span><span class="si">%s</span><span class="s">&quot;</span><span class="p">))</span>
82+
<span class="p">)</span>
83+
84+
<span class="n">name_id_policy_format</span> <span class="o">=</span> <span class="n">sp_data</span><span class="p">[</span><span class="s">&#39;NameIDFormat&#39;</span><span class="p">]</span>
85+
<span class="k">if</span> <span class="s">&#39;wantNameIdEncrypted&#39;</span> <span class="ow">in</span> <span class="n">security</span> <span class="ow">and</span> <span class="n">security</span><span class="p">[</span><span class="s">&#39;wantNameIdEncrypted&#39;</span><span class="p">]:</span>
86+
<span class="n">name_id_policy_format</span> <span class="o">=</span> <span class="n">OneLogin_Saml2_Constants</span><span class="o">.</span><span class="n">NAMEID_ENCRYPTED</span>
87+
88+
<span class="n">provider_name_str</span> <span class="o">=</span> <span class="s">&#39;&#39;</span>
89+
<span class="n">organization_data</span> <span class="o">=</span> <span class="n">settings</span><span class="o">.</span><span class="n">get_organization</span><span class="p">()</span>
90+
<span class="k">if</span> <span class="nb">isinstance</span><span class="p">(</span><span class="n">organization_data</span><span class="p">,</span> <span class="nb">dict</span><span class="p">):</span>
91+
<span class="n">langs</span> <span class="o">=</span> <span class="n">organization_data</span><span class="o">.</span><span class="n">keys</span><span class="p">()</span>
92+
<span class="k">if</span> <span class="s">&#39;en-US&#39;</span> <span class="ow">in</span> <span class="n">langs</span><span class="p">:</span>
93+
<span class="n">lang</span> <span class="o">=</span> <span class="s">&#39;en-US&#39;</span>
94+
<span class="k">else</span><span class="p">:</span>
95+
<span class="n">lang</span> <span class="o">=</span> <span class="n">langs</span><span class="p">[</span><span class="mi">0</span><span class="p">]</span>
96+
<span class="k">if</span> <span class="s">&#39;displayname&#39;</span> <span class="ow">in</span> <span class="n">organization_data</span><span class="p">[</span><span class="n">lang</span><span class="p">]</span> <span class="ow">and</span> <span class="n">organization_data</span><span class="p">[</span><span class="n">lang</span><span class="p">][</span><span class="s">&#39;displayname&#39;</span><span class="p">]</span> <span class="ow">is</span> <span class="ow">not</span> <span class="bp">None</span><span class="p">:</span>
97+
<span class="n">provider_name_str</span> <span class="o">=</span> <span class="s">&#39;ProviderName=&quot;</span><span class="si">%s</span><span class="s">&quot;&#39;</span> <span class="o">%</span> <span class="n">organization_data</span><span class="p">[</span><span class="n">lang</span><span class="p">][</span><span class="s">&#39;displayname&#39;</span><span class="p">]</span>
98+
99+
<span class="n">request</span> <span class="o">=</span> <span class="s">&quot;&quot;&quot;&lt;samlp:AuthnRequest</span>
100+
<span class="s"> xmlns:samlp=&quot;urn:oasis:names:tc:SAML:2.0:protocol&quot;</span>
101+
<span class="s"> xmlns:saml=&quot;urn:oasis:names:tc:SAML:2.0:assertion&quot;</span>
102+
<span class="s"> ID=&quot;</span><span class="si">%(id)s</span><span class="s">&quot;</span>
103+
<span class="s"> Version=&quot;2.0&quot;</span>
104+
<span class="s"> </span><span class="si">%(provider_name)s</span><span class="s"></span>
105+
<span class="s"> IssueInstant=&quot;</span><span class="si">%(issue_instant)s</span><span class="s">&quot;</span>
106+
<span class="s"> ProtocolBinding=&quot;urn:oasis:names:tc:SAML:2.0:bindings:HTTP-POST&quot;</span>
107+
<span class="s"> AssertionConsumerServiceURL=&quot;</span><span class="si">%(assertion_url)s</span><span class="s">&quot;&gt;</span>
108+
<span class="s"> &lt;saml:Issuer&gt;</span><span class="si">%(entity_id)s</span><span class="s">&lt;/saml:Issuer&gt;</span>
109+
<span class="s"> &lt;samlp:NameIDPolicy</span>
110+
<span class="s"> Format=&quot;</span><span class="si">%(name_id_policy)s</span><span class="s">&quot;</span>
111+
<span class="s"> AllowCreate=&quot;true&quot; /&gt;</span>
112+
<span class="s"> &lt;samlp:RequestedAuthnContext Comparison=&quot;exact&quot;&gt;</span>
113+
<span class="s"> &lt;saml:AuthnContextMethodRef&gt;urn:oasis:names:tc:SAML:2.0:ac:classes:PasswordProtectedTransport&lt;/saml:AuthnContextMethodRef&gt;</span>
114+
<span class="s"> &lt;/samlp:RequestedAuthnContext&gt;</span>
115+
<span class="s">&lt;/samlp:AuthnRequest&gt;&quot;&quot;&quot;</span> <span class="o">%</span> <span class="p">{</span>
116+
<span class="s">&#39;id&#39;</span><span class="p">:</span> <span class="n">uid</span><span class="p">,</span>
117+
<span class="s">&#39;provider_name&#39;</span><span class="p">:</span> <span class="n">provider_name_str</span><span class="p">,</span>
118+
<span class="s">&#39;issue_instant&#39;</span><span class="p">:</span> <span class="n">issue_instant</span><span class="p">,</span>
119+
<span class="s">&#39;assertion_url&#39;</span><span class="p">:</span> <span class="n">sp_data</span><span class="p">[</span><span class="s">&#39;assertionConsumerService&#39;</span><span class="p">][</span><span class="s">&#39;url&#39;</span><span class="p">],</span>
120+
<span class="s">&#39;entity_id&#39;</span><span class="p">:</span> <span class="n">sp_data</span><span class="p">[</span><span class="s">&#39;entityId&#39;</span><span class="p">],</span>
121+
<span class="s">&#39;name_id_policy&#39;</span><span class="p">:</span> <span class="n">name_id_policy_format</span><span class="p">,</span>
122+
<span class="p">}</span>
123+
124+
<span class="bp">self</span><span class="o">.</span><span class="n">__authn_request</span> <span class="o">=</span> <span class="n">request</span>
125+
126+
<div class="viewcode-block" id="OneLogin_Saml2_Authn_Request.get_request"><a class="viewcode-back" href="../../saml2.html#saml2.authn_request.OneLogin_Saml2_Authn_Request.get_request">[docs]</a> <span class="k">def</span> <span class="nf">get_request</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
127+
<span class="sd">&quot;&quot;&quot;</span>
128+
<span class="sd"> Returns unsigned AuthnRequest.</span>
129+
<span class="sd"> :return: Unsigned AuthnRequest</span>
130+
<span class="sd"> :rtype: str object</span>
131+
<span class="sd"> &quot;&quot;&quot;</span>
132+
<span class="n">deflated_request</span> <span class="o">=</span> <span class="n">compress</span><span class="p">(</span><span class="bp">self</span><span class="o">.</span><span class="n">__authn_request</span><span class="p">)[</span><span class="mi">2</span><span class="p">:</span><span class="o">-</span><span class="mi">4</span><span class="p">]</span>
133+
<span class="k">return</span> <span class="n">b64encode</span><span class="p">(</span><span class="n">deflated_request</span><span class="p">)</span></div></div>
134+
</pre></div>
135+
136+
</div>
137+
</div>
138+
</div>
139+
<div class="sphinxsidebar">
140+
<div class="sphinxsidebarwrapper">
141+
<div id="searchbox" style="display: none">
142+
<h3>Quick search</h3>
143+
<form class="search" action="../../search.html" method="get">
144+
<input type="text" name="q" />
145+
<input type="submit" value="Go" />
146+
<input type="hidden" name="check_keywords" value="yes" />
147+
<input type="hidden" name="area" value="default" />
148+
</form>
149+
<p class="searchtip" style="font-size: 90%">
150+
Enter search terms or a module, class or function name.
151+
</p>
152+
</div>
153+
<script type="text/javascript">$('#searchbox').show(0);</script>
154+
</div>
155+
</div>
156+
<div class="clearer"></div>
157+
</div>
158+
<div class="related">
159+
<h3>Navigation</h3>
160+
<ul>
161+
<li class="right" style="margin-right: 10px">
162+
<a href="../../genindex.html" title="General Index"
163+
>index</a></li>
164+
<li class="right" >
165+
<a href="../../py-modindex.html" title="Python Class Index"
166+
>modules</a> |</li>
167+
<li><a href="../../index.html">OneLogin SAML Python library classes and methods</a> &raquo;</li>
168+
<li><a href="../index.html" >Class code</a> &raquo;</li>
169+
</ul>
170+
</div>
171+
<div class="footer">
172+
&copy; Copyright 2014, OneLogin Inc..
173+
Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1.3.
174+
</div>
175+
</body>
176+
</html>

0 commit comments

Comments
 (0)