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
|
<?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.store.interface.OpenIDStore</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.store-module.html">Package store</a> ::
<a href="openid.store.interface-module.html">Module interface</a> ::
Class OpenIDStore
</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.store.interface.OpenIDStore-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type OpenIDStore</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<b>OpenIDStore</b>
</pre><br />
<dl><dt><b>Known Subclasses:</b></dt>
<dd>
<a href="openid.store.filestore.FileOpenIDStore-class.html"><code>FileOpenIDStore</code></a>,
<a href="openid.store.sqlstore.SQLStore-class.html"><code>SQLStore</code></a></dd></dl>
<hr/>
This is the interface for the store objects the OpenID library uses.
It is a single class that provides all of the persistence mechanisms that
the OpenID library needs, for both servers and consumers.
<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"> <code>NoneType</code>
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#storeAssociation" class="summary-sig-name"><code>storeAssociation</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server_url</span>,
<span class=summary-sig-arg>association</span>)</span></code>
<br />
This method puts a <code><a
href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> object into storage,
retrievable by server URL and handle.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code><a href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> or
<code>NoneType</code>
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#getAssociation" class="summary-sig-name"><code>getAssociation</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server_url</span>,
<span class=summary-sig-arg>handle</span>)</span></code>
<br />
This method returns an <code><a
href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> object from storage that
matches the server URL and, if specified, handle.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>bool</code> or <code>int</code>
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#removeAssociation" class="summary-sig-name"><code>removeAssociation</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server_url</span>,
<span class=summary-sig-arg>handle</span>)</span></code>
<br />
This method removes the matching association if it's found, and
returns whether the association was removed or not.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> <code>bool</code>
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#useNonce" class="summary-sig-name"><code>useNonce</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>server_url</span>,
<span class=summary-sig-arg>timestamp</span>,
<span class=summary-sig-arg>salt</span>)</span></code>
<br />
Called when using a nonce.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#cleanup" class="summary-sig-name"><code>cleanup</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Shortcut for <code><a
href="openid.store.interface.OpenIDStore-class.html#cleanupNonces"
class="link"><code>cleanupNonces</code></a>()</code>, <code><a
href="openid.store.interface.OpenIDStore-class.html#cleanupAssociations"
class="link"><code>cleanupAssociations</code></a>()</code>.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> int
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#cleanupAssociations" class="summary-sig-name"><code>cleanupAssociations</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Remove expired associations from the store.</td></tr>
<tr><td align="right" valign="top" width="15%"><font size="-1"> int
</font></td>
<td><code><span class="summary-sig"><a href="openid.store.interface.OpenIDStore-class.html#cleanupNonces" class="summary-sig-name"><code>cleanupNonces</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Remove expired nonces from the store.</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#__init__"><code>__init__</code></a>,
<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 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="storeAssociation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">storeAssociation</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>,
<span class=sig-arg>association</span>)</span>
</h3>
This method puts a <code><a
href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> object into storage,
retrievable by server URL and handle.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server_url</b></code> -
The URL of the identity server that this association is with.
Because of the way the server portion of the library uses this
interface, don't assume there are any limitations on the
character set of the input string. In particular, expect to see
unescaped non-url-safe characters in the server_url field.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>association</b></code> -
The <code><a href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> to store.
<br /><i>
(type=<code><a
href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
<code>None</code>
<br /><i>
(type=<code>NoneType</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getAssociation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getAssociation</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>,
<span class=sig-arg>handle</span>=<span class=sig-default>None</span>)</span>
</h3>
<p>This method returns an <code><a
href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> object from storage
that matches the server URL and, if specified, handle. It returns
<code>None</code> if no such association is found or if the matching
association is expired.</p>
<p>If no handle is specified, the store may return any association
which matches the server URL. If multiple associations are valid, the
recommended return value for this method is the one most recently
issued.</p>
This method is allowed (and encouraged) to garbage collect expired
associations when found. This method must not return expired
associations.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server_url</b></code> -
The URL of the identity server to get the association for.
Because of the way the server portion of the library uses this
interface, don't assume there are any limitations on the
character set of the input string. In particular, expect to see
unescaped non-url-safe characters in the server_url field.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>handle</b></code> -
This optional parameter is the handle of the specific
association to get. If no specific handle is provided, any valid
association matching the server URL is returned.
<br /><i>
(type=<code>str</code> or <code>NoneType</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
The <code><a href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> for the given
identity server.
<br /><i>
(type=<code><a href="openid.association.Association-class.html"
class="link"><code>Association</code></a></code> or
<code>NoneType</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="removeAssociation"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">removeAssociation</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>,
<span class=sig-arg>handle</span>)</span>
</h3>
This method removes the matching association if it's found, and
returns whether the association was removed or not.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server_url</b></code> -
The URL of the identity server the association to remove
belongs to. Because of the way the server portion of the library
uses this interface, don't assume there are any limitations on
the character set of the input string. In particular, expect to
see unescaped non-url-safe characters in the server_url
field.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>handle</b></code> -
This is the handle of the association to remove. If there
isn't an association found that matches both the given URL and
handle, then there was no matching handle found.
<br /><i>
(type=<code>str</code>)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Returns whether or not the given association existed.
<br /><i>
(type=<code>bool</code> or <code>int</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="useNonce"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">useNonce</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>,
<span class=sig-arg>timestamp</span>,
<span class=sig-arg>salt</span>)</span>
</h3>
<p>Called when using a nonce.</p>
<p>This method should return <code>True</code> if the nonce has not
been used before, and store it for a while to make sure nobody tries to
use the same value again. If the nonce has already been used or the
timestamp is not current, return <code>False</code>.</p>
You may use <code>openid.store.nonce.SKEW</code> for your timestamp
window.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>server_url</b></code> -
The URL of the server from which the nonce originated.
<br /><i>
(type=<code>str</code>)</i>
<dd><code><b>timestamp</b></code> -
The time that the nonce was created (to the nearest second),
in seconds since January 1 1970 UTC.
<br /><i>
(type=<code>int</code>)</i>
<dd><code><b>salt</b></code> -
A random string that makes two nonces from the same server
issued during the same second unique.
<br /><i>
(type=str)</i>
</dd>
</dl>
<dl><dt><b>Returns:</b></dt>
<dd>
Whether or not the nonce was valid.
<br /><i>
(type=<code>bool</code>)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="cleanup"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cleanup</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Shortcut for <code><a
href="openid.store.interface.OpenIDStore-class.html#cleanupNonces"
class="link"><code>cleanupNonces</code></a>()</code>, <code><a
href="openid.store.interface.OpenIDStore-class.html#cleanupAssociations"
class="link"><code>cleanupAssociations</code></a>()</code>.</p>
This method is not called in the normal operation of the library. It
provides a way for store admins to keep their storage from filling up
with expired data.
<dl><dt></dt><dd>
</dd></dl>
</td></tr></table>
<a name="cleanupAssociations"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cleanupAssociations</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Remove expired associations from the store.</p>
This method is not called in the normal operation of the library. It
provides a way for store admins to keep their storage from filling up
with expired data.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
the number of associations expired.
<br /><i>
(type=int)</i>
</dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="cleanupNonces"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">cleanupNonces</span>(<span class=sig-arg>self</span>)</span>
</h3>
<p>Remove expired nonces from the store.</p>
<p>Discards any nonce from storage that is old enough that its
timestamp would not pass <a
href="openid.store.interface.OpenIDStore-class.html#useNonce"
class="link"><code>useNonce</code></a>.</p>
This method is not called in the normal operation of the library. It
provides a way for store admins to keep their storage from filling up
with expired data.
<dl><dt></dt><dd>
<dl><dt><b>Returns:</b></dt>
<dd>
the number of nonces expired.
<br /><i>
(type=int)</i>
</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>
|
