OpenID provider (server) implementation
category | Zend |
---|---|
package | Zend_OpenId |
subpackage | Zend_OpenId_Provider |
copyright | Copyright (c) 2005-2015 Zend Technologies USA Inc. (http://www.zend.com) |
license | New BSD License |
__construct(string $loginUrl= null
, string $trustUrl= null
, \Zend_OpenId_Provider_User $user= null
, \Zend_OpenId_Provider_Storage $storage= null
, integer $sessionTtl= 3600
)
string
is an URL that provides login screen for end-user (by default it is the same URL with additional GET variable openid.action=login)
string
is an URL that shows a question if end-user trust to given consumer (by default it is the same URL with additional GET variable openid.action=trust)
\Zend_OpenId_Provider_User
is an object for communication with User-Agent and store information about logged-in user (it is a Zend_OpenId_Provider_User_Session object by default)
\Zend_OpenId_Provider_Storage
is an object for keeping persistent database (it is a Zend_OpenId_Provider_Storage_File object by default)
integer
is a default time to live for association session in seconds (1 hour by default). Consumer must reestablish association after that time.
allowSite(string $root, mixed $extensions = null
) : boolean
string
root URL
mixed
extension object or array of extensions objects
boolean
delSite(string $root) : boolean
Returns true on success and false on error.
string
root URL
boolean
denySite(string $root) : boolean
string
root URL
boolean
getLoggedInUser() : mixed
mixed
getSiteRoot(array $params) : mixed
Returns URL or false in case of failure
array
query arguments
mixed
getTrustedSites() : mixed
mixed
handle(array $params= null
, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : mixed
array
GET or POST variables. If this parameter is omited or set to null, then $_GET or $_POST superglobal variable is used according to REQUEST_METHOD.
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
an optional response object to perform HTTP or HTML form redirection
mixed
hasUser(string $id) : boolean
string
user identity URL
boolean
login(string $id, string $password) : boolean
string
user identity URL
string
user password
boolean
logout() : void
register(string $id, string $password) : boolean
string
user identity URL
string
encoded user password
boolean
respondToConsumer(array $params, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : boolean
array
GET or POST request variables
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
an optional response object to perform HTTP or HTML form redirection
boolean
setOpEndpoint(string $url) : null
string
the OP Endpoint URL
null
_associate(float $version, array $params) : array
Returns array of variables to push back to consumer.
float
OpenID version
array
GET or POST request variables
array
_checkAuthentication(float $version, array $params) : array
It MUST contain 'is_valid' variable with value 'true' or 'false'.
float
OpenID version
array
GET or POST request variables
array
_checkId(float $version, array $params, boolean $immediate, mixed $extensions= null
, \Zend_Controller_Response_Abstract $response= null
) : array
float
OpenID version
array
GET or POST request variables
boolean
enables or disables interaction with user
mixed
extension object or array of extensions objects
\Zend_Controller_Response_Abstract
array
_genSecret(string $func) : mixed
string
hash function (sha1 or sha256)
mixed
_respond(float $version, array $ret, array $params, mixed $extensions = null
) : array
float
OpenID protcol version
array
arguments to be send back to consumer
array
GET or POST request variables
mixed
extension object or array of extensions objects
array
_secureStringCompare(string $a, string $b) : boolean
string
string
boolean
$_loginUrl : string
$_opEndpoint : string
$_sessionTtl : integer
$_storage : \Zend_OpenId_Provider_Storage
$_trustUrl : string
$_user : \Zend_OpenId_Provider_User