Class Auth_OpenID_GenericConsumer

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.

Package: OpenID
Copyright: 2005-2008 Janrain, Inc.
License: Apache
Author: JanRain, Inc. openid@janrain.com
Located at zp-extensions/federated_logon/Auth/OpenID/Consumer.php

Methods summary
`public`	# `Auth_OpenID_GenericConsumer( Auth_OpenID_OpenIDStore $store, boolean $immediate,… )` This method initializes a new `Auth_OpenID_Consumer` instance to access the library. This method initializes a new `Auth_OpenID_Consumer` instance to access the library. Parameters `$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. `$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.
`public`	# `begin( $service_endpoint )` Called to begin OpenID authentication using the specified `Auth_OpenID_ServiceEndpoint`. Called to begin OpenID authentication using the specified `Auth_OpenID_ServiceEndpoint`.
`public`	# `complete( $message, $endpoint, $return_to )` Given an `Auth_OpenID_Message`, `Auth_OpenID_ServiceEndpoint` and optional return_to URL, complete OpenID authentication. Given an `Auth_OpenID_Message`, `Auth_OpenID_ServiceEndpoint` and optional return_to URL, complete OpenID authentication.
`public`	# `_completeInvalid( $message, $endpoint, $unused = null )`
`public`	# `_complete_cancel( $message, $endpoint, $unused )`
`public`	# `_complete_error( $message, $endpoint, $unused )`
`public`	# `_complete_setup_needed( $message, $endpoint, $unused )`
`public`	# `_complete_id_res( $message, $endpoint, $return_to )`
`public`	# `_checkSetupNeeded( $message )`
`public`	# `_doIdRes( $message, $endpoint, $return_to )`
`public`	# `_checkReturnTo( $message, $return_to )`
`public`	# `_verifyReturnToArgs( $query )`
`public`	# `_idResCheckSignature( $message, $server_url )`
`public`	# `_verifyDiscoveryResults( $message, $endpoint = null )`
`public`	# `_verifyDiscoveryResultsOpenID1( $message, $endpoint )`
`public`	# `_verifyDiscoverySingle( $endpoint, $to_match )`
`public`	# `_verifyDiscoveryResultsOpenID2( $message, $endpoint )`
`public`	# `_discoverAndVerify( $claimed_id, $to_match_endpoints )`
`public`	# `_verifyDiscoveryServices( $claimed_id, $services, $to_match_endpoints )`
`public`	# `_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. 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
`public`	# `_idResCheckNonce( $message, $endpoint )`
`public`	# `_idResCheckForFields( $message )`
`public`	# `_checkAuth( $message, $server_url )`
`public`	# `_createCheckAuthRequest( $message )`
`public`	# `_processCheckAuthResponse( $response, $server_url )`
`public static`	# `_httpResponseToMessage( $response, $server_url )` Adapt a POST response to a Message. Adapt a POST response to a Message. Parameters `$response` of a POST to an OpenID endpoint. `$server_url`
`public`	# `_makeKVPost( $message, $server_url )`
`public`	# `_getAssociation( $endpoint )`
`public`	# `_extractSupportedAssociationType( $server_error, $endpoint, $assoc_type )` Handle ServerErrors resulting from association requests. 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.
`public`	# `_negotiateAssociation( $endpoint )`
`public`	# `_requestAssociation( $endpoint, $assoc_type, $session_type )`
`public`	# `_extractAssociation( $assoc_response, $assoc_session )`
`public`	# `_createAssociateRequest( $endpoint, $assoc_type, $session_type )`
`public`	# `_getOpenID1SessionType( $assoc_response )` Given an association response message, extract the OpenID 1.X session type. 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' Returns $typ The association type for this message

Properties summary
`public string`	`$discoverMethod`	# `'Auth_OpenID_discover'`
`public`	`$store` This consumer's store object. This consumer's store object.	#
`public`	`$_use_assocs`	#
`public string`	`$openid1_nonce_query_arg_name`	# `'janrain_nonce'`
`public string`	`$openid1_return_to_identifier_name` 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. 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.	# `'openid1_claimed_id'`

Packages

Classes

Functions

Class Auth_OpenID_GenericConsumer

Parameters

Returns

Parameters

Returns

Returns