Zend Framework
LICENSE
This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.
Abstract class to implement external storage for OpenID consumer

addAssociation(
string $url, string $handle, string $macFunc, string $secret, \long $expires
)
:
void
Stores information about association identified by $url/$handle
Name | Type | Description |
---|---|---|
$url | string | OpenID server URL |
$handle | string | assiciation handle |
$macFunc | string | HMAC function (sha1 or sha256) |
$secret | string | shared secret |
$expires | \long | expiration UNIX time |

addDiscoveryInfo(
string $id, string $realId, string $server, float $version, \long $expires
)
:
void
Stores information discovered from identity $id
Name | Type | Description |
---|---|---|
$id | string | identity |
$realId | string | discovered real identity URL |
$server | string | discovered OpenID server URL |
$version | float | discovered OpenID protocol version |
$expires | \long | expiration UNIX time |

delAssociation(
string $url
)
:
void
Deletes association identified by $url
Name | Type | Description |
---|---|---|
$url | string | OpenID server URL |

delDiscoveryInfo(
string $id
)
:
bool
Removes cached information discovered from identity $id
Name | Type | Description |
---|---|---|
$id | string | identity |
Type | Description |
---|---|
bool |

getAssociation(
string $url, string $handle, string $macFunc, string $secret, \long $expires
)
:
bool
Gets information about association identified by $url Returns true if given association found and not expired and false otherwise
Name | Type | Description |
---|---|---|
$url | string | OpenID server URL |
$handle | string | &$handle assiciation handle |
$macFunc | string | &$macFunc HMAC function (sha1 or sha256) |
$secret | string | &$secret shared secret |
$expires | \long | &$expires expiration UNIX time |
Type | Description |
---|---|
bool |

getAssociationByHandle(
string $handle, string $url, string $macFunc, string $secret, \long $expires
)
:
bool
Gets information about association identified by $handle Returns true if given association found and not expired and false othverwise
Name | Type | Description |
---|---|---|
$handle | string | assiciation handle |
$url | string | &$url OpenID server URL |
$macFunc | string | &$macFunc HMAC function (sha1 or sha256) |
$secret | string | &$secret shared secret |
$expires | \long | &$expires expiration UNIX time |
Type | Description |
---|---|
bool |

getDiscoveryInfo(
string $id, string $realId, string $server, float $version, \long $expires
)
:
bool
Gets information discovered from identity $id Returns true if such information exists and false otherwise
Name | Type | Description |
---|---|---|
$id | string | identity |
$realId | string | &$realId discovered real identity URL |
$server | string | &$server discovered OpenID server URL |
$version | float | &$version discovered OpenID protocol version |
$expires | \long | &$expires expiration UNIX time |
Type | Description |
---|---|
bool |

isUniqueNonce(
string $provider, string $nonce
)
:
bool
The function checks the uniqueness of openid.response_nonce
Name | Type | Description |
---|---|---|
$provider | string | openid.openid_op_endpoint field from authentication response |
$nonce | string | openid.response_nonce field from authentication response |
Type | Description |
---|---|
bool |