<?php
// PukiWiki - Yet another WikiWikiWeb clone
-// $Id: auth.php,v 1.22 2011/01/25 15:01:01 henoheno Exp $
-// Copyright (C) 2003-2005, 2007 PukiWiki Developers Team
+// auth.php
+// Copyright 2003-2017 PukiWiki Development Team
// License: GPL v2 or (at your option) any later version
//
// Authentication related functions
define('AUTH_TYPE_EXTERNAL_REMOTE_USER', 4);
define('AUTH_TYPE_EXTERNAL_X_FORWARDED_USER', 5);
+define('AUTH_TYPE_SAML', 6);
// Passwd-auth related ----
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 ----
// Check edit-permission
-function check_editable($page, $auth_flag = TRUE, $exit_flag = TRUE)
+function check_editable($page, $auth_enabled = TRUE, $exit_on_fail = TRUE)
{
- global $script, $_title_cannotedit, $_msg_unfreeze;
+ global $_title_cannotedit, $_msg_unfreeze;
- if (edit_auth($page, $auth_flag, $exit_flag) && is_editable($page)) {
+ if (edit_auth($page, $auth_enabled, $exit_on_fail) && is_editable($page)) {
// Editable
return TRUE;
} else {
// Not editable
- if ($exit_flag === FALSE) {
+ if ($exit_on_fail === FALSE) {
return FALSE; // Without exit
} else {
// With exit
$body = $title = str_replace('$1',
htmlsc(strip_bracket($page)), $_title_cannotedit);
if (is_freeze($page))
- $body .= '(<a href="' . $script . '?cmd=unfreeze&page=' .
+ $body .= '(<a href="' . get_base_uri() . '?cmd=unfreeze&page=' .
rawurlencode($page) . '">' . $_msg_unfreeze . '</a>)';
$page = str_replace('$1', make_search($page), $_title_cannotedit);
catbody($title, $page, $body);
}
}
-// Check read-permission
-function check_readable($page, $auth_flag = TRUE, $exit_flag = TRUE)
-{
- return read_auth($page, $auth_flag, $exit_flag);
+/**
+ * Whether the page is readable from current user or not.
+ */
+function is_page_readable($page) {
+ global $read_auth_pages;
+ return _is_page_accessible($page, $read_auth_pages);
}
-function edit_auth($page, $auth_flag = TRUE, $exit_flag = TRUE)
-{
- global $edit_auth, $edit_auth_pages, $_title_cannotedit;
- return $edit_auth ? basic_auth($page, $auth_flag, $exit_flag,
- $edit_auth_pages, $_title_cannotedit) : TRUE;
+/**
+ * Whether the page is writable from current user or not.
+ */
+function is_page_writable($page) {
+ global $edit_auth_pages;
+ return _is_page_accessible($page, $edit_auth_pages);
}
-function read_auth($page, $auth_flag = TRUE, $exit_flag = TRUE)
-{
- global $read_auth, $read_auth_pages, $_title_cannotread;
- return $read_auth ? basic_auth($page, $auth_flag, $exit_flag,
- $read_auth_pages, $_title_cannotread) : TRUE;
-}
+/**
+ * Get whether a current auth user can access the page
+ *
+ * @param $page page name
+ * @param $auth_pages pagepattern -> groups map
+ * @return true if a current user can access the page
+ */
+function _is_page_accessible($page, $auth_pages) {
+ global $auth_method_type, $auth_user_groups, $auth_user;
-// Basic authentication
-function basic_auth($page, $auth_flag, $exit_flag, $auth_pages, $title_cannot)
-{
- 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') {
} else if ($auth_method_type == 'contents') {
$target_str = join('', get_source($page)); // Its contents
}
-
$user_list = array();
- foreach($auth_pages as $key=>$val)
- if (preg_match($key, $target_str))
+ foreach($auth_pages as $key=>$val) {
+ if (preg_match($key, $target_str)) {
$user_list = array_merge($user_list, explode(',', $val));
-
+ }
+ }
if (empty($user_list)) return TRUE; // No limit
+ if (!$auth_user) {
+ // Current user doesen't yet log in.
+ return FALSE;
+ }
+ if (count(array_intersect($auth_user_groups, $user_list)) === 0) {
+ return FALSE;
+ }
+ return TRUE;
+}
- $matches = array();
- if (PKWK_READONLY ||
- ! $auth_user ||
- count(array_intersect($auth_user_groups, $user_list)) === 0)
- {
+/**
+ * Ensure the page is readable, or show Login UI.
+ * @param $page page
+ */
+function ensure_page_readable($page) {
+ global $read_auth, $read_auth_pages, $_title_cannotread;
+ if (!$read_auth) {
+ return true;
+ }
+ return basic_auth($page, true, true,
+ $read_auth_pages, $_title_cannotread);
+}
+
+/**
+ * Ensure the page is writable, or show Login UI.
+ * @param $page page
+ */
+function ensure_page_writable($page) {
+ global $edit_auth, $edit_auth_pages, $_title_cannotedit;
+ if (!$edit_auth) {
+ return true;
+ }
+ return basic_auth($page, true, true,
+ $edit_auth_pages, $_title_cannotedit);
+}
+
+/**
+ * Check a page is readable or not, show Auth UI in some cases.
+ *
+ * @param $page page name
+ * @param $auth_enabled true if auth is available (Normally true)
+ * @param $exit_on_fail (Normally true)
+ * @return true if the page is readable
+ */
+function check_readable($page, $auth_enabled = TRUE, $exit_on_fail = TRUE)
+{
+ return read_auth($page, $auth_enabled, $exit_on_fail);
+}
+
+function edit_auth($page, $auth_enabled = TRUE, $exit_on_fail = TRUE)
+{
+ global $edit_auth, $edit_auth_pages, $_title_cannotedit;
+ return $edit_auth ? basic_auth($page, $auth_enabled, $exit_on_fail,
+ $edit_auth_pages, $_title_cannotedit) : TRUE;
+}
+
+function read_auth($page, $auth_enabled = TRUE, $exit_on_fail = TRUE)
+{
+ global $read_auth, $read_auth_pages, $_title_cannotread;
+ return $read_auth ? basic_auth($page, $auth_enabled, $exit_on_fail,
+ $read_auth_pages, $_title_cannotread) : TRUE;
+}
+
+/**
+ * Authentication
+ *
+ * @param $page page name
+ * @param $auth_enabled true if auth is available
+ * @param $exit_on_fail Show forbidden message and stop all following processes
+ * @param $auth_pages accessible users -> pages pattern map
+ * @param $title_cannot forbidden message
+ */
+function basic_auth($page, $auth_enabled, $exit_on_fail, $auth_pages, $title_cannot)
+{
+ global $auth_users, $_msg_auth, $auth_user;
+ global $auth_type, $g_query_string;
+ $is_accessible = _is_page_accessible($page, $auth_pages);
+ if ($is_accessible) {
+ return TRUE;
+ } else {
// Auth failed
pkwk_common_headers();
- if ($auth_flag && !$auth_user) {
+ if ($auth_enabled && !$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'
+ $url_after_login = get_base_uri() . '?' . $g_query_string;
+ $loginurl = get_base_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;
+ } elseif (AUTH_TYPE_EXTERNAL === $auth_type ||
+ AUTH_TYPE_SAML === $auth_type) {
+ $url_after_login = get_base_uri(PKWK_URI_ABSOLUTE) . '?' . $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) {
+ if ($exit_on_fail) {
$body = $title = str_replace('$1',
htmlsc(strip_bracket($page)), $title_cannot);
$page = str_replace('$1', make_search($page), $title_cannot);
exit;
}
return FALSE;
- } else {
- return TRUE;
}
}
{
global $auth_type, $auth_users, $_msg_auth, $auth_user, $auth_groups;
global $auth_user_groups, $auth_user_fullname;
- global $auth_provider_user_prefix;
+ 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:
+ case AUTH_TYPE_SAML:
+ 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:
{
header('HTTP/1.0 401 Unauthorized');
}
$auth_user = '';
- $auth_user_groups = get_groups_from_username($user);
+ $auth_user_groups = array();
return true; // no auth input
}
case AUTH_TYPE_FORM:
case AUTH_TYPE_EXTERNAL:
+ case AUTH_TYPE_SAML:
{
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 {
- if ($auth_type === AUTH_TYPE_EXTERNAL && $ldap_user_account) {
+ $fullname = $user;
+ if (($auth_type === AUTH_TYPE_EXTERNAL || $auth_type === AUTH_TYPE_SAML) &&
+ $ldap_user_account) {
$ldap_user_info = ldap_get_simple_user_info($user);
if ($ldap_user_info) {
$fullname = $ldap_user_info['fullname'];
- $_SESSION['authenticated_user_fullname'] = $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:
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
}
$groups[] = $group;
}
}
- // Implecit group that has same name as user itself
+ // Implicit group that has same name as user itself
$groups[] = $user;
// 'valid-user' group for
$valid_user = 'valid-user';
function ldap_auth($username, $password)
{
- global $ldap_url, $ldap_bind_dn, $ldap_bind_password;
- if (preg_match('#^(ldap\:\/\/[^/]+/)(.*)$#', $ldap_url, $m)) {
- $ldap_server = $m[1];
- $ldap_base_dn = $m[2];
- $ldapconn = ldap_connect($ldap_server);
- if ($ldapconn) {
- ldap_set_option($ldapconn, LDAP_OPT_PROTOCOL_VERSION, 3);
- if (preg_match('#\$login\b#', $ldap_bind_dn)) {
- // Bind by user credential
- $bind_dn_user = preg_replace('#\$login#', $username, $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) {
+ 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;
}
}
- } 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) {
- session_regenerate_id(true); // require: PHP5.1+
- $_SESSION['authenticated_user'] = $user_info['uid'];
- $_SESSION['authenticated_user_fullname'] = $user_info['fullname'];
- return true;
- }
- }
- }
}
}
}
// Get LDAP user info via bind DN
function ldap_get_simple_user_info($username)
{
- global $ldap_url, $ldap_bind_dn, $ldap_bind_password;
- if (preg_match('#^(ldap\:\/\/[^/]+/)(.*)$#', $ldap_url, $m)) {
- $ldap_server = $m[1];
- $ldap_base_dn = $m[2];
- $ldapconn = ldap_connect($ldap_server);
- if ($ldapconn) {
- ldap_set_option($ldapconn, LDAP_OPT_PROTOCOL_VERSION, 3);
- // 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) {
- return $user_info;
- }
+ 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 boolean
*/
function get_ldap_user_info($ldapconn, $username, $base_dn) {
- $filter = "(|(uid=$username)(sAMAccountName=$username))";
+ $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])) {
'dn' => $user_dn,
'uid' => $cano_username,
'fullname' => $cano_fullname,
- 'mail' => $info['mail'][0]
+ 'mail' => $info['mail'][0],
+ 'is_ad' => $is_active_directory,
);
}
return false;
if ($location) {
header('Location: ' . $location);
} else {
- $url = get_script_uri() . '?' . $page;
+ $url = get_page_uri($page, PKWK_URI_ROOT);
header('Location: ' . $url);
}
}
. '&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;
+ global $auth_provider_user_prefix_saml;
+ $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_SAML:
+ $user_prefix = $auth_provider_user_prefix_saml;
+ 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;
+}
OSDN Git Service
