Class OpenID_Assertion

Description
Description | Vars (details) | Methods (details) Constants

Class for verifying assertions. Does basic validation (nonce, return_to, etc), as well as signature verification and check_authentication.

Located in /OpenID/Assertion.php (line 38) 

OpenID
   |
   --OpenID_Assertion
Variable Summary
Description | Vars (details) | Methods (details) Constants
int $clockSkew
OpenID_Message $message
string $requestedURL
Method Summary
Description | Constants Vars (details) | Methods (details)
void __construct (OpenID_Message $message,  $requestedURL, [int $clockSkew = null])
OpenID_Message checkAuthentication ([ $options = array()])
OpenID_Discover|false getDiscover (string $identifier)
void validateDiscover ()
void validateNonce ()
void validateReturnTo ()
void validateReturnToNonce ()
bool verifySignature (OpenID_Association $assoc)
Variables
Description | Vars (details) Constants | Methods (details)
int $clockSkew = null (line 59)

The clock skew limit for checking nonces.

  • var: (in seconds)
  • access: protected
OpenID_Message $message = null (line 45)

Response message passed to the constructor

  • access: protected
string $requestedURL = null (line 52)

The URL of the current request (to compare with openid.return_to)

  • access: protected

Inherited Variables

Inherited from OpenID

OpenID::$lastEvent
 OpenID::$observers
 OpenID::$store
 OpenID::$versionMap
Methods
Description | Vars (details) Constants Methods (details)
Constructor __construct (line 71)

Sets the request message, url, and clock skew. Then does some basic validation (return_to, nonce, discover).

  • access: public
void __construct (OpenID_Message $message,  $requestedURL, [int $clockSkew = null])
  • OpenID_Message $message: Message from the request
  • Net_URL2 $requestedURL: The requested URL
  • int $clockSkew: Nonce clock skew in seconds
checkAuthentication (line 114)

Performs a check_authentication request.

  • return: Reponse to the check_authentication request
  • access: public
OpenID_Message checkAuthentication ([ $options = array()])
  • array $options: Options to pass to HTTP_Request
getDiscover (line 288)

Gets an instance of OpenID_Discover. Abstracted for testing.

  • access: protected
OpenID_Discover|false getDiscover (string $identifier)
  • string $identifier: OpenID Identifier
validateDiscover (line 179)

Validates and performs discovery on the openid.claimed_id paramter.

  • throws: OpenID_Assertion_Exception on failure
  • access: protected
void validateDiscover ()
validateNonce (line 219)

Validates the openid.response_nonce parameter.

  • throws: OpenID_Assertion_Exception on invalid or existing nonce
  • access: protected
void validateNonce ()
validateReturnTo (line 130)

Validates the openid.return_to parameter in the response.

  • throws: OpenID_Assertion_Exception on failure
  • access: protected
void validateReturnTo ()
validateReturnToNonce (line 239)

Validates the nonce embedded in the openid.return_to paramater and deletes it from storage.. (For use with OpenID 1.1 only)

  • throws: OpenID_Assertion_Exception on invalid or non-existing nonce
  • access: protected
void validateReturnToNonce ()
verifySignature (line 102)

Verifies the signature of this message association.

bool verifySignature (OpenID_Association $assoc)

Inherited Methods

Inherited From OpenID

OpenID::attach()
OpenID::detach()
OpenID::directRequest()
OpenID::getHTTPRequest2Instance()
OpenID::getLastEvent()
OpenID::getStore()
OpenID::getXRIGlobalSymbols()
OpenID::normalizeIdentifier()
OpenID::notify()
OpenID::setLastEvent()
OpenID::setStore()
Class Constants
Description | Constants (details) Vars (details) | Methods (details)

Inherited Constants

Inherited from OpenID

OpenID::ASSOC_TYPE_HMAC_SHA1
 OpenID::ASSOC_TYPE_HMAC_SHA256
 OpenID::HASH_ALGORITHM_1_1
 OpenID::HASH_ALGORITHM_2_0
 OpenID::MODE_ASSOCIATE
 OpenID::MODE_CANCEL
 OpenID::MODE_CHECKID_IMMEDIATE
 OpenID::MODE_CHECKID_SETUP
 OpenID::MODE_CHECK_AUTHENTICATION
 OpenID::MODE_ERROR
 OpenID::MODE_ID_RES
 OpenID::MODE_SETUP_NEEDED
 OpenID::NS_1_1
 OpenID::NS_2_0
 OpenID::NS_2_0_ID_SELECT
 OpenID::SERVICE_1_0_SIGNON
 OpenID::SERVICE_1_1_SIGNON
 OpenID::SERVICE_2_0_SERVER
 OpenID::SERVICE_2_0_SIGNON
 OpenID::SESSION_TYPE_DH_SHA1
 OpenID::SESSION_TYPE_DH_SHA256
 OpenID::SESSION_TYPE_NO_ENCRYPTION

Documentation generated on Tue, 15 Dec 2009 19:00:50 -0800 by phpDocumentor 1.4.3