From a9f4ec34f80f30d3bf4b31841e5c8dd7fdb5dd6e Mon Sep 17 00:00:00 2001 From: Yannick Warnier Date: Wed, 3 Oct 2007 04:03:32 +0200 Subject: [PATCH] [svn r13376] Initial scripts, imported from Drupal, for OpenID authentication method. Not functional. Still need a lot of work to detach from Drupal. --- main/auth/openid/login.php | 380 +++++++++++++++++++++++++++++ main/auth/openid/openid.conf.php | 9 + main/auth/openid/openid.lib.php | 405 +++++++++++++++++++++++++++++++ main/auth/openid/xrds.lib.php | 80 ++++++ 4 files changed, 874 insertions(+) create mode 100644 main/auth/openid/login.php create mode 100644 main/auth/openid/openid.conf.php create mode 100644 main/auth/openid/openid.lib.php create mode 100644 main/auth/openid/xrds.lib.php diff --git a/main/auth/openid/login.php b/main/auth/openid/login.php new file mode 100644 index 0000000000..86edb0f414 --- /dev/null +++ b/main/auth/openid/login.php @@ -0,0 +1,380 @@ +'; +} + +/** + * The initial step of OpenID authentication responsible for the following: + * - Perform discovery on the claimed OpenID. + * - If possible, create an association with the Provider's endpoint. + * - Create the authentication request. + * - Perform the appropriate redirect. + * + * @param $claimed_id The OpenID to authenticate + * @param $return_to The endpoint to return to from the OpenID Provider + */ +function openid_begin($claimed_id, $return_to = '', $form_values = array()) +{ + + $claimed_id = _openid_normalize($claimed_id); + + $services = openid_discovery($claimed_id); + if (count($services) == 0) { + echo 'Sorry, that is not a valid OpenID. Please ensure you have spelled your ID correctly.'; + return; + } + + $op_endpoint = $services[0]['uri']; + // Store the discovered endpoint in the session (so we don't have to rediscover). + $_SESSION['openid_op_endpoint'] = $op_endpoint; + // Store the claimed_id in the session (for handling delegation). + $_SESSION['openid_claimed_id'] = $claimed_id; + // Store the login form values so we can pass them to + // user_exteral_login later. + $_SESSION['openid_user_login_values'] = $form_values; + + // If bcmath is present, then create an association + $assoc_handle = ''; + if (function_exists('bcadd')) { + $assoc_handle = openid_association($op_endpoint); + } + + // Now that there is an association created, move on + // to request authentication from the IdP + $identity = (!empty($services[0]['delegate'])) ? $services[0]['delegate'] : $claimed_id; + if (isset($services[0]['types']) && is_array($services[0]['types']) && in_array(OPENID_NS_2_0 .'/server', $services[0]['types'])) { + $identity = 'http://openid.net/identifier_select/2.0'; + } + $authn_request = openid_authentication_request($claimed_id, $identity, $return_to, $assoc_handle, $services[0]['version']); + + if ($services[0]['version'] == 2) { + openid_redirect($op_endpoint, $authn_request); + } + else { + openid_redirect_http($op_endpoint, $authn_request); + } +} + +/** + * Completes OpenID authentication by validating returned data from the OpenID + * Provider. + * + * @param $response Array of returned from the OpenID provider (typically $_REQUEST). + * + * @return $response Response values for further processing with + * $response['status'] set to one of 'success', 'failed' or 'cancel'. + */ +function openid_complete($response) +{ + // Default to failed response + $response['status'] = 'failed'; + if (isset($_SESSION['openid_op_endpoint']) && isset($_SESSION['openid_claimed_id'])) { + _openid_fix_post($response); + $op_endpoint = $_SESSION['openid_op_endpoint']; + $claimed_id = $_SESSION['openid_claimed_id']; + unset($_SESSION['openid_op_endpoint']); + unset($_SESSION['openid_claimed_id']); + if (isset($response['openid.mode'])) { + if ($response['openid.mode'] == 'cancel') { + $response['status'] = 'cancel'; + } + else { + if (openid_verify_assertion($op_endpoint, $response)) { + $response['openid.identity'] = $claimed_id; + $response['status'] = 'success'; + } + } + } + } + return $response; +} + +/** + * Perform discovery on a claimed ID to determine the OpenID provider endpoint. + * + * @param $claimed_id The OpenID URL to perform discovery on. + * + * @return Array of services discovered (including OpenID version, endpoint + * URI, etc). + */ +function openid_discovery($claimed_id) { + + $services = array(); + + $xrds_url = $claimed_id; + if (_openid_is_xri($claimed_id)) { + $xrds_url = 'http://xri.net/'. $claimed_id; + } + $url = @parse_url($xrds_url); + if ($url['scheme'] == 'http' || $url['scheme'] == 'https') { + // For regular URLs, try Yadis resolution first, then HTML-based discovery + $headers = array('Accept' => 'application/xrds+xml'); + //TODO + $result = drupal_http_request($xrds_url, $headers); + + if (!isset($result->error)) { + if (isset($result->headers['Content-Type']) && preg_match("/application\/xrds\+xml/", $result->headers['Content-Type'])) { + // Parse XML document to find URL + $services = xrds_parse($result->data); + } + else { + $xrds_url = NULL; + if (isset($result->headers['X-XRDS-Location'])) { + $xrds_url = $result->headers['X-XRDS-Location']; + } + else { + // Look for meta http-equiv link in HTML head + $xrds_url = _openid_meta_httpequiv('X-XRDS-Location', $result->data); + } + if (!empty($xrds_url)) { + $headers = array('Accept' => 'application/xrds+xml'); + //TODO + $xrds_result = drupal_http_request($xrds_url, $headers); + if (!isset($xrds_result->error)) { + $services = xrds_parse($xrds_result->data); + } + } + } + + // Check for HTML delegation + if (count($services) == 0) { + // Look for 2.0 links + $uri = _openid_link_href('openid2.provider', $result->data); + $delegate = _openid_link_href('openid2.local_id', $result->data); + $version = 2; + + // 1.0 links + if (empty($uri)) { + $uri = _openid_link_href('openid.server', $result->data); + $delegate = _openid_link_href('openid.delegate', $result->data); + $version = 1; + } + if (!empty($uri)) { + $services[] = array('uri' => $uri, 'delegate' => $delegate, 'version' => $version); + } + } + } + } + return $services; +} + +/** + * Attempt to create a shared secret with the OpenID Provider. + * + * @param $op_endpoint URL of the OpenID Provider endpoint. + * + * @return $assoc_handle The association handle. + */ +function openid_association($op_endpoint) { + + // Remove Old Associations: + //TODO + api_sql_query("DELETE FROM {openid_association} WHERE created + expires_in < %d", time()); + + // Check to see if we have an association for this IdP already + $assoc_handle = api_sql_query("SELECT assoc_handle FROM {openid_association} WHERE idp_endpoint_uri = '%s'", $op_endpoint)); + if (Database::num_rows($assoc_handle)<=1) { + $mod = OPENID_DH_DEFAULT_MOD; + $gen = OPENID_DH_DEFAULT_GEN; + $r = _openid_dh_rand($mod); + $private = bcadd($r, 1); + $public = bcpowmod($gen, $private, $mod); + + // If there is no existing association, then request one + $assoc_request = openid_association_request($public); + $assoc_message = _openid_encode_message(_openid_create_message($assoc_request)); + $assoc_headers = array('Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'); + //TODO + $assoc_result = drupal_http_request($op_endpoint, $assoc_headers, 'POST', $assoc_message); + if (isset($assoc_result->error)) { + return FALSE; + } + + $assoc_response = _openid_parse_message($assoc_result->data); + if (isset($assoc_response['mode']) && $assoc_response['mode'] == 'error') { + return FALSE; + } + + if ($assoc_response['session_type'] == 'DH-SHA1') { + $spub = _openid_dh_base64_to_long($assoc_response['dh_server_public']); + $enc_mac_key = base64_decode($assoc_response['enc_mac_key']); + $shared = bcpowmod($spub, $private, $mod); + $assoc_response['mac_key'] = base64_encode(_openid_dh_xorsecret($shared, $enc_mac_key)); + } + //TODO + api_sql_query("INSERT INTO {openid_association} (idp_endpoint_uri, session_type, assoc_handle, assoc_type, expires_in, mac_key, created) VALUES('%s', '%s', '%s', '%s', %d, '%s', %d)", + $op_endpoint, $assoc_response['session_type'], $assoc_response['assoc_handle'], $assoc_response['assoc_type'], $assoc_response['expires_in'], $assoc_response['mac_key'], time()); + + $assoc_handle = $assoc_response['assoc_handle']; + } + + return $assoc_handle; +} + +/** + * Authenticate a user or attempt registration. + * + * @param $response Response values from the OpenID Provider. + */ +function openid_authentication($response) { + + $identity = $response['openid.identity']; + + $account = user_external_load($identity); + if (isset($account->uid)) { + if (!variable_get('user_email_verification', TRUE) || $account->login) { + user_external_login($account, $_SESSION['openid_user_login_values']); + } + else { + //TODO + //drupal_set_message(t('You must validate your email address for this account before logging in via OpenID')); + } + } + elseif (variable_get('user_register', 1)) { + // Register new user + $form_state['redirect'] = NULL; + $form_state['values']['name'] = (empty($response['openid.sreg.nickname'])) ? $identity : $response['openid.sreg.nickname']; + $form_state['values']['mail'] = (empty($response['openid.sreg.email'])) ? '' : $response['openid.sreg.email']; + $form_state['values']['pass'] = user_password(); + $form_state['values']['status'] = variable_get('user_register', 1) == 1; + $form_state['values']['response'] = $response; + $form_state['values']['auth_openid'] = $identity; + //TODO + $form = drupal_retrieve_form('user_register', $form_state); + drupal_prepare_form('user_register', $form, $form_state); + drupal_validate_form('user_register', $form, $form_state); + if (form_get_errors()) { + // We were unable to register a valid new user, redirect to standard + // user/register and prefill with the values we received. + drupal_set_message(t('OpenID registration failed for the reasons listed. You may register now, or if you already have an account you can log in now and add your OpenID under "My Account"', array('@login' => url('user/login'))), 'error'); + $_SESSION['openid'] = $form_state['values']; + // We'll want to redirect back to the same place. + $destination = drupal_get_destination(); + unset($_REQUEST['destination']); + drupal_goto('user/register', $destination); + } + else { + unset($form_state['values']['response']); + $account = user_save('', $form_state['values']); + user_external_login($account); + } + drupal_redirect_form($form, $form_state['redirect']); + } + else { + drupal_set_message(t('Only site administrators can create new user accounts.'), 'error'); + } + drupal_goto(); +} + +function openid_association_request($public) { + include_once drupal_get_path('module', 'openid') .'/openid.inc'; + + $request = array( + 'openid.ns' => OPENID_NS_2_0, + 'openid.mode' => 'associate', + 'openid.session_type' => 'DH-SHA1', + 'openid.assoc_type' => 'HMAC-SHA1' + ); + + if ($request['openid.session_type'] == 'DH-SHA1' || $request['openid.session_type'] == 'DH-SHA256') { + $cpub = _openid_dh_long_to_base64($public); + $request['openid.dh_consumer_public'] = $cpub; + } + + return $request; +} + +function openid_authentication_request($claimed_id, $identity, $return_to = '', $assoc_handle = '', $version = 2) { + + $realm = ($return_to) ? $return_to : url('', array('absolute' => TRUE)); + + $ns = ($version == 2) ? OPENID_NS_2_0 : OPENID_NS_1_0; + $request = array( + 'openid.ns' => $ns, + 'openid.mode' => 'checkid_setup', + 'openid.identity' => $identity, + 'openid.claimed_id' => $claimed_id, + 'openid.assoc_handle' => $assoc_handle, + 'openid.return_to' => $return_to, + ); + + if ($version == 2) { + $request['openid.realm'] = $realm; + } + else { + $request['openid.trust_root'] = $realm; + } + + // Simple Registration + $request['openid.sreg.required'] = 'nickname,email'; + $request['openid.ns.sreg'] = "http://openid.net/extensions/sreg/1.1"; + + $request = array_merge($request, module_invoke_all('openid', 'request', $request)); + + return $request; +} + +/** + * Attempt to verify the response received from the OpenID Provider. + * + * @param $op_endpoint The OpenID Provider URL. + * @param $response Array of repsonse values from the provider. + * + * @return boolean + */ +function openid_verify_assertion($op_endpoint, $response) { + + $valid = FALSE; + + //TODO + $association = db_fetch_object(db_query("SELECT * FROM {openid_association} WHERE assoc_handle = '%s'", $response['openid.assoc_handle'])); + if ($association && isset($association->session_type)) { + $keys_to_sign = explode(',', $response['openid.signed']); + $self_sig = _openid_signature($association, $response, $keys_to_sign); + if ($self_sig == $response['openid.sig']) { + $valid = TRUE; + } + else { + $valid = FALSE; + } + } + else { + $request = $response; + $request['openid.mode'] = 'check_authentication'; + $message = _openid_create_message($request); + $headers = array('Content-Type' => 'application/x-www-form-urlencoded; charset=utf-8'); + $result = drupal_http_request($op_endpoint, $headers, 'POST', _openid_encode_message($message)); + if (!isset($result->error)) { + $response = _openid_parse_message($result->data); + if (strtolower(trim($response['is_valid'])) == 'true') { + $valid = TRUE; + } + else { + $valid = FALSE; + } + } + } + + return $valid; +} \ No newline at end of file diff --git a/main/auth/openid/openid.conf.php b/main/auth/openid/openid.conf.php new file mode 100644 index 0000000000..d7ac38d627 --- /dev/null +++ b/main/auth/openid/openid.conf.php @@ -0,0 +1,9 @@ +OpenID is a secure way to use one user ID and password to log in to many web sites without special software, giving the same password to each site, or losing control over which information is shared with each site that you visit.

'; +$langMainInfoDetail .= '

Users can create accounts using their OpenID, assign one or more OpenIDs to an existing account, and log in using an OpenID. This lowers the barrier to registration, which is good for the site, and offers convenience and security to the users. Logging in via OpenID is far more secure than cross-site logins using drupal.module.

'; +$langMainInfoDetail .= '

More information on OpenID is available at OpenID.net

'; +?> \ No newline at end of file diff --git a/main/auth/openid/openid.lib.php b/main/auth/openid/openid.lib.php new file mode 100644 index 0000000000..e177dd4c70 --- /dev/null +++ b/main/auth/openid/openid.lib.php @@ -0,0 +1,405 @@ + $val) { + $query[] = $key .'='. urlencode($val); + } + + $sep = (strpos($url, '?') === FALSE) ? '?' : '&'; + header('Location: '. $url . $sep . implode('&', $query), TRUE, 302); + exit; +} + +/** + * Creates a js auto-submit redirect for (for the 2.x protocol) + */ +function openid_redirect($url, $message) { + $output = ''.get_lang('OpenIDRedirect'). "\n"; + //$output .= drupal_get_form('openid_redirect_form', $url, $message); + $output .= '
'; + foreach($message as $key => $value) + { + $output .=''; + } + //$output .= '
'; + $output .= ''; + $output .= ''; + $output .= ''; + $output .= "\n"; + print $output; + exit; +} + +/** + * Determine if the given identifier is an XRI ID. + */ +function _openid_is_xri($identifier) { + $firstchar = substr($identifier, 0, 1); + if ($firstchar == "@" || $firstchar == "=") + return TRUE; + + if (stristr($identifier, 'xri://') !== FALSE) { + return TRUE; + } + + return FALSE; +} + +/** + * Normalize the given identifier as per spec. + */ +function _openid_normalize($identifier) { + if (_openid_is_xri($identifier)) { + return _openid_normalize_xri($identifier); + } + else { + return _openid_normalize_url($identifier); + } +} + +function _openid_normalize_xri($xri) { + $normalized_xri = $xri; + if (stristr($xri, 'xri://') !== FALSE) { + $normalized_xri = substr($xri, 6); + } + return $normalized_xri; +} + +function _openid_normalize_url($url) { + $normalized_url = $url; + + if (stristr($url, '://') === FALSE) { + $normalized_url = 'http://'. $url; + } + + if (substr_count($normalized_url, '/') < 3) { + $normalized_url .= '/'; + } + + return $normalized_url; +} + +/** + * Create a serialized message packet as per spec: $key:$value\n . + */ +function _openid_create_message($data) { + $serialized = ''; + + foreach ($data as $key => $value) { + if ((strpos($key, ':') !== FALSE) || (strpos($key, "\n") !== FALSE) || (strpos($value, "\n") !== FALSE)) { + return null; + } + $serialized .= "$key:$value\n"; + } + return $serialized; +} + +/** + * Encode a message from _openid_create_message for HTTP Post + */ +function _openid_encode_message($message) { + $encoded_message = ''; + + $items = explode("\n", $message); + foreach ($items as $item) { + $parts = explode(':', $item, 2); + + if (count($parts) == 2) { + if ($encoded_message != '') { + $encoded_message .= '&'; + } + $encoded_message .= rawurlencode(trim($parts[0])) .'='. rawurlencode(trim($parts[1])); + } + } + + return $encoded_message; +} + +/** + * Convert a direct communication message + * into an associative array. + */ +function _openid_parse_message($message) { + $parsed_message = array(); + + $items = explode("\n", $message); + foreach ($items as $item) { + $parts = explode(':', $item, 2); + + if (count($parts) == 2) { + $parsed_message[$parts[0]] = $parts[1]; + } + } + + return $parsed_message; +} + +/** + * Return a nonce value - formatted per OpenID spec. + */ +function _openid_nonce() { + // YYYY-MM-DDThh:mm:ssTZD UTC, plus some optional extra unique chars + return gmstrftime('%Y-%m-%dT%H:%M:%S%Z') . + chr(mt_rand(0, 25) + 65) . + chr(mt_rand(0, 25) + 65) . + chr(mt_rand(0, 25) + 65) . + chr(mt_rand(0, 25) + 65); +} + +/** + * Pull the href attribute out of an html link element. + */ +function _openid_link_href($rel, $html) { + $rel = preg_quote($rel); + preg_match('||iU', $html, $matches); + if (isset($matches[3])) { + preg_match('|href=["\']([^"]+)["\']|iU', $matches[0], $href); + return trim($href[1]); + } + return FALSE; +} + +/** + * Pull the http-equiv attribute out of an html meta element + */ +function _openid_meta_httpequiv($equiv, $html) { + preg_match('||iU', $html, $matches); + if (isset($matches[1])) { + preg_match('|content=["\']([^"]+)["\']|iU', $matches[1], $content); + return $content[1]; + } + return FALSE; +} + +/** + * Sign certain keys in a message + * @param $association - object loaded from openid_association or openid_server_association table + * - important fields are ->assoc_type and ->mac_key + * @param $message_array - array of entire message about to be sent + * @param $keys_to_sign - keys in the message to include in signature (without + * 'openid.' appended) + */ +function _openid_signature($association, $message_array, $keys_to_sign) { + $signature = ''; + $sign_data = array(); + + foreach ($keys_to_sign as $key) { + if (isset($message_array['openid.'. $key])) { + $sign_data[$key] = $message_array['openid.'. $key]; + } + } + + $message = _openid_create_message($sign_data); + $secret = base64_decode($association->mac_key); + $signature = _openid_hmac($secret, $message); + + return base64_encode($signature); +} + +function _openid_hmac($key, $text) { + if (strlen($key) > OPENID_SHA1_BLOCKSIZE) { + $key = _openid_sha1($key, true); + } + + $key = str_pad($key, OPENID_SHA1_BLOCKSIZE, chr(0x00)); + $ipad = str_repeat(chr(0x36), OPENID_SHA1_BLOCKSIZE); + $opad = str_repeat(chr(0x5c), OPENID_SHA1_BLOCKSIZE); + $hash1 = _openid_sha1(($key ^ $ipad) . $text, true); + $hmac = _openid_sha1(($key ^ $opad) . $hash1, true); + + return $hmac; +} + +function _openid_sha1($text) { + $hex = sha1($text); + $raw = ''; + for ($i = 0; $i < 40; $i += 2) { + $hexcode = substr($hex, $i, 2); + $charcode = (int)base_convert($hexcode, 16, 10); + $raw .= chr($charcode); + } + return $raw; +} + +function _openid_dh_base64_to_long($str) { + $b64 = base64_decode($str); + + return _openid_dh_binary_to_long($b64); +} + +function _openid_dh_long_to_base64($str) { + return base64_encode(_openid_dh_long_to_binary($str)); +} + +function _openid_dh_binary_to_long($str) { + $bytes = array_merge(unpack('C*', $str)); + + $n = 0; + foreach ($bytes as $byte) { + $n = bcmul($n, pow(2, 8)); + $n = bcadd($n, $byte); + } + + return $n; +} + +function _openid_dh_long_to_binary($long) { + $cmp = bccomp($long, 0); + if ($cmp < 0) { + return FALSE; + } + + if ($cmp == 0) { + return "\x00"; + } + + $bytes = array(); + + while (bccomp($long, 0) > 0) { + array_unshift($bytes, bcmod($long, 256)); + $long = bcdiv($long, pow(2, 8)); + } + + if ($bytes && ($bytes[0] > 127)) { + array_unshift($bytes, 0); + } + + $string = ''; + foreach ($bytes as $byte) { + $string .= pack('C', $byte); + } + + return $string; +} + +function _openid_dh_xorsecret($shared, $secret) { + $dh_shared_str = _openid_dh_long_to_binary($shared); + $sha1_dh_shared = _openid_sha1($dh_shared_str); + $xsecret = ""; + for ($i = 0; $i < strlen($secret); $i++) { + $xsecret .= chr(ord($secret[$i]) ^ ord($sha1_dh_shared[$i])); + } + + return $xsecret; +} + +function _openid_dh_rand($stop) { + static $duplicate_cache = array(); + + // Used as the key for the duplicate cache + $rbytes = _openid_dh_long_to_binary($stop); + + if (array_key_exists($rbytes, $duplicate_cache)) { + list($duplicate, $nbytes) = $duplicate_cache[$rbytes]; + } + else { + if ($rbytes[0] == "\x00") { + $nbytes = strlen($rbytes) - 1; + } + else { + $nbytes = strlen($rbytes); + } + + $mxrand = bcpow(256, $nbytes); + + // If we get a number less than this, then it is in the + // duplicated range. + $duplicate = bcmod($mxrand, $stop); + + if (count($duplicate_cache) > 10) { + $duplicate_cache = array(); + } + + $duplicate_cache[$rbytes] = array($duplicate, $nbytes); + } + + do { + $bytes = "\x00" . _openid_get_bytes($nbytes); + $n = _openid_dh_binary_to_long($bytes); + // Keep looping if this value is in the low duplicated range. + } while (bccomp($n, $duplicate) < 0); + + return bcmod($n, $stop); +} + +function _openid_get_bytes($num_bytes) { + static $f = null; + $bytes = ''; + if (!isset($f)) { + $f = @fopen(OPENID_RAND_SOURCE, "r"); + } + if (!$f) { + // pseudorandom used + $bytes = ''; + for ($i = 0; $i < $num_bytes; $i += 4) { + $bytes .= pack('L', mt_rand()); + } + $bytes = substr($bytes, 0, $num_bytes); + } + else { + $bytes = fread($f, $num_bytes); + } + return $bytes; +} + +/** + * Fix PHP's habit of replacing '.' by '_' in posted data. + */ +function _openid_fix_post(&$post) { + $extensions = module_invoke_all('openid', 'extension'); + foreach ($post as $key => $value) { + if (strpos($key, 'openid_') === 0) { + $fixed_key = str_replace('openid_', 'openid.', $key); + $fixed_key = str_replace('openid.ns_', 'openid.ns.', $fixed_key); + $fixed_key = str_replace('openid.sreg_', 'openid.sreg.', $fixed_key); + foreach ($extensions as $ext) { + $fixed_key = str_replace('openid.'.$ext.'_', 'openid.'.$ext.'.', $fixed_key); + } + unset($post[$key]); + $post[$fixed_key] = $value; + } + } +} + +/** + * Provide bcpowmod support for PHP4. + */ +if (!function_exists('bcpowmod')) { + function bcpowmod($base, $exp, $mod) { + $square = bcmod($base, $mod); + $result = 1; + while (bccomp($exp, 0) > 0) { + if (bcmod($exp, 2)) { + $result = bcmod(bcmul($result, $square), $mod); + } + $square = bcmod(bcmul($square, $square), $mod); + $exp = bcdiv($exp, 2); + } + return $result; + } +} diff --git a/main/auth/openid/xrds.lib.php b/main/auth/openid/xrds.lib.php new file mode 100644 index 0000000000..4702c65015 --- /dev/null +++ b/main/auth/openid/xrds.lib.php @@ -0,0 +1,80 @@ +