OpenID consumer implementation
category | Zend |
---|---|
package | Zend_OpenId |
subpackage | Zend_OpenId_Consumer |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
__construct(\Zend_OpenId_Consumer_Storage $storage= null
, boolean $dumbMode= false
)
Enables or disables future association with server based on Diffie-Hellman key agreement.
\Zend_OpenId_Consumer_Storage
implementation of custom storage object
boolean
Enables or disables consumer to use association with server based on Diffie-Hellman key agreement
check(string $id, string $returnTo= null
, string $root= null
, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : boolean
This is the first step of OpenID authentication process. On success the function does not return (it does HTTP redirection to server and exits). On failure it returns false.
string
OpenID identity
string
HTTP URL to redirect response from server to
string
HTTP URL to identify consumer on server
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
an optional response object to perform HTTP or HTML form redirection
boolean
getError() : string
string
getHttpClient() : \Zend_Http_Client
\Zend_Http_Client
getSession() : \Zend_Session_Namespace
\Zend_Session_Namespace
login(string $id, string $returnTo= null
, string $root= null
, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : boolean
This is the first step of OpenID authentication process. On success the function does not return (it does HTTP redirection to server and exits). On failure it returns false.
string
OpenID identity
string
URL to redirect response from server to
string
HTTP URL to identify consumer on server
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
an optional response object to perform HTTP or HTML form redirection
boolean
setHttpClient(\Zend_Http_Client $client)
\Zend_Http_Client
HTTP client object to be used
setSession(\Zend_Session_Namespace $session)
\Zend_Session_Namespace
HTTP client object to be used
verify(array $params, $identity= ""
, mixed $extensions= null
) : boolean
This is the second step of OpenID authentication process. The function returns true on successful authentication and false on failure.
array
HTTP query data from OpenID server
mixed
extension object or array of extensions objects
boolean
_addAssociation(string $url, string $handle, string $macFunc, string $secret, integer $expires) : void
string
OpenID server url
string
association handle
string
HMAC function (sha1 or sha256)
string
shared secret
integer
expiration UNIX time
_associate(string $url, float $version, string $priv_key = null
) : boolean
string
OpenID server url
float
OpenID protocol version
string
for testing only
boolean
_checkId(boolean $immediate, string $id, string $returnTo= null
, string $root= null
, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : boolean
This is the first step of OpenID authentication process. On success the function does not return (it does HTTP redirection to server and exits). On failure it returns false.
boolean
enables or disables interaction with user
string
OpenID identity
string
HTTP URL to redirect response from server to
string
HTTP URL to identify consumer on server
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
an optional response object to perform HTTP or HTML form redirection
boolean
_discovery($id, $server, $version) : boolean
todo | OpenID 2.0 (7.3) XRI and Yadis discovery |
---|
boolean
_getAssociation(string $url, $handle, $macFunc, $secret, $expires) : void
string
OpenID server url
_httpRequest(string $url, string $method= 'GET'
, array $params= array()
, $status= null
) : mixed
Send additinal query specified by variable/value array, On success returns HTTP response without headers, false on failure.
string
OpenID server url
string
HTTP request method 'GET' or 'POST'
array
additional qwery parameters to be passed with
mixed
_setError(string $message)
string
error message
$_cache : array
array()
$_dumbMode : \Zend_OpenId_Consumer_Storage
false
$_signParams
array('op_endpoint', 'return_to', 'response_nonce', 'assoc_handle')
$_storage : \Zend_OpenId_Consumer_Storage
null
$_error : string
''
$_httpClient : \Zend_Http_Client
null
$_session : \Zend_Session_Namespace
null