Auth_OpenID_GenericConsumer Class Reference

List of all members.

Detailed Description

This class is the interface to the OpenID consumer logic. Instances of it maintain no per-request state, so they can be reused (or even used by multiple threads concurrently) as needed.

Definition at line 568 of file Consumer.php.


Public Member Functions

 Auth_OpenID_GenericConsumer (&$store)
 begin ($service_endpoint)
 complete ($message, $endpoint, $return_to)
 _completeInvalid ($message, &$endpoint, $unused)
 _complete_cancel ($message, &$endpoint, $unused)
 _complete_error ($message, &$endpoint, $unused)
 _complete_setup_needed ($message, &$endpoint, $unused)
 _complete_id_res ($message, &$endpoint, $return_to)
 _checkSetupNeeded ($message)
 _doIdRes ($message, $endpoint, $return_to)
 _checkReturnTo ($message, $return_to)
 _verifyReturnToArgs ($query)
 _idResCheckSignature ($message, $server_url)
 _verifyDiscoveryResults ($message, $endpoint=null)
 _verifyDiscoveryResultsOpenID1 ($message, $endpoint)
 _verifyDiscoverySingle ($endpoint, $to_match)
 _verifyDiscoveryResultsOpenID2 ($message, $endpoint)
 _discoverAndVerify ($claimed_id, $to_match_endpoints)
 _verifyDiscoveryServices ($claimed_id, &$services, &$to_match_endpoints)
 _idResGetNonceOpenID1 ($message, $endpoint)
 _idResCheckNonce ($message, $endpoint)
 _idResCheckForFields ($message)
 _checkAuth ($message, $server_url)
 _createCheckAuthRequest ($message)
 _processCheckAuthResponse ($response, $server_url)
 _httpResponseToMessage ($response, $server_url)
 _makeKVPost ($message, $server_url)
 _getAssociation ($endpoint)
 _extractSupportedAssociationType (&$server_error, &$endpoint, $assoc_type)
 _negotiateAssociation ($endpoint)
 _requestAssociation ($endpoint, $assoc_type, $session_type)
 _extractAssociation (&$assoc_response, &$assoc_session)
 _createAssociateRequest ($endpoint, $assoc_type, $session_type)
 _getOpenID1SessionType ($assoc_response)

Public Attributes

 $discoverMethod = 'Auth_OpenID_discover'
 $store
 $_use_assocs
 $openid1_nonce_query_arg_name = 'janrain_nonce'
 $openid1_return_to_identifier_name = 'openid1_claimed_id'

Member Function Documentation

Auth_OpenID_GenericConsumer.Auth_OpenID_GenericConsumer ( &$  store  ) 

This method initializes a new Auth_OpenID_Consumer instance to access the library.

Parameters:
Auth_OpenID_OpenIDStore $store This must be an object that implements the interface in Auth_OpenID_OpenIDStore. Several concrete implementations are provided, to cover most common use cases. For stores backed by MySQL, PostgreSQL, or SQLite, see the Auth_OpenID_SQLStore class and its sublcasses. For a filesystem-backed store, see the Auth_OpenID_FileStore module. As a last resort, if it isn't possible for the server to store state at all, an instance of Auth_OpenID_DumbStore can be used.
bool $immediate This is an optional boolean value. It controls whether the library uses immediate mode, as explained in the module description. The default value is False, which disables immediate mode.

Definition at line 614 of file Consumer.php.

Auth_OpenID_GenericConsumer.begin ( $  service_endpoint  ) 

Called to begin OpenID authentication using the specified Auth_OpenID_ServiceEndpoint.

private

Definition at line 631 of file Consumer.php.

Auth_OpenID_GenericConsumer.complete ( $  message,
$  endpoint,
$  return_to 
)

Given an Auth_OpenID_Message, Auth_OpenID_ServiceEndpoint and optional return_to URL, complete OpenID authentication.

private

Definition at line 653 of file Consumer.php.

Auth_OpenID_GenericConsumer._completeInvalid ( $  message,
&$  endpoint,
$  unused 
)

private

Definition at line 675 of file Consumer.php.

Auth_OpenID_GenericConsumer._complete_cancel ( $  message,
&$  endpoint,
$  unused 
)

private

Definition at line 687 of file Consumer.php.

Auth_OpenID_GenericConsumer._complete_error ( $  message,
&$  endpoint,
$  unused 
)

private

Definition at line 695 of file Consumer.php.

Auth_OpenID_GenericConsumer._complete_setup_needed ( $  message,
&$  endpoint,
$  unused 
)

private

Definition at line 708 of file Consumer.php.

Auth_OpenID_GenericConsumer._complete_id_res ( $  message,
&$  endpoint,
$  return_to 
)

private

Definition at line 722 of file Consumer.php.

Auth_OpenID_GenericConsumer._checkSetupNeeded ( $  message  ) 

private

Definition at line 738 of file Consumer.php.

Auth_OpenID_GenericConsumer._doIdRes ( $  message,
$  endpoint,
$  return_to 
)

private

Definition at line 757 of file Consumer.php.

Auth_OpenID_GenericConsumer._checkReturnTo ( $  message,
$  return_to 
)

private

Definition at line 813 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyReturnToArgs ( $  query  ) 

private

Definition at line 880 of file Consumer.php.

Auth_OpenID_GenericConsumer._idResCheckSignature ( $  message,
$  server_url 
)

private

Definition at line 937 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyDiscoveryResults ( $  message,
$  endpoint = null 
)

private

Definition at line 980 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyDiscoveryResultsOpenID1 ( $  message,
$  endpoint 
)

private

Definition at line 994 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyDiscoverySingle ( $  endpoint,
$  to_match 
)

private

Definition at line 1051 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyDiscoveryResultsOpenID2 ( $  message,
$  endpoint 
)

private

Definition at line 1103 of file Consumer.php.

Auth_OpenID_GenericConsumer._discoverAndVerify ( $  claimed_id,
$  to_match_endpoints 
)

private

Definition at line 1179 of file Consumer.php.

Auth_OpenID_GenericConsumer._verifyDiscoveryServices ( $  claimed_id,
&$  services,
&$  to_match_endpoints 
)

private

Definition at line 1199 of file Consumer.php.

Auth_OpenID_GenericConsumer._idResGetNonceOpenID1 ( $  message,
$  endpoint 
)

Extract the nonce from an OpenID 1 response. Return the nonce from the BARE_NS since we independently check the return_to arguments are the same as those in the response message.

See the openid1_nonce_query_arg_name class variable

Returns:
$nonce The nonce as a string or null
private

Definition at line 1234 of file Consumer.php.

Auth_OpenID_GenericConsumer._idResCheckNonce ( $  message,
$  endpoint 
)

private

Definition at line 1243 of file Consumer.php.

Auth_OpenID_GenericConsumer._idResCheckForFields ( $  message  ) 

private

Definition at line 1281 of file Consumer.php.

Auth_OpenID_GenericConsumer._checkAuth ( $  message,
$  server_url 
)

private

Definition at line 1333 of file Consumer.php.

Auth_OpenID_GenericConsumer._createCheckAuthRequest ( $  message  ) 

private

Definition at line 1352 of file Consumer.php.

Auth_OpenID_GenericConsumer._processCheckAuthResponse ( $  response,
$  server_url 
)

private

Definition at line 1372 of file Consumer.php.

Auth_OpenID_GenericConsumer._httpResponseToMessage ( $  response,
$  server_url 
)

Adapt a POST response to a Message.

Parameters:
$response Result of a POST to an OpenID endpoint.
private

Definition at line 1399 of file Consumer.php.

Auth_OpenID_GenericConsumer._makeKVPost ( $  message,
$  server_url 
)

private

Definition at line 1417 of file Consumer.php.

Auth_OpenID_GenericConsumer._getAssociation ( $  endpoint  ) 

private

Definition at line 1432 of file Consumer.php.

Auth_OpenID_GenericConsumer._extractSupportedAssociationType ( &$  server_error,
&$  endpoint,
$  assoc_type 
)

Handle ServerErrors resulting from association requests.

Returns:
$result If server replied with an C{unsupported-type} error, return a tuple of supported C{association_type}, C{session_type}. Otherwise logs the error and returns null.
private

Definition at line 1463 of file Consumer.php.

Auth_OpenID_GenericConsumer._negotiateAssociation ( $  endpoint  ) 

private

Definition at line 1498 of file Consumer.php.

Auth_OpenID_GenericConsumer._requestAssociation ( $  endpoint,
$  assoc_type,
$  session_type 
)

private

Definition at line 1547 of file Consumer.php.

Auth_OpenID_GenericConsumer._extractAssociation ( &$  assoc_response,
&$  assoc_session 
)

private

Definition at line 1568 of file Consumer.php.

Auth_OpenID_GenericConsumer._createAssociateRequest ( $  endpoint,
$  assoc_type,
$  session_type 
)

private

Definition at line 1660 of file Consumer.php.

Auth_OpenID_GenericConsumer._getOpenID1SessionType ( $  assoc_response  ) 

Given an association response message, extract the OpenID 1.X session type.

This function mostly takes care of the 'no-encryption' default behavior in OpenID 1.

If the association type is plain-text, this function will return 'no-encryption'

private

Returns:
$typ The association type for this message

Definition at line 1707 of file Consumer.php.

Member Data Documentation

Auth_OpenID_GenericConsumer.$discoverMethod = 'Auth_OpenID_discover'

private

Definition at line 572 of file Consumer.php.

Auth_OpenID_GenericConsumer.$store

This consumer's store object.

Definition at line 577 of file Consumer.php.

Auth_OpenID_GenericConsumer.$_use_assocs

private

Definition at line 582 of file Consumer.php.

Auth_OpenID_GenericConsumer.$openid1_nonce_query_arg_name = 'janrain_nonce'

private

Definition at line 587 of file Consumer.php.

Auth_OpenID_GenericConsumer.$openid1_return_to_identifier_name = 'openid1_claimed_id'

Another query parameter that gets added to the return_to for OpenID 1; if the user's session state is lost, use this claimed identifier to do discovery when verifying the response.

Definition at line 594 of file Consumer.php.

The documentation for this class was generated from the following file:
Generated on Thu Feb 19 15:03:25 2009 for OXID eShop CE by  doxygen 1.5.5