4 * This is the PHP OpenID library by JanRain, Inc.
6 * This module contains core utility functionality used by the
7 * library. See Consumer.php and Server.php for the consumer and
8 * server implementations.
10 * PHP versions 4 and 5
12 * LICENSE: See the COPYING file included in this distribution.
15 * @author JanRain, Inc. <openid@janrain.com>
16 * @copyright 2005-2008 Janrain, Inc.
17 * @license http://www.apache.org/licenses/LICENSE-2.0 Apache
21 * The library version string
23 define('Auth_OpenID_VERSION', '2.2.2');
26 * Require the fetcher code.
28 require_once "Auth/Yadis/PlainHTTPFetcher.php";
29 require_once "Auth/Yadis/ParanoidHTTPFetcher.php";
30 require_once "Auth/OpenID/BigMath.php";
31 require_once "Auth/OpenID/URINorm.php";
34 * Status code returned by the server when the only option is to show
35 * an error page, since we do not have enough information to redirect
36 * back to the consumer. The associated value is an error message that
37 * should be displayed on an HTML error page.
39 * @see Auth_OpenID_Server
41 define('Auth_OpenID_LOCAL_ERROR', 'local_error');
44 * Status code returned when there is an error to return in key-value
45 * form to the consumer. The caller should return a 400 Bad Request
46 * response with content-type text/plain and the value as the body.
48 * @see Auth_OpenID_Server
50 define('Auth_OpenID_REMOTE_ERROR', 'remote_error');
53 * Status code returned when there is a key-value form OK response to
54 * the consumer. The value associated with this code is the
55 * response. The caller should return a 200 OK response with
56 * content-type text/plain and the value as the body.
58 * @see Auth_OpenID_Server
60 define('Auth_OpenID_REMOTE_OK', 'remote_ok');
63 * Status code returned when there is a redirect back to the
64 * consumer. The value is the URL to redirect back to. The caller
65 * should return a 302 Found redirect with a Location: header
68 * @see Auth_OpenID_Server
70 define('Auth_OpenID_REDIRECT', 'redirect');
73 * Status code returned when the caller needs to authenticate the
74 * user. The associated value is a {@link Auth_OpenID_ServerRequest}
75 * object that can be used to complete the authentication. If the user
76 * has taken some authentication action, use the retry() method of the
77 * {@link Auth_OpenID_ServerRequest} object to complete the request.
79 * @see Auth_OpenID_Server
81 define('Auth_OpenID_DO_AUTH', 'do_auth');
84 * Status code returned when there were no OpenID arguments
85 * passed. This code indicates that the caller should return a 200 OK
86 * response and display an HTML page that says that this is an OpenID
89 * @see Auth_OpenID_Server
91 define('Auth_OpenID_DO_ABOUT', 'do_about');
94 * Defines for regexes and format checking.
96 define('Auth_OpenID_letters',
97 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ");
99 define('Auth_OpenID_digits',
102 define('Auth_OpenID_punct',
103 "!\"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~");
105 Auth_OpenID_include_init();
108 * The OpenID utility function class.
116 * Return true if $thing is an Auth_OpenID_FailureResponse object;
121 static function isFailure($thing)
123 return is_a($thing, 'Auth_OpenID_FailureResponse');
127 * Gets the query data from the server environment based on the
128 * request method used. If GET was used, this looks at
129 * $_SERVER['QUERY_STRING'] directly. If POST was used, this
130 * fetches data from the special php://input file stream.
132 * Returns an associative array of the query arguments.
134 * Skips invalid key/value pairs (i.e. keys with no '=value'
137 * Returns an empty array if neither GET nor POST was used, or if
138 * POST was used but php://input cannot be opened.
141 * http://lists.openidenabled.com/pipermail/dev/2007-March/000395.html
145 static function getQuery($query_str=null)
149 if ($query_str !== null) {
150 $data = Auth_OpenID::params_from_string($query_str);
151 } else if (!array_key_exists('REQUEST_METHOD', $_SERVER)) {
154 // XXX HACK FIXME HORRIBLE.
156 // POSTing to a URL with query parameters is acceptable, but
157 // we don't have a clean way to distinguish those parameters
158 // when we need to do things like return_to verification
159 // which only want to look at one kind of parameter. We're
160 // going to emulate the behavior of some other environments
161 // by defaulting to GET and overwriting with POST if POST
162 // data is available.
163 $data = Auth_OpenID::params_from_string($_SERVER['QUERY_STRING']);
165 if ($_SERVER['REQUEST_METHOD'] == 'POST') {
166 $str = file_get_contents('php://input');
168 if ($str === false) {
171 $post = Auth_OpenID::params_from_string($str);
174 $data = array_merge($data, $post);
181 static function params_from_string($str)
183 $chunks = explode("&", $str);
186 foreach ($chunks as $chunk) {
187 $parts = explode("=", $chunk, 2);
189 if (count($parts) != 2) {
193 list($k, $v) = $parts;
194 $data[urldecode($k)] = urldecode($v);
201 * Create dir_name as a directory if it does not exist. If it
202 * exists, make sure that it is, in fact, a directory. Returns
203 * true if the operation succeeded; false if not.
207 static function ensureDir($dir_name)
209 if (is_dir($dir_name) || @mkdir($dir_name)) {
212 $parent_dir = dirname($dir_name);
214 // Terminal case; there is no parent directory to create.
215 if ($parent_dir == $dir_name) {
219 return (Auth_OpenID::ensureDir($parent_dir) && @mkdir($dir_name));
224 * Adds a string prefix to all values of an array. Returns a new
225 * array containing the prefixed values.
229 static function addPrefix($values, $prefix)
231 $new_values = array();
232 foreach ($values as $s) {
233 $new_values[] = $prefix . $s;
239 * Convenience function for getting array values. Given an array
240 * $arr and a key $key, get the corresponding value from the array
241 * or return $default if the key is absent.
245 static function arrayGet($arr, $key, $fallback = null)
247 if (is_array($arr)) {
248 if (array_key_exists($key, $arr)) {
254 trigger_error("Auth_OpenID::arrayGet (key = ".$key.") expected " .
255 "array as first parameter, got " .
256 gettype($arr), E_USER_WARNING);
263 * Replacement for PHP's broken parse_str.
265 static function parse_str($query)
267 if ($query === null) {
271 $parts = explode('&', $query);
273 $new_parts = array();
274 for ($i = 0; $i < count($parts); $i++) {
275 $pair = explode('=', $parts[$i]);
277 if (count($pair) != 2) {
281 list($key, $value) = $pair;
282 $new_parts[urldecode($key)] = urldecode($value);
289 * Implements the PHP 5 'http_build_query' functionality.
292 * @param array $data Either an array key/value pairs or an array
293 * of arrays, each of which holding two values: a key and a value,
295 * @return string $result The result of url-encoding the key/value
296 * pairs from $data into a URL query string
297 * (e.g. "username=bob&id=56").
299 static function httpBuildQuery($data)
302 foreach ($data as $key => $value) {
303 if (is_array($value)) {
304 $pairs[] = urlencode($value[0])."=".urlencode($value[1]);
306 $pairs[] = urlencode($key)."=".urlencode($value);
309 return implode("&", $pairs);
313 * "Appends" query arguments onto a URL. The URL may or may not
314 * already have arguments (following a question mark).
317 * @param string $url A URL, which may or may not already have
319 * @param array $args Either an array key/value pairs or an array of
320 * arrays, each of which holding two values: a key and a value,
321 * sequentially. If $args is an ordinary key/value array, the
322 * parameters will be added to the URL in sorted alphabetical order;
323 * if $args is an array of arrays, their order will be preserved.
324 * @return string $url The original URL with the new parameters added.
327 static function appendArgs($url, $args)
329 if (count($args) == 0) {
333 // Non-empty array; if it is an array of arrays, use
334 // multisort; otherwise use sort.
335 if (array_key_exists(0, $args) &&
336 is_array($args[0])) {
339 $keys = array_keys($args);
342 foreach ($keys as $key) {
343 $new_args[] = array($key, $args[$key]);
349 if (strpos($url, '?') !== false) {
353 return $url . $sep . Auth_OpenID::httpBuildQuery($args);
357 * Implements python's urlunparse, which is not available in PHP.
358 * Given the specified components of a URL, this function rebuilds
359 * and returns the URL.
362 * @param string $scheme The scheme (e.g. 'http'). Defaults to 'http'.
363 * @param string $host The host. Required.
364 * @param string $port The port.
365 * @param string $path The path.
366 * @param string $query The query.
367 * @param string $fragment The fragment.
368 * @return string $url The URL resulting from assembling the
369 * specified components.
371 static function urlunparse($scheme, $host, $port = null, $path = '/',
372 $query = '', $fragment = '')
387 $result = $scheme . "://" . $host;
390 $result .= ":" . $port;
396 $result .= "?" . $query;
400 $result .= "#" . $fragment;
407 * Given a URL, this "normalizes" it by adding a trailing slash
408 * and / or a leading http:// scheme where necessary. Returns
409 * null if the original URL is malformed and cannot be normalized.
412 * @param string $url The URL to be normalized.
413 * @return mixed $new_url The URL after normalization, or null if
414 * $url was malformed.
416 static function normalizeUrl($url)
418 @$parsed = parse_url($url);
424 if (isset($parsed['scheme']) &&
425 isset($parsed['host'])) {
426 $scheme = strtolower($parsed['scheme']);
427 if (!in_array($scheme, array('http', 'https'))) {
431 $url = 'http://' . $url;
434 $normalized = Auth_OpenID_urinorm($url);
435 if ($normalized === null) {
438 list($defragged, $frag) = Auth_OpenID::urldefrag($normalized);
443 * Replacement (wrapper) for PHP's intval() because it's broken.
447 static function intval($value)
451 if (!preg_match($re, $value)) {
455 return intval($value);
459 * Count the number of bytes in a string independently of
460 * multibyte support conditions.
462 * @param string $str The string of bytes to count.
463 * @return int The number of bytes in $str.
465 static function bytes($str)
467 return strlen(bin2hex($str)) / 2;
471 * Get the bytes in a string independently of multibyte support
474 static function toBytes($str)
476 $hex = bin2hex($str);
483 for ($i = 0; $i < strlen($hex); $i += 2) {
484 $b[] = chr(base_convert(substr($hex, $i, 2), 16, 10));
490 static function urldefrag($url)
492 $parts = explode("#", $url, 2);
494 if (count($parts) == 1) {
495 return array($parts[0], "");
501 static function filter($callback, &$sequence)
505 foreach ($sequence as $item) {
506 if (call_user_func_array($callback, array($item))) {
514 static function update(&$dest, &$src)
516 foreach ($src as $k => $v) {
522 * Wrap PHP's standard error_log functionality. Use this to
523 * perform all logging. It will interpolate any additional
524 * arguments into the format string before logging.
526 * @param string $format_string The sprintf format for the message
528 static function log($format_string)
530 $args = func_get_args();
531 $message = call_user_func_array('sprintf', $args);
535 static function autoSubmitHTML($form, $title="OpenId transaction in progress")
541 "<body onload='document.forms[0].submit();'>".
544 "var elements = document.forms[0].elements;".
545 "for (var i = 0; i < elements.length; i++) {".
546 " elements[i].style.display = \"none\";".
555 * Function to run when this file is included.
556 * Abstracted to a function to make life easier
557 * for some PHP optimizers.
559 function Auth_OpenID_include_init() {
560 if (Auth_OpenID_getMathLib() === null) {
561 Auth_OpenID_setNoMathSupport();