AX.php

Go to the documentation of this file.

<?php
 
require_once "Auth/OpenID/Extension.php";
require_once "Auth/OpenID/Message.php";
require_once "Auth/OpenID/TrustRoot.php";
 
define('Auth_OpenID_AX_NS_URI',
       'http://openid.net/srv/ax/1.0');
 
// Use this as the 'count' value for an attribute in a FetchRequest to
// ask for as many values as the OP can provide.
define('Auth_OpenID_AX_UNLIMITED_VALUES', 'unlimited');
 
// Minimum supported alias length in characters.  Here for
// completeness.
define('Auth_OpenID_AX_MINIMUM_SUPPORTED_ALIAS_LENGTH', 32);
 
class Auth_OpenID_AX {
    static function isError($thing)
    {
        return is_a($thing, 'Auth_OpenID_AX_Error');
    }
}
 
function Auth_OpenID_AX_checkAlias($alias)
{
  if (strpos($alias, ',') !== false) {
      return new Auth_OpenID_AX_Error(sprintf(
                   "Alias %s must not contain comma", $alias));
  }
  if (strpos($alias, '.') !== false) {
      return new Auth_OpenID_AX_Error(sprintf(
                   "Alias %s must not contain period", $alias));
  }
 
  return true;
}
 
class Auth_OpenID_AX_Error {
    function Auth_OpenID_AX_Error($message=null)
    {
        $this->message = $message;
    }
}
 
class Auth_OpenID_AX_Message extends Auth_OpenID_Extension {
    var $ns_alias = 'ax';
 
    var $mode = null;
 
    var $ns_uri = Auth_OpenID_AX_NS_URI;
 
    function _checkMode($ax_args)
    {
        $mode = Auth_OpenID::arrayGet($ax_args, 'mode');
        if ($mode != $this->mode) {
            return new Auth_OpenID_AX_Error(
                            sprintf(
                                    "Expected mode '%s'; got '%s'",
                                    $this->mode, $mode));
        }
 
        return true;
    }
 
    function _newArgs()
    {
        return array('mode' => $this->mode);
    }
}
 
class Auth_OpenID_AX_AttrInfo {
    function Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
                                     $alias)
    {
        $this->required = $required;
 
        $this->count = $count;
 
        $this->type_uri = $type_uri;
 
        $this->alias = $alias;
    }
 
    static function make($type_uri, $count=1, $required=false,
                  $alias=null)
    {
        if ($alias !== null) {
            $result = Auth_OpenID_AX_checkAlias($alias);
 
            if (Auth_OpenID_AX::isError($result)) {
                return $result;
            }
        }
 
        return new Auth_OpenID_AX_AttrInfo($type_uri, $count, $required,
                                           $alias);
    }
 
    function wantsUnlimitedValues()
    {
        return $this->count === Auth_OpenID_AX_UNLIMITED_VALUES;
    }
}
 
function Auth_OpenID_AX_toTypeURIs($namespace_map, $alias_list_s)
{
    $uris = array();
 
    if ($alias_list_s) {
        foreach (explode(',', $alias_list_s) as $alias) {
            $type_uri = $namespace_map->getNamespaceURI($alias);
            if ($type_uri === null) {
                // raise KeyError(
                // 'No type is defined for attribute name %r' % (alias,))
                return new Auth_OpenID_AX_Error(
                  sprintf('No type is defined for attribute name %s',
                          $alias)
                  );
            } else {
                $uris[] = $type_uri;
            }
        }
    }
 
    return $uris;
}
 
class Auth_OpenID_AX_FetchRequest extends Auth_OpenID_AX_Message {
 
    var $mode = 'fetch_request';
 
    function Auth_OpenID_AX_FetchRequest($update_url=null)
    {
        $this->requested_attributes = array();
 
        $this->update_url = $update_url;
    }
 
    function add($attribute)
    {
        if ($this->contains($attribute->type_uri)) {
            return new Auth_OpenID_AX_Error(
              sprintf("The attribute %s has already been requested",
                      $attribute->type_uri));
        }
 
        $this->requested_attributes[$attribute->type_uri] = $attribute;
 
        return true;
    }
 
    function getExtensionArgs()
    {
        $aliases = new Auth_OpenID_NamespaceMap();
 
        $required = array();
        $if_available = array();
 
        $ax_args = $this->_newArgs();
 
        foreach ($this->requested_attributes as $type_uri => $attribute) {
            if ($attribute->alias === null) {
                $alias = $aliases->add($type_uri);
            } else {
                $alias = $aliases->addAlias($type_uri, $attribute->alias);
 
                if ($alias === null) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Could not add alias %s for URI %s",
                              $attribute->alias, $type_uri
                      ));
                }
            }
 
            if ($attribute->required) {
                $required[] = $alias;
            } else {
                $if_available[] = $alias;
            }
 
            if ($attribute->count != 1) {
                $ax_args['count.' . $alias] = strval($attribute->count);
            }
 
            $ax_args['type.' . $alias] = $type_uri;
        }
 
        if ($required) {
            $ax_args['required'] = implode(',', $required);
        }
 
        if ($if_available) {
            $ax_args['if_available'] = implode(',', $if_available);
        }
 
        return $ax_args;
    }
 
    function getRequiredAttrs()
    {
        $required = array();
        foreach ($this->requested_attributes as $type_uri => $attribute) {
            if ($attribute->required) {
                $required[] = $type_uri;
            }
        }
 
        return $required;
    }
 
    static function fromOpenIDRequest($request)
    {
        $m = $request->message;
        $obj = new Auth_OpenID_AX_FetchRequest();
        $ax_args = $m->getArgs($obj->ns_uri);
 
        $result = $obj->parseExtensionArgs($ax_args);
 
        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }
 
        if ($obj->update_url) {
            // Update URL must match the openid.realm of the
            // underlying OpenID 2 message.
            $realm = $m->getArg(Auth_OpenID_OPENID_NS, 'realm',
                        $m->getArg(
                                  Auth_OpenID_OPENID_NS,
                                  'return_to'));
 
            if (!$realm) {
                $obj = new Auth_OpenID_AX_Error(
                  sprintf("Cannot validate update_url %s " .
                          "against absent realm", $obj->update_url));
            } else if (!Auth_OpenID_TrustRoot::match($realm,
                                                     $obj->update_url)) {
                $obj = new Auth_OpenID_AX_Error(
                  sprintf("Update URL %s failed validation against realm %s",
                          $obj->update_url, $realm));
            }
        }
 
        return $obj;
    }
 
    function parseExtensionArgs($ax_args)
    {
        $result = $this->_checkMode($ax_args);
        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }
 
        $aliases = new Auth_OpenID_NamespaceMap();
 
        foreach ($ax_args as $key => $value) {
            if (strpos($key, 'type.') === 0) {
                $alias = substr($key, 5);
                $type_uri = $value;
 
                $alias = $aliases->addAlias($type_uri, $alias);
 
                if ($alias === null) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Could not add alias %s for URI %s",
                              $alias, $type_uri)
                      );
                }
 
                $count_s = Auth_OpenID::arrayGet($ax_args, 'count.' . $alias);
                if ($count_s) {
                    $count = Auth_OpenID::intval($count_s);
                    if (($count === false) &&
                        ($count_s === Auth_OpenID_AX_UNLIMITED_VALUES)) {
                        $count = $count_s;
                    }
                } else {
                    $count = 1;
                }
 
                if ($count === false) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Integer value expected for %s, got %s",
                              'count.' . $alias, $count_s));
                }
 
                $attrinfo = Auth_OpenID_AX_AttrInfo::make($type_uri, $count,
                                                          false, $alias);
 
                if (Auth_OpenID_AX::isError($attrinfo)) {
                    return $attrinfo;
                }
 
                $this->add($attrinfo);
            }
        }
 
        $required = Auth_OpenID_AX_toTypeURIs($aliases,
                         Auth_OpenID::arrayGet($ax_args, 'required'));
 
        foreach ($required as $type_uri) {
            $attrib = $this->requested_attributes[$type_uri];
            $attrib->required = true;
        }
 
        $if_available = Auth_OpenID_AX_toTypeURIs($aliases,
                             Auth_OpenID::arrayGet($ax_args, 'if_available'));
 
        $all_type_uris = array_merge($required, $if_available);
 
        foreach ($aliases->iterNamespaceURIs() as $type_uri) {
            if (!in_array($type_uri, $all_type_uris)) {
                return new Auth_OpenID_AX_Error(
                  sprintf('Type URI %s was in the request but not ' .
                          'present in "required" or "if_available"',
                          $type_uri));
 
            }
        }
 
        $this->update_url = Auth_OpenID::arrayGet($ax_args, 'update_url');
 
        return true;
    }
 
    function iterAttrs()
    {
        return array_values($this->requested_attributes);
    }
 
    function iterTypes()
    {
        return array_keys($this->requested_attributes);
    }
 
    function contains($type_uri)
    {
        return in_array($type_uri, $this->iterTypes());
    }
}
 
class Auth_OpenID_AX_KeyValueMessage extends Auth_OpenID_AX_Message {
 
    function Auth_OpenID_AX_KeyValueMessage()
    {
        $this->data = array();
    }
 
    function addValue($type_uri, $value)
    {
        if (!array_key_exists($type_uri, $this->data)) {
            $this->data[$type_uri] = array();
        }
 
        $values =& $this->data[$type_uri];
        $values[] = $value;
    }
 
    function setValues($type_uri, &$values)
    {
        $this->data[$type_uri] =& $values;
    }
 
    function _getExtensionKVArgs($aliases)
    {
        if ($aliases === null) {
            $aliases = new Auth_OpenID_NamespaceMap();
        }
 
        $ax_args = array();
 
        foreach ($this->data as $type_uri => $values) {
            $alias = $aliases->add($type_uri);
 
            $ax_args['type.' . $alias] = $type_uri;
            $ax_args['count.' . $alias] = strval(count($values));
 
            foreach ($values as $i => $value) {
              $key = sprintf('value.%s.%d', $alias, $i + 1);
              $ax_args[$key] = $value;
            }
        }
 
        return $ax_args;
    }
 
    function parseExtensionArgs($ax_args)
    {
        $result = $this->_checkMode($ax_args);
        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }
 
        $aliases = new Auth_OpenID_NamespaceMap();
 
        foreach ($ax_args as $key => $value) {
            if (strpos($key, 'type.') === 0) {
                $type_uri = $value;
                $alias = substr($key, 5);
 
                $result = Auth_OpenID_AX_checkAlias($alias);
 
                if (Auth_OpenID_AX::isError($result)) {
                    return $result;
                }
 
                $alias = $aliases->addAlias($type_uri, $alias);
 
                if ($alias === null) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Could not add alias %s for URI %s",
                              $alias, $type_uri)
                      );
                }
            }
        }
 
        foreach ($aliases->iteritems() as $pair) {
            list($type_uri, $alias) = $pair;
 
            if (array_key_exists('count.' . $alias, $ax_args) && ($ax_args['count.' . $alias] !== Auth_OpenID_AX_UNLIMITED_VALUES)) {
 
                $count_key = 'count.' . $alias;
                $count_s = $ax_args[$count_key];
 
                $count = Auth_OpenID::intval($count_s);
 
                if ($count === false) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Integer value expected for %s, got %s",
                              'count. %s' . $alias, $count_s,
                              Auth_OpenID_AX_UNLIMITED_VALUES)
                                                    );
                }
 
                $values = array();
                for ($i = 1; $i < $count + 1; $i++) {
                    $value_key = sprintf('value.%s.%d', $alias, $i);
 
                    if (!array_key_exists($value_key, $ax_args)) {
                      return new Auth_OpenID_AX_Error(
                        sprintf(
                                "No value found for key %s",
                                $value_key));
                    }
 
                    $value = $ax_args[$value_key];
                    $values[] = $value;
                }
            } else {
                $key = 'value.' . $alias;
 
                if (!array_key_exists($key, $ax_args)) {
                  return new Auth_OpenID_AX_Error(
                    sprintf(
                            "No value found for key %s",
                            $key));
                }
 
                $value = $ax_args['value.' . $alias];
 
                if ($value == '') {
                    $values = array();
                } else {
                    $values = array($value);
                }
            }
 
            $this->data[$type_uri] = $values;
        }
 
        return true;
    }
 
    function getSingle($type_uri, $default=null)
    {
        $values = Auth_OpenID::arrayGet($this->data, $type_uri);
        if (!$values) {
            return $default;
        } else if (count($values) == 1) {
            return $values[0];
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf('More than one value present for %s',
                      $type_uri)
              );
        }
    }
 
    function get($type_uri)
    {
        if (array_key_exists($type_uri, $this->data)) {
            return $this->data[$type_uri];
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf("Type URI %s not found in response",
                      $type_uri)
              );
        }
    }
 
    function count($type_uri)
    {
        if (array_key_exists($type_uri, $this->data)) {
            return count($this->get($type_uri));
        } else {
            return new Auth_OpenID_AX_Error(
              sprintf("Type URI %s not found in response",
                      $type_uri)
              );
        }
    }
}
 
class Auth_OpenID_AX_FetchResponse extends Auth_OpenID_AX_KeyValueMessage {
    var $mode = 'fetch_response';
 
    function Auth_OpenID_AX_FetchResponse($update_url=null)
    {
        $this->Auth_OpenID_AX_KeyValueMessage();
        $this->update_url = $update_url;
    }
 
    function getExtensionArgs($request=null)
    {
        $aliases = new Auth_OpenID_NamespaceMap();
 
        $zero_value_types = array();
 
        if ($request !== null) {
            // Validate the data in the context of the request (the
            // same attributes should be present in each, and the
            // counts in the response must be no more than the counts
            // in the request)
 
            foreach ($this->data as $type_uri => $unused) {
                if (!$request->contains($type_uri)) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("Response attribute not present in request: %s",
                              $type_uri)
                      );
                }
            }
 
            foreach ($request->iterAttrs() as $attr_info) {
                // Copy the aliases from the request so that reading
                // the response in light of the request is easier
                if ($attr_info->alias === null) {
                    $aliases->add($attr_info->type_uri);
                } else {
                    $alias = $aliases->addAlias($attr_info->type_uri,
                                                $attr_info->alias);
 
                    if ($alias === null) {
                        return new Auth_OpenID_AX_Error(
                          sprintf("Could not add alias %s for URI %s",
                                  $attr_info->alias, $attr_info->type_uri)
                          );
                    }
                }
 
                if (array_key_exists($attr_info->type_uri, $this->data)) {
                    $values = $this->data[$attr_info->type_uri];
                } else {
                    $values = array();
                    $zero_value_types[] = $attr_info;
                }
 
                if (($attr_info->count != Auth_OpenID_AX_UNLIMITED_VALUES) &&
                    ($attr_info->count < count($values))) {
                    return new Auth_OpenID_AX_Error(
                      sprintf("More than the number of requested values " .
                              "were specified for %s",
                              $attr_info->type_uri)
                      );
                }
            }
        }
 
        $kv_args = $this->_getExtensionKVArgs($aliases);
 
        // Add the KV args into the response with the args that are
        // unique to the fetch_response
        $ax_args = $this->_newArgs();
 
        // For each requested attribute, put its type/alias and count
        // into the response even if no data were returned.
        foreach ($zero_value_types as $attr_info) {
            $alias = $aliases->getAlias($attr_info->type_uri);
            $kv_args['type.' . $alias] = $attr_info->type_uri;
            $kv_args['count.' . $alias] = '0';
        }
 
        $update_url = null;
        if ($request) {
            $update_url = $request->update_url;
        } else {
            $update_url = $this->update_url;
        }
 
        if ($update_url) {
            $ax_args['update_url'] = $update_url;
        }
 
        Auth_OpenID::update($ax_args, $kv_args);
 
        return $ax_args;
    }
 
    function parseExtensionArgs($ax_args)
    {
        $result = parent::parseExtensionArgs($ax_args);
 
        if (Auth_OpenID_AX::isError($result)) {
            return $result;
        }
 
        $this->update_url = Auth_OpenID::arrayGet($ax_args, 'update_url');
 
        return true;
    }
 
    static function fromSuccessResponse($success_response, $signed=true)
    {
        $obj = new Auth_OpenID_AX_FetchResponse();
        if ($signed) {
            $ax_args = $success_response->getSignedNS($obj->ns_uri);
        } else {
            $ax_args = $success_response->message->getArgs($obj->ns_uri);
        }
        if ($ax_args === null || Auth_OpenID::isFailure($ax_args) ||
              sizeof($ax_args) == 0) {
            return null;
        }
 
        $result = $obj->parseExtensionArgs($ax_args);
        if (Auth_OpenID_AX::isError($result)) {
            #XXX log me
            return null;
        }
        return $obj;
    }
}
 
class Auth_OpenID_AX_StoreRequest extends Auth_OpenID_AX_KeyValueMessage {
    var $mode = 'store_request';
 
    function getExtensionArgs($aliases=null)
    {
        $ax_args = $this->_newArgs();
        $kv_args = $this->_getExtensionKVArgs($aliases);
        Auth_OpenID::update($ax_args, $kv_args);
        return $ax_args;
    }
}
 
class Auth_OpenID_AX_StoreResponse extends Auth_OpenID_AX_Message {
    var $SUCCESS_MODE = 'store_response_success';
    var $FAILURE_MODE = 'store_response_failure';
 
    function make($succeeded=true, $error_message=null)
    {
        if (($succeeded) && ($error_message !== null)) {
            return new Auth_OpenID_AX_Error('An error message may only be '.
                                    'included in a failing fetch response');
        }
 
        return new Auth_OpenID_AX_StoreResponse($succeeded, $error_message);
    }
 
    function Auth_OpenID_AX_StoreResponse($succeeded=true, $error_message=null)
    {
        if ($succeeded) {
            $this->mode = $this->SUCCESS_MODE;
        } else {
            $this->mode = $this->FAILURE_MODE;
        }
 
        $this->error_message = $error_message;
    }
 
    function succeeded()
    {
        return $this->mode == $this->SUCCESS_MODE;
    }
 
    function getExtensionArgs()
    {
        $ax_args = $this->_newArgs();
        if ((!$this->succeeded()) && $this->error_message) {
            $ax_args['error'] = $this->error_message;
        }
 
        return $ax_args;
    }
}