301 lines
8.8 KiB
PHP
301 lines
8.8 KiB
PHP
<?php
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @category Zend
|
|
* @package Zend_OpenId
|
|
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
* @version $Id: Sreg.php 16212 2009-06-21 19:24:49Z thomas $
|
|
*/
|
|
|
|
/**
|
|
* @see Zend_OpenId_Extension
|
|
*/
|
|
require_once "Zend/OpenId/Extension.php";
|
|
|
|
/**
|
|
* 'Simple Refistration Extension' for Zend_OpenId
|
|
*
|
|
* @category Zend
|
|
* @package Zend_OpenId
|
|
* @copyright Copyright (c) 2005-2009 Zend Technologies USA Inc. (http://www.zend.com)
|
|
* @license http://framework.zend.com/license/new-bsd New BSD License
|
|
*/
|
|
class Zend_OpenId_Extension_Sreg extends Zend_OpenId_Extension
|
|
{
|
|
/**
|
|
* SREG 1.1 namespace. All OpenID SREG 1.1 messages MUST contain variable
|
|
* openid.ns.sreg with its value.
|
|
*/
|
|
const NAMESPACE_1_1 = "http://openid.net/extensions/sreg/1.1";
|
|
|
|
private $_props;
|
|
private $_policy_url;
|
|
private $_version;
|
|
|
|
/**
|
|
* Creates SREG extension object
|
|
*
|
|
* @param array $props associative array of SREG variables
|
|
* @param string $policy_url SREG policy URL
|
|
* @param float $version SREG version
|
|
* @return array
|
|
*/
|
|
public function __construct(array $props=null, $policy_url=null, $version=1.0)
|
|
{
|
|
$this->_props = $props;
|
|
$this->_policy_url = $policy_url;
|
|
$this->_version = $version;
|
|
}
|
|
|
|
/**
|
|
* Returns associative array of SREG variables
|
|
*
|
|
* @return array
|
|
*/
|
|
public function getProperties() {
|
|
if (is_array($this->_props)) {
|
|
return $this->_props;
|
|
} else {
|
|
return array();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns SREG policy URL
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getPolicyUrl() {
|
|
return $this->_policy_url;
|
|
}
|
|
|
|
/**
|
|
* Returns SREG protocol version
|
|
*
|
|
* @return float
|
|
*/
|
|
public function getVersion() {
|
|
return $this->_version;
|
|
}
|
|
|
|
/**
|
|
* Returns array of allowed SREG variable names.
|
|
*
|
|
* @return array
|
|
*/
|
|
public static function getSregProperties()
|
|
{
|
|
return array(
|
|
"nickname",
|
|
"email",
|
|
"fullname",
|
|
"dob",
|
|
"gender",
|
|
"postcode",
|
|
"country",
|
|
"language",
|
|
"timezone"
|
|
);
|
|
}
|
|
|
|
/**
|
|
* Adds additional SREG data to OpenId 'checkid_immediate' or
|
|
* 'checkid_setup' request.
|
|
*
|
|
* @param array &$params request's var/val pairs
|
|
* @return bool
|
|
*/
|
|
public function prepareRequest(&$params)
|
|
{
|
|
if (is_array($this->_props) && count($this->_props) > 0) {
|
|
foreach ($this->_props as $prop => $req) {
|
|
if ($req) {
|
|
if (isset($required)) {
|
|
$required .= ','.$prop;
|
|
} else {
|
|
$required = $prop;
|
|
}
|
|
} else {
|
|
if (isset($optional)) {
|
|
$optional .= ','.$prop;
|
|
} else {
|
|
$optional = $prop;
|
|
}
|
|
}
|
|
}
|
|
if ($this->_version >= 1.1) {
|
|
$params['openid.ns.sreg'] = Zend_OpenId_Extension_Sreg::NAMESPACE_1_1;
|
|
}
|
|
if (!empty($required)) {
|
|
$params['openid.sreg.required'] = $required;
|
|
}
|
|
if (!empty($optional)) {
|
|
$params['openid.sreg.optional'] = $optional;
|
|
}
|
|
if (!empty($this->_policy_url)) {
|
|
$params['openid.sreg.policy_url'] = $this->_policy_url;
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Parses OpenId 'checkid_immediate' or 'checkid_setup' request,
|
|
* extracts SREG variables and sets ovject properties to corresponding
|
|
* values.
|
|
*
|
|
* @param array $params request's var/val pairs
|
|
* @return bool
|
|
*/
|
|
public function parseRequest($params)
|
|
{
|
|
if (isset($params['openid_ns_sreg']) &&
|
|
$params['openid_ns_sreg'] === Zend_OpenId_Extension_Sreg::NAMESPACE_1_1) {
|
|
$this->_version= 1.1;
|
|
} else {
|
|
$this->_version= 1.0;
|
|
}
|
|
if (!empty($params['openid_sreg_policy_url'])) {
|
|
$this->_policy_url = $params['openid_sreg_policy_url'];
|
|
} else {
|
|
$this->_policy_url = null;
|
|
}
|
|
$props = array();
|
|
if (!empty($params['openid_sreg_optional'])) {
|
|
foreach (explode(',', $params['openid_sreg_optional']) as $prop) {
|
|
$prop = trim($prop);
|
|
$props[$prop] = false;
|
|
}
|
|
}
|
|
if (!empty($params['openid_sreg_required'])) {
|
|
foreach (explode(',', $params['openid_sreg_required']) as $prop) {
|
|
$prop = trim($prop);
|
|
$props[$prop] = true;
|
|
}
|
|
}
|
|
$props2 = array();
|
|
foreach (self::getSregProperties() as $prop) {
|
|
if (isset($props[$prop])) {
|
|
$props2[$prop] = $props[$prop];
|
|
}
|
|
}
|
|
|
|
$this->_props = (count($props2) > 0) ? $props2 : null;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Adds additional SREG data to OpenId 'id_res' response.
|
|
*
|
|
* @param array &$params response's var/val pairs
|
|
* @return bool
|
|
*/
|
|
public function prepareResponse(&$params)
|
|
{
|
|
if (is_array($this->_props) && count($this->_props) > 0) {
|
|
if ($this->_version >= 1.1) {
|
|
$params['openid.ns.sreg'] = Zend_OpenId_Extension_Sreg::NAMESPACE_1_1;
|
|
}
|
|
foreach (self::getSregProperties() as $prop) {
|
|
if (!empty($this->_props[$prop])) {
|
|
$params['openid.sreg.' . $prop] = $this->_props[$prop];
|
|
}
|
|
}
|
|
}
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Parses OpenId 'id_res' response and sets object's properties according
|
|
* to 'openid.sreg.*' variables in response
|
|
*
|
|
* @param array $params response's var/val pairs
|
|
* @return bool
|
|
*/
|
|
public function parseResponse($params)
|
|
{
|
|
if (isset($params['openid_ns_sreg']) &&
|
|
$params['openid_ns_sreg'] === Zend_OpenId_Extension_Sreg::NAMESPACE_1_1) {
|
|
$this->_version= 1.1;
|
|
} else {
|
|
$this->_version= 1.0;
|
|
}
|
|
$props = array();
|
|
foreach (self::getSregProperties() as $prop) {
|
|
if (!empty($params['openid_sreg_' . $prop])) {
|
|
$props[$prop] = $params['openid_sreg_' . $prop];
|
|
}
|
|
}
|
|
if (isset($this->_props) && is_array($this->_props)) {
|
|
foreach (self::getSregProperties() as $prop) {
|
|
if (isset($this->_props[$prop]) &&
|
|
$this->_props[$prop] &&
|
|
!isset($props[$prop])) {
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
$this->_props = (count($props) > 0) ? $props : null;
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Addes SREG properties that are allowed to be send to consumer to
|
|
* the given $data argument.
|
|
*
|
|
* @param array &$data data to be stored in tusted servers database
|
|
* @return bool
|
|
*/
|
|
public function getTrustData(&$data)
|
|
{
|
|
$data[get_class()] = $this->getProperties();
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Check if given $data contains necessury SREG properties to sutisfy
|
|
* OpenId request. On success sets SREG response properties from given
|
|
* $data and returns true, on failure returns false.
|
|
*
|
|
* @param array $data data from tusted servers database
|
|
* @return bool
|
|
*/
|
|
public function checkTrustData($data)
|
|
{
|
|
if (is_array($this->_props) && count($this->_props) > 0) {
|
|
$props = array();
|
|
$name = get_class();
|
|
if (isset($data[$name])) {
|
|
$props = $data[$name];
|
|
} else {
|
|
$props = array();
|
|
}
|
|
$props2 = array();
|
|
foreach ($this->_props as $prop => $req) {
|
|
if (empty($props[$prop])) {
|
|
if ($req) {
|
|
return false;
|
|
}
|
|
} else {
|
|
$props2[$prop] = $props[$prop];
|
|
}
|
|
}
|
|
$this->_props = (count($props2) > 0) ? $props2 : null;
|
|
}
|
|
return true;
|
|
}
|
|
}
|