Référence de la classe Auth_OpenID_GenericConsumer

Liste de tous les membres

Fonctions membres publiques

• 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)

Attributs publics

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

---

Documentation des fonctions membres

Auth_OpenID_GenericConsumer::_checkAuth	(	$	message,
		$	server_url
	)

private

Références _createCheckAuthRequest(), _makeKVPost(), et _processCheckAuthResponse().

Référencé par _idResCheckSignature().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_checkReturnTo	(	$	message,
		$	return_to
	)

private

Références _verifyReturnToArgs(), Auth_OpenID::arrayGet(), Auth_OpenID_urinorm(), et Auth_OpenID::isFailure().

Référencé par _doIdRes().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_checkSetupNeeded

(

$

message

)

private

Référencé par _complete_id_res().

Voici le graphe d'appel pour cette fonction :

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

private

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

private

Références $error.

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

private

Références _checkSetupNeeded(), et _doIdRes().

Voici le graphe d'appel pour cette fonction :

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

private

Références _completeInvalid().

Voici le graphe d'appel pour cette fonction :

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

private

Référencé par _complete_setup_needed().

Voici le graphe d'appel pour cette fonction :

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

private

Références Auth_OpenID_Message::fromOpenIDArgs().

Référencé par _requestAssociation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_createCheckAuthRequest

(

$

message

)

private

Références $k.

Référencé par _checkAuth().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_discoverAndVerify	(	$	claimed_id,
		$	to_match_endpoints
	)

private

Références _verifyDiscoveryServices().

Référencé par _verifyDiscoveryResultsOpenID1(), et _verifyDiscoveryResultsOpenID2().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

private

Références _checkReturnTo(), _idResCheckForFields(), _idResCheckNonce(), _idResCheckSignature(), _verifyDiscoveryResults(), Auth_OpenID::addPrefix(), et Auth_OpenID::isFailure().

Référencé par _complete_id_res().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

private

Références _getOpenID1SessionType(), Auth_OpenID_Association::fromExpiresIn(), Auth_OpenID::intval(), et Auth_OpenID::isFailure().

Référencé par _requestAssociation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

Handle ServerErrors resulting from association requests.

Renvoie:

$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

Référencé par _negotiateAssociation().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_getAssociation

(

$

endpoint

)

private

Références _negotiateAssociation().

Référencé par begin().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

Renvoie:

$typ The association type for this message

Référencé par _extractAssociation().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_httpResponseToMessage	(	$	response,
		$	server_url
	)

Adapt a POST response to a Message.

Paramètres:

$response

Result of a POST to an OpenID endpoint.

private

Références Auth_OpenID_Message::fromKVForm(), et Auth_OpenID_ServerErrorContainer::fromMessage().

Référencé par _makeKVPost().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_idResCheckForFields

(

$

message

)

private

Références Auth_OpenID::isFailure().

Référencé par _doIdRes().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_idResCheckNonce	(	$	message,
		$	endpoint
	)

private

Références $parts, _idResGetNonceOpenID1(), et Auth_OpenID_splitNonce().

Référencé par _doIdRes().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_idResCheckSignature	(	$	message,
		$	server_url
	)

private

Références _checkAuth(), et Auth_OpenID::isFailure().

Référencé par _doIdRes().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

Renvoie:

$nonce The nonce as a string or null

private

Référencé par _idResCheckNonce().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_makeKVPost	(	$	message,
		$	server_url
	)

private

Références _httpResponseToMessage().

Référencé par _checkAuth(), et _requestAssociation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_negotiateAssociation

(

$

endpoint

)

private

Références _extractSupportedAssociationType(), _requestAssociation(), et Auth_OpenID::isFailure().

Référencé par _getAssociation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_processCheckAuthResponse	(	$	response,
		$	server_url
	)

private

Référencé par _checkAuth().

Voici le graphe d'appel pour cette fonction :

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

private

Références _createAssociateRequest(), _extractAssociation(), et _makeKVPost().

Référencé par _negotiateAssociation().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

private

Références _verifyDiscoveryResultsOpenID1(), et _verifyDiscoveryResultsOpenID2().

Référencé par _doIdRes().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_verifyDiscoveryResultsOpenID1	(	$	message,
		$	endpoint
	)

private

Références _discoverAndVerify(), _verifyDiscoverySingle(), et Auth_OpenID::isFailure().

Référencé par _verifyDiscoveryResults().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_verifyDiscoveryResultsOpenID2	(	$	message,
		$	endpoint
	)

private

Références _discoverAndVerify(), _verifyDiscoverySingle(), Auth_OpenID_ServiceEndpoint::fromOPEndpointURL(), et Auth_OpenID::isFailure().

Référencé par _verifyDiscoveryResults().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

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

private

Références _verifyDiscoverySingle(), et Auth_OpenID::isFailure().

Référencé par _discoverAndVerify().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_verifyDiscoverySingle	(	$	endpoint,
		$	to_match
	)

private

Références Auth_OpenID::urldefrag().

Référencé par _verifyDiscoveryResultsOpenID1(), _verifyDiscoveryResultsOpenID2(), et _verifyDiscoveryServices().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::_verifyReturnToArgs

(

$

query

)

private

Références $query, Auth_OpenID::arrayGet(), Auth_OpenID_Message::fromPostArgs(), Auth_OpenID::isFailure(), et Auth_OpenID::parse_str().

Référencé par _checkReturnTo().

Voici le graphe d'appel pour cette fonction :

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::Auth_OpenID_GenericConsumer

(

&$

store

)

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

Paramètres:

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.

Références $store, Auth_OpenID_getAvailableSessionTypes(), Auth_OpenID_getDefaultNegotiator(), et Auth_Yadis_Yadis::getHTTPFetcher().

Voici le graphe d'appel pour cette fonction :

Auth_OpenID_GenericConsumer::begin

(

$

service_endpoint

)

Called to begin OpenID authentication using the specified Auth_OpenID_ServiceEndpoint.

private

Références _getAssociation(), et Auth_OpenID_mkNonce().

Voici le graphe d'appel pour cette fonction :

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

Références Auth_OpenID::arrayGet().

Voici le graphe d'appel pour cette fonction :

---

Documentation des données membres

Auth_OpenID_GenericConsumer::$_use_assocs

private

Auth_OpenID_GenericConsumer::$discoverMethod = 'Auth_OpenID_discover'

private

Auth_OpenID_GenericConsumer::$openid1_nonce_query_arg_name = 'janrain_nonce'

private

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.

Auth_OpenID_GenericConsumer::$store

This consumer's store object.

Référencé par Auth_OpenID_GenericConsumer().

---

La documentation de cette classe a été générée à partir du fichier suivant :

• Consumer.php