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
|
<?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.filestore.FileOpenIDStore</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.filestore-module.html">Module filestore</a> ::
Class FileOpenIDStore
</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.filestore.FileOpenIDStore-class.html" target="_top">no frames</a>]</font></td></tr>
</table></td>
</tr></table>
<!-- =========== START OF CLASS DESCRIPTION =========== -->
<h2 class="class">Type FileOpenIDStore</h2>
<pre class="base-tree">
<a href="__builtin__.object-class.html"><code>object</code></a> --+
|
<a href="openid.store.interface.OpenIDStore-class.html"><code>OpenIDStore</code></a> --+
|
<b>FileOpenIDStore</b>
</pre><br />
<hr/>
<p>This is a filesystem-based store for OpenID associations and nonces.
This store should be safe for use in concurrent systems on both windows
and unix (excluding NFS filesystems). There are a couple race conditions
in the system, but those failure cases have been set up in such a way
that the worst-case behavior is someone having to try to log in a second
time.</p>
<p>Most of the methods of this class are implementation details. People
wishing to just use this store need only pay attention to the <code><a
href="openid.store.filestore.FileOpenIDStore-class.html#__init__"
class="link"><code>__init__</code></a></code> method.</p>
Methods of this object can raise OSError if unexpected filesystem
conditions, such as bad permissions or missing directories, occur.
<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.store.filestore.FileOpenIDStore-class.html#__init__" class="summary-sig-name"><code>__init__</code></a>(<span class=summary-sig-arg>self</span>,
<span class=summary-sig-arg>directory</span>)</span></code>
<br />
Initializes a new FileOpenIDStore.</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.filestore.FileOpenIDStore-class.html#cleanup" class="summary-sig-name"><code>cleanup</code></a>(<span class=summary-sig-arg>self</span>)</span></code>
<br />
Remove expired entries from the database.</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.filestore.FileOpenIDStore-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.filestore.FileOpenIDStore-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 align="right" valign="top" width="15%"><font size="-1"> </font></td>
<td><code><span class="summary-sig"><a href="openid.store.filestore.FileOpenIDStore-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 />
Retrieve an association.</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.filestore.FileOpenIDStore-class.html#getAssociationFilename" class="summary-sig-name"><code>getAssociationFilename</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 />
Create a unique filename for a given server url and handle.</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.filestore.FileOpenIDStore-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 />
Remove an association if it exists.</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.filestore.FileOpenIDStore-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 />
Store an association in the association directory.</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.filestore.FileOpenIDStore-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 />
Return whether this nonce 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 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="__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>directory</span>)</span>
<br /><i>(Constructor)</i>
</h3>
Initializes a new FileOpenIDStore. This initializes the nonce and
association directories, which are subdirectories of the directory
passed in.
<dl><dt></dt><dd>
<dl><dt><b>Parameters:</b></dt>
<dd><code><b>directory</b></code> -
This is the directory to put the store directories in.
<br /><i>
(type=<code>str</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>
</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>Remove expired entries from the database. This is potentially
expensive, so only run when it is acceptable to take time.</p>
() -> NoneType
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#cleanup"><code>openid.store.interface.OpenIDStore.cleanup</code></a></dd>
</dl>
</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>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#cleanupAssociations"><code>openid.store.interface.OpenIDStore.cleanupAssociations</code></a> <i>(inherited documentation)</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>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#cleanupNonces"><code>openid.store.interface.OpenIDStore.cleanupNonces</code></a> <i>(inherited documentation)</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>Retrieve an association. If no handle is specified, return the
association with the latest expiration.</p>
(str, str or NoneType) -> Association or NoneType
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#getAssociation"><code>openid.store.interface.OpenIDStore.getAssociation</code></a></dd>
</dl>
</dd></dl>
</td></tr></table>
<a name="getAssociationFilename"></a>
<table width="100%" class="func-details" bgcolor="#e0e0e0"><tr><td>
<h3><span class="sig"><span class="sig-name">getAssociationFilename</span>(<span class=sig-arg>self</span>,
<span class=sig-arg>server_url</span>,
<span class=sig-arg>handle</span>)</span>
</h3>
<p>Create a unique filename for a given server url and handle. This
implementation does not assume anything about the format of the handle.
The filename that is returned will contain the domain name from the
server URL for ease of human inspection of the data directory.</p>
(str, str) -> str
<dl><dt></dt><dd>
</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>
<p>Remove an association if it exists. Do nothing if it does not.</p>
(str, str) -> bool
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#removeAssociation"><code>openid.store.interface.OpenIDStore.removeAssociation</code></a></dd>
</dl>
</dd></dl>
</td></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>
<p>Store an association in the association directory.</p>
(str, Association) -> NoneType
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#storeAssociation"><code>openid.store.interface.OpenIDStore.storeAssociation</code></a></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>Return whether this nonce is valid.</p>
str -> bool
<dl><dt></dt><dd>
<dl><dt><b>Overrides:</b></dt>
<dd><a href="openid.store.interface.OpenIDStore-class.html#useNonce"><code>openid.store.interface.OpenIDStore.useNonce</code></a></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: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>
|
