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
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
|
<?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.consumer.consumer.Consumer</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.consumer-module.html">Package consumer</a> ::
<a href="openid.consumer.consumer-module.html">Module consumer</a> ::
Class Consumer
</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.consumer.consumer.Consumer-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type Consumer</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>Consumer</b>
</pre><br />
<hr/>
An OpenID consumer implementation that performs discovery and does
session management.
<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><span class="summary-sig"><a href="openid.consumer.consumer.Consumer-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>session</span>,
<span class=summary-sig-arg>store</span>,
<span class=summary-sig-arg>consumer_class</span>)</span></code>
<br />
Initialize a Consumer instance.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="openid.consumer.consumer.AuthRequest-class.html"
class="link"><code>AuthRequest</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.Consumer-class.html#begin" class="summary-sig-name"><code>begin</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>user_url</span>,
<span class=summary-sig-arg>anonymous</span>)</span></code>
<br />
Start the OpenID authentication process.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <a href="openid.consumer.consumer.AuthRequest-class.html"
class="link"><code>AuthRequest</code></a>
</font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.Consumer-class.html#beginWithoutDiscovery" class="summary-sig-name"><code>beginWithoutDiscovery</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>service</span>,
<span class=summary-sig-arg>anonymous</span>)</span></code>
<br />
Start OpenID verification without doing OpenID server discovery.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.Consumer-class.html#complete" class="summary-sig-name"><code>complete</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>query</span>,
<span class=summary-sig-arg>current_url</span>)</span></code>
<br />
Called to interpret the server's response to an OpenID request.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.consumer.consumer.Consumer-class.html#setAssociationPreference" class="summary-sig-name"><code>setAssociationPreference</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>association_preferences</span>)</span></code>
<br />
Set the order in which association types/sessions should be
attempted.</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">GenericConsumer</font></td>
<td><b><a href="openid.consumer.consumer.Consumer-class.html#consumer"><code>consumer</code></a></b>: an instance of an object implementing the OpenID protocol, but doing
no discovery or session management.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><b><a href="openid.consumer.consumer.Consumer-class.html#session"><code>session</code></a></b>: A dictionary-like object representing the user's session data.</td></tr>
</table><br />
<!-- =========== START OF CLASS VARIABLE SUMMARY =========== -->
<table class="summary" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="summary">
<th colspan="2">Class Variable Summary</th></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"><code>str</code></font></td>
<td><b><a href="openid.consumer.consumer.Consumer-class.html#session_key_prefix"><code>session_key_prefix</code></a></b>: A string that is prepended to session keys to ensure that they are
unique.</td></tr>
</table><br />
<!-- =========== START OF INSTANCE METHOD DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Instance Method Details</th></tr>
</table>
<a name="__init__"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">__init__</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>session</span>,
<span class=sig-arg>store</span>,
<span class=sig-arg>consumer_class</span>=<span class=sig-default>None</span>)</span>
<br /><i>(Constructor)</i>
</h3>
<p>Initialize a Consumer instance.</p>
You should create a new instance of the Consumer object with every
HTTP request that handles OpenID transactions.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>session</b></code> -
See <a
href="openid.consumer.consumer.Consumer-class.html#session"
class="link"><code>the session instance variable</code></a>
<dd><code><b>store</b></code> -
an object that implements the interface in <code><a
href="openid.store.interface.OpenIDStore-class.html"
class="link"><code>openid.store.interface.OpenIDStore</code></a></code>.
Several implementations are provided, to cover common database
environments.
<br /><i>
(type=<code><a
href="openid.store.interface.OpenIDStore-class.html"
class="link"><code>openid.store.interface.OpenIDStore</code></a></code>)</i>
</dd>
</dl>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="__builtin__.object-class.html#__init__"><code>__builtin__.object.__init__</code></a></dd>
</dl>
<dl><dt><b>See Also:</b></dt>
<dd>
<a href="openid.store.interface-module.html"
class="link"><code>openid.store.interface</code></a>,
<a href="openid.store-module.html"
class="link"><code>openid.store</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="begin"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">begin</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>user_url</span>,
<span class=sig-arg>anonymous</span>=<span class=sig-default>False</span>)</span>
</h3>
Start the OpenID authentication process. See steps 1-2 in the
overview at the top of this file.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>user_url</b></code> -
Identity URL given by the user. This method performs a textual
transformation of the URL to try and make sure it is normalized.
For example, a user_url of example.com will be normalized to
http://example.com/ normalizing and resolving any redirects the
server might issue.
<br /><i>
(type=unicode)</i>
<dd><code><b>anonymous</b></code> -
Whether to make an anonymous request of the OpenID provider.
Such a request does not ask for an authorization assertion for an
OpenID identifier, but may be used with extensions to pass other
data. e.g. "I don't care who you are, but I'd like to know
your time zone."
<br /><i>
(type=bool)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
An object containing the discovered information will be
returned, with a method for building a redirect URL to the
server, as described in step 3 of the overview. This object may
also be used to add extension arguments to the request, using its
<a
href="openid.consumer.consumer.AuthRequest-class.html#addExtensionArg"
class="link"><code>addExtensionArg</code></a> method.
<br /><i>
(type=<a href="openid.consumer.consumer.AuthRequest-class.html"
class="link"><code>AuthRequest</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Raises:</b></dt>
<dd><code><b>openid.consumer.discover.DiscoveryFailure</b></code> -
when I fail to find an OpenID server for this URL. If the
<code>yadis</code> package is available, <a
href="openid.yadis.discover.DiscoveryFailure-class.html"
class="link"><code>openid.consumer.discover.DiscoveryFailure</code></a>
is an alias for <code>yadis.discover.DiscoveryFailure</code>.
</dl>
</dd></dl>
</td></tr></table>
<a name="beginWithoutDiscovery"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">beginWithoutDiscovery</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>service</span>,
<span class=sig-arg>anonymous</span>=<span class=sig-default>False</span>)</span>
</h3>
Start OpenID verification without doing OpenID server discovery.
This method is used internally by Consumer.begin after discovery is
performed, and exists to provide an interface for library users needing
to perform their own discovery.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>service</b></code> -
an OpenID service endpoint descriptor. This object and
factories for it are found in the <a
href="openid.consumer.discover-module.html"
class="link"><code>openid.consumer.discover</code></a>
module.
<br /><i>
(type=<a
href="openid.consumer.discover.OpenIDServiceEndpoint-class.html"
class="link"><code>OpenIDServiceEndpoint</code></a>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
an OpenID authentication request object.
<br /><i>
(type=<a href="openid.consumer.consumer.AuthRequest-class.html"
class="link"><code>AuthRequest</code></a>)</i>
</dd>
</dl>
<dl><dt><b>See Also:</b></dt>
<dd>
Openid.consumer.consumer.Consumer.begin,
openid.consumer.discover
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="complete"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">complete</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>query</span>,
<span class=sig-arg>current_url</span>)</span>
</h3>
Called to interpret the server's response to an OpenID request. It
is called in step 4 of the flow described in the consumer overview.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>query</b></code> -
A dictionary of the query parameters for this HTTP
request.
<dd><code><b>current_url</b></code> -
The URL used to invoke the application. Extract the URL from
your application's web request framework and specify it here to
have it checked against the openid.return_to value in the
response. If the return_to URL check fails, the status of the
completion will be FAILURE.
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
a subclass of Response. The type of response is indicated by
the status attribute, which will be one of SUCCESS, CANCEL,
FAILURE, or SETUP_NEEDED.
</dd>
</dl>
<dl><dt><b>See Also:</b></dt>
<dd>
<a href="openid.consumer.consumer.SuccessResponse-class.html"
class="link"><code>SuccessResponse</code></a>,
<a href="openid.consumer.consumer.CancelResponse-class.html"
class="link"><code>CancelResponse</code></a>,
<a href="openid.consumer.consumer.SetupNeededResponse-class.html"
class="link"><code>SetupNeededResponse</code></a>,
<a href="openid.consumer.consumer.FailureResponse-class.html"
class="link"><code>FailureResponse</code></a>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="setAssociationPreference"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">setAssociationPreference</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>association_preferences</span>)</span>
</h3>
Set the order in which association types/sessions should be
attempted. For instance, to only allow HMAC-SHA256 associations created
with a DH-SHA256 association session:
<pre class="doctestblock">
<span class="py-src"><span class="py-prompt">>>> </span>consumer.setAssociationPreference([(<span class="py-string">'HMAC-SHA256'</span>, <span class="py-string">'DH-SHA256'</span>)])</span></pre>
Any association type/association type pair that is not in this list
will not be attempted at all.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>association_preferences</b></code> -
The list of allowed (association type, association session
type) pairs that should be allowed for this consumer to use, in
order from most preferred to least preferred.
<br /><i>
(type=[(str, str)])</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
None
</dd>
</dl>
<p><b>See Also:</b> <code><a href="openid.association.SessionNegotiator-class.html"
class="link"><code>openid.association.SessionNegotiator</code></a></code>
</p>
</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="consumer"></a>
<h3>consumer</h3>
an instance of an object implementing the OpenID protocol, but doing
no discovery or session management.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
GenericConsumer
</dd>
</dl>
</dd>
</dl></td></tr></table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="session"></a>
<h3>session</h3>
A dictionary-like object representing the user's session data. This is
used for keeping state of the OpenID transaction when the user is
redirected to the server.
</td></tr></table>
<br />
<!-- =========== START OF CLASS VARIABLE DETAILS =========== -->
<table class="details" border="1" cellpadding="3" cellspacing="0" width="100%" bgcolor="white">
<tr bgcolor="#70b0f0" class="details">
<th colspan="2">Class Variable Details</th></tr>
</table>
<table width="100%" class="var-details" bgcolor="#e0e0e0"><tr><td>
<a name="session_key_prefix"></a>
<h3>session_key_prefix</h3>
A string that is prepended to session keys to ensure that they are
unique. This variable may be changed to suit your application.
<dl>
<dt></dt>
<dd>
<dl>
<dt><b>Type:</b></dt>
<dd>
<code>str</code>
</dd>
<span title="'_openid_consumer_'"> <dt><b>Value:</b></dt>
<dd><table><tr><td>
<pre class="variable">
<span class="variable-quote">'</span>_openid_consumer_<span class="variable-quote">'</span> </pre>
</td></tr></table></dd>
</span> </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:21 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>
|
