JanRain OpenID Library

Auth_OpenID_OpenIDStore
in package

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 {@link 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.

Tags
author

JanRain, Inc. openid@janrain.com

Table of Contents

cleanup()  : array<string|int, mixed>
Shortcut for cleanupNonces(), cleanupAssociations().
cleanupAssociations()  : int
Remove expired associations from the store.
cleanupNonces()  : int
Remove expired nonces from the store.
getAssociation()  : Auth_OpenID_Association
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.
removeAssociation()  : mixed
This method removes the matching association if it's found, and returns whether the association was removed or not.
reset()  : mixed
Removes all entries from the store; implementation is optional.
storeAssociation()  : mixed
This method puts an Association object into storage, retrievable by server URL and handle.
supportsCleanup()  : mixed
Report whether this storage supports cleanup
useNonce()  : bool
Called when using a nonce.

Methods

cleanup()

Shortcut for cleanupNonces(), cleanupAssociations().

public cleanup() : array<string|int, mixed>

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.

Return values
array<string|int, mixed> —

cleanupAssociations()

Remove expired associations from the store.

public cleanupAssociations() : int

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.

Return values
int —

the number of associations expired.

cleanupNonces()

Remove expired nonces from the store.

public cleanupNonces() : int

Discards any nonce from storage that is old enough that its timestamp would not pass useNonce().

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.

Return values
int —

the number of nonces expired

getAssociation()

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.

public getAssociation(string $server_url[, mixed $handle = null ]) : Auth_OpenID_Association

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.

Parameters
$server_url : string

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.

$handle : mixed = null

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.

Return values
Auth_OpenID_Association —

The Association for the given identity server.

removeAssociation()

This method removes the matching association if it's found, and returns whether the association was removed or not.

public removeAssociation(string $server_url, string $handle) : mixed
Parameters
$server_url : string

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.

$handle : string

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.

Return values
mixed —

Returns whether or not the given association existed.

reset()

Removes all entries from the store; implementation is optional.

public reset() : mixed
Return values
mixed —

storeAssociation()

This method puts an Association object into storage, retrievable by server URL and handle.

public storeAssociation(string $server_url, Auth_OpenID_Association $association) : mixed
Parameters
$server_url : string

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 : Auth_OpenID_Association

The Association to store.

Return values
mixed —

supportsCleanup()

Report whether this storage supports cleanup

public supportsCleanup() : mixed
Return values
mixed —

useNonce()

Called when using a nonce.

public useNonce(string $server_url, int $timestamp, string $salt) : bool

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.

Parameters
$server_url : string
$timestamp : int
$salt : string
Return values
bool —

Whether or not the nonce was valid.

Search results