1
<?xml version="1.0" encoding="ascii"?>
1
<?xml version="1.0" encoding="iso-8859-1"?>
2
2
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
3
3
"DTD/xhtml1-transitional.dtd">
4
4
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
6
6
<title>openid</title>
7
<link rel="stylesheet" href="epydoc.css" type="text/css" />
8
<script type="text/javascript" src="epydoc.js"></script>
7
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
11
9
<body bgcolor="white" text="black" link="blue" vlink="#204080"
13
<!-- ==================== NAVIGATION BAR ==================== -->
14
<table class="navbar" border="0" width="100%" cellpadding="0"
15
bgcolor="#a0c0ff" cellspacing="0">
18
<th bgcolor="#70b0f0" class="navbar-select"
19
> Home </th>
22
<th> <a
23
href="module-tree.html">Trees</a> </th>
26
<th> <a
27
href="identifier-index.html">Indices</a> </th>
30
<th> <a
31
href="help.html">Help</a> </th>
33
<!-- Project homepage -->
34
<th class="navbar" align="right" width="100%">
35
<table border="0" cellpadding="0" cellspacing="0">
36
<tr><th class="navbar" align="center"
37
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
12
<!-- =========== START OF NAVBAR =========== -->
13
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
15
<th bgcolor="#70b0f0" class="navselect"> Home </th>
16
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
17
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
18
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
19
<th class="navbar" align="right" width="100%">
20
<table border="0" cellpadding="0" cellspacing="0">
21
<tr><th class="navbar" align="center">
23
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
24
</p></th></tr></table>
41
28
<table width="100%" cellpadding="0" cellspacing="0">
44
<span class="breadcrumbs">
31
<font size="-1"><b class="breadcrumbs">
45
32
Package openid
49
<table cellpadding="0" cellspacing="0">
50
<!-- hide/show private -->
51
<tr><td align="right"><span class="options"
52
>[<a href="frames.html" target="_top">frames</a
53
>] | <a href="openid-module.html"
54
target="_top">no frames</a>]</span></td></tr>
59
<!-- ==================== PACKAGE DESCRIPTION ==================== -->
60
<h1 class="epydoc">Package openid</h1><span class="codelink"><a href="openid-pysrc.html">source code</a></span><br /><br />
35
<td><table cellpadding="0" cellspacing="0">
36
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid-module.html" target="_top">no frames</a>]</font></td></tr>
40
<!-- =========== START OF PACKAGE DESCRIPTION =========== -->
41
<h2 class="package">Package openid</h2>
61
43
This package is an implementation of the OpenID specification in
62
Python. It contains code for both server and consumer implementations.
63
For information on implementing an OpenID consumer, see the <code><a
64
href="openid.consumer.consumer-module.html"
65
class="link">openid.consumer.consumer</a></code> module. For information
66
on implementing an OpenID server, see the <code><a
67
href="openid.server.server-module.html"
68
class="link">openid.server.server</a></code> module.<br /><br />
70
<!-- ==================== SUBMODULES ==================== -->
71
<a name="section-Submodules"></a>
72
<table class="summary" border="1" cellpadding="3"
73
cellspacing="0" width="100%" bgcolor="white">
74
<tr bgcolor="#70b0f0" class="table-header">
75
<td colspan="2" class="table-header">
76
<table border="0" cellpadding="0" cellspacing="0" width="100%">
78
<td align="left"><span class="table-header">Submodules</span></td>
79
<td align="right" valign="top"
80
><span class="options">[<a href="#section-Submodules"
81
class="privatelink" onclick="toggle_private();"
82
>hide private</a>]</span></td>
87
<tr><td class="summary">
89
<li> <strong class="uidlink"><a href="openid.association-module.html">openid.association</a></strong>: <em class="summary">This module contains code for dealing with associations between
90
consumers and servers.</em></li>
91
<li> <strong class="uidlink"><a href="openid.consumer-module.html">openid.consumer</a></strong>: <em class="summary">This package contains the portions of the library used only when
92
implementing an OpenID consumer.</em></li>
94
<li> <strong class="uidlink"><a href="openid.consumer.consumer-module.html">openid.consumer.consumer</a></strong>: <em class="summary">This module documents the main interface with the OpenID
95
consumer library.</em></li>
96
<li> <strong class="uidlink"><a href="openid.consumer.discover-module.html">openid.consumer.discover</a></strong></li>
99
<li> <strong class="uidlink"><a href="openid.dh-module.html">openid.dh</a></strong></li>
100
<li> <strong class="uidlink"><a href="openid.server-module.html">openid.server</a></strong>: <em class="summary">This package contains the portions of the library used only when
101
implementing an OpenID server.</em></li>
103
<li> <strong class="uidlink"><a href="openid.server.server-module.html">openid.server.server</a></strong>: <em class="summary">OpenID server protocol and logic.</em></li>
104
<li> <strong class="uidlink"><a href="openid.server.trustroot-module.html">openid.server.trustroot</a></strong>: <em class="summary">This module contains the <code><a
105
href="openid.server.trustroot.TrustRoot-class.html"
106
class="link">TrustRoot</a></code> class, which helps handle trust
107
root checking.</em></li>
110
<li> <strong class="uidlink"><a href="openid.store-module.html">openid.store</a></strong>: <em class="summary">This package contains the modules related to this library's use
111
of persistent storage.</em></li>
113
<li> <strong class="uidlink"><a href="openid.store.dumbstore-module.html">openid.store.dumbstore</a></strong>: <em class="summary">This module contains an <code><a
114
href="openid.store.interface.OpenIDStore-class.html"
115
class="link">OpenIDStore</a></code> implementation with no
116
persistent backing, for use only by limited consumers.</em></li>
117
<li> <strong class="uidlink"><a href="openid.store.filestore-module.html">openid.store.filestore</a></strong>: <em class="summary">This module contains an <code><a
118
href="openid.store.interface.OpenIDStore-class.html"
119
class="link">OpenIDStore</a></code> implementation backed by flat
121
<li> <strong class="uidlink"><a href="openid.store.interface-module.html">openid.store.interface</a></strong>: <em class="summary">This module contains the definition of the <code><a
122
href="openid.store.interface.OpenIDStore-class.html"
123
class="link">OpenIDStore</a></code> interface.</em></li>
124
<li> <strong class="uidlink"><a href="openid.store.sqlstore-module.html">openid.store.sqlstore</a></strong>: <em class="summary">This module contains <code><a
125
href="openid.store.interface.OpenIDStore-class.html"
126
class="link">OpenIDStore</a></code> implementations that use
127
various SQL databases to back them.</em></li>
44
Python. It contains code for both server and consumer implementations.
45
For information on implementing an OpenID consumer, see the <code><a
46
href="openid.consumer.consumer-module.html"
47
class="link"><code>openid.consumer.consumer</code></a></code> module. For
48
information on implementing an OpenID server, see the <code><a
49
href="openid.server.server-module.html"
50
class="link"><code>openid.server.server</code></a></code> module.
53
href="http://lists.openidenabled.com/mailman/listinfo/dev">dev@lists.openidenabled.com</a>
56
<p><b>Copyright:</b> (C) 2005-2007 JanRain, Inc.
59
<p><b>License:</b> <p>Licensed under the Apache License, Version 2.0 (the
60
"License"); you may not use this file except in compliance with
61
the License. You may obtain a copy of the License at <a
62
href="http://www.apache.org/licenses/LICENSE-2.0">http://www.apache.org/licenses/LICENSE-2.0</a></p>
63
Unless required by applicable law or agreed to in writing, software
64
distributed under the License is distributed on an "AS IS"
65
BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
66
implied. See the License for the specific language governing permissions
67
and limitations under the License.
71
<!-- =========== START OF SUBMODULES =========== -->
72
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
73
<tr bgcolor="#70b0f0" class="details">
74
<th colspan="2">Submodules</th></tr>
76
<li> <b><a href="openid.association-module.html"><code>association</code></a></b>: <i>This module contains code for dealing with associations between
77
consumers and servers.</i>
78
<li> <b><a href="openid.consumer-module.html"><code>consumer</code></a></b>: <i>This package contains the portions of the library used only when
79
implementing an OpenID consumer.</i>
81
<li> <b><a href="openid.consumer.consumer-module.html"><code>consumer</code></a></b>: <i>OpenID support for Relying Parties (aka Consumers).</i>
82
<li> <b><a href="openid.consumer.discover-module.html"><code>discover</code></a></b>: <i>Functions to discover OpenID endpoints from identifiers.</i>
83
<li> <b><a href="openid.consumer.html_parse-module.html"><code>html_parse</code></a></b>: <i>This module implements a VERY limited parser that finds <link>
84
tags in the head of HTML or XHTML documents and parses out their
85
attributes according to the OpenID spec.</i>
87
<li> <b><a href="openid.cryptutil-module.html"><code>cryptutil</code></a></b>: <i>Module containing a cryptographic-quality source of randomness and
88
other cryptographically useful functionality</i>
89
<li> <b><a href="openid.dh-module.html"><code>dh</code></a></b>
90
<li> <b><a href="openid.extension-module.html"><code>extension</code></a></b>
91
<li> <b><a href="openid.fetchers-module.html"><code>fetchers</code></a></b>: <i>This module contains the HTTP fetcher interface and several
93
<li> <b><a href="openid.kvform-module.html"><code>kvform</code></a></b>
94
<li> <b><a href="openid.message-module.html"><code>message</code></a></b>: <i>Extension argument processing code</i>
95
<li> <b><a href="openid.oidutil-module.html"><code>oidutil</code></a></b>: <i>This module contains general utility code that is used throughout the
97
<li> <b><a href="openid.server-module.html"><code>server</code></a></b>: <i>This package contains the portions of the library used only when
98
implementing an OpenID server.</i>
100
<li> <b><a href="openid.server.server-module.html"><code>server</code></a></b>: <i>OpenID server protocol and logic.</i>
101
<li> <b><a href="openid.server.trustroot-module.html"><code>trustroot</code></a></b>: <i>This module contains the <code><a
102
href="openid.server.trustroot.TrustRoot-class.html"
103
class="link"><code>TrustRoot</code></a></code> class, which helps handle
104
trust root checking.</i>
106
<li> <b><a href="openid.sreg-module.html"><code>sreg</code></a></b>: <i>Simple registration request and response parsing and object
108
<li> <b><a href="openid.store-module.html"><code>store</code></a></b>: <i>This package contains the modules related to this library's use of
109
persistent storage.</i>
111
<li> <b><a href="openid.store.interface-module.html"><code>interface</code></a></b>: <i>This module contains the definition of the <code><a
112
href="openid.store.interface.OpenIDStore-class.html"
113
class="link"><code>OpenIDStore</code></a></code> interface.</i>
114
<li> <b><a href="openid.store.filestore-module.html"><code>filestore</code></a></b>: <i>This module contains an <code><a
115
href="openid.store.interface.OpenIDStore-class.html"
116
class="link"><code>OpenIDStore</code></a></code> implementation backed by
118
<li> <b><a href="openid.store.sqlstore-module.html"><code>sqlstore</code></a></b>: <i>This module contains <code><a
119
href="openid.store.interface.OpenIDStore-class.html"
120
class="link"><code>OpenIDStore</code></a></code> implementations that use
121
various SQL databases to back them.</i>
122
<li> <b><a href="openid.store.memstore-module.html"><code>memstore</code></a></b>: <i>A simple store using only in-process memory.</i>
123
<li> <b><a href="openid.store.nonce-module.html"><code>nonce</code></a></b>
125
<li> <b><a href="openid.urinorm-module.html"><code>urinorm</code></a></b>
126
<li> <b><a href="openid.yadis-module.html"><code>yadis</code></a></b>: <i>Yadis.</i>
128
<li> <b><a href="openid.yadis.accept-module.html"><code>accept</code></a></b>: <i>Functions for generating and parsing HTTP Accept: headers for
129
supporting server-directed content negotiation.</i>
130
<li> <b><a href="openid.yadis.constants-module.html"><code>constants</code></a></b>
131
<li> <b><a href="openid.yadis.discover-module.html"><code>discover</code></a></b>
132
<li> <b><a href="openid.yadis.etxrd-module.html"><code>etxrd</code></a></b>: <i>ElementTree interface to an XRD document.</i>
133
<li> <b><a href="openid.yadis.filters-module.html"><code>filters</code></a></b>: <i>This module contains functions and classes used for extracting
134
endpoint information out of a Yadis XRD file using the ElementTree XML
136
<li> <b><a href="openid.yadis.manager-module.html"><code>manager</code></a></b>
137
<li> <b><a href="openid.yadis.parsehtml-module.html"><code>parsehtml</code></a></b>
138
<li> <b><a href="openid.yadis.services-module.html"><code>services</code></a></b>
139
<li> <b><a href="openid.yadis.xri-module.html"><code>xri</code></a></b>: <i>Utility functions for handling XRIs.</i>
140
<li> <b><a href="openid.yadis.xrires-module.html"><code>xrires</code></a></b>: <i>XRI resolution.</i>
134
<!-- ==================== VARIABLES ==================== -->
135
<a name="section-Variables"></a>
136
<table class="summary" border="1" cellpadding="3"
137
cellspacing="0" width="100%" bgcolor="white">
138
<tr bgcolor="#70b0f0" class="table-header">
139
<td colspan="2" class="table-header">
140
<table border="0" cellpadding="0" cellspacing="0" width="100%">
142
<td align="left"><span class="table-header">Variables</span></td>
143
<td align="right" valign="top"
144
><span class="options">[<a href="#section-Variables"
145
class="privatelink" onclick="toggle_private();"
146
>hide private</a>]</span></td>
152
<td width="15%" align="right" valign="top" class="summary">
153
<span class="summary-type"> </span>
154
</td><td class="summary">
155
<a href="openid-module.html#__version__">__version__</a> = <code title="'1.2.0'">'1.2.0'</code>
159
<td width="15%" align="right" valign="top" class="summary">
160
<span class="summary-type"> </span>
161
</td><td class="summary">
162
<a href="openid-module.html#version_info">version_info</a> = <code title="(1, 2, 0)">(1, 2, 0)</code>
168
<!-- ==================== VARIABLES DETAILS ==================== -->
169
<a name="section-VariablesDetails"></a>
170
<table class="summary" border="1" cellpadding="3"
171
cellspacing="0" width="100%" bgcolor="white">
172
<tr bgcolor="#70b0f0" class="table-header">
173
<td colspan="2" class="table-header">
174
<table border="0" cellpadding="0" cellspacing="0" width="100%">
176
<td align="left"><span class="table-header">Variables Details</span></td>
177
<td align="right" valign="top"
178
><span class="options">[<a href="#section-VariablesDetails"
179
class="privatelink" onclick="toggle_private();"
180
>hide private</a>]</span></td>
186
<a name="__version__"></a>
188
<table class="details" border="1" cellpadding="3"
189
cellspacing="0" width="100%" bgcolor="white">
191
<h3 class="epydoc">__version__</h3>
195
<dd><table><tr><td><pre class="variable">
196
<span class="variable-quote">'</span>1.2.0<span class="variable-quote">'</span>
197
</pre></td></tr></table></dd>
202
<a name="version_info"></a>
204
<table class="details" border="1" cellpadding="3"
205
cellspacing="0" width="100%" bgcolor="white">
207
<h3 class="epydoc">version_info</h3>
211
<dd><table><tr><td><pre class="variable">
213
</pre></td></tr></table></dd>
219
<!-- ==================== NAVIGATION BAR ==================== -->
220
<table class="navbar" border="0" width="100%" cellpadding="0"
221
bgcolor="#a0c0ff" cellspacing="0">
224
<th bgcolor="#70b0f0" class="navbar-select"
225
> Home </th>
228
<th> <a
229
href="module-tree.html">Trees</a> </th>
232
<th> <a
233
href="identifier-index.html">Indices</a> </th>
236
<th> <a
237
href="help.html">Help</a> </th>
239
<!-- Project homepage -->
240
<th class="navbar" align="right" width="100%">
241
<table border="0" cellpadding="0" cellspacing="0">
242
<tr><th class="navbar" align="center"
243
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
146
<!-- =========== START OF NAVBAR =========== -->
147
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
149
<th bgcolor="#70b0f0" class="navselect"> Home </th>
150
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
151
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
152
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
153
<th class="navbar" align="right" width="100%">
154
<table border="0" cellpadding="0" cellspacing="0">
155
<tr><th class="navbar" align="center">
157
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
158
</p></th></tr></table>
247
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
163
<table border="0" cellpadding="0" cellspacing="0" width="100%">
249
<td align="left" class="footer">Generated by Epydoc
250
3.0alpha3 on Fri Dec 8 13:26:20 2006</td>
251
<td align="right" class="footer">
252
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
165
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:12 2007</font></td>
166
<td align="right"><a href="http://epydoc.sourceforge.net"
167
><font size="-2">http://epydoc.sf.net</font></a></td>
257
<script type="text/javascript">
259
// Private objects are initially displayed (because if
260
// javascript is turned off then we want them to be
261
// visible); but by default, we want to hide them. So hide
262
// them unless we have a cookie that says to show them.