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
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN"
"DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
<head>
<title>openid.association.SessionNegotiator</title>
<link rel="stylesheet" href="epydoc.css" type="text/css"></link>
</head>
<body bgcolor="white" text="black" link="blue" vlink="#204080"
alink="#204080">
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table width="100%" cellpadding="0" cellspacing="0">
<tr valign="top">
<td width="100%">
<font size="-1"><b class="breadcrumbs">
<a href="openid-module.html">Package openid</a> ::
<a href="openid.association-module.html">Module association</a> ::
Class SessionNegotiator
</b></font></br>
</td>
<td><table cellpadding="0" cellspacing="0">
<tr><td align="right"><font size="-2">[<a href="frames.html"target="_top">frames</a> | <a href="openid.association.SessionNegotiator-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type SessionNegotiator</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>SessionNegotiator</b>
</pre><br />
<hr/>
<p>A session negotiator controls the allowed and preferred association
types and association session types. Both the <code><a
href="openid.consumer.consumer.Consumer-class.html"
class="link"><code>Consumer</code></a></code> and <code><a
href="openid.server.server.Server-class.html"
class="link"><code>Server</code></a></code> use negotiators when creating
associations.</p>
You can create and use negotiators if you:
<ul>
<li>
Do not want to do Diffie-Hellman key exchange because you use
transport-layer encryption (e.g. SSL)
</li>
<li>
Want to use only SHA-256 associations
</li>
<li>
Do not want to support plain-text associations over a non-secure
channel
</li>
</ul>
It is up to you to set a policy for what kinds of associations to
accept. By default, the library will make any kind of association that is
allowed in the OpenID 2.0 specification.
<h1 class="heading">Use of negotiators in the library</h1>
<p>When a consumer makes an association request, it calls <code><a
href="openid.association.SessionNegotiator-class.html#getAllowedType"
class="link"><code>getAllowedType</code></a></code> to get the
preferred association type and association session type.</p>
<p>The server gets a request for a particular association/session type
and calls <code><a
href="openid.association.SessionNegotiator-class.html#isAllowed"
class="link"><code>isAllowed</code></a></code> to determine if it
should create an association. If it is supported, negotiation is
complete. If it is not, the server calls <code><a
href="openid.association.SessionNegotiator-class.html#getAllowedType"
class="link"><code>getAllowedType</code></a></code> to get an allowed
association type to return to the consumer.</p>
If the consumer gets an error response indicating that the requested
association/session type is not supported by the server that contains
an assocation/session type to try, it calls <code><a
href="openid.association.SessionNegotiator-class.html#isAllowed"
class="link"><code>isAllowed</code></a></code> to determine if it
should try again with the given combination of association/session
type.
<hr/>
<!-- =========== START OF METHOD SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Method Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="__init__"></a><span class="summary-sig"><span class="summary-sig-name">__init__</span>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>allowed_types</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.association.SessionNegotiator-class.html#addAllowedType" class="summary-sig-name"><code>addAllowedType</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>assoc_type</span>,
<span class=summary-sig-arg>session_type</span>)</span></code>
<br />
Add an association type and session type to the allowed types
list.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><a name="copy"></a><span class="summary-sig"><span class="summary-sig-name">copy</span>(<span class=summary-sig-arg>self</span>)</span></code>
</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.association.SessionNegotiator-class.html#getAllowedType" class="summary-sig-name"><code>getAllowedType</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Get a pair of assocation type and session type that are supported</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.association.SessionNegotiator-class.html#isAllowed" class="summary-sig-name"><code>isAllowed</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>assoc_type</span>,
<span class=summary-sig-arg>session_type</span>)</span></code>
<br />
Is this combination of association type and session type allowed?</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.association.SessionNegotiator-class.html#setAllowedTypes" class="summary-sig-name"><code>setAllowedTypes</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>allowed_types</span>)</span></code>
<br />
Set the allowed association types, checking to make sure each
combination is valid.</td></tr>
<tr><td colspan="2">
<b>Inherited from <a href="__builtin__.object-class.html"><code>object</code></a>:</b>
<a href="__builtin__.object-class.html#__delattr__"><code>__delattr__</code></a>,
<a href="__builtin__.object-class.html#__getattribute__"><code>__getattribute__</code></a>,
<a href="__builtin__.object-class.html#__hash__"><code>__hash__</code></a>,
<a href="__builtin__.object-class.html#__new__"><code>__new__</code></a>,
<a href="__builtin__.object-class.html#__reduce__"><code>__reduce__</code></a>,
<a href="__builtin__.object-class.html#__reduce_ex__"><code>__reduce_ex__</code></a>,
<a href="__builtin__.object-class.html#__repr__"><code>__repr__</code></a>,
<a href="__builtin__.object-class.html#__setattr__"><code>__setattr__</code></a>,
<a href="__builtin__.object-class.html#__str__"><code>__str__</code></a>
</td></tr>
</table><br />
<!-- =========== START OF INSTANCE VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Instance Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1">[(str, str)]</font></td>
<td><b><a href="openid.association.SessionNegotiator-class.html#allowed_types"><code>allowed_types</code></a></b>: A list of association/session types that are allowed by the
server.</td></tr>
</table><br />
<!-- =========== START OF METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Method Details</th></tr>
</table>
<a name="addAllowedType"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">addAllowedType</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>assoc_type</span>,
<span class=sig-arg>session_type</span>=<span class=sig-default>None</span>)</span>
</h3>
Add an association type and session type to the allowed types list.
The assocation/session pairs are tried in the order that they are
added.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="getAllowedType"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getAllowedType</span>(<span class=sig-arg>self</span>)</span>
</h3>
Get a pair of assocation type and session type that are
supported
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="isAllowed"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">isAllowed</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>assoc_type</span>,
<span class=sig-arg>session_type</span>)</span>
</h3>
Is this combination of association type and session type
allowed?
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="setAllowedTypes"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setAllowedTypes</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>allowed_types</span>)</span>
</h3>
Set the allowed association types, checking to make sure each
combination is valid.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<br />
<!-- =========== START OF INSTANCE VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="allowed_types"></a>
<h3>allowed_types</h3>
A list of association/session types that are allowed by the server.
The order of the pairs in this list determines preference. If an
association/session type comes earlier in the list, the library is more
likely to use that type.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
[(str, str)]
</dd>
</dl>
</dd>
</dl></td></tr></table>
<br />
<!-- =========== START OF NAVBAR =========== -->
<table class="navbar" border="0" width="100%" cellpadding="0" bgcolor="#a0c0ff" cellspacing="0">
<tr valign="center">
<th class="navbar"> <a class="navbar" href="openid-module.html">Home</a> </th>
<th class="navbar"> <a class="navbar" href="trees.html">Trees</a> </th>
<th class="navbar"> <a class="navbar" href="indices.html">Index</a> </th>
<th class="navbar"> <a class="navbar" href="help.html">Help</a> </th>
<th class="navbar" align="right" width="100%">
<table border="0" cellpadding="0" cellspacing="0">
<tr><th class="navbar" align="center">
<p class="nomargin">
<a class="navbar" target="_top" href="http://openidenabled.com/python-openid/">Python-OpenID</a>
</p></th></tr></table>
</th>
</tr>
</table>
<table border="0" cellpadding="0" cellspacing="0" width="100%">
<tr>
<td align="left"><font size="-2">Generated by Epydoc 2.1 on Wed Apr 22 16:14:20 2009</font></td>
<td align="right"><a href="http://epydoc.sourceforge.net"
><font size="-2">http://epydoc.sf.net</font></a></td>
</tr>
</table>
</body>
</html>
|
