ILIAS  release_5-1 Revision 5.0.0-5477-g43f3e3fab5
Auth_OpenID_OpenIDStore Class Reference
+ Inheritance diagram for Auth_OpenID_OpenIDStore:
+ Collaboration diagram for Auth_OpenID_OpenIDStore:

Public Member Functions

 storeAssociation ($server_url, $association)
 This method puts an Association object into storage, retrievable by server URL and handle. More...
 
 cleanupNonces ()
 
 cleanupAssociations ()
 
 cleanup ()
 
 supportsCleanup ()
 Report whether this storage supports cleanup. More...
 
 getAssociation ($server_url, $handle=null)
 This method returns an Association object from storage that matches the server URL and, if specified, handle. More...
 
 removeAssociation ($server_url, $handle)
 This method removes the matching association if it's found, and returns whether the association was removed or not. More...
 
 useNonce ($server_url, $timestamp, $salt)
 Called when using a nonce. More...
 
 reset ()
 Removes all entries from the store; implementation is optional. More...
 

Detailed Description

Definition at line 30 of file Interface.php.

Member Function Documentation

◆ cleanup()

Auth_OpenID_OpenIDStore::cleanup ( )

Definition at line 90 of file Interface.php.

References cleanupAssociations(), and cleanupNonces().

91  {
92  return array($this->cleanupNonces(),
93  $this->cleanupAssociations());
94  }
+ Here is the call graph for this function:

◆ cleanupAssociations()

Auth_OpenID_OpenIDStore::cleanupAssociations ( )

Definition at line 77 of file Interface.php.

Referenced by cleanup().

78  {
79  trigger_error("Auth_OpenID_OpenIDStore::cleanupAssociations ".
80  "not implemented", E_USER_ERROR);
81  }
+ Here is the caller graph for this function:

◆ cleanupNonces()

Auth_OpenID_OpenIDStore::cleanupNonces ( )

Definition at line 62 of file Interface.php.

Referenced by cleanup().

63  {
64  trigger_error("Auth_OpenID_OpenIDStore::cleanupNonces ".
65  "not implemented", E_USER_ERROR);
66  }
+ Here is the caller graph for this function:

◆ getAssociation()

Auth_OpenID_OpenIDStore::getAssociation (   $server_url,
  $handle = null 
)

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.

Parameters
string$server_urlThe 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$handleThis 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.
Returns
Association The Association for the given identity server.

Definition at line 134 of file Interface.php.

135  {
136  trigger_error("Auth_OpenID_OpenIDStore::getAssociation ".
137  "not implemented", E_USER_ERROR);
138  }

◆ removeAssociation()

Auth_OpenID_OpenIDStore::removeAssociation (   $server_url,
  $handle 
)

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

Parameters
string$server_urlThe 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$handleThis 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.
Returns
mixed Returns whether or not the given association existed.

Definition at line 158 of file Interface.php.

159  {
160  trigger_error("Auth_OpenID_OpenIDStore::removeAssociation ".
161  "not implemented", E_USER_ERROR);
162  }

◆ reset()

Auth_OpenID_OpenIDStore::reset ( )

Removes all entries from the store; implementation is optional.

Definition at line 192 of file Interface.php.

193  {
194  }

◆ storeAssociation()

Auth_OpenID_OpenIDStore::storeAssociation (   $server_url,
  $association 
)

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

Parameters
string$server_urlThe 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$associationThe Association to store.

Definition at line 44 of file Interface.php.

45  {
46  trigger_error("Auth_OpenID_OpenIDStore::storeAssociation ".
47  "not implemented", E_USER_ERROR);
48  }

◆ supportsCleanup()

Auth_OpenID_OpenIDStore::supportsCleanup ( )

Report whether this storage supports cleanup.

Definition at line 99 of file Interface.php.

100  {
101  return true;
102  }

◆ useNonce()

Auth_OpenID_OpenIDStore::useNonce (   $server_url,
  $timestamp,
  $salt 
)

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.

Parameters
string$nonceThe nonce to use.
Returns
bool Whether or not the nonce was valid.

Definition at line 183 of file Interface.php.

184  {
185  trigger_error("Auth_OpenID_OpenIDStore::useNonce ".
186  "not implemented", E_USER_ERROR);
187  }

The documentation for this class was generated from the following file: