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.
Located in /Auth/OpenID/Interface.php (line 26)
Class | Description |
---|---|
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. |
Auth_OpenID_FileStore | This is a filesystem-based store for OpenID associations and |
Auth_OpenID_SQLStore | This is the parent class for the SQL stores, which contains the logic common to all of the SQL stores. |
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 that will remain valid for the longest duration.
This method is allowed (and encouraged) to garbage collect expired associations when found. This method must not return expired associations.
This method returns a key used to sign the tokens, to ensure that they haven't been tampered with in transit. It should return the same key every time it is called. The key returned should be AUTH_KEY_LEN bytes long.
This method must return true if the store is a dumb-mode-style store. Unlike all other methods in this class, this one provides a default implementation, which returns false.
In general, any custom subclass of Auth_OpenID_OpenIDStore won't override this method, as custom subclasses are only likely to be created when the store is fully functional.
This method removes the matching association if it's found, and returns whether the association was removed or not.
Removes all entries from the store; implementation is optional.
This method puts an Association object into storage, retrievable by server URL and handle.
Stores a nonce. This is used by the consumer to prevent replay attacks.
This method is called when the library is attempting to use a nonce. If the nonce is in the store, this method removes it and returns a value which evaluates as true. Otherwise it returns a value which evaluates as false.
This method is allowed and encouraged to treat nonces older than some period (a very conservative window would be 6 hours, for example) as no longer existing, and return False and remove them.
Documentation generated on Mon, 10 Sep 2007 13:29:29 -0700 by phpDocumentor 1.3.2