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.association</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> <a
19
href="openid-module.html">Home</a> </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 class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </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
<a href="openid-module.html">Package openid</a> ::
46
33
Module association
50
<table cellpadding="0" cellspacing="0">
51
<!-- hide/show private -->
52
<tr><td align="right"><span class="options"
53
>[<a href="frames.html" target="_top">frames</a
54
>] | <a href="openid.association-module.html"
55
target="_top">no frames</a>]</span></td></tr>
60
<!-- ==================== MODULE DESCRIPTION ==================== -->
61
<h1 class="epydoc">Module association</h1><span class="codelink"><a href="openid.association-pysrc.html">source code</a></span><br /><br />
62
This module contains code for dealing with associations between
63
consumers and servers.<br /><br />
65
<!-- ==================== CLASSES ==================== -->
66
<a name="section-Classes"></a>
67
<table class="summary" border="1" cellpadding="3"
68
cellspacing="0" width="100%" bgcolor="white">
69
<tr bgcolor="#70b0f0" class="table-header">
70
<td colspan="2" class="table-header">
71
<table border="0" cellpadding="0" cellspacing="0" width="100%">
73
<td align="left"><span class="table-header">Classes</span></td>
74
<td align="right" valign="top"
75
><span class="options">[<a href="#section-Classes"
76
class="privatelink" onclick="toggle_private();"
77
>hide private</a>]</span></td>
83
<td width="15%" align="right" valign="top" class="summary">
84
<span class="summary-type"> </span>
85
</td><td class="summary">
86
<a href="openid.association.Association-class.html">Association</a><br />
87
This class represents an association between a server and a
36
<td><table cellpadding="0" cellspacing="0">
37
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.association-module.html" target="_top">no frames</a>]</font></td></tr>
41
<!-- =========== START OF MODULE DESCRIPTION =========== -->
42
<h2 class="module">Module openid.association</h2>
44
<p>This module contains code for dealing with associations between
45
consumers and servers. Associations contain a shared secret that is used
46
to sign <code>openid.mode=id_res</code> messages.</p>
47
Users of the library should not usually need to interact directly with
48
associations. The <a href="openid.store-module.html"
49
class="link"><code>store</code></a>, <a
50
href="openid.server.server-module.html"
51
class="link"><code>server</code></a> and <a
52
href="openid.consumer.consumer-module.html"
53
class="link"><code>consumer</code></a> objects will create and manage the
54
associations. The consumer and server code will make use of a <code><a
55
href="openid.association.SessionNegotiator-class.html"
56
class="link"><code>SessionNegotiator</code></a></code> when managing
57
associations, which enables users to express a preference for what kind
58
of associations should be allowed, and what kind of exchange should be
59
done to establish the association.
62
<!-- =========== START OF CLASSES =========== -->
63
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
64
<tr bgcolor="#70b0f0" class="summary">
65
<th colspan="2">Classes</th></tr>
67
<b><a href="openid.association.Association-class.html"><code>Association</code></a></b></td>
68
<td>This class represents an association between a server and a
71
<b><a href="openid.association.SessionNegotiator-class.html"><code>SessionNegotiator</code></a></b></td>
72
<td>A session negotiator controls the allowed and preferred association
73
types and association session types.</td></tr>
77
<!-- =========== START OF VARIABLE SUMMARY =========== -->
78
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
79
<tr bgcolor="#70b0f0" class="summary">
80
<th colspan="2">Variable Summary</th></tr>
81
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SessionNegotiator</code></font></td>
82
<td><b><a href="openid.association-module.html#default_negotiator"><code>default_negotiator</code></a></b>: A <code><a href="openid.association.SessionNegotiator-class.html"
83
class="link"><code>SessionNegotiator</code></a></code> that allows all
84
association types that are specified by the OpenID specification.</td></tr>
85
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>SessionNegotiator</code></font></td>
86
<td><b><a href="openid.association-module.html#encrypted_negotiator"><code>encrypted_negotiator</code></a></b>: A <code><a href="openid.association.SessionNegotiator-class.html"
87
class="link"><code>SessionNegotiator</code></a></code> that does not
88
support <code>'no-encryption'</code> associations.</td></tr>
92
<!-- =========== START OF VARIABLE DETAILS =========== -->
93
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
94
<tr bgcolor="#70b0f0" class="details">
95
<th colspan="2">Variable Details</th></tr>
97
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
98
<a name="default_negotiator"></a>
99
<h3>default_negotiator</h3>
100
A <code><a href="openid.association.SessionNegotiator-class.html"
101
class="link"><code>SessionNegotiator</code></a></code> that allows all
102
association types that are specified by the OpenID specification. It
103
prefers to use HMAC-SHA1/DH-SHA1, if it's available. If HMAC-SHA256 is
104
not supported by your Python runtime, HMAC-SHA256 and DH-SHA256 will not
110
<dt><b>Type:</b></dt>
112
<code>SessionNegotiator</code>
115
<span title="<openid.association.SessionNegotiator object at 0x82d068c>"> <dt><b>Value:</b></dt>
117
<pre class="variable">
118
<openid.association.SessionNegotiator object at 0x82d068c> </pre>
119
</td></tr></table></dd>
122
</dl></td></tr></table>
123
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
124
<a name="encrypted_negotiator"></a>
125
<h3>encrypted_negotiator</h3>
126
A <code><a href="openid.association.SessionNegotiator-class.html"
127
class="link"><code>SessionNegotiator</code></a></code> that does not
128
support <code>'no-encryption'</code> associations. It prefers
129
HMAC-SHA1/DH-SHA1 association types if available.
134
<dt><b>Type:</b></dt>
136
<code>SessionNegotiator</code>
139
<span title="<openid.association.SessionNegotiator object at 0x82d06cc>"> <dt><b>Value:</b></dt>
141
<pre class="variable">
142
<openid.association.SessionNegotiator object at 0x82d06cc> </pre>
143
</td></tr></table></dd>
146
</dl></td></tr></table>
94
<!-- ==================== NAVIGATION BAR ==================== -->
95
<table class="navbar" border="0" width="100%" cellpadding="0"
96
bgcolor="#a0c0ff" cellspacing="0">
99
<th> <a
100
href="openid-module.html">Home</a> </th>
103
<th> <a
104
href="module-tree.html">Trees</a> </th>
107
<th> <a
108
href="identifier-index.html">Indices</a> </th>
111
<th> <a
112
href="help.html">Help</a> </th>
114
<!-- Project homepage -->
115
<th class="navbar" align="right" width="100%">
116
<table border="0" cellpadding="0" cellspacing="0">
117
<tr><th class="navbar" align="center"
118
><a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a></th>
150
<!-- =========== START OF NAVBAR =========== -->
151
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
153
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
154
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
155
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
156
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
157
<th class="navbar" align="right" width="100%">
158
<table border="0" cellpadding="0" cellspacing="0">
159
<tr><th class="navbar" align="center">
161
<a class="navbar" target="_top" href="http://www.openidenabled.com/">Python-OpenID</a>
162
</p></th></tr></table>
122
<table border="0" cellpadding="0" cellspacing="0" width="100%%">
167
<table border="0" cellpadding="0" cellspacing="0" width="100%">
124
<td align="left" class="footer">Generated by Epydoc
125
3.0alpha3 on Fri Dec 8 13:26:20 2006</td>
126
<td align="right" class="footer">
127
<a href="http://epydoc.sourceforge.net">http://epydoc.sourceforge.net</a>
169
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Mon Sep 10 13:00:13 2007</font></td>
170
<td align="right"><a href="http://epydoc.sourceforge.net"
171
><font size="-2">http://epydoc.sf.net</font></a></td>
132
<script type="text/javascript">
134
// Private objects are initially displayed (because if
135
// javascript is turned off then we want them to be
136
// visible); but by default, we want to hide them. So hide
137
// them unless we have a cookie that says to show them.