[OpenID] element index

All elements
a b c d e f g h i l m n o p r s t u v y _
_
top
__construct
Optionally instanciates this object with the contents of an OpenID message.
__construct
Calls MDB2::factory(). Connections are lazy loaded upon queries.
__construct
Allows you to pass in a Log instance and an array of events to log. If no instance of Log is given, the 'file' Log driver will be used, and write to /tmp/OpenID_Observer_Log.log.
__construct
Sets the OP endpoint URL, and optionally the clock skew and custom storage driver.
__construct
Sets the identifier, returnTo, and realm to be used for messages. The identifier is normalized before being set.
__construct
Sets the user-supplied identifier and adds a service if one is passed
__construct
Sets the basic information used in the message.
__construct
Sets the arguments passed in, as well as creates the request message.
__construct
Constructor. Sets the user supplied identifier.
__construct
Constructor. Sets the
__construct
Instantiate Cache_Lite. Allows for options to be passed to Cache_Lite.
__construct
Validates some association values before setting them as member variables.
__construct
Sets the instance of OpenID_Message being used, and also an optional instance of Crypt_DiffieHellman
__construct
Constructor. Enables libxml internal errors, normalized the identifier.
__construct
Sets the request message, url, and clock skew. Then does some basic validation (return_to, nonce, discover).
__construct
Sets the message type, request or response
__get
OpenID_Discover::__get() in Discover.php
Gets member variables
__get
OpenID_Association::__get() in Association.php
Allows access to association data via $assoc->name
a
top
$alias
Alias string to use
$alias
The alias to use.
$alias
OpenID_Extension::$alias in Extension.php
Namespace text, "sreg" or "ax" for example
$alias
Alias to use
$assertion
Whether the assertion was positive or negative
$assertionMethod
What assertion method was used (association, check_authentication)
$assocHandle
assoc_handle parameter of the association.
$assocType
assoc_type parameter of the association. Should be one of HMAC-SHA1 or HMAC-SHA256
addExtension
Adds an extension to the message.
addExtension
Adds an extension to an OpenID_Message object.
addNonce
Adds a nonce to the openid.return_to URL parameter. Only used in OpenID 1.1
addService
Adds a service to the services array
associate
Sends the association request. Loops over errors and adapts to 'unsupported-type' responses.
ASSOC_TYPE_HMAC_SHA1
ASSOC_TYPE_HMAC_SHA256
attach
OpenID::attach() in OpenID.php
Attaches an observer
Assertion.php
Assertion.php in Assertion.php
Association.php
Association.php in Association.php
AX.php
AX.php in AX.php
b
top
buildAssociation
Build the OpenID_Association class based on the association response
buildServiceEndpoint
Builds the service endpoint
c
top
$cache
Instance of Cache_Lite
$cdh
Optional instance of Crypt_DiffieHellman
$cdh
The instance of Crypt_DiffieHellman. May be passed into the constructor if you want to use custom keys.
$checkAuthResponse
The check_authentication response
$clockSkew
How far off of the current time to allow for nonce checking
$clockSkew
The clock skew limit for checking nonces.
$clockSkew
Default clock skew, i.e. how long in the past we're willing to allow for.
$created
OpenID_Association::$created in Association.php
Unix timestamp of when this association was created.
checkAuthentication
Performs a check_authentication request.
checkMessageSignature
Checks the signature of an OpenID_Message using this association
count
OpenID_ServiceEndpoints::count() in ServiceEndpoints.php
Returns the number of service endpoints
createNonce
Creates a nonce, but does not store it. You may specify the lenth of the random string, as well as the time stamp to use.
createNonceAndStore
Creates a nonce and also stores it.
createTables
Creates tables
Common.php
Common.php in Common.php
CacheLite.php
CacheLite.php in CacheLite.php
d
top
$data
OpenID_Message::$data in Message.php
$db
Instance of MDB2
$defaultOptions
Default options for Cache_Lite
$dh
OpenID_Association_DiffieHellman instance
$discoveryOrder
Order that discover should be performed
delete
Deletes a key from a message
deleteAssociation
Deletes an association from the SQL server
deleteAssociation
Deletes an association from storage
deleteAssociation
Deletes an association from storage
deleteDiscover
Deletes a cached OpenID_Discover object
deleteNonce
Deletes a nonce from the SQL server
deleteNonce
Deletes a nonce from storage
deleteNonce
Deletes a nonce from storage
detach
OpenID::detach() in OpenID.php
Detaches the observer
DH_DEFAULT_GENERATOR
DH_DEFAULT_MODULUS
DiffieHellman specific constants
directRequest
Sends a direct HTTP request.
disableAssociations
Disables the use if associations
discover
Performs discovery
discover
Performs HTML discovery.
discover
Performs discovery on the user supplied identifier
discover
Performs YADIS discovery
DiffieHellman.php
DiffieHellman.php in DiffieHellman.php
Discover.php
Discover.php in Discover.php
e
top
$events
Events to act upon
$expiresIn
expires_in paramater of the association. Time is in seconds.
enableAssociations
Enables the use of associations (default)
ensureDirectoryExists
Make sure the given sub directory exists. If not, create it.
extensionSupported
Determines if dicovered information supports a given OpenID extension
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
Extension.php
Extension.php in Extension.php
Exception.php
Exception.php in Exception.php
Exception.php
Exception.php in Exception.php
f
top
factory
Creates an instance of a storage driver
FORMAT_ARRAY
FORMAT_HTTP
FORMAT_KV
fromMessageResponse
Extracts extension contents from an OpenID_Message
g
top
get
OpenID_Message::get() in Message.php
Gets the value of any key in this message.
get
OpenID_Extension::get() in Extension.php
Gets a key's value
getAlgorithm
Gets the algo part of the assoc_type (strips 'HMAC-')
getArrayFormat
Gets the current message in ARRAY format
getAssertionMethod
Gets the method used to verify the assertion
getAssertionObject
Gets an instance of OpenID_Assertion. Abstracted for testing purposes.
getAssociation
Gets an association from the SQL server
getAssociation
Gets an OpenID_Assocation instance from storage
getAssociation
Gets an association from cache if it exists, otherwise, creates one.
getAssociation
Gets an OpenID_Assocation instance from storage
getAssociationRequestObject
Gets a new OpenID_Association_Request object. Abstracted for testing.
getAssociationType
Gets the current association type
getAuthorizeURL
Gets the auth request message in a URL format suitable for redirection. The decision about whether to use directed identity or not id done here.
getCheckAuthResponse
Gets the check_authentication response
getDH
Gets an instance of OpenID_Association_DiffieHellman. If one is not already instanciated, a new one is returned.
getDiscover
Gets an OpenID_Discover object from storage
getDiscover
Gets an instance of OpenID_Discover. Abstracted for testing.
getDiscover
Gets an instance of OpenID_Discover from the SQL server if it exists.
getDiscover
Gets discovered information from cache if it exists, otherwise performs discovery.
getDiscover
Static helper method for retrieving discovered information from cache if it exists, otherwise executing discovery and storing results if they are positive.
getDiscover
Gets an OpenID_Discover object from storage
getDiscoverCacheKey
Common method for creating a cache key based on the normalized identifier
getEndpointURL
Gets the OP Endpoint URL
getEvents
Gets the current array of events
getExpiresHeader
Gets the Expires header from the response object
getExpiresHeader
Gets the Expires header value
getHTTPFormat
Gets the current message in HTTP (url encoded) format
getHTTPRequest2
Instantiates HTTP_Request2. Abstracted for testing.
getHTTPRequest2Instance
Instantiates HTTP_Request2. Abstracted for testing.
getIdentifier
Returns the user-supplied identifier
getIterator
Returns an ArrayIterator object to traverse the services array
getKVFormat
Gets the current message in KV format
getLastEvent
Gets the last event
getLocalID
Returns the local ID
getMessage
Gets the message in one of three formats:
getMessageForSigning
Returns a KV formatted message for signing based on the contents of the openid.signed key. This allows for duplicate entries, which OpenID_Message::getKVFormat() doesn't. (Yahoo! uses duplicates)
getMode
Gets the current openid.mode value
getNamespace
Gets the namespace of this extension
getNonce
Gets a nonce from the SQL server if it exists
getNonce
Gets a nonce from storage
getNonce
Gets the OpenID_Nonce instance if set, otherwise instantiates one.
getNonce
Gets a nonce from storage
getNonceCacheKey
Common method for creating a nonce key based on both the nonce and the OP endpoint URL
getResponse
Gets the last association response
getServicesYadis
Gets the Services_Yadis instance. Abstracted for testing.
getSessionType
Gets the current session type
getSharedSecret
Gets the shared secret out of a response
getSharedSecretKey
Gets the shared secret key in BTWOC format. Computes the key if it has not been computed already.
getSource
Returns the discovery source
getStore
OpenID::getStore() in OpenID.php
Gets the OpenID_Store_Interface instance. If none has been set, then the default store is used (CacheLite).
getTypes
OpenID_ServiceEndpoint::getTypes() in ServiceEndpoint.php
Returns the service types
getURIs
OpenID_ServiceEndpoint::getURIs() in ServiceEndpoint.php
Returns the URIs for this endpoint
getUserSetupURL
Returns the openid.user_setup_url value from the response
getVersion
Returns the OpenID protocol version this endpoint supports
getXRIGlobalSymbols
Returns an array of the 5 XRI globals symbols
h
top
hashHMAC
Gets a an HMAC hash of an OpenID_Message using this association.
HASH_ALGORITHM_1_1
HASH_ALGORITHM_2_0
Supported Association Hash Algorithms (preferred)
HTML.php
HTML.php in HTML.php
i
top
$identifier
The normalized identifier
$identifier
The normalized version of the user supplied identifier
$identifier
The normalized identifier
init
Initialize the diffie-hellman parameters for the association request.
initDH
Initialize the diffie-hellman parameters for the association request.
isValid
OpenID_ServiceEndpoint::isValid() in ServiceEndpoint.php
Determines if this service endpoint is valid
Interface.php
Interface.php in Interface.php
Interface.php
Interface.php in Interface.php
l
top
$lastEvent
OpenID::$lastEvent in OpenID.php
Stores the last event
$localID
OpenID_ServiceEndpoint::$localID in ServiceEndpoint.php
The local ID represented by this endpoint
$log
Holds the instance of Log
Log.php
Log.php in Log.php
m
top
$message
Contains contents of the association request
$message
Response message passed to the constructor
$message
The request message
$message
The OpenID_Message being used in the request
MODE_ASSOCIATE
OpenID Modes
MODE_CANCEL
OpenID::MODE_CANCEL in OpenID.php
MODE_CHECKID_IMMEDIATE
MODE_CHECKID_SETUP
MODE_CHECK_AUTHENTICATION
MODE_ERROR
OpenID::MODE_ERROR in OpenID.php
MODE_ID_RES
OpenID::MODE_ID_RES in OpenID.php
MODE_SETUP_NEEDED
Message.php
Message.php in Message.php
MDB2.php
MDB2.php in MDB2.php
n
top
$namespace
URL for the openid.ns.ax parameter
$namespace
URI of the UI namespace
$namespace
Sets the URI of the spec for alias assignment
$namespace
Namespace URI
$nonce
Nonce class in case we are in 1.1 mode and need to embed it in the return_to
$normalizedID
The user supplied identifier, normalized
normalizeIdentifier
Normalizes an identifier (URI or XRI)
notify
OpenID::notify() in OpenID.php
Notifies all observers of an event
NS_1_1
OpenID::NS_1_1 in OpenID.php
NS_2_0
OpenID::NS_2_0 in OpenID.php
OP identifier constants
NS_2_0_ID_SELECT
NoClaimedID.php
NoClaimedID.php in NoClaimedID.php
Nonce.php
Nonce.php in Nonce.php
o
top
$observers
OpenID::$observers in OpenID.php
Array of attached observers
$opEndpointURL
OpenID provider endpoint URL
$opEndpointURL
The OP Endoint URL a nonce is associated with
offsetExists
Checks to see if the offset exists in the services array
offsetGet
OpenID_ServiceEndpoints::offsetGet() in ServiceEndpoints.php
Returns the value of the services array at the specified offset
offsetSet
OpenID_ServiceEndpoints::offsetSet() in ServiceEndpoints.php
Sets a value in the services array
offsetUnset
Removes a particular offset in the services array
OpenID
OpenID in OpenID.php
OpenID
OpenID.php
OpenID.php in OpenID.php
OpenID_Assertion
OpenID_Assertion in Assertion.php
Class for verifying assertions. Does basic validation (nonce, return_to, etc), as well as signature verification and check_authentication.
OpenID_Assertion_Exception
OpenID_Assertion_Exception
OpenID_Assertion_Exception_NoClaimedID
Identify cases where a claimed id is not present.
OpenID_Assertion_Result
A class that represents the result of verifying an assertion.
OpenID_Association
OpenID_Association in Association.php
OpenID_Association
OpenID_Association_DiffieHellman
OpenID_Association_DiffieHellman
OpenID_Association_Exception
OpenID_Association_Exception
OpenID_Association_Request
OpenID_Association_Request
OpenID_Auth_Exception
OpenID_Auth_Exception in Exception.php
OpenID_Auth_Exception
OpenID_Auth_Request
OpenID_Auth_Request in Request.php
Creates an OpenID authorization request of type "checkid_setup" or "checkid_immediate".
OpenID_Discover
OpenID_Discover in Discover.php
OpenID_Discover
OpenID_Discover_Exception
OpenID_Discover_Exception in Exception.php
OpenID_Discover_Exception
OpenID_Discover_HTML
Implements HTML discovery
OpenID_Discover_Interface
OpenID_Discover_Interface in Interface.php
Describes the discovery driver interface
OpenID_Discover_Yadis
Implements YADIS discovery
OpenID_Exception
OpenID_Exception in Exception.php
OpenID_Exception
OpenID_Extension
OpenID_Extension in Extension.php
OpenID_Extension
OpenID_Extension_AX
Support for the AX extension
OpenID_Extension_Exception
OpenID_Extension_Exception
OpenID_Extension_SREG10
Implementation of the Simple Registration Extension version 1.0. See http://openid.net/specs/openid-simple-registration-extension-1_0.html for more information on this extension.
OpenID_Extension_SREG11
Implementation of the Simple Registration Extension, version 1.1 Draft 1.
OpenID_Extension_UI
Provides support for the UI extension
OpenID_Message
OpenID_Message in Message.php
OpenID_Message
OpenID_Message_Exception
OpenID_Message_Exception in Exception.php
OpenID_Message_Exception
OpenID_Nonce
OpenID_Nonce in Nonce.php
Handles nonce functionality. Requires the OP Endpoint URL nonces are to be associated with.
OpenID_Observer_Common
Allows for observers to listen in to key events. The most common use case is for logging. To use OpenID_Observe_Log, for example you could do this:
OpenID_Observer_Log
An observer based on PEAR's Log package. You may either pass in your own Log instance to the constructor, or allow the default file driver to write to /tmp/OpenID_Observer_Log.log by default.
OpenID_RelyingParty
OpenID_RelyingParty in RelyingParty.php
OpenID_RelyingParty
OpenID_ServiceEndpoint
OpenID_ServiceEndpoint in ServiceEndpoint.php
OpenID_ServiceEndpoint
OpenID_ServiceEndpoints
OpenID_ServiceEndpoints in ServiceEndpoints.php
OpenID_ServiceEndpoints
OpenID_Store
OpenID_Store in Store.php
Provides a factory for creating storage classes.
OpenID_Store_CacheLite
OpenID_Store_CacheLite in CacheLite.php
PEAR Cache_Lite driver for storage. This is the default driver used.
OpenID_Store_Exception
OpenID_Store_Exception in Exception.php
OpenID_Store_Exception
OpenID_Store_Interface
OpenID_Store_Interface in Interface.php
Defines the OpenID storage interface.
OpenID_Store_MDB2
OpenID_Store_MDB2 in MDB2.php
A first pass at SQL support via MDB2. This may have some MySQL specific things so it might get refactored a bit to support other DBs.
p
top
prepare
OpenID_RelyingParty::prepare() in RelyingParty.php
Prepares an OpenID_Auth_Request and returns it. This process includes performing discovery and optionally creating an association before preparing the OpenID_Auth_Request object.
prepareExecute
A shortcut to handle the error checking of prepare()/execute() in one place.
r
top
$realm
OpenID_RelyingParty::$realm in RelyingParty.php
The URI used for the openid.realm paramater
$request
Local storage of the HTTP_Request2 object
$requestedURL
The URL of the current request (to compare with openid.return_to)
$requestKeys
Supported keys in a request
$requestKeys
Keys appropriate for a request. Leave empty to allow any keys.
$requestOptions
HTTP_Request2 options
$requiredParams
Required parameters for storing an association.
$reserved
$response
The association request response in array format
$response
Local storage of the HTTP_Request2_Response object
$responseKeys
Keys appropriate for a response. Leave empty to allow any keys.
$responseKeys
Supported keys in a response
$returnTo
OpenID_RelyingParty::$returnTo in RelyingParty.php
The URI used for the openid.return_to parameter
Result.php
Result.php in Result.php
Request.php
Request.php in Request.php
Request.php
Request.php in Request.php
RelyingParty.php
RelyingParty.php in RelyingParty.php
REQUEST
OpenID_Extension::REQUEST in Extension.php
RESPONSE
RETURN_TO_NONCE
Constant for the parameter used with OpenID 1.1 nonces in the return_to URL
s
top
$serviceEndpoint
The OP Endpoint we are communicating with
$services
Instance of OpenID_ServiceEndpoints
$sharedKeyComputed
Whether or not the sharedSecretKey has been computed or not
$sharedSecret
In the association response, this is also referred to as the "mac_key", or is derived from the "enc_mac_key" if the session used encryption.
$source
OpenID_ServiceEndpoint::$source in ServiceEndpoint.php
The source of discovery
$store
OpenID::$store in OpenID.php
Instance of OpenID_Store_Interface
$storeDirectories
Sub-directory storage for each type of store
$supportedTypes
Local list of supported association types.
$supportedTypes
List of supported discover types
SREG10.php
SREG10.php in SREG10.php
SREG11.php
SREG11.php in SREG11.php
ServiceEndpoint.php
ServiceEndpoint.php in ServiceEndpoint.php
ServiceEndpoints.php
ServiceEndpoints.php in ServiceEndpoints.php
Store.php
Store.php in Store.php
sendAssociationRequest
Actually sends the assocition request to the OP Endpoing URL.
sendRequest
Sends the request via HTTP_Request2
SERVICE_1_0_SIGNON
SERVICE_1_1_SIGNON
SERVICE_2_0_SERVER
SERVICE_2_0_SIGNON
SESSION_TYPE_DH_SHA1
SESSION_TYPE_DH_SHA256
SESSION_TYPE_NO_ENCRYPTION
set
OpenID_Extension::set() in Extension.php
Sets a key value pair
set
Adds mode checking to set()
set
Adds some validation checking when setting a key, then calls the parent set()
set
OpenID_Message::set() in Message.php
Sets a message key value.
setAssertionMethod
Sets the assertion method used to verify the assertion
setAssertionResult
Sets the result of verifying the assertion.
setAssociation
Sets an association in the SQL server
setAssociation
Stores an OpenID_Association instance. Details (such as endpoint url and expiration) are retrieved from the object itself.
setAssociation
Stores an OpenID_Association instance. Details (such as endpoint url and exiration) are retrieved from the object itself.
setAssociationType
Sets he association type for the request. Can be sha1 or sha256.
setCheckAuthResponse
Sets the check_authentication response in the form of an OpenID_Message instance
setClockSkew
Sets the clock skew for nonce checking
setDiscover
Stores an instance of OpenID_Discover
setDiscover
Stores an instance of OpenID_Discover
setDiscover
Adds discoverd infomation to the SQL server
setEvents
Sets a custom array of events to act upon
setExpiresHeader
Sets the Expires header value
setIdentifier
Sets the user-supplied indentifier
setLastEvent
Sets the last event and notifies the observers
setLocalID
Sets the local ID
setMessage
Sets message contents. Wipes out any existing message contents. Default source format is Array, but you can also use KV and HTTP formats.
setMode
Sets the openid.mode parameter. Can be either "checkid_setup" or "checkid_immediate"
setNonce
Stores a nonce for an OP endpoint URL
setNonce
Sets the instance of OpenID_Nonce for use with 1.1 return_to nonces
setNonce
Sets a nonce in the SQL server
setNonce
Stores a nonce for an OP endpoint URL
setOptions
Sets options for Cache_Lite based on the needs of the current method.
setRequestOptions
Sets the HTTP_Request2 options to use
setSessionType
Sets the session type. Can be sha1, sha256, or no-encryption
setSource
Sets the source of discovery
setStore
OpenID::setStore() in OpenID.php
Sets a custom OpenID_Store_Interface object
setTypes
OpenID_ServiceEndpoint::setTypes() in ServiceEndpoint.php
Sets the service type
setURIs
OpenID_ServiceEndpoint::setURIs() in ServiceEndpoint.php
Sets the endpoint URIs
setUserSetupURL
Sets the openid.user_setup_url from the OP negative response
setVersion
Sets the OpenID protocol version this endpoint supports
signMessage
Signs an OpenID_Message instance
success
Indicates if the assertion was successful (positive) or not (negative)
t
top
$tableNames
Table names which you can override in a child class
$type
OpenID_Extension::$type in Extension.php
Type of message - 'request' or 'response'
$types
OpenID_ServiceEndpoint::$types in ServiceEndpoint.php
An array of service types
toMessage
Adds the extension contents to an OpenID_Message
TYPE_ASSOCIATION
Constants used for setting which type of storage is being used.
TYPE_DISCOVER
TYPE_HTML
TYPE_NONCE
TYPE_YADIS
u
top
$uri
OpenID_Association::$uri in Association.php
URI of the OP Endpoint
$uris
OpenID_ServiceEndpoint::$uris in ServiceEndpoint.php
An array of URIs for this endpoint
$useAssociations
Whether or not to use associations
$useNamespaceAlias
Enables namespaces. The only differnce I can see in the specs.
$useNamespaceAlias
Whether or not to use namespace alias assignments (for SREG 1.0 mostly)
$useNamespaceAlias
Disables NS use, since this extension was done before OpenID 2.0
$userSetupURL
The value of openid.user_setup_url, which is returned on a 1.1 negative response to a checkid_immediate request
UI.php
UI.php in UI.php
update
Acts upon an event that just occured
update
Logs the event
v
top
$validFormats
$validModes
Valid modes for AX requests/responses
$validModes
Valid modes (only 'popup' so far)
$values
OpenID_Extension::$values in Extension.php
values
$version
Version of OpenID in use. This determines which algorithms we can use.
$version
OpenID_ServiceEndpoint::$version in ServiceEndpoint.php
The version of the OpenID protocol this endpoint supports
$versionMap
OpenID::$versionMap in OpenID.php
A map of which service types (versions) map to which protocol version. 1.0 is mapped to 1.1. This is mostly helpful to see if openid.ns is supported.
validate
Validates the syntax of a nonce, as well as checks to see if its timestamp is within the allowed clock skew
validateDiscover
Validates and performs discovery on the openid.claimed_id paramter.
validateNonce
Validates the openid.response_nonce parameter.
validateReturnTo
Validates the openid.return_to parameter in the response.
validateReturnToNonce
Validates the nonce embedded in the openid.return_to paramater and deletes it from storage.. (For use with OpenID 1.1 only)
verify
OpenID_RelyingParty::verify() in RelyingParty.php
Verifies an assertion response from the OP. If the openid.mode is error, an exception is thrown.
verifyResponseNonce
Checks to see if the response nonce has been seen before. If not, store it and then validate its syntax
verifySignature
Verifies the signature of this message association.
y
top
$yadis
The Services_Yadis instance
Yadis.php
Yadis.php in Yadis.php
a b c d e f g h i l m n o p r s t u v y _