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
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
|
<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class Auth_OpenID_OpenIDStore</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class Auth_OpenID_OpenIDStore</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-descendents">Descendents</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This is the interface for the store objects the OpenID library</p>
<p class="description"><p>uses. It is a single class that provides all of the persistence mechanisms that the OpenID library needs, for both servers and consumers. If you want to create an SQL-driven store, please see then <a href="../OpenID/Auth_OpenID_SQLStore.html">Auth_OpenID_SQLStore</a> class.</p><p>Change: Version 2.0 removed the storeNonce, getAuthKey, and isDumb methods, and changed the behavior of the useNonce method to support one-way nonces.</p></p>
<ul class="tags">
<li><span class="field">author:</span> JanRain, Inc. <<a href="mailto:openid@janrain.com">openid@janrain.com</a>></li>
</ul>
<p class="notes">
Located in <a class="field" href="_Auth---OpenID---Interface.php.html">/Auth/OpenID/Interface.php</a> (line <span class="field">30</span>)
</p>
<pre></pre>
</div>
</div>
<a name="sec-descendents"></a>
<div class="info-box">
<div class="info-box-title">Direct descendents</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<span class="disabled">Descendents</span>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<table cellpadding="2" cellspacing="0" class="class-table">
<tr>
<th class="class-table-header">Class</th>
<th class="class-table-header">Description</th>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_DumbStore.html">Auth_OpenID_DumbStore</a></td>
<td>
This is a store for use in the worst case, when you have no way of saving state on the consumer site. Using this store makes the consumer vulnerable to replay attacks, as it's unable to use nonces. Avoid using this store if it is at all possible.
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_FileStore.html">Auth_OpenID_FileStore</a></td>
<td>
This is a filesystem-based store for OpenID associations and
</td>
</tr>
<tr>
<td style="padding-right: 2em"><a href="../OpenID/Auth_OpenID_SQLStore.html">Auth_OpenID_SQLStore</a></td>
<td>
This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores.
</td>
</tr>
</table>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">void</span>
<a href="#cleanup" title="details" class="method-name">cleanup</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#cleanupAssociations" title="details" class="method-name">cleanupAssociations</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#cleanupNonces" title="details" class="method-name">cleanupNonces</a>
()
</div>
<div class="method-definition">
<span class="method-result">Association</span>
<a href="#getAssociation" title="details" class="method-name">getAssociation</a>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, [<span class="var-type">mixed</span> <span class="var-name">$handle</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">mixed</span>
<a href="#removeAssociation" title="details" class="method-name">removeAssociation</a>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, <span class="var-type">string</span> <span class="var-name">$handle</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#reset" title="details" class="method-name">reset</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#storeAssociation" title="details" class="method-name">storeAssociation</a>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, <span class="var-type">Association</span> <span class="var-name">$association</span>)
</div>
<div class="method-definition">
<span class="method-result">bool</span>
<a href="#useNonce" title="details" class="method-name">useNonce</a>
(<span class="var-type"></span> <span class="var-name">$server_url</span>, <span class="var-type"></span> <span class="var-name">$timestamp</span>, <span class="var-type"></span> <span class="var-name">$salt</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>)
</div>
</div>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-descendents">Descendents</a> |
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="methodcleanup" id="cleanup"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">cleanup</span> (line <span class="line-number">90</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
cleanup
</span>
()
</div>
</div>
<a name="methodcleanupAssociations" id="cleanupAssociations"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">cleanupAssociations</span> (line <span class="line-number">77</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
cleanupAssociations
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methodcleanupAssociations">Auth_OpenID_FileStore::cleanupAssociations()</a>
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodcleanupAssociations">Auth_OpenID_SQLStore::cleanupAssociations()</a>
</li>
</ul>
</div>
<a name="methodcleanupNonces" id="cleanupNonces"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">cleanupNonces</span> (line <span class="line-number">62</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
cleanupNonces
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methodcleanupNonces">Auth_OpenID_FileStore::cleanupNonces()</a>
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodcleanupNonces">Auth_OpenID_SQLStore::cleanupNonces()</a>
</li>
</ul>
</div>
<a name="methodgetAssociation" id="getAssociation"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">getAssociation</span> (line <span class="line-number">126</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method returns an Association object from storage that matches the server URL and, if specified, handle. It returns null if no such association is found or if the matching association is expired.</p>
<p class="description"><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><p>This method is allowed (and encouraged) to garbage collect expired associations when found. This method must not return expired associations.</p></p>
<ul class="tags">
<li><span class="field">return:</span> The Association for the given identity server.</li>
</ul>
<div class="method-signature">
<span class="method-result">Association</span>
<span class="method-name">
getAssociation
</span>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, [<span class="var-type">mixed</span> <span class="var-name">$handle</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$server_url</span><span class="var-description">: 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.</span> </li>
<li>
<span class="var-type">mixed</span>
<span class="var-name">$handle</span><span class="var-description">: 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.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_DumbStore.html#methodgetAssociation">Auth_OpenID_DumbStore::getAssociation()</a>
: This implementation always returns null.
</li>
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methodgetAssociation">Auth_OpenID_FileStore::getAssociation()</a>
: Retrieve an association. If no handle is specified, return the association with the most recent issue time.
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodgetAssociation">Auth_OpenID_SQLStore::getAssociation()</a>
</li>
</ul>
</div>
<a name="methodremoveAssociation" id="removeAssociation"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">removeAssociation</span> (line <span class="line-number">150</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method removes the matching association if it's found, and returns whether the association was removed or not.</p>
<ul class="tags">
<li><span class="field">return:</span> Returns whether or not the given association existed.</li>
</ul>
<div class="method-signature">
<span class="method-result">mixed</span>
<span class="method-name">
removeAssociation
</span>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, <span class="var-type">string</span> <span class="var-name">$handle</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$server_url</span><span class="var-description">: 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.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$handle</span><span class="var-description">: 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.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_DumbStore.html#methodremoveAssociation">Auth_OpenID_DumbStore::removeAssociation()</a>
: This implementation always returns false.
</li>
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methodremoveAssociation">Auth_OpenID_FileStore::removeAssociation()</a>
: Remove an association if it exists. Do nothing if it does not.
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodremoveAssociation">Auth_OpenID_SQLStore::removeAssociation()</a>
</li>
</ul>
</div>
<a name="methodreset" id="reset"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">reset</span> (line <span class="line-number">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Removes all entries from the store; implementation is optional.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
reset
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodreset">Auth_OpenID_SQLStore::reset()</a>
: Resets the store by removing all records from the store's tables.
</li>
</ul>
</div>
<a name="methodstoreAssociation" id="storeAssociation"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">storeAssociation</span> (line <span class="line-number">44</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">This method puts an Association object into storage, retrievable by server URL and handle.</p>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
storeAssociation
</span>
(<span class="var-type">string</span> <span class="var-name">$server_url</span>, <span class="var-type">Association</span> <span class="var-name">$association</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$server_url</span><span class="var-description">: 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.</span> </li>
<li>
<span class="var-type">Association</span>
<span class="var-name">$association</span><span class="var-description">: The Association to store.</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_DumbStore.html#methodstoreAssociation">Auth_OpenID_DumbStore::storeAssociation()</a>
: This implementation does nothing.
</li>
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methodstoreAssociation">Auth_OpenID_FileStore::storeAssociation()</a>
: Store an association in the association directory.
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methodstoreAssociation">Auth_OpenID_SQLStore::storeAssociation()</a>
</li>
</ul>
</div>
<a name="methoduseNonce" id="useNonce"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">useNonce</span> (line <span class="line-number">175</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Called when using a nonce.</p>
<p class="description"><p>This method should return C{True} 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, return C{False}.</p><p>Change: In earlier versions, round-trip nonces were used and a nonce was only valid if it had been previously stored with storeNonce. Version 2.0 uses one-way nonces, requiring a different implementation here that does not depend on a storeNonce call. (storeNonce is no longer part of the interface.</p></p>
<ul class="tags">
<li><span class="field">return:</span> Whether or not the nonce was valid.</li>
</ul>
<div class="method-signature">
<span class="method-result">bool</span>
<span class="method-name">
useNonce
</span>
(<span class="var-type"></span> <span class="var-name">$server_url</span>, <span class="var-type"></span> <span class="var-name">$timestamp</span>, <span class="var-type"></span> <span class="var-name">$salt</span>, <span class="var-type">string</span> <span class="var-name">$nonce</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$nonce</span><span class="var-description">: The nonce to use.</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$server_url</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$timestamp</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$salt</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefined in descendants as:</div>
<ul class="redefinitions">
<li>
<a href="../OpenID/Auth_OpenID_DumbStore.html#methoduseNonce">Auth_OpenID_DumbStore::useNonce()</a>
: In a system truly limited to dumb mode, nonces must all be accepted. This therefore always returns true, which makes replay attacks feasible.
</li>
<li>
<a href="../OpenID/Auth_OpenID_FileStore.html#methoduseNonce">Auth_OpenID_FileStore::useNonce()</a>
: Return whether this nonce is present. As a side effect, mark it as no longer present.
</li>
<li>
<a href="../OpenID/Auth_OpenID_SQLStore.html#methoduseNonce">Auth_OpenID_SQLStore::useNonce()</a>
</li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Wed, 05 Dec 2007 14:02:12 -0800 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.3.2</a>
</p>
</div></body>
</html>
|
