<?php
// PukiWiki - Yet another WikiWikiWeb clone
-// $Id: auth.php,v 1.17 2005/06/09 14:52:10 henoheno Exp $
-// Copyright (C) 2003-2005 PukiWiki Developers Team
+// $Id: auth.php,v 1.22 2011/01/25 15:01:01 henoheno Exp $
+// Copyright (C) 2003-2005, 2007 PukiWiki Developers Team
// License: GPL v2 or (at your option) any later version
//
// Authentication related functions
define('PKWK_PASSPHRASE_LIMIT_LENGTH', 512);
+/////////////////////////////////////////////////
+// Auth type
+
+define('AUTH_TYPE_NONE', 0);
+define('AUTH_TYPE_BASIC', 1);
+define('AUTH_TYPE_EXTERNAL', 2);
+define('AUTH_TYPE_FORM', 3);
+
+define('AUTH_TYPE_EXTERNAL_REMOTE_USER', 4);
+define('AUTH_TYPE_EXTERNAL_X_FORWARDED_USER', 5);
+
+
// Passwd-auth related ----
function pkwk_login($pass = '')
global $adminpass;
if (! PKWK_READONLY && isset($adminpass) &&
- pkwk_hash_compute($adminpass, $pass) === $adminpass) {
+ pkwk_hash_compute($pass, $adminpass) === $adminpass) {
return TRUE;
} else {
sleep(2); // Blocking brute force attack
}
// Compute RFC2307 'userPassword' value, like slappasswd (OpenLDAP)
-// $scheme : Specify '{scheme}' or '{scheme}salt'
// $phrase : Pass-phrase
+// $scheme : Specify '{scheme}' or '{scheme}salt'
// $prefix : Output with a scheme-prefix or not
// $canonical : Correct or Preserve $scheme prefix
-function pkwk_hash_compute($scheme = '{php_md5}', $phrase = '', $prefix = TRUE, $canonical = FALSE)
+function pkwk_hash_compute($phrase = '', $scheme = '{x-php-md5}', $prefix = TRUE, $canonical = FALSE)
{
+ if (! is_string($phrase) || ! is_string($scheme)) return FALSE;
+
if (strlen($phrase) > PKWK_PASSPHRASE_LIMIT_LENGTH)
die('pkwk_hash_compute(): malicious message length');
// LDAP MD5
case '{md5}' :
$hash = ($prefix ? ($canonical ? '{MD5}' : $scheme) : '') .
- base64_encode(hex2bin(md5($phrase)));
+ base64_encode(pkwk_hex2bin(md5($phrase)));
break;
// LDAP SMD5
// MD5 Key length = 128bits = 16bytes
$salt = ($salt != '' ? substr(base64_decode($salt), 16) : substr(crypt(''), -8));
$hash = ($prefix ? ($canonical ? '{SMD5}' : $scheme) : '') .
- base64_encode(hex2bin(md5($phrase . $salt)) . $salt);
+ base64_encode(pkwk_hex2bin(md5($phrase . $salt)) . $salt);
break;
// LDAP SHA
case '{sha}' :
$hash = ($prefix ? ($canonical ? '{SHA}' : $scheme) : '') .
- base64_encode(hex2bin(sha1($phrase)));
+ base64_encode(pkwk_hex2bin(sha1($phrase)));
break;
// LDAP SSHA
// SHA-1 Key length = 160bits = 20bytes
$salt = ($salt != '' ? substr(base64_decode($salt), 20) : substr(crypt(''), -8));
$hash = ($prefix ? ($canonical ? '{SSHA}' : $scheme) : '') .
- base64_encode(hex2bin(sha1($phrase . $salt)) . $salt);
+ base64_encode(pkwk_hex2bin(sha1($phrase . $salt)) . $salt);
break;
// LDAP CLEARTEXT and just cleartext
return $hash;
}
+// LDAP related functions
+
+function _pkwk_ldap_escape_callback($matches) {
+ return sprintf('\\%02x', ord($matches[0]));
+}
+
+function pkwk_ldap_escape_filter($value) {
+ if (function_exists('ldap_escape')) {
+ return ldap_escape($value, false, LDAP_ESCAPE_FILTER);
+ }
+ return preg_replace_callback('/[\\\\*()\0]/',
+ '_pkwk_ldap_escape_callback', $value);
+}
+
+function pkwk_ldap_escape_dn($value) {
+ if (function_exists('ldap_escape')) {
+ return ldap_escape($value, false, LDAP_ESCAPE_DN);
+ }
+ return preg_replace_callback('/[\\\\,=+<>;"#]/',
+ '_pkwk_ldap_escape_callback', $value);
+}
+
// Basic-auth related ----
} else {
// With exit
$body = $title = str_replace('$1',
- htmlspecialchars(strip_bracket($page)), $_title_cannotedit);
+ htmlsc(strip_bracket($page)), $_title_cannotedit);
if (is_freeze($page))
$body .= '(<a href="' . $script . '?cmd=unfreeze&page=' .
rawurlencode($page) . '">' . $_msg_unfreeze . '</a>)';
// Basic authentication
function basic_auth($page, $auth_flag, $exit_flag, $auth_pages, $title_cannot)
{
- global $auth_method_type, $auth_users, $_msg_auth;
-
+ global $auth_method_type, $auth_users, $_msg_auth, $auth_user, $auth_groups;
+ global $auth_user_groups, $auth_type, $g_query_string;
// Checked by:
$target_str = '';
if ($auth_method_type == 'pagename') {
if (empty($user_list)) return TRUE; // No limit
$matches = array();
- if (! isset($_SERVER['PHP_AUTH_USER']) &&
- ! isset($_SERVER ['PHP_AUTH_PW']) &&
- isset($_SERVER['HTTP_AUTHORIZATION']) &&
- preg_match('/^Basic (.*)$/', $_SERVER['HTTP_AUTHORIZATION'], $matches))
- {
-
- // Basic-auth with $_SERVER['HTTP_AUTHORIZATION']
- list($_SERVER['PHP_AUTH_USER'], $_SERVER['PHP_AUTH_PW']) =
- explode(':', base64_decode($matches[1]));
- }
-
if (PKWK_READONLY ||
- ! isset($_SERVER['PHP_AUTH_USER']) ||
- ! in_array($_SERVER['PHP_AUTH_USER'], $user_list) ||
- ! isset($auth_users[$_SERVER['PHP_AUTH_USER']]) ||
- pkwk_hash_compute($auth_users[$_SERVER['PHP_AUTH_USER']],
- $_SERVER['PHP_AUTH_PW']) !== $auth_users[$_SERVER['PHP_AUTH_USER']])
+ ! $auth_user ||
+ count(array_intersect($auth_user_groups, $user_list)) === 0)
{
// Auth failed
pkwk_common_headers();
- if ($auth_flag) {
- header('WWW-Authenticate: Basic realm="' . $_msg_auth . '"');
- header('HTTP/1.0 401 Unauthorized');
+ if ($auth_flag && !$auth_user) {
+ if (AUTH_TYPE_BASIC === $auth_type) {
+ header('WWW-Authenticate: Basic realm="' . $_msg_auth . '"');
+ header('HTTP/1.0 401 Unauthorized');
+ } elseif (AUTH_TYPE_FORM === $auth_type) {
+ $url_after_login = get_script_uri() . '?' . $g_query_string;
+ $loginurl = get_script_uri() . '?plugin=loginform'
+ . '&page=' . rawurlencode($page)
+ . '&url_after_login=' . rawurlencode($url_after_login);
+ header('HTTP/1.0 302 Found');
+ header('Location: ' . $loginurl);
+ } elseif (AUTH_TYPE_EXTERNAL === $auth_type) {
+ $url_after_login = get_script_uri() . '?' . $g_query_string;
+ $loginurl = get_auth_external_login_url($page, $url_after_login);
+ header('HTTP/1.0 302 Found');
+ header('Location: ' . $loginurl);
+ }
}
if ($exit_flag) {
$body = $title = str_replace('$1',
- htmlspecialchars(strip_bracket($page)), $title_cannot);
+ htmlsc(strip_bracket($page)), $title_cannot);
$page = str_replace('$1', make_search($page), $title_cannot);
catbody($title, $page, $body);
exit;
return TRUE;
}
}
-?>
+
+/**
+ * Send 401 if client send a invalid credentials
+ *
+ * @return true if valid, false if invalid credentials
+ */
+function ensure_valid_auth_user()
+{
+ global $auth_type, $auth_users, $_msg_auth, $auth_user, $auth_groups;
+ global $auth_user_groups, $auth_user_fullname;
+ global $ldap_user_account;
+ global $read_auth, $edit_auth;
+ if ($read_auth || $edit_auth) {
+ switch ($auth_type) {
+ case AUTH_TYPE_BASIC:
+ case AUTH_TYPE_FORM:
+ case AUTH_TYPE_EXTERNAL:
+ case AUTH_TYPE_EXTERNAL_REMOTE_USER:
+ case AUTH_TYPE_EXTERNAL_X_FORWARDED_USER:
+ break;
+ default:
+ // $auth_type is not valid, Set form auth as default
+ $auth_type = AUTH_TYPE_FORM;
+ }
+ }
+ $auth_dynamic_groups = null;
+ switch ($auth_type) {
+ case AUTH_TYPE_BASIC:
+ {
+ if (isset($_SERVER['PHP_AUTH_USER'])) {
+ $user = $_SERVER['PHP_AUTH_USER'];
+ if (in_array($user, array_keys($auth_users))) {
+ if (pkwk_hash_compute(
+ $_SERVER['PHP_AUTH_PW'],
+ $auth_users[$user]) === $auth_users[$user]) {
+ $auth_user = $user;
+ $auth_user_fullname = $auth_user;
+ $auth_user_groups = get_groups_from_username($user);
+ return true;
+ }
+ }
+ header('WWW-Authenticate: Basic realm="' . $_msg_auth . '"');
+ header('HTTP/1.0 401 Unauthorized');
+ }
+ $auth_user = '';
+ $auth_user_groups = array();
+ return true; // no auth input
+ }
+ case AUTH_TYPE_FORM:
+ case AUTH_TYPE_EXTERNAL:
+ {
+ session_start();
+ $user = '';
+ $fullname = '';
+ $dynamic_groups = array();
+ if (isset($_SESSION['authenticated_user'])) {
+ $user = $_SESSION['authenticated_user'];
+ if (isset($_SESSION['authenticated_user_fullname'])) {
+ $fullname = $_SESSION['authenticated_user_fullname'];
+ $dynamic_groups = $_SESSION['dynamic_member_groups'];
+ } else {
+ $fullname = $user;
+ if ($auth_type === AUTH_TYPE_EXTERNAL && $ldap_user_account) {
+ $ldap_user_info = ldap_get_simple_user_info($user);
+ if ($ldap_user_info) {
+ $fullname = $ldap_user_info['fullname'];
+ $dynamic_groups = $ldap_user_info['dynamic_member_groups'];
+ }
+ }
+ $_SESSION['authenticated_user_fullname'] = $fullname;
+ $_SESSION['dynamic_member_groups'] = $dynamic_groups;
+ }
+ }
+ $auth_user = $user;
+ $auth_user_fullname = $fullname;
+ $auth_dynamic_groups = $dynamic_groups;
+ break;
+ }
+ case AUTH_TYPE_EXTERNAL_REMOTE_USER:
+ $auth_user = $_SERVER['REMOTE_USER'];
+ $auth_user_fullname = $auth_user;
+ break;
+ case AUTH_TYPE_EXTERNAL_X_FORWARDED_USER:
+ $auth_user = $_SERVER['HTTP_X_FORWARDED_USER'];
+ $auth_user_fullname = $auth_user;
+ break;
+ default: // AUTH_TYPE_NONE
+ $auth_user = '';
+ $auth_user_fullname = '';
+ break;
+ }
+ $auth_user_groups = get_groups_from_username($auth_user);
+ if ($auth_dynamic_groups && is_array($auth_dynamic_groups)) {
+ $auth_user_groups = array_values(array_merge($auth_user_groups, $auth_dynamic_groups));
+ }
+ return true; // is not basic auth
+}
+
+/**
+ * Return group name array whose group contains the user
+ *
+ * Result array contains reserved 'valid-user' group for all authenticated user
+ * @global array $auth_groups
+ * @param string $user
+ * @return array
+ */
+function get_groups_from_username($user)
+{
+ global $auth_groups;
+ if ($user !== '') {
+ $groups = array();
+ foreach ($auth_groups as $group=>$users) {
+ $sp = explode(',', $users);
+ if (in_array($user, $sp)) {
+ $groups[] = $group;
+ }
+ }
+ // Implicit group that has same name as user itself
+ $groups[] = $user;
+ // 'valid-user' group for
+ $valid_user = 'valid-user';
+ if (!in_array($valid_user, $groups)) {
+ $groups[] = $valid_user;
+ }
+ return $groups;
+ }
+ return array();
+}
+
+/**
+ * Get authenticated user name.
+ *
+ * @global type $auth_user
+ * @return type
+ */
+function get_auth_user()
+{
+ global $auth_user;
+ return $auth_user;
+}
+
+/**
+ * Sign in with username and password
+ *
+ * @param String username
+ * @param String password
+ * @return true is sign in is OK
+ */
+function form_auth($username, $password)
+{
+ global $ldap_user_account, $auth_users;
+ $user = $username;
+ if ($ldap_user_account) {
+ // LDAP account
+ return ldap_auth($username, $password);
+ } else {
+ // Defined users in pukiwiki.ini.php
+ if (in_array($user, array_keys($auth_users))) {
+ if (pkwk_hash_compute(
+ $password,
+ $auth_users[$user]) === $auth_users[$user]) {
+ session_start();
+ session_regenerate_id(true); // require: PHP5.1+
+ $_SESSION['authenticated_user'] = $user;
+ $_SESSION['authenticated_user_fullname'] = $user;
+ return true;
+ }
+ }
+ }
+ return false;
+}
+
+function ldap_auth($username, $password)
+{
+ global $ldap_server, $ldap_base_dn, $ldap_bind_dn, $ldap_bind_password;
+ $ldapconn = ldap_connect($ldap_server);
+ if ($ldapconn) {
+ ldap_set_option($ldapconn, LDAP_OPT_PROTOCOL_VERSION, 3);
+ ldap_set_option($ldapconn, LDAP_OPT_REFERRALS, 0);
+ if (preg_match('#\$login\b#', $ldap_bind_dn)) {
+ // Bind by user credential
+ $username_esc = pkwk_ldap_escape_dn($username);
+ $bind_dn_user = preg_replace('#\$login\b#', $username_esc, $ldap_bind_dn);
+ $ldap_bind_user = ldap_bind($ldapconn, $bind_dn_user, $password);
+ if ($ldap_bind_user) {
+ $user_info = get_ldap_user_info($ldapconn, $username, $ldap_base_dn);
+ if ($user_info) {
+ $ldap_groups = get_ldap_groups_with_user($ldapconn, $username, $user_info['is_ad']);
+ session_regenerate_id(true); // require: PHP5.1+
+ $_SESSION['authenticated_user'] = $user_info['uid'];
+ $_SESSION['authenticated_user_fullname'] = $user_info['fullname'];
+ $_SESSION['dynamic_member_groups'] = $ldap_groups;
+ return true;
+ }
+ }
+ } else {
+ // Bind by bind dn
+ $ldap_bind = ldap_bind($ldapconn, $ldap_bind_dn, $ldap_bind_password);
+ if ($ldap_bind) {
+ $user_info = get_ldap_user_info($ldapconn, $username, $ldap_base_dn);
+ if ($user_info) {
+ $ldap_bind_user2 = ldap_bind($ldapconn, $user_info['dn'], $password);
+ if ($ldap_bind_user2) {
+ $ldap_groups = get_ldap_groups_with_user($ldapconn, $username, $user_info['is_ad']);
+ session_regenerate_id(true); // require: PHP5.1+
+ $_SESSION['authenticated_user'] = $user_info['uid'];
+ $_SESSION['authenticated_user_fullname'] = $user_info['fullname'];
+ $_SESSION['dynamic_member_groups'] = $ldap_groups;
+ return true;
+ }
+ }
+ }
+ }
+ }
+ return false;
+}
+
+// Get LDAP user info via bind DN
+function ldap_get_simple_user_info($username)
+{
+ global $ldap_server, $ldap_base_dn, $ldap_bind_dn, $ldap_bind_password;
+ $ldapconn = ldap_connect($ldap_server);
+ if ($ldapconn) {
+ ldap_set_option($ldapconn, LDAP_OPT_PROTOCOL_VERSION, 3);
+ ldap_set_option($ldapconn, LDAP_OPT_REFERRALS, 0);
+ // Bind by bind dn
+ $ldap_bind = ldap_bind($ldapconn, $ldap_bind_dn, $ldap_bind_password);
+ if ($ldap_bind) {
+ $user_info = get_ldap_user_info($ldapconn, $username, $ldap_base_dn);
+ if ($user_info) {
+ $ldap_groups = get_ldap_groups_with_user($ldapconn,
+ $username, $user_info['is_ad']);
+ $user_info['dynamic_member_groups'] = $ldap_groups;
+ return $user_info;
+ }
+ }
+ }
+ return false;
+}
+
+/**
+ * Search user and get 'dn', 'uid', 'fullname' and 'mail'
+ * @param type $ldapconn
+ * @param type $username
+ * @param type $base_dn
+ * @return boolean
+ */
+function get_ldap_user_info($ldapconn, $username, $base_dn) {
+ $username_esc = pkwk_ldap_escape_filter($username);
+ $filter = "(|(uid=$username_esc)(sAMAccountName=$username_esc))";
+ $result1 = ldap_search($ldapconn, $base_dn, $filter, array('dn', 'uid', 'cn', 'samaccountname', 'displayname', 'mail'));
+ $entries = ldap_get_entries($ldapconn, $result1);
+ if (!isset($entries[0])) {
+ return false;
+ }
+ $info = $entries[0];
+ if (isset($info['dn'])) {
+ $user_dn = $info['dn'];
+ $cano_username = $username;
+ $is_active_directory = false;
+ if (isset($info['uid'][0])) {
+ $cano_username = $info['uid'][0];
+ } elseif (isset($info['samaccountname'][0])) {
+ $cano_username = $info['samaccountname'][0];
+ $is_active_directory = true;
+ }
+ $cano_fullname = $username;
+ if (isset($info['displayname'][0])) {
+ $cano_fullname = $info['displayname'][0];
+ } elseif (isset($info['cn'][0])) {
+ $cano_fullname = $info['cn'][0];
+ }
+ return array(
+ 'dn' => $user_dn,
+ 'uid' => $cano_username,
+ 'fullname' => $cano_fullname,
+ 'mail' => $info['mail'][0],
+ 'is_ad' => $is_active_directory,
+ );
+ }
+ return false;
+}
+
+/**
+ * Redirect after login. Need to assing location or page
+ *
+ * @param type $location
+ * @param type $page
+ */
+function form_auth_redirect($location, $page)
+{
+ header('HTTP/1.0 302 Found');
+ if ($location) {
+ header('Location: ' . $location);
+ } else {
+ $url = get_script_uri() . '?' . $page;
+ header('Location: ' . $url);
+ }
+}
+
+/**
+ * Get External Auth log-in URL
+ */
+function get_auth_external_login_url($page, $url_after_login) {
+ global $auth_external_login_url_base;
+ $sep = '&';
+ if (strpos($auth_external_login_url_base, '?') === FALSE) {
+ $sep = '?';
+ }
+ $url = $auth_external_login_url_base . $sep
+ . 'page=' . rawurlencode($page)
+ . '&url_after_login=' . rawurlencode($url_after_login);
+ return $url;
+}
+
+function get_auth_user_prefix() {
+ global $ldap_user_account, $auth_type;
+ global $auth_provider_user_prefix_default;
+ global $auth_provider_user_prefix_ldap;
+ global $auth_provider_user_prefix_external;
+ $user_prefix = '';
+ switch ($auth_type) {
+ case AUTH_TYPE_BASIC:
+ $user_prefix = $auth_provider_user_prefix_default;
+ break;
+ case AUTH_TYPE_EXTERNAL:
+ case AUTH_TYPE_EXTERNAL_REMOTE_USER:
+ case AUTH_TYPE_EXTERNAL_X_FORWARDED_USER:
+ $user_prefix = $auth_provider_user_prefix_external;
+ break;
+ case AUTH_TYPE_FORM:
+ if ($ldap_user_account) {
+ $user_prefix = $auth_provider_user_prefix_ldap;
+ } else {
+ $user_prefix = $auth_provider_user_prefix_default;
+ }
+ break;
+ }
+ return $user_prefix;
+}
+
+function get_ldap_related_groups() {
+ global $read_auth_pages, $edit_auth_pages;
+ global $auth_provider_user_prefix_ldap;
+ $ldap_groups = array();
+ foreach ($read_auth_pages as $pattern=>$groups) {
+ $sp_groups = explode(',', $groups);
+ foreach ($sp_groups as $group) {
+ if (strpos($group, $auth_provider_user_prefix_ldap) === 0) {
+ $ldap_groups[] = $group;
+ }
+ }
+ }
+ foreach ($edit_auth_pages as $pattern=>$groups) {
+ $sp_groups = explode(',', $groups);
+ foreach ($sp_groups as $group) {
+ if (strpos($group, $auth_provider_user_prefix_ldap) === 0) {
+ $ldap_groups[] = $group;
+ }
+ }
+ }
+ $ldap_groups_unique = array_values(array_unique($ldap_groups));
+ return $ldap_groups_unique;
+}
+
+/**
+ * Get LDAP groups user belongs to
+ *
+ * @param Resource $ldapconn
+ * @param String $user
+ * @param bool $is_ad
+ * @return Array
+ */
+function get_ldap_groups_with_user($ldapconn, $user, $is_ad) {
+ global $auth_provider_user_prefix_ldap;
+ global $ldap_base_dn;
+ $related_groups = get_ldap_related_groups();
+ if (count($related_groups) == 0) {
+ return array();
+ }
+ $gfilter = '(|';
+ foreach ($related_groups as $group_full) {
+ $g = substr($group_full, strlen($auth_provider_user_prefix_ldap));
+ $gfilter .= sprintf('(cn=%s)', pkwk_ldap_escape_filter($g));
+ if ($is_ad) {
+ $gfilter .= sprintf('(sAMAccountName=%s)', pkwk_ldap_escape_filter($g));
+ }
+ }
+ $gfilter .= ')';
+ $result_g = ldap_search($ldapconn, $ldap_base_dn, $gfilter,
+ array('dn', 'uid', 'cn', 'samaccountname'));
+ $entries = ldap_get_entries($ldapconn, $result_g);
+ if (!isset($entries[0])) {
+ return false;
+ }
+ if (!$entries) {
+ return array();
+ }
+ $entry_count = $entries['count'];
+ $group_list = array();
+ for ($i = 0; $i < $entry_count; $i++) {
+ $group_name = $entries[$i]['cn'][0];
+ if ($is_ad) {
+ $group_name = $entries[$i]['samaccountname'][0];
+ }
+ $group_list[] = array(
+ 'name' => $group_name,
+ 'dn' => $entries[$i]['dn']
+ );
+ }
+ $groups_member = array();
+ $groups_nonmember = array();
+ foreach ($group_list as $gp) {
+ $fmt = '(&(uid=%s)(memberOf=%s))';
+ if ($is_ad) {
+ // LDAP_MATCHING_RULE_IN_CHAIN: Active Directory specific rule
+ $fmt = '(&(sAMAccountName=%s)(memberOf:1.2.840.113556.1.4.1941:=%s))';
+ }
+ $user_gfilter = sprintf($fmt,
+ pkwk_ldap_escape_filter($user),
+ pkwk_ldap_escape_filter($gp['dn']));
+ $result_e = ldap_search($ldapconn, $ldap_base_dn, $user_gfilter,
+ array('dn'), 0, 1);
+ $user_e = ldap_get_entries($ldapconn, $result_e);
+ if (isset($user_e['count']) && $user_e['count'] > 0) {
+ $groups_member[] = $gp['name'];
+ } else {
+ $groups_nonmember[] = $gp['name'];
+ }
+ }
+ $groups_full = array();
+ foreach ($groups_member as $g) {
+ $groups_full[] = $auth_provider_user_prefix_ldap . $g;
+ }
+ return $groups_full;
+}