Class: OpenID_Association_Request

Source Location: /OpenID-0.4.0/OpenID/Association/Request.php

Class Overview

OpenID
   |
   --OpenID_Association_Request

OpenID_Association_Request

Author(s):

Bill Shupp <hostmaster at shupp.org>

Copyright:

2009 Bill Shupp

Variables

Methods

Inherited Variables

Class: OpenID

OpenID::$lastEvent
OpenID::$observers
OpenID::$store
OpenID::$versionMap

Inherited Methods

Class: OpenID

OpenID::attach(): Attaches an observer
OpenID::detach(): Detaches the observer
OpenID::directRequest(): Sends a direct HTTP request.
OpenID::getHTTPRequest2Instance(): Instantiates HTTP_Request2. Abstracted for testing.
OpenID::getLastEvent(): Gets the last event
OpenID::getStore(): Gets the OpenID_Store_Interface instance. If none has been set, then the default store is used (CacheLite).
OpenID::getXRIGlobalSymbols(): Returns an array of the 5 XRI globals symbols
OpenID::normalizeIdentifier(): Normalizes an identifier (URI or XRI)
OpenID::notify(): Notifies all observers of an event
OpenID::resetInternalData(): Resets internal static variables.
OpenID::setLastEvent(): Sets the last event and notifies the observers
OpenID::setStore(): Sets a custom OpenID_Store_Interface object

Class Details

[line 38]
OpenID_Association_Request

Request object for establishing OpenID Associations.

Author: Bill Shupp <hostmaster@shupp.org>
Copyright: 2009 Bill Shupp
Link: http://github.com/shupp/openid
License: FreeBSD
Uses: OpenID

[ Top ]

Class Variables

$cdh = null

[line 74]

Optional instance of Crypt_DiffieHellman

Access: protected

Type:

Crypt_DiffieHellman

[ Top ]

$dh = null

[line 81]

OpenID_Association_DiffieHellman instance

Access: protected

Type:

OpenID_Association_DiffieHellman

[ Top ]

$message = null

[line 52]

Contains contents of the association request

Access: protected

Type:

OpenID_Message

[ Top ]

$opEndpointURL = null

[line 45]

OpenID provider endpoint URL

Access: protected

Type:

string

[ Top ]

$requestOptions = array()

[line 88]

HTTP_Request2 options

Access: protected

Type:

array

[ Top ]

$response = array()

[line 67]

The association request response in array format

See: OpenID_Association_Request::getResponse()
Access: protected

Type:

array

[ Top ]

$version = null

[line 59]

Version of OpenID in use. This determines which algorithms we can use.

Access: protected

Type:

string

[ Top ]

Method Detail

__construct (Constructor) [line 101]

void __construct(
string
$opEndpointURL, string
$version, [Crypt_DiffieHellman
$cdh = null])

Sets the arguments passed in, as well as creates the request message.

Access: public

Parameters:

string	`$opEndpointURL`	—	URL of OP Endpoint
string	`$version`	—	Version of OpenID in use
Crypt_DiffieHellman	`$cdh`	—	Custom Crypt_DiffieHellman instance

[ Top ]

associate [line 138]

mixed associate(
)

Sends the association request. Loops over errors and adapts to 'unsupported-type' responses.

Return: OpenID_Association on success, false on failure
See: OpenID_Association_Request::buildAssociation()
See: OpenID_Association_Request::sendAssociationRequest()
Access: public

[ Top ]

buildAssociation [line 175]

OpenID_Association buildAssociation(
array
$response)

Build the OpenID_Association class based on the association response

See: OpenID_Association_Request::associate()
Access: protected

Parameters:

array $response — Association response in array format

[ Top ]

getAssociationType [line 292]

void getAssociationType(
)

Gets the current association type

Access: public

[ Top ]

getDH [line 254]

OpenID_Association_DiffieHellman getDH(
)

Gets an instance of OpenID_Association_DiffieHellman. If one is not already instanciated, a new one is returned.

Access: protected

[ Top ]

getEndpointURL [line 349]

string getEndpointURL(
)

Gets the OP Endpoint URL

Return: OP Endpoint URL
Access: public

[ Top ]

getRequestOptions [line 372]

array getRequestOptions(
)

Return the HTTP_Request2 options

Return: Array of HTTP_Request2 options
Access: public

[ Top ]

getResponse [line 233]

void getResponse(
)

Gets the last association response

Access: public

[ Top ]

getSessionType [line 339]

string getSessionType(
)

Gets the current session type

Return: Current session type (sha1, sha256, or no-encryption)
Access: public

[ Top ]

initDH [line 243]

void initDH(
)

Initialize the diffie-hellman parameters for the association request.

Access: protected

[ Top ]

sendAssociationRequest [line 205]

OpenID_Message sendAssociationRequest(
)

Actually sends the assocition request to the OP Endpoint URL.

See: OpenID_Association_Request::associate()
Access: protected

[ Top ]

setAssociationType [line 272]

void setAssociationType(
string
$type)

Sets he association type for the request. Can be sha1 or sha256.

Throws: OpenID_Association_Exception on invalid type
Access: public

Parameters:

string $type — sha1 or sha256

[ Top ]

setRequestOptions [line 361]

self setRequestOptions(
array
$options)

Sets the HTTP_Request2 options to use

Return: Fluent interface
Access: public

Parameters:

array $options — Array of HTTP_Request2 options

[ Top ]

setSessionType [line 306]

void setSessionType(
string
$type)

Sets the session type. Can be sha1, sha256, or no-encryption

Throws: OpenID_Association_Exception on invalid type, or if you set no-encryption for an OP URL that doesn't support HTTPS
Access: public

Parameters:

string $type — sha1, sha256, or no-encryption

[ Top ]