| [ Index ] |
PHP Cross Reference of Joomla 1.5.25 |
[Source view] [Print] [Project Stats]
This module documents the main interface with the OpenID consumer library. The only part of the library which has to be used and isn't documented in full here is the store required to create an Auth_OpenID_Consumer instance. More on the abstract store type and concrete implementations of it that are provided in the documentation for the Auth_OpenID_Consumer constructor. OVERVIEW
| Author: | JanRain, Inc. <openid@janrain.com> |
| Copyright: | 2005-2008 Janrain, Inc. |
| License: | http://www.apache.org/licenses/LICENSE-2.0 Apache |
| File Size: | 2232 lines (78 kb) |
| Included or required: | 1 time |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
Auth_OpenID_Consumer:: (5 methods):
Auth_OpenID_Consumer()
getDiscoveryObject()
begin()
beginWithoutDiscovery()
complete()
Auth_OpenID_DiffieHellmanSHA1ConsumerSession:: (3 methods):
Auth_OpenID_DiffieHellmanSHA1ConsumerSession()
getRequest()
extractSecret()
Auth_OpenID_DiffieHellmanSHA256ConsumerSession:: (0 methods):
Auth_OpenID_PlainTextConsumerSession:: (3 methods):
getRequest()
extractSecret()
Auth_OpenID_getAvailableSessionTypes()
Auth_OpenID_GenericConsumer:: (34 methods):
Auth_OpenID_GenericConsumer()
begin()
complete()
_completeInvalid()
_complete_cancel()
_complete_error()
_complete_setup_needed()
_complete_id_res()
_checkSetupNeeded()
_doIdRes()
_checkReturnTo()
_verifyReturnToArgs()
_idResCheckSignature()
_verifyDiscoveryResults()
_verifyDiscoveryResultsOpenID1()
_verifyDiscoverySingle()
_verifyDiscoveryResultsOpenID2()
_discoverAndVerify()
_verifyDiscoveryServices()
_idResGetNonceOpenID1()
_idResCheckNonce()
_idResCheckForFields()
_checkAuth()
_createCheckAuthRequest()
_processCheckAuthResponse()
_httpResponseToMessage()
_makeKVPost()
_getAssociation()
_extractSupportedAssociationType()
_negotiateAssociation()
_requestAssociation()
_extractAssociation()
_createAssociateRequest()
_getOpenID1SessionType()
Auth_OpenID_AuthRequest:: (9 methods):
Auth_OpenID_AuthRequest()
addExtension()
addExtensionArg()
setAnonymous()
getMessage()
redirectURL()
formMarkup()
htmlMarkup()
shouldSendRedirect()
Auth_OpenID_ConsumerResponse:: (2 methods):
setEndpoint()
getDisplayIdentifier()
Auth_OpenID_SuccessResponse:: (7 methods):
Auth_OpenID_SuccessResponse()
extensionResponse()
isOpenID1()
isSigned()
getSigned()
getSignedNS()
getReturnTo()
Auth_OpenID_FailureResponse:: (1 method):
Auth_OpenID_FailureResponse()
Auth_OpenID_TypeURIMismatch:: (0 methods):
Auth_OpenID_ServerErrorContainer:: (2 methods):
Auth_OpenID_ServerErrorContainer()
fromMessage()
Auth_OpenID_CancelResponse:: (1 method):
Auth_OpenID_CancelResponse()
Auth_OpenID_SetupNeededResponse:: (1 method):
Auth_OpenID_SetupNeededResponse()
Class: Auth_OpenID_Consumer - X-Ref
An OpenID consumer implementation that performs discovery and does| Auth_OpenID_Consumer(&$store, $session = null,$consumer_cls = null) X-Ref |
| Initialize a Consumer instance. You should create a new instance of the Consumer object with every HTTP request that handles OpenID transactions. param: Auth_OpenID_OpenIDStore $store This must be an object param: mixed $session An object which implements the interface param: str $consumer_cls The name of the class to instantiate |
| getDiscoveryObject(&$session, $openid_url,$session_key_prefix) X-Ref |
| Used in testing to define the discovery mechanism. |
| begin($user_url, $anonymous=false) X-Ref |
| Start the OpenID authentication process. See steps 1-2 in the overview at the top of this file. param: string $user_url Identity URL given by the user. This param: bool $anonymous True if the OpenID request is to be sent return: Auth_OpenID_AuthRequest $auth_request An object |
| beginWithoutDiscovery($endpoint, $anonymous=false) X-Ref |
| Start OpenID verification without doing OpenID server discovery. This method is used internally by Consumer.begin after discovery is performed, and exists to provide an interface for library users needing to perform their own discovery. param: Auth_OpenID_ServiceEndpoint $endpoint an OpenID service param: bool anonymous Set to true if you want to perform OpenID return: Auth_OpenID_AuthRequest $auth_request An OpenID |
| complete($current_url, $query=null) X-Ref |
| Called to interpret the server's response to an OpenID request. It is called in step 4 of the flow described in the consumer overview. param: string $current_url The URL used to invoke the application. param: array $query An array of the query parameters (key => return: Auth_OpenID_ConsumerResponse $response A instance of an |
Class: Auth_OpenID_DiffieHellmanSHA1ConsumerSession - X-Ref
A class implementing HMAC/DH-SHA1 consumer sessions.| Auth_OpenID_DiffieHellmanSHA1ConsumerSession($dh = null) X-Ref |
| No description |
| getRequest() X-Ref |
| No description |
| extractSecret($response) X-Ref |
| No description |
Class: Auth_OpenID_DiffieHellmanSHA256ConsumerSession - X-Ref
A class implementing HMAC/DH-SHA256 consumer sessions.Class: Auth_OpenID_PlainTextConsumerSession - X-Ref
A class implementing plaintext consumer sessions.| getRequest() X-Ref |
| No description |
| extractSecret($response) X-Ref |
| No description |
| Auth_OpenID_getAvailableSessionTypes() X-Ref |
| Returns available session types. |
Class: Auth_OpenID_GenericConsumer - X-Ref
This class is the interface to the OpenID consumer logic.| Auth_OpenID_GenericConsumer(&$store) X-Ref |
| This method initializes a new {@link Auth_OpenID_Consumer} instance to access the library. param: Auth_OpenID_OpenIDStore $store This must be an object param: bool $immediate This is an optional boolean value. It |
| begin($service_endpoint) X-Ref |
| Called to begin OpenID authentication using the specified {@link Auth_OpenID_ServiceEndpoint}. |
| complete($message, $endpoint, $return_to) X-Ref |
| Given an {@link Auth_OpenID_Message}, {@link Auth_OpenID_ServiceEndpoint} and optional return_to URL, complete OpenID authentication. |
| _completeInvalid($message, &$endpoint, $unused) X-Ref |
| _complete_cancel($message, &$endpoint, $unused) X-Ref |
| _complete_error($message, &$endpoint, $unused) X-Ref |
| _complete_setup_needed($message, &$endpoint, $unused) X-Ref |
| _complete_id_res($message, &$endpoint, $return_to) X-Ref |
| _checkSetupNeeded($message) X-Ref |
| _doIdRes($message, $endpoint, $return_to) X-Ref |
| _checkReturnTo($message, $return_to) X-Ref |
| _verifyReturnToArgs($query) X-Ref |
| _idResCheckSignature($message, $server_url) X-Ref |
| _verifyDiscoveryResults($message, $endpoint=null) X-Ref |
| _verifyDiscoveryResultsOpenID1($message, $endpoint) X-Ref |
| _verifyDiscoverySingle($endpoint, $to_match) X-Ref |
| _verifyDiscoveryResultsOpenID2($message, $endpoint) X-Ref |
| _discoverAndVerify($claimed_id, $to_match_endpoints) X-Ref |
| _verifyDiscoveryServices($claimed_id, &$services, &$to_match_endpoints) X-Ref |
| _idResGetNonceOpenID1($message, $endpoint) X-Ref |
| 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 |
| _idResCheckNonce($message, $endpoint) X-Ref |
| _idResCheckForFields($message) X-Ref |
| _checkAuth($message, $server_url) X-Ref |
| _createCheckAuthRequest($message) X-Ref |
| _processCheckAuthResponse($response, $server_url) X-Ref |
| _httpResponseToMessage($response, $server_url) X-Ref |
| Adapt a POST response to a Message. param: $response Result of a POST to an OpenID endpoint. |
| _makeKVPost($message, $server_url) X-Ref |
| _getAssociation($endpoint) X-Ref |
| _extractSupportedAssociationType(&$server_error, &$endpoint,$assoc_type) X-Ref |
| Handle ServerErrors resulting from association requests. return: $result If server replied with an C{unsupported-type} |
| _negotiateAssociation($endpoint) X-Ref |
| _requestAssociation($endpoint, $assoc_type, $session_type) X-Ref |
| _extractAssociation(&$assoc_response, &$assoc_session) X-Ref |
| _createAssociateRequest($endpoint, $assoc_type, $session_type) X-Ref |
| _getOpenID1SessionType($assoc_response) X-Ref |
| 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' return: $typ The association type for this message |
Class: Auth_OpenID_AuthRequest - X-Ref
This class represents an authentication request from a consumer to| Auth_OpenID_AuthRequest(&$endpoint, $assoc) X-Ref |
| Initialize an authentication request with the specified token, association, and endpoint. Users of this library should not create instances of this class. Instances of this class are created by the library when needed. |
| addExtension(&$extension_request) X-Ref |
| Add an extension to this checkid request. $extension_request: An object that implements the extension request interface for adding arguments to an OpenID message. |
| addExtensionArg($namespace, $key, $value) X-Ref |
| Add an extension argument to this OpenID authentication request. Use caution when adding arguments, because they will be URL-escaped and appended to the redirect URL, which can easily get quite long. param: string $namespace The namespace for the extension. For param: string $key The key within the extension namespace. For param: string $value The value to provide to the server for |
| setAnonymous($is_anonymous) X-Ref |
| Set whether this request should be made anonymously. If a request is anonymous, the identifier will not be sent in the request. This is only useful if you are making another kind of request with an extension in this request. Anonymous requests are not allowed when the request is made with OpenID 1. |
| getMessage($realm, $return_to=null, $immediate=false) X-Ref |
| Produce a {@link Auth_OpenID_Message} representing this request. param: string $realm The URL (or URL pattern) that identifies param: string $return_to The URL that the OpenID provider will param: bool $immediate If true, the OpenID provider is to send |
| redirectURL($realm, $return_to = null,$immediate = false) X-Ref |
| No description |
| formMarkup($realm, $return_to=null, $immediate=false,$form_tag_attrs=null) X-Ref |
| Get html for a form to submit this request to the IDP. form_tag_attrs: An array of attributes to be added to the form tag. 'accept-charset' and 'enctype' have defaults that can be overridden. If a value is supplied for 'action' or 'method', it will be replaced. |
| htmlMarkup($realm, $return_to=null, $immediate=false,$form_tag_attrs=null) X-Ref |
| Get a complete html document that will autosubmit the request to the IDP. Wraps formMarkup. See the documentation for that function. |
| shouldSendRedirect() X-Ref |
| No description |
Class: Auth_OpenID_ConsumerResponse - X-Ref
The base class for responses from the Auth_OpenID_Consumer.| setEndpoint($endpoint) X-Ref |
| No description |
| getDisplayIdentifier() X-Ref |
| Return the display identifier for this response. The display identifier is related to the Claimed Identifier, but the two are not always identical. The display identifier is something the user should recognize as what they entered, whereas the response's claimed identifier (in the identity_url attribute) may have extra information for better persistence. URLs will be stripped of their fragments for display. XRIs will display the human-readable identifier (i-name) instead of the persistent identifier (i-number). Use the display identifier in your user interface. Use identity_url for querying your database or authorization server. |
Class: Auth_OpenID_SuccessResponse - X-Ref
A response with a status of Auth_OpenID_SUCCESS. Indicates that| Auth_OpenID_SuccessResponse($endpoint, $message, $signed_args=null) X-Ref |
| extensionResponse($namespace_uri, $require_signed) X-Ref |
| Extract signed extension data from the server's response. param: string $prefix The extension namespace from which to |
| isOpenID1() X-Ref |
| No description |
| isSigned($ns_uri, $ns_key) X-Ref |
| No description |
| getSigned($ns_uri, $ns_key, $default = null) X-Ref |
| No description |
| getSignedNS($ns_uri) X-Ref |
| No description |
| getReturnTo() X-Ref |
| Get the openid.return_to argument from this response. This is useful for verifying that this request was initiated by this consumer. return: string $return_to The return_to URL supplied to the |
Class: Auth_OpenID_FailureResponse - X-Ref
A response with a status of Auth_OpenID_FAILURE. Indicates that the| Auth_OpenID_FailureResponse($endpoint, $message = null,$contact = null, $reference = null) X-Ref |
| No description |
Class: Auth_OpenID_TypeURIMismatch - X-Ref
A specific, internal failure used to detect type URI mismatch.Class: Auth_OpenID_ServerErrorContainer - X-Ref
Exception that is raised when the server returns a 400 response| Auth_OpenID_ServerErrorContainer($error_text,$error_code,$message) X-Ref |
| No description |
| fromMessage($message) X-Ref |
Class: Auth_OpenID_CancelResponse - X-Ref
A response with a status of Auth_OpenID_CANCEL. Indicates that the| Auth_OpenID_CancelResponse($endpoint) X-Ref |
| No description |
Class: Auth_OpenID_SetupNeededResponse - X-Ref
A response with a status of Auth_OpenID_SETUP_NEEDED. Indicates| Auth_OpenID_SetupNeededResponse($endpoint,$setup_url = null) X-Ref |
| No description |
| Generated: Mon Nov 14 16:47:20 2011 | Cross-referenced by PHPXref 0.7.1 |