Auth_OpenID_OpenIDStore
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. If you want to create an SQL-driven store, please see then Auth_OpenID_SQLStore class.
Change: Version 2.0 removed the storeNonce, getAuthKey, and isDumb methods, and changed the behavior of the useNonce method to support one-way nonces.
Located in /openid/Auth/OpenID/Interface.php (line 33)
Auth_OpenID_OpenIDStore
| Class | Description |
|---|---|
|
Auth_OpenID_MemcachedStore
|
This is a memcached-based store for OpenID associations and nonces. |
|
Auth_OpenID_SQLStore
|
This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores. |
|
Auth_OpenID_FileStore
|
This is a filesystem-based store for OpenID associations and |
|
Auth_OpenID_DumbStore
|
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. |
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.
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.
This method is allowed (and encouraged) to garbage collect expired associations when found. This method must not return expired associations.
- string $server_url: 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.
- mixed $handle: 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.
- Auth_OpenID_MemcachedStore::getAssociation() : Read association from memcached. If no handle given
- Auth_OpenID_SQLStore::getAssociation()
- Auth_OpenID_FileStore::getAssociation() : Retrieve an association. If no handle is specified, return the association with the most recent issue time.
- Auth_OpenID_DumbStore::getAssociation() : This implementation always returns null.
This method removes the matching association if it's found, and returns whether the association was removed or not.
- string $server_url: 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.
- string $handle: 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.
- Auth_OpenID_MemcachedStore::removeAssociation() : Immediately delete association from memcache.
- Auth_OpenID_SQLStore::removeAssociation()
- Auth_OpenID_FileStore::removeAssociation() : Remove an association if it exists. Do nothing if it does not.
- Auth_OpenID_DumbStore::removeAssociation() : This implementation always returns false.
Removes all entries from the store; implementation is optional.
- Auth_OpenID_SQLStore::reset() : Resets the store by removing all records from the store's tables.
This method puts an Association object into storage, retrievable by server URL and handle.
- string $server_url: 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.
- Association $association: The Association to store.
- Auth_OpenID_MemcachedStore::storeAssociation() : Store association until its expiration time in memcached.
- Auth_OpenID_SQLStore::storeAssociation()
- Auth_OpenID_FileStore::storeAssociation() : Store an association in the association directory.
- Auth_OpenID_DumbStore::storeAssociation() : This implementation does nothing.
Report whether this storage supports cleanup
- Auth_OpenID_MemcachedStore::supportsCleanup() : Report that this storage doesn't support cleanup
Called when using a nonce.
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}.
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.
- string $nonce: The nonce to use.
- $server_url
- $timestamp
- $salt
- Auth_OpenID_MemcachedStore::useNonce() : Create nonce for server and salt, expiring after $Auth_OpenID_SKEW seconds.
- Auth_OpenID_SQLStore::useNonce()
- Auth_OpenID_FileStore::useNonce() : Return whether this nonce is present. As a side effect, mark it as no longer present.
- Auth_OpenID_DumbStore::useNonce() : In a system truly limited to dumb mode, nonces must all be accepted. This therefore always returns true, which makes replay attacks feasible.
Documentation generated on Sat, 14 Nov 2009 11:15:14 +0000 by phpDocumentor 1.3.1