diff options
Diffstat (limited to 'phpBB/phpbb/auth')
| -rw-r--r-- | phpBB/phpbb/auth/auth.php | 1089 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/index.htm | 10 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/apache.php | 264 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/base.php | 108 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/db.php | 235 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/index.htm | 10 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/ldap.php | 349 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/oauth.php | 621 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/base.php | 51 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/bitly.php | 94 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/exception.php | 21 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/facebook.php | 94 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/google.php | 105 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/service/service_interface.php | 73 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/oauth/token_storage.php | 363 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider/provider_interface.php | 193 | ||||
| -rw-r--r-- | phpBB/phpbb/auth/provider_collection.php | 65 | 
17 files changed, 3745 insertions, 0 deletions
diff --git a/phpBB/phpbb/auth/auth.php b/phpBB/phpbb/auth/auth.php new file mode 100644 index 0000000000..65249275d4 --- /dev/null +++ b/phpBB/phpbb/auth/auth.php @@ -0,0 +1,1089 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth; + +/** +* Permission/Auth class +*/ +class auth +{ +	var $acl = array(); +	var $cache = array(); +	var $acl_options = array(); +	var $acl_forum_ids = false; + +	/** +	* Init permissions +	*/ +	function acl(&$userdata) +	{ +		global $db, $cache; + +		$this->acl = $this->cache = $this->acl_options = array(); +		$this->acl_forum_ids = false; + +		if (($this->acl_options = $cache->get('_acl_options')) === false) +		{ +			$sql = 'SELECT auth_option_id, auth_option, is_global, is_local +				FROM ' . ACL_OPTIONS_TABLE . ' +				ORDER BY auth_option_id'; +			$result = $db->sql_query($sql); + +			$global = $local = 0; +			$this->acl_options = array(); +			while ($row = $db->sql_fetchrow($result)) +			{ +				if ($row['is_global']) +				{ +					$this->acl_options['global'][$row['auth_option']] = $global++; +				} + +				if ($row['is_local']) +				{ +					$this->acl_options['local'][$row['auth_option']] = $local++; +				} + +				$this->acl_options['id'][$row['auth_option']] = (int) $row['auth_option_id']; +				$this->acl_options['option'][(int) $row['auth_option_id']] = $row['auth_option']; +			} +			$db->sql_freeresult($result); + +			$cache->put('_acl_options', $this->acl_options); +		} + +		if (!trim($userdata['user_permissions'])) +		{ +			$this->acl_cache($userdata); +		} + +		// Fill ACL array +		$this->_fill_acl($userdata['user_permissions']); + +		// Verify bitstring length with options provided... +		$renew = false; +		$global_length = sizeof($this->acl_options['global']); +		$local_length = sizeof($this->acl_options['local']); + +		// Specify comparing length (bitstring is padded to 31 bits) +		$global_length = ($global_length % 31) ? ($global_length - ($global_length % 31) + 31) : $global_length; +		$local_length = ($local_length % 31) ? ($local_length - ($local_length % 31) + 31) : $local_length; + +		// You thought we are finished now? Noooo... now compare them. +		foreach ($this->acl as $forum_id => $bitstring) +		{ +			if (($forum_id && strlen($bitstring) != $local_length) || (!$forum_id && strlen($bitstring) != $global_length)) +			{ +				$renew = true; +				break; +			} +		} + +		// If a bitstring within the list does not match the options, we have a user with incorrect permissions set and need to renew them +		if ($renew) +		{ +			$this->acl_cache($userdata); +			$this->_fill_acl($userdata['user_permissions']); +		} + +		return; +	} + +	/** +	* Retrieves data wanted by acl function from the database for the +	* specified user. +	* +	* @param int $user_id User ID +	* @return array User attributes +	*/ +	public function obtain_user_data($user_id) +	{ +		global $db; + +		$sql = 'SELECT user_id, username, user_permissions, user_type +			FROM ' . USERS_TABLE . ' +			WHERE user_id = ' . $user_id; +		$result = $db->sql_query($sql); +		$user_data = $db->sql_fetchrow($result); +		$db->sql_freeresult($result); +		return $user_data; +	} + +	/** +	* Fill ACL array with relevant bitstrings from user_permissions column +	* @access private +	*/ +	function _fill_acl($user_permissions) +	{ +		$seq_cache = array(); +		$this->acl = array(); +		$user_permissions = explode("\n", $user_permissions); + +		foreach ($user_permissions as $f => $seq) +		{ +			if ($seq) +			{ +				$i = 0; + +				if (!isset($this->acl[$f])) +				{ +					$this->acl[$f] = ''; +				} + +				while ($subseq = substr($seq, $i, 6)) +				{ +					if (isset($seq_cache[$subseq])) +					{ +						$converted = $seq_cache[$subseq]; +					} +					else +					{ +						$converted = $seq_cache[$subseq] = str_pad(base_convert($subseq, 36, 2), 31, 0, STR_PAD_LEFT); +					} + +					// We put the original bitstring into the acl array +					$this->acl[$f] .= $converted; +					$i += 6; +				} +			} +		} +	} + +	/** +	* Look up an option +	* if the option is prefixed with !, then the result becomes negated +	* +	* If a forum id is specified the local option will be combined with a global option if one exist. +	* If a forum id is not specified, only the global option will be checked. +	*/ +	function acl_get($opt, $f = 0) +	{ +		$negate = false; + +		if (strpos($opt, '!') === 0) +		{ +			$negate = true; +			$opt = substr($opt, 1); +		} + +		if (!isset($this->cache[$f][$opt])) +		{ +			// We combine the global/local option with an OR because some options are global and local. +			// If the user has the global permission the local one is true too and vice versa +			$this->cache[$f][$opt] = false; + +			// Is this option a global permission setting? +			if (isset($this->acl_options['global'][$opt])) +			{ +				if (isset($this->acl[0])) +				{ +					$this->cache[$f][$opt] = $this->acl[0][$this->acl_options['global'][$opt]]; +				} +			} + +			// Is this option a local permission setting? +			// But if we check for a global option only, we won't combine the options... +			if ($f != 0 && isset($this->acl_options['local'][$opt])) +			{ +				if (isset($this->acl[$f]) && isset($this->acl[$f][$this->acl_options['local'][$opt]])) +				{ +					$this->cache[$f][$opt] |= $this->acl[$f][$this->acl_options['local'][$opt]]; +				} +			} +		} + +		// Founder always has all global options set to true... +		return ($negate) ? !$this->cache[$f][$opt] : $this->cache[$f][$opt]; +	} + +	/** +	* Get forums with the specified permission setting +	* if the option is prefixed with !, then the result becomes negated +	* +	* @param bool $clean set to true if only values needs to be returned which are set/unset +	*/ +	function acl_getf($opt, $clean = false) +	{ +		$acl_f = array(); +		$negate = false; + +		if (strpos($opt, '!') === 0) +		{ +			$negate = true; +			$opt = substr($opt, 1); +		} + +		// If we retrieve a list of forums not having permissions in, we need to get every forum_id +		if ($negate) +		{ +			if ($this->acl_forum_ids === false) +			{ +				global $db; + +				$sql = 'SELECT forum_id +					FROM ' . FORUMS_TABLE; + +				if (sizeof($this->acl)) +				{ +					$sql .= ' WHERE ' . $db->sql_in_set('forum_id', array_keys($this->acl), true); +				} +				$result = $db->sql_query($sql); + +				$this->acl_forum_ids = array(); +				while ($row = $db->sql_fetchrow($result)) +				{ +					$this->acl_forum_ids[] = $row['forum_id']; +				} +				$db->sql_freeresult($result); +			} +		} + +		if (isset($this->acl_options['local'][$opt])) +		{ +			foreach ($this->acl as $f => $bitstring) +			{ +				// Skip global settings +				if (!$f) +				{ +					continue; +				} + +				$allowed = (!isset($this->cache[$f][$opt])) ? $this->acl_get($opt, $f) : $this->cache[$f][$opt]; + +				if (!$clean) +				{ +					$acl_f[$f][$opt] = ($negate) ? !$allowed : $allowed; +				} +				else +				{ +					if (($negate && !$allowed) || (!$negate && $allowed)) +					{ +						$acl_f[$f][$opt] = 1; +					} +				} +			} +		} + +		// If we get forum_ids not having this permission, we need to fill the remaining parts +		if ($negate && sizeof($this->acl_forum_ids)) +		{ +			foreach ($this->acl_forum_ids as $f) +			{ +				$acl_f[$f][$opt] = 1; +			} +		} + +		return $acl_f; +	} + +	/** +	* Get local permission state for any forum. +	* +	* Returns true if user has the permission in one or more forums, false if in no forum. +	* If global option is checked it returns the global state (same as acl_get($opt)) +	* Local option has precedence... +	*/ +	function acl_getf_global($opt) +	{ +		if (is_array($opt)) +		{ +			// evaluates to true as soon as acl_getf_global is true for one option +			foreach ($opt as $check_option) +			{ +				if ($this->acl_getf_global($check_option)) +				{ +					return true; +				} +			} + +			return false; +		} + +		if (isset($this->acl_options['local'][$opt])) +		{ +			foreach ($this->acl as $f => $bitstring) +			{ +				// Skip global settings +				if (!$f) +				{ +					continue; +				} + +				// as soon as the user has any permission we're done so return true +				if ((!isset($this->cache[$f][$opt])) ? $this->acl_get($opt, $f) : $this->cache[$f][$opt]) +				{ +					return true; +				} +			} +		} +		else if (isset($this->acl_options['global'][$opt])) +		{ +			return $this->acl_get($opt); +		} + +		return false; +	} + +	/** +	* Get permission settings (more than one) +	*/ +	function acl_gets() +	{ +		$args = func_get_args(); +		$f = array_pop($args); + +		if (!is_numeric($f)) +		{ +			$args[] = $f; +			$f = 0; +		} + +		// alternate syntax: acl_gets(array('m_', 'a_'), $forum_id) +		if (is_array($args[0])) +		{ +			$args = $args[0]; +		} + +		$acl = 0; +		foreach ($args as $opt) +		{ +			$acl |= $this->acl_get($opt, $f); +		} + +		return $acl; +	} + +	/** +	* Get permission listing based on user_id/options/forum_ids +	* +	* Be careful when using this function with permissions a_, m_, u_ and f_ ! +	* It may not work correctly. When a user group grants an a_* permission, +	* e.g. a_foo, but the user's a_foo permission is set to "Never", then +	* the user does not in fact have the a_ permission. +	* But the user will still be listed as having the a_ permission. +	* +	* For more information see: http://tracker.phpbb.com/browse/PHPBB3-10252 +	*/ +	function acl_get_list($user_id = false, $opts = false, $forum_id = false) +	{ +		if ($user_id !== false && !is_array($user_id) && $opts === false && $forum_id === false) +		{ +			$hold_ary = array($user_id => $this->acl_raw_data_single_user($user_id)); +		} +		else +		{ +			$hold_ary = $this->acl_raw_data($user_id, $opts, $forum_id); +		} + +		$auth_ary = array(); +		foreach ($hold_ary as $user_id => $forum_ary) +		{ +			foreach ($forum_ary as $forum_id => $auth_option_ary) +			{ +				foreach ($auth_option_ary as $auth_option => $auth_setting) +				{ +					if ($auth_setting) +					{ +						$auth_ary[$forum_id][$auth_option][] = $user_id; +					} +				} +			} +		} + +		return $auth_ary; +	} + +	/** +	* Cache data to user_permissions row +	*/ +	function acl_cache(&$userdata) +	{ +		global $db; + +		// Empty user_permissions +		$userdata['user_permissions'] = ''; + +		$hold_ary = $this->acl_raw_data_single_user($userdata['user_id']); + +		// Key 0 in $hold_ary are global options, all others are forum_ids + +		// If this user is founder we're going to force fill the admin options ... +		if ($userdata['user_type'] == USER_FOUNDER) +		{ +			foreach ($this->acl_options['global'] as $opt => $id) +			{ +				if (strpos($opt, 'a_') === 0) +				{ +					$hold_ary[0][$this->acl_options['id'][$opt]] = ACL_YES; +				} +			} +		} + +		$hold_str = $this->build_bitstring($hold_ary); + +		if ($hold_str) +		{ +			$userdata['user_permissions'] = $hold_str; + +			$sql = 'UPDATE ' . USERS_TABLE . " +				SET user_permissions = '" . $db->sql_escape($userdata['user_permissions']) . "', +					user_perm_from = 0 +				WHERE user_id = " . $userdata['user_id']; +			$db->sql_query($sql); +		} + +		return; +	} + +	/** +	* Build bitstring from permission set +	*/ +	function build_bitstring(&$hold_ary) +	{ +		$hold_str = ''; + +		if (sizeof($hold_ary)) +		{ +			ksort($hold_ary); + +			$last_f = 0; + +			foreach ($hold_ary as $f => $auth_ary) +			{ +				$ary_key = (!$f) ? 'global' : 'local'; + +				$bitstring = array(); +				foreach ($this->acl_options[$ary_key] as $opt => $id) +				{ +					if (isset($auth_ary[$this->acl_options['id'][$opt]])) +					{ +						$bitstring[$id] = $auth_ary[$this->acl_options['id'][$opt]]; + +						$option_key = substr($opt, 0, strpos($opt, '_') + 1); + +						// If one option is allowed, the global permission for this option has to be allowed too +						// example: if the user has the a_ permission this means he has one or more a_* permissions +						if ($auth_ary[$this->acl_options['id'][$opt]] == ACL_YES && (!isset($bitstring[$this->acl_options[$ary_key][$option_key]]) || $bitstring[$this->acl_options[$ary_key][$option_key]] == ACL_NEVER)) +						{ +							$bitstring[$this->acl_options[$ary_key][$option_key]] = ACL_YES; +						} +					} +					else +					{ +						$bitstring[$id] = ACL_NEVER; +					} +				} + +				// Now this bitstring defines the permission setting for the current forum $f (or global setting) +				$bitstring = implode('', $bitstring); + +				// The line number indicates the id, therefore we have to add empty lines for those ids not present +				$hold_str .= str_repeat("\n", $f - $last_f); + +				// Convert bitstring for storage - we do not use binary/bytes because PHP's string functions are not fully binary safe +				for ($i = 0, $bit_length = strlen($bitstring); $i < $bit_length; $i += 31) +				{ +					$hold_str .= str_pad(base_convert(str_pad(substr($bitstring, $i, 31), 31, 0, STR_PAD_RIGHT), 2, 36), 6, 0, STR_PAD_LEFT); +				} + +				$last_f = $f; +			} +			unset($bitstring); + +			$hold_str = rtrim($hold_str); +		} + +		return $hold_str; +	} + +	/** +	* Clear one or all users cached permission settings +	*/ +	function acl_clear_prefetch($user_id = false) +	{ +		global $db, $cache; + +		// Rebuild options cache +		$cache->destroy('_role_cache'); + +		$sql = 'SELECT * +			FROM ' . ACL_ROLES_DATA_TABLE . ' +			ORDER BY role_id ASC'; +		$result = $db->sql_query($sql); + +		$this->role_cache = array(); +		while ($row = $db->sql_fetchrow($result)) +		{ +			$this->role_cache[$row['role_id']][$row['auth_option_id']] = (int) $row['auth_setting']; +		} +		$db->sql_freeresult($result); + +		foreach ($this->role_cache as $role_id => $role_options) +		{ +			$this->role_cache[$role_id] = serialize($role_options); +		} + +		$cache->put('_role_cache', $this->role_cache); + +		// Now empty user permissions +		$where_sql = ''; + +		if ($user_id !== false) +		{ +			$user_id = (!is_array($user_id)) ? $user_id = array((int) $user_id) : array_map('intval', $user_id); +			$where_sql = ' WHERE ' . $db->sql_in_set('user_id', $user_id); +		} + +		$sql = 'UPDATE ' . USERS_TABLE . " +			SET user_permissions = '', +				user_perm_from = 0 +			$where_sql"; +		$db->sql_query($sql); + +		return; +	} + +	/** +	* Get assigned roles +	*/ +	function acl_role_data($user_type, $role_type, $ug_id = false, $forum_id = false) +	{ +		global $db; + +		$roles = array(); + +		$sql_id = ($user_type == 'user') ? 'user_id' : 'group_id'; + +		$sql_ug = ($ug_id !== false) ? ((!is_array($ug_id)) ? "AND a.$sql_id = $ug_id" : 'AND ' . $db->sql_in_set("a.$sql_id", $ug_id)) : ''; +		$sql_forum = ($forum_id !== false) ? ((!is_array($forum_id)) ? "AND a.forum_id = $forum_id" : 'AND ' . $db->sql_in_set('a.forum_id', $forum_id)) : ''; + +		// Grab assigned roles... +		$sql = 'SELECT a.auth_role_id, a.' . $sql_id . ', a.forum_id +			FROM ' . (($user_type == 'user') ? ACL_USERS_TABLE : ACL_GROUPS_TABLE) . ' a, ' . ACL_ROLES_TABLE . " r +			WHERE a.auth_role_id = r.role_id +				AND r.role_type = '" . $db->sql_escape($role_type) . "' +				$sql_ug +				$sql_forum +			ORDER BY r.role_order ASC"; +		$result = $db->sql_query($sql); + +		while ($row = $db->sql_fetchrow($result)) +		{ +			$roles[$row[$sql_id]][$row['forum_id']] = $row['auth_role_id']; +		} +		$db->sql_freeresult($result); + +		return $roles; +	} + +	/** +	* Get raw acl data based on user/option/forum +	*/ +	function acl_raw_data($user_id = false, $opts = false, $forum_id = false) +	{ +		global $db; + +		$sql_user = ($user_id !== false) ? ((!is_array($user_id)) ? 'user_id = ' . (int) $user_id : $db->sql_in_set('user_id', array_map('intval', $user_id))) : ''; +		$sql_forum = ($forum_id !== false) ? ((!is_array($forum_id)) ? 'AND a.forum_id = ' . (int) $forum_id : 'AND ' . $db->sql_in_set('a.forum_id', array_map('intval', $forum_id))) : ''; + +		$sql_opts = $sql_opts_select = $sql_opts_from = ''; +		$hold_ary = array(); + +		if ($opts !== false) +		{ +			$sql_opts_select = ', ao.auth_option'; +			$sql_opts_from = ', ' . ACL_OPTIONS_TABLE . ' ao'; +			$this->build_auth_option_statement('ao.auth_option', $opts, $sql_opts); +		} + +		$sql_ary = array(); + +		// Grab non-role settings - user-specific +		$sql_ary[] = 'SELECT a.user_id, a.forum_id, a.auth_setting, a.auth_option_id' . $sql_opts_select . ' +			FROM ' . ACL_USERS_TABLE . ' a' . $sql_opts_from . ' +			WHERE a.auth_role_id = 0 ' . +				(($sql_opts_from) ? 'AND a.auth_option_id = ao.auth_option_id ' : '') . +				(($sql_user) ? 'AND a.' . $sql_user : '') . " +				$sql_forum +				$sql_opts"; + +		// Now the role settings - user-specific +		$sql_ary[] = 'SELECT a.user_id, a.forum_id, r.auth_option_id, r.auth_setting, r.auth_option_id' . $sql_opts_select . ' +			FROM ' . ACL_USERS_TABLE . ' a, ' . ACL_ROLES_DATA_TABLE . ' r' . $sql_opts_from . ' +			WHERE a.auth_role_id = r.role_id ' . +				(($sql_opts_from) ? 'AND r.auth_option_id = ao.auth_option_id ' : '') . +				(($sql_user) ? 'AND a.' . $sql_user : '') . " +				$sql_forum +				$sql_opts"; + +		foreach ($sql_ary as $sql) +		{ +			$result = $db->sql_query($sql); + +			while ($row = $db->sql_fetchrow($result)) +			{ +				$option = ($sql_opts_select) ? $row['auth_option'] : $this->acl_options['option'][$row['auth_option_id']]; +				$hold_ary[$row['user_id']][$row['forum_id']][$option] = $row['auth_setting']; +			} +			$db->sql_freeresult($result); +		} + +		$sql_ary = array(); + +		// Now grab group settings - non-role specific... +		$sql_ary[] = 'SELECT ug.user_id, a.forum_id, a.auth_setting, a.auth_option_id' . $sql_opts_select . ' +			FROM ' . ACL_GROUPS_TABLE . ' a, ' . USER_GROUP_TABLE . ' ug, ' . GROUPS_TABLE . ' g' . $sql_opts_from . ' +			WHERE a.auth_role_id = 0 ' . +				(($sql_opts_from) ? 'AND a.auth_option_id = ao.auth_option_id ' : '') . ' +				AND a.group_id = ug.group_id +				AND g.group_id = ug.group_id +				AND ug.user_pending = 0 +				AND NOT (ug.group_leader = 1 AND g.group_skip_auth = 1) +				' . (($sql_user) ? 'AND ug.' . $sql_user : '') . " +				$sql_forum +				$sql_opts"; + +		// Now grab group settings - role specific... +		$sql_ary[] = 'SELECT ug.user_id, a.forum_id, r.auth_setting, r.auth_option_id' . $sql_opts_select . ' +			FROM ' . ACL_GROUPS_TABLE . ' a, ' . USER_GROUP_TABLE . ' ug, ' . GROUPS_TABLE . ' g, ' . ACL_ROLES_DATA_TABLE . ' r' . $sql_opts_from . ' +			WHERE a.auth_role_id = r.role_id ' . +				(($sql_opts_from) ? 'AND r.auth_option_id = ao.auth_option_id ' : '') . ' +				AND a.group_id = ug.group_id +				AND g.group_id = ug.group_id +				AND ug.user_pending = 0 +				AND NOT (ug.group_leader = 1 AND g.group_skip_auth = 1) +				' . (($sql_user) ? 'AND ug.' . $sql_user : '') . " +				$sql_forum +				$sql_opts"; + +		foreach ($sql_ary as $sql) +		{ +			$result = $db->sql_query($sql); + +			while ($row = $db->sql_fetchrow($result)) +			{ +				$option = ($sql_opts_select) ? $row['auth_option'] : $this->acl_options['option'][$row['auth_option_id']]; + +				if (!isset($hold_ary[$row['user_id']][$row['forum_id']][$option]) || (isset($hold_ary[$row['user_id']][$row['forum_id']][$option]) && $hold_ary[$row['user_id']][$row['forum_id']][$option] != ACL_NEVER)) +				{ +					$hold_ary[$row['user_id']][$row['forum_id']][$option] = $row['auth_setting']; + +					// If we detect ACL_NEVER, we will unset the flag option (within building the bitstring it is correctly set again) +					if ($row['auth_setting'] == ACL_NEVER) +					{ +						$flag = substr($option, 0, strpos($option, '_') + 1); + +						if (isset($hold_ary[$row['user_id']][$row['forum_id']][$flag]) && $hold_ary[$row['user_id']][$row['forum_id']][$flag] == ACL_YES) +						{ +							unset($hold_ary[$row['user_id']][$row['forum_id']][$flag]); + +/*							if (in_array(ACL_YES, $hold_ary[$row['user_id']][$row['forum_id']])) +							{ +								$hold_ary[$row['user_id']][$row['forum_id']][$flag] = ACL_YES; +							} +*/ +						} +					} +				} +			} +			$db->sql_freeresult($result); +		} + +		return $hold_ary; +	} + +	/** +	* Get raw user based permission settings +	*/ +	function acl_user_raw_data($user_id = false, $opts = false, $forum_id = false) +	{ +		global $db; + +		$sql_user = ($user_id !== false) ? ((!is_array($user_id)) ? 'user_id = ' . (int) $user_id : $db->sql_in_set('user_id', array_map('intval', $user_id))) : ''; +		$sql_forum = ($forum_id !== false) ? ((!is_array($forum_id)) ? 'AND a.forum_id = ' . (int) $forum_id : 'AND ' . $db->sql_in_set('a.forum_id', array_map('intval', $forum_id))) : ''; + +		$sql_opts = ''; +		$hold_ary = $sql_ary = array(); + +		if ($opts !== false) +		{ +			$this->build_auth_option_statement('ao.auth_option', $opts, $sql_opts); +		} + +		// Grab user settings - non-role specific... +		$sql_ary[] = 'SELECT a.user_id, a.forum_id, a.auth_setting, a.auth_option_id, ao.auth_option +			FROM ' . ACL_USERS_TABLE . ' a, ' . ACL_OPTIONS_TABLE . ' ao +			WHERE a.auth_role_id = 0 +				AND a.auth_option_id = ao.auth_option_id ' . +				(($sql_user) ? 'AND a.' . $sql_user : '') . " +				$sql_forum +				$sql_opts +			ORDER BY a.forum_id, ao.auth_option"; + +		// Now the role settings - user-specific +		$sql_ary[] = 'SELECT a.user_id, a.forum_id, r.auth_option_id, r.auth_setting, r.auth_option_id, ao.auth_option +			FROM ' . ACL_USERS_TABLE . ' a, ' . ACL_ROLES_DATA_TABLE . ' r, ' . ACL_OPTIONS_TABLE . ' ao +			WHERE a.auth_role_id = r.role_id +				AND r.auth_option_id = ao.auth_option_id ' . +				(($sql_user) ? 'AND a.' . $sql_user : '') . " +				$sql_forum +				$sql_opts +			ORDER BY a.forum_id, ao.auth_option"; + +		foreach ($sql_ary as $sql) +		{ +			$result = $db->sql_query($sql); + +			while ($row = $db->sql_fetchrow($result)) +			{ +				$hold_ary[$row['user_id']][$row['forum_id']][$row['auth_option']] = $row['auth_setting']; +			} +			$db->sql_freeresult($result); +		} + +		return $hold_ary; +	} + +	/** +	* Get raw group based permission settings +	*/ +	function acl_group_raw_data($group_id = false, $opts = false, $forum_id = false) +	{ +		global $db; + +		$sql_group = ($group_id !== false) ? ((!is_array($group_id)) ? 'group_id = ' . (int) $group_id : $db->sql_in_set('group_id', array_map('intval', $group_id))) : ''; +		$sql_forum = ($forum_id !== false) ? ((!is_array($forum_id)) ? 'AND a.forum_id = ' . (int) $forum_id : 'AND ' . $db->sql_in_set('a.forum_id', array_map('intval', $forum_id))) : ''; + +		$sql_opts = ''; +		$hold_ary = $sql_ary = array(); + +		if ($opts !== false) +		{ +			$this->build_auth_option_statement('ao.auth_option', $opts, $sql_opts); +		} + +		// Grab group settings - non-role specific... +		$sql_ary[] = 'SELECT a.group_id, a.forum_id, a.auth_setting, a.auth_option_id, ao.auth_option +			FROM ' . ACL_GROUPS_TABLE . ' a, ' . ACL_OPTIONS_TABLE . ' ao +			WHERE a.auth_role_id = 0 +				AND a.auth_option_id = ao.auth_option_id ' . +				(($sql_group) ? 'AND a.' . $sql_group : '') . " +				$sql_forum +				$sql_opts +			ORDER BY a.forum_id, ao.auth_option"; + +		// Now grab group settings - role specific... +		$sql_ary[] = 'SELECT a.group_id, a.forum_id, r.auth_setting, r.auth_option_id, ao.auth_option +			FROM ' . ACL_GROUPS_TABLE . ' a, ' . ACL_ROLES_DATA_TABLE . ' r, ' . ACL_OPTIONS_TABLE . ' ao +			WHERE a.auth_role_id = r.role_id +				AND r.auth_option_id = ao.auth_option_id ' . +				(($sql_group) ? 'AND a.' . $sql_group : '') . " +				$sql_forum +				$sql_opts +			ORDER BY a.forum_id, ao.auth_option"; + +		foreach ($sql_ary as $sql) +		{ +			$result = $db->sql_query($sql); + +			while ($row = $db->sql_fetchrow($result)) +			{ +				$hold_ary[$row['group_id']][$row['forum_id']][$row['auth_option']] = $row['auth_setting']; +			} +			$db->sql_freeresult($result); +		} + +		return $hold_ary; +	} + +	/** +	* Get raw acl data based on user for caching user_permissions +	* This function returns the same data as acl_raw_data(), but without the user id as the first key within the array. +	*/ +	function acl_raw_data_single_user($user_id) +	{ +		global $db, $cache; + +		// Check if the role-cache is there +		if (($this->role_cache = $cache->get('_role_cache')) === false) +		{ +			$this->role_cache = array(); + +			// We pre-fetch roles +			$sql = 'SELECT * +				FROM ' . ACL_ROLES_DATA_TABLE . ' +				ORDER BY role_id ASC'; +			$result = $db->sql_query($sql); + +			while ($row = $db->sql_fetchrow($result)) +			{ +				$this->role_cache[$row['role_id']][$row['auth_option_id']] = (int) $row['auth_setting']; +			} +			$db->sql_freeresult($result); + +			foreach ($this->role_cache as $role_id => $role_options) +			{ +				$this->role_cache[$role_id] = serialize($role_options); +			} + +			$cache->put('_role_cache', $this->role_cache); +		} + +		$hold_ary = array(); + +		// Grab user-specific permission settings +		$sql = 'SELECT forum_id, auth_option_id, auth_role_id, auth_setting +			FROM ' . ACL_USERS_TABLE . ' +			WHERE user_id = ' . $user_id; +		$result = $db->sql_query($sql); + +		while ($row = $db->sql_fetchrow($result)) +		{ +			// If a role is assigned, assign all options included within this role. Else, only set this one option. +			if ($row['auth_role_id']) +			{ +				$hold_ary[$row['forum_id']] = (empty($hold_ary[$row['forum_id']])) ? unserialize($this->role_cache[$row['auth_role_id']]) : $hold_ary[$row['forum_id']] + unserialize($this->role_cache[$row['auth_role_id']]); +			} +			else +			{ +				$hold_ary[$row['forum_id']][$row['auth_option_id']] = $row['auth_setting']; +			} +		} +		$db->sql_freeresult($result); + +		// Now grab group-specific permission settings +		$sql = 'SELECT a.forum_id, a.auth_option_id, a.auth_role_id, a.auth_setting +			FROM ' . ACL_GROUPS_TABLE . ' a, ' . USER_GROUP_TABLE . ' ug, ' . GROUPS_TABLE . ' g +			WHERE a.group_id = ug.group_id +				AND g.group_id = ug.group_id +				AND ug.user_pending = 0 +				AND NOT (ug.group_leader = 1 AND g.group_skip_auth = 1) +				AND ug.user_id = ' . $user_id; +		$result = $db->sql_query($sql); + +		while ($row = $db->sql_fetchrow($result)) +		{ +			if (!$row['auth_role_id']) +			{ +				$this->_set_group_hold_ary($hold_ary[$row['forum_id']], $row['auth_option_id'], $row['auth_setting']); +			} +			else if (!empty($this->role_cache[$row['auth_role_id']])) +			{ +				foreach (unserialize($this->role_cache[$row['auth_role_id']]) as $option_id => $setting) +				{ +					$this->_set_group_hold_ary($hold_ary[$row['forum_id']], $option_id, $setting); +				} +			} +		} +		$db->sql_freeresult($result); + +		return $hold_ary; +	} + +	/** +	* Private function snippet for setting a specific piece of the hold_ary +	*/ +	function _set_group_hold_ary(&$hold_ary, $option_id, $setting) +	{ +		if (!isset($hold_ary[$option_id]) || (isset($hold_ary[$option_id]) && $hold_ary[$option_id] != ACL_NEVER)) +		{ +			$hold_ary[$option_id] = $setting; + +			// If we detect ACL_NEVER, we will unset the flag option (within building the bitstring it is correctly set again) +			if ($setting == ACL_NEVER) +			{ +				$flag = substr($this->acl_options['option'][$option_id], 0, strpos($this->acl_options['option'][$option_id], '_') + 1); +				$flag = (int) $this->acl_options['id'][$flag]; + +				if (isset($hold_ary[$flag]) && $hold_ary[$flag] == ACL_YES) +				{ +					unset($hold_ary[$flag]); + +/*					This is uncommented, because i suspect this being slightly wrong due to mixed permission classes being possible +					if (in_array(ACL_YES, $hold_ary)) +					{ +						$hold_ary[$flag] = ACL_YES; +					}*/ +				} +			} +		} +	} + +	/** +	* Authentication plug-ins is largely down to Sergey Kanareykin, our thanks to him. +	*/ +	function login($username, $password, $autologin = false, $viewonline = 1, $admin = 0) +	{ +		global $config, $db, $user, $phpbb_root_path, $phpEx, $phpbb_container; + +		$method = trim(basename($config['auth_method'])); + +		$provider = $phpbb_container->get('auth.provider.' . $method); +		if ($provider) +		{ +			$login = $provider->login($username, $password); + +			// If the auth module wants us to create an empty profile do so and then treat the status as LOGIN_SUCCESS +			if ($login['status'] == LOGIN_SUCCESS_CREATE_PROFILE) +			{ +				// we are going to use the user_add function so include functions_user.php if it wasn't defined yet +				if (!function_exists('user_add')) +				{ +					include($phpbb_root_path . 'includes/functions_user.' . $phpEx); +				} + +				user_add($login['user_row'], (isset($login['cp_data'])) ? $login['cp_data'] : false); + +				$sql = 'SELECT user_id, username, user_password, user_passchg, user_email, user_type +					FROM ' . USERS_TABLE . " +					WHERE username_clean = '" . $db->sql_escape(utf8_clean_string($username)) . "'"; +				$result = $db->sql_query($sql); +				$row = $db->sql_fetchrow($result); +				$db->sql_freeresult($result); + +				if (!$row) +				{ +					return array( +						'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +						'error_msg'		=> 'AUTH_NO_PROFILE_CREATED', +						'user_row'		=> array('user_id' => ANONYMOUS), +					); +				} + +				$login = array( +					'status'	=> LOGIN_SUCCESS, +					'error_msg'	=> false, +					'user_row'	=> $row, +				); +			} + +			// If the auth provider wants us to link an empty account do so and redirect +			if ($login['status'] == LOGIN_SUCCESS_LINK_PROFILE) +			{ +				// If this status exists a fourth field is in the $login array called 'redirect_data' +				// This data is passed along as GET data to the next page allow the account to be linked + +				$params = array('mode' => 'login_link'); +				$url = append_sid($phpbb_root_path . 'ucp.' . $phpEx, array_merge($params, $login['redirect_data'])); + +				redirect($url); +			} + +			// If login succeeded, we will log the user in... else we pass the login array through... +			if ($login['status'] == LOGIN_SUCCESS) +			{ +				$old_session_id = $user->session_id; + +				if ($admin) +				{ +					global $SID, $_SID; + +					$cookie_expire = time() - 31536000; +					$user->set_cookie('u', '', $cookie_expire); +					$user->set_cookie('sid', '', $cookie_expire); +					unset($cookie_expire); + +					$SID = '?sid='; +					$user->session_id = $_SID = ''; +				} + +				$result = $user->session_create($login['user_row']['user_id'], $admin, $autologin, $viewonline); + +				// Successful session creation +				if ($result === true) +				{ +					// If admin re-authentication we remove the old session entry because a new one has been created... +					if ($admin) +					{ +						// the login array is used because the user ids do not differ for re-authentication +						$sql = 'DELETE FROM ' . SESSIONS_TABLE . " +							WHERE session_id = '" . $db->sql_escape($old_session_id) . "' +							AND session_user_id = {$login['user_row']['user_id']}"; +						$db->sql_query($sql); +					} + +					return array( +						'status'		=> LOGIN_SUCCESS, +						'error_msg'		=> false, +						'user_row'		=> $login['user_row'], +					); +				} + +				return array( +					'status'		=> LOGIN_BREAK, +					'error_msg'		=> $result, +					'user_row'		=> $login['user_row'], +				); +			} + +			return $login; +		} + +		trigger_error('Authentication method not found', E_USER_ERROR); +	} + +	/** +	* Fill auth_option statement for later querying based on the supplied options +	*/ +	function build_auth_option_statement($key, $auth_options, &$sql_opts) +	{ +		global $db; + +		if (!is_array($auth_options)) +		{ +			if (strpos($auth_options, '%') !== false) +			{ +				$sql_opts = "AND $key " . $db->sql_like_expression(str_replace('%', $db->get_any_char(), $auth_options)); +			} +			else +			{ +				$sql_opts = "AND $key = '" . $db->sql_escape($auth_options) . "'"; +			} +		} +		else +		{ +			$is_like_expression = false; + +			foreach ($auth_options as $option) +			{ +				if (strpos($option, '%') !== false) +				{ +					$is_like_expression = true; +				} +			} + +			if (!$is_like_expression) +			{ +				$sql_opts = 'AND ' . $db->sql_in_set($key, $auth_options); +			} +			else +			{ +				$sql = array(); + +				foreach ($auth_options as $option) +				{ +					if (strpos($option, '%') !== false) +					{ +						$sql[] = $key . ' ' . $db->sql_like_expression(str_replace('%', $db->get_any_char(), $option)); +					} +					else +					{ +						$sql[] = $key . " = '" . $db->sql_escape($option) . "'"; +					} +				} + +				$sql_opts = 'AND (' . implode(' OR ', $sql) . ')'; +			} +		} +	} +} diff --git a/phpBB/phpbb/auth/index.htm b/phpBB/phpbb/auth/index.htm new file mode 100644 index 0000000000..ee1f723a7d --- /dev/null +++ b/phpBB/phpbb/auth/index.htm @@ -0,0 +1,10 @@ +<html> +<head> +<title></title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</head> + +<body bgcolor="#FFFFFF" text="#000000"> + +</body> +</html> diff --git a/phpBB/phpbb/auth/provider/apache.php b/phpBB/phpbb/auth/provider/apache.php new file mode 100644 index 0000000000..4f44efe9af --- /dev/null +++ b/phpBB/phpbb/auth/provider/apache.php @@ -0,0 +1,264 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider; + +/** +* Apache authentication provider for phpBB3 +*/ +class apache extends \phpbb\auth\provider\base +{ +	/** +	* phpBB passwords manager +	* +	* @var \phpbb\passwords\manager +	*/ +	protected $passwords_manager; + +	/** +	 * Apache Authentication Constructor +	 * +	 * @param 	\phpbb\db\driver\driver_interface 	$db +	 * @param 	\phpbb\config\config 		$config +	 * @param	\phpbb\passwords\manager	$passwords_manager +	 * @param 	\phpbb\request\request 		$request +	 * @param 	\phpbb\user 			$user +	 * @param 	string 				$phpbb_root_path +	 * @param 	string 				$php_ext +	 */ +	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext) +	{ +		$this->db = $db; +		$this->config = $config; +		$this->passwords_manager = $passwords_manager; +		$this->request = $request; +		$this->user = $user; +		$this->phpbb_root_path = $phpbb_root_path; +		$this->php_ext = $php_ext; +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function init() +	{ +		if (!$this->request->is_set('PHP_AUTH_USER', \phpbb\request\request_interface::SERVER) || $this->user->data['username'] !== htmlspecialchars_decode($this->request->server('PHP_AUTH_USER'))) +		{ +			return $this->user->lang['APACHE_SETUP_BEFORE_USE']; +		} +		return false; +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function login($username, $password) +	{ +		// do not allow empty password +		if (!$password) +		{ +			return array( +				'status'	=> LOGIN_ERROR_PASSWORD, +				'error_msg'	=> 'NO_PASSWORD_SUPPLIED', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		if (!$username) +		{ +			return array( +				'status'	=> LOGIN_ERROR_USERNAME, +				'error_msg'	=> 'LOGIN_ERROR_USERNAME', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		if (!$this->request->is_set('PHP_AUTH_USER', \phpbb\request\request_interface::SERVER)) +		{ +			return array( +				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +				'error_msg'		=> 'LOGIN_ERROR_EXTERNAL_AUTH_APACHE', +				'user_row'		=> array('user_id' => ANONYMOUS), +			); +		} + +		$php_auth_user = htmlspecialchars_decode($this->request->server('PHP_AUTH_USER')); +		$php_auth_pw = htmlspecialchars_decode($this->request->server('PHP_AUTH_PW')); + +		if (!empty($php_auth_user) && !empty($php_auth_pw)) +		{ +			if ($php_auth_user !== $username) +			{ +				return array( +					'status'	=> LOGIN_ERROR_USERNAME, +					'error_msg'	=> 'LOGIN_ERROR_USERNAME', +					'user_row'	=> array('user_id' => ANONYMOUS), +				); +			} + +			$sql = 'SELECT user_id, username, user_password, user_passchg, user_email, user_type +				FROM ' . USERS_TABLE . " +				WHERE username = '" . $this->db->sql_escape($php_auth_user) . "'"; +			$result = $this->db->sql_query($sql); +			$row = $this->db->sql_fetchrow($result); +			$this->db->sql_freeresult($result); + +			if ($row) +			{ +				// User inactive... +				if ($row['user_type'] == USER_INACTIVE || $row['user_type'] == USER_IGNORE) +				{ +					return array( +						'status'		=> LOGIN_ERROR_ACTIVE, +						'error_msg'		=> 'ACTIVE_ERROR', +						'user_row'		=> $row, +					); +				} + +				// Successful login... +				return array( +					'status'		=> LOGIN_SUCCESS, +					'error_msg'		=> false, +					'user_row'		=> $row, +				); +			} + +			// this is the user's first login so create an empty profile +			return array( +				'status'		=> LOGIN_SUCCESS_CREATE_PROFILE, +				'error_msg'		=> false, +				'user_row'		=> user_row_apache($php_auth_user, $php_auth_pw), +			); +		} + +		// Not logged into apache +		return array( +			'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +			'error_msg'		=> 'LOGIN_ERROR_EXTERNAL_AUTH_APACHE', +			'user_row'		=> array('user_id' => ANONYMOUS), +		); +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function autologin() +	{ +		if (!$this->request->is_set('PHP_AUTH_USER', \phpbb\request\request_interface::SERVER)) +		{ +			return array(); +		} + +		$php_auth_user = htmlspecialchars_decode($this->request->server('PHP_AUTH_USER')); +		$php_auth_pw = htmlspecialchars_decode($this->request->server('PHP_AUTH_PW')); + +		if (!empty($php_auth_user) && !empty($php_auth_pw)) +		{ +			set_var($php_auth_user, $php_auth_user, 'string', true); +			set_var($php_auth_pw, $php_auth_pw, 'string', true); + +			$sql = 'SELECT * +				FROM ' . USERS_TABLE . " +				WHERE username = '" . $this->db->sql_escape($php_auth_user) . "'"; +			$result = $this->db->sql_query($sql); +			$row = $this->db->sql_fetchrow($result); +			$this->db->sql_freeresult($result); + +			if ($row) +			{ +				return ($row['user_type'] == USER_INACTIVE || $row['user_type'] == USER_IGNORE) ? array() : $row; +			} + +			if (!function_exists('user_add')) +			{ +				include($this->phpbb_root_path . 'includes/functions_user.' . $this->php_ext); +			} + +			// create the user if he does not exist yet +			user_add(user_row_apache($php_auth_user, $php_auth_pw)); + +			$sql = 'SELECT * +				FROM ' . USERS_TABLE . " +				WHERE username_clean = '" . $this->db->sql_escape(utf8_clean_string($php_auth_user)) . "'"; +			$result = $this->db->sql_query($sql); +			$row = $this->db->sql_fetchrow($result); +			$this->db->sql_freeresult($result); + +			if ($row) +			{ +				return $row; +			} +		} + +		return array(); +	} + +	/** +	 * This function generates an array which can be passed to the user_add +	 * function in order to create a user +	 * +	 * @param 	string	$username 	The username of the new user. +	 * @param 	string	$password 	The password of the new user. +	 * @return 	array 				Contains data that can be passed directly to +	 *								the user_add function. +	 */ +	private function user_row($username, $password) +	{ +		// first retrieve default group id +		$sql = 'SELECT group_id +			FROM ' . GROUPS_TABLE . " +			WHERE group_name = '" . $this->db->sql_escape('REGISTERED') . "' +				AND group_type = " . GROUP_SPECIAL; +		$result = $this->db->sql_query($sql); +		$row = $this->db->sql_fetchrow($result); +		$this->db->sql_freeresult($result); + +		if (!$row) +		{ +			trigger_error('NO_GROUP'); +		} + +		// generate user account data +		return array( +			'username'		=> $username, +			'user_password'	=> $this->passwords_manager->hash($password), +			'user_email'	=> '', +			'group_id'		=> (int) $row['group_id'], +			'user_type'		=> USER_NORMAL, +			'user_ip'		=> $this->user->ip, +			'user_new'		=> ($this->config['new_member_post_limit']) ? 1 : 0, +		); +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function validate_session($user) +	{ +		// Check if PHP_AUTH_USER is set and handle this case +		if ($this->request->is_set('PHP_AUTH_USER', \phpbb\request\request_interface::SERVER)) +		{ +			$php_auth_user = $this->request->server('PHP_AUTH_USER'); + +			return ($php_auth_user === $user['username']) ? true : false; +		} + +		// PHP_AUTH_USER is not set. A valid session is now determined by the user type (anonymous/bot or not) +		if ($user['user_type'] == USER_IGNORE) +		{ +			return true; +		} + +		return false; +	} +} diff --git a/phpBB/phpbb/auth/provider/base.php b/phpBB/phpbb/auth/provider/base.php new file mode 100644 index 0000000000..4c49070eaf --- /dev/null +++ b/phpBB/phpbb/auth/provider/base.php @@ -0,0 +1,108 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider; + +/** +* Base authentication provider class that all other providers should implement +*/ +abstract class base implements \phpbb\auth\provider\provider_interface +{ +	/** +	* {@inheritdoc} +	*/ +	public function init() +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function autologin() +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function acp() +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_acp_template($new_config) +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_login_data() +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_auth_link_data() +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function logout($data, $new_session) +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function validate_session($user) +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function login_link_has_necessary_data($login_link_data) +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function link_account(array $link_data) +	{ +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function unlink_account(array $link_data) +	{ +		return; +	} +} diff --git a/phpBB/phpbb/auth/provider/db.php b/phpBB/phpbb/auth/provider/db.php new file mode 100644 index 0000000000..142a47247f --- /dev/null +++ b/phpBB/phpbb/auth/provider/db.php @@ -0,0 +1,235 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider; + +/** + * Database authentication provider for phpBB3 + * This is for authentication via the integrated user table + */ +class db extends \phpbb\auth\provider\base +{ +	/** +	* phpBB passwords manager +	* +	* @var \phpbb\passwords\manager +	*/ +	protected $passwords_manager; + +	/** +	 * Database Authentication Constructor +	 * +	 * @param	\phpbb\db\driver\driver_interface		$db +	 * @param	\phpbb\config\config 		$config +	 * @param	\phpbb\passwords\manager	$passwords_manager +	 * @param	\phpbb\request\request		$request +	 * @param	\phpbb\user			$user +	 * @param	string				$phpbb_root_path +	 * @param	string				$php_ext +	 */ +	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request $request, \phpbb\user $user, $phpbb_root_path, $php_ext) +	{ +		$this->db = $db; +		$this->config = $config; +		$this->passwords_manager = $passwords_manager; +		$this->request = $request; +		$this->user = $user; +		$this->phpbb_root_path = $phpbb_root_path; +		$this->php_ext = $php_ext; +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function login($username, $password) +	{ +		// Auth plugins get the password untrimmed. +		// For compatibility we trim() here. +		$password = trim($password); + +		// do not allow empty password +		if (!$password) +		{ +			return array( +				'status'	=> LOGIN_ERROR_PASSWORD, +				'error_msg'	=> 'NO_PASSWORD_SUPPLIED', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		if (!$username) +		{ +			return array( +				'status'	=> LOGIN_ERROR_USERNAME, +				'error_msg'	=> 'LOGIN_ERROR_USERNAME', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		$username_clean = utf8_clean_string($username); + +		$sql = 'SELECT user_id, username, user_password, user_passchg, user_email, user_type, user_login_attempts +			FROM ' . USERS_TABLE . " +			WHERE username_clean = '" . $this->db->sql_escape($username_clean) . "'"; +		$result = $this->db->sql_query($sql); +		$row = $this->db->sql_fetchrow($result); +		$this->db->sql_freeresult($result); + +		if (($this->user->ip && !$this->config['ip_login_limit_use_forwarded']) || +			($this->user->forwarded_for && $this->config['ip_login_limit_use_forwarded'])) +		{ +			$sql = 'SELECT COUNT(*) AS attempts +				FROM ' . LOGIN_ATTEMPT_TABLE . ' +				WHERE attempt_time > ' . (time() - (int) $this->config['ip_login_limit_time']); +			if ($this->config['ip_login_limit_use_forwarded']) +			{ +				$sql .= " AND attempt_forwarded_for = '" . $this->db->sql_escape($this->user->forwarded_for) . "'"; +			} +			else +			{ +				$sql .= " AND attempt_ip = '" . $this->db->sql_escape($this->user->ip) . "' "; +			} + +			$result = $this->db->sql_query($sql); +			$attempts = (int) $this->db->sql_fetchfield('attempts'); +			$this->db->sql_freeresult($result); + +			$attempt_data = array( +				'attempt_ip'			=> $this->user->ip, +				'attempt_browser'		=> trim(substr($this->user->browser, 0, 149)), +				'attempt_forwarded_for'	=> $this->user->forwarded_for, +				'attempt_time'			=> time(), +				'user_id'				=> ($row) ? (int) $row['user_id'] : 0, +				'username'				=> $username, +				'username_clean'		=> $username_clean, +			); +			$sql = 'INSERT INTO ' . LOGIN_ATTEMPT_TABLE . $this->db->sql_build_array('INSERT', $attempt_data); +			$result = $this->db->sql_query($sql); +		} +		else +		{ +			$attempts = 0; +		} + +		if (!$row) +		{ +			if ($this->config['ip_login_limit_max'] && $attempts >= $this->config['ip_login_limit_max']) +			{ +				return array( +					'status'		=> LOGIN_ERROR_ATTEMPTS, +					'error_msg'		=> 'LOGIN_ERROR_ATTEMPTS', +					'user_row'		=> array('user_id' => ANONYMOUS), +				); +			} + +			return array( +				'status'	=> LOGIN_ERROR_USERNAME, +				'error_msg'	=> 'LOGIN_ERROR_USERNAME', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		$show_captcha = ($this->config['max_login_attempts'] && $row['user_login_attempts'] >= $this->config['max_login_attempts']) || +			($this->config['ip_login_limit_max'] && $attempts >= $this->config['ip_login_limit_max']); + +		// If there are too many login attempts, we need to check for a confirm image +		// Every auth module is able to define what to do by itself... +		if ($show_captcha) +		{ +			// Visual Confirmation handling +			if (!class_exists('phpbb_captcha_factory', false)) +			{ +				include ($this->phpbb_root_path . 'includes/captcha/captcha_factory.' . $this->php_ext); +			} + +			$captcha = \phpbb_captcha_factory::get_instance($this->config['captcha_plugin']); +			$captcha->init(CONFIRM_LOGIN); +			$vc_response = $captcha->validate($row); +			if ($vc_response) +			{ +				return array( +					'status'		=> LOGIN_ERROR_ATTEMPTS, +					'error_msg'		=> 'LOGIN_ERROR_ATTEMPTS', +					'user_row'		=> $row, +				); +			} +			else +			{ +				$captcha->reset(); +			} + +		} + +		// Check password ... +		if ($this->passwords_manager->check($password, $row['user_password'])) +		{ +			// Check for old password hash... +			if ($this->passwords_manager->convert_flag || strlen($row['user_password']) == 32) +			{ +				$hash = $this->passwords_manager->hash($password); + +				// Update the password in the users table to the new format +				$sql = 'UPDATE ' . USERS_TABLE . " +					SET user_password = '" . $this->db->sql_escape($hash) . "' +					WHERE user_id = {$row['user_id']}"; +				$this->db->sql_query($sql); + +				$row['user_password'] = $hash; +			} + +			$sql = 'DELETE FROM ' . LOGIN_ATTEMPT_TABLE . ' +				WHERE user_id = ' . $row['user_id']; +			$this->db->sql_query($sql); + +			if ($row['user_login_attempts'] != 0) +			{ +				// Successful, reset login attempts (the user passed all stages) +				$sql = 'UPDATE ' . USERS_TABLE . ' +					SET user_login_attempts = 0 +					WHERE user_id = ' . $row['user_id']; +				$this->db->sql_query($sql); +			} + +			// User inactive... +			if ($row['user_type'] == USER_INACTIVE || $row['user_type'] == USER_IGNORE) +			{ +				return array( +					'status'		=> LOGIN_ERROR_ACTIVE, +					'error_msg'		=> 'ACTIVE_ERROR', +					'user_row'		=> $row, +				); +			} + +			// Successful login... set user_login_attempts to zero... +			return array( +				'status'		=> LOGIN_SUCCESS, +				'error_msg'		=> false, +				'user_row'		=> $row, +			); +		} + +		// Password incorrect - increase login attempts +		$sql = 'UPDATE ' . USERS_TABLE . ' +			SET user_login_attempts = user_login_attempts + 1 +			WHERE user_id = ' . (int) $row['user_id'] . ' +				AND user_login_attempts < ' . LOGIN_ATTEMPTS_MAX; +		$this->db->sql_query($sql); + +		// Give status about wrong password... +		return array( +			'status'		=> ($show_captcha) ? LOGIN_ERROR_ATTEMPTS : LOGIN_ERROR_PASSWORD, +			'error_msg'		=> ($show_captcha) ? 'LOGIN_ERROR_ATTEMPTS' : 'LOGIN_ERROR_PASSWORD', +			'user_row'		=> $row, +		); +	} +} diff --git a/phpBB/phpbb/auth/provider/index.htm b/phpBB/phpbb/auth/provider/index.htm new file mode 100644 index 0000000000..ee1f723a7d --- /dev/null +++ b/phpBB/phpbb/auth/provider/index.htm @@ -0,0 +1,10 @@ +<html> +<head> +<title></title> +<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> +</head> + +<body bgcolor="#FFFFFF" text="#000000"> + +</body> +</html> diff --git a/phpBB/phpbb/auth/provider/ldap.php b/phpBB/phpbb/auth/provider/ldap.php new file mode 100644 index 0000000000..e7764b754b --- /dev/null +++ b/phpBB/phpbb/auth/provider/ldap.php @@ -0,0 +1,349 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider; + +/** + * Database authentication provider for phpBB3 + * This is for authentication via the integrated user table + */ +class ldap extends \phpbb\auth\provider\base +{ +	/** +	* phpBB passwords manager +	* +	* @var \phpbb\passwords\manager +	*/ +	protected $passwords_manager; + +	/** +	 * LDAP Authentication Constructor +	 * +	 * @param 	\phpbb\db\driver\driver_interface		$db +	 * @param 	\phpbb\config\config		$config +	 * @param	\phpbb\passwords\manager	$passwords_manager +	 * @param 	\phpbb\user			$user +	 */ +	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\user $user) +	{ +		$this->db = $db; +		$this->config = $config; +		$this->passwords_manager = $passwords_manager; +		$this->user = $user; +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function init() +	{ +		if (!@extension_loaded('ldap')) +		{ +			return $this->user->lang['LDAP_NO_LDAP_EXTENSION']; +		} + +		$this->config['ldap_port'] = (int) $this->config['ldap_port']; +		if ($this->config['ldap_port']) +		{ +			$ldap = @ldap_connect($this->config['ldap_server'], $this->config['ldap_port']); +		} +		else +		{ +			$ldap = @ldap_connect($this->config['ldap_server']); +		} + +		if (!$ldap) +		{ +			return $this->user->lang['LDAP_NO_SERVER_CONNECTION']; +		} + +		@ldap_set_option($ldap, LDAP_OPT_PROTOCOL_VERSION, 3); +		@ldap_set_option($ldap, LDAP_OPT_REFERRALS, 0); + +		if ($this->config['ldap_user'] || $this->config['ldap_password']) +		{ +			if (!@ldap_bind($ldap, htmlspecialchars_decode($this->config['ldap_user']), htmlspecialchars_decode($this->config['ldap_password']))) +			{ +				return $this->user->lang['LDAP_INCORRECT_USER_PASSWORD']; +			} +		} + +		// ldap_connect only checks whether the specified server is valid, so the connection might still fail +		$search = @ldap_search( +			$ldap, +			htmlspecialchars_decode($this->config['ldap_base_dn']), +			$this->ldap_user_filter($this->user->data['username']), +			(empty($this->config['ldap_email'])) ? +				array(htmlspecialchars_decode($this->config['ldap_uid'])) : +				array(htmlspecialchars_decode($this->config['ldap_uid']), htmlspecialchars_decode($this->config['ldap_email'])), +			0, +			1 +		); + +		if ($search === false) +		{ +			return $this->user->lang['LDAP_SEARCH_FAILED']; +		} + +		$result = @ldap_get_entries($ldap, $search); + +		@ldap_close($ldap); + +		if (!is_array($result) || sizeof($result) < 2) +		{ +			return sprintf($this->user->lang['LDAP_NO_IDENTITY'], $this->user->data['username']); +		} + +		if (!empty($this->config['ldap_email']) && !isset($result[0][htmlspecialchars_decode($this->config['ldap_email'])])) +		{ +			return $this->user->lang['LDAP_NO_EMAIL']; +		} + +		return false; +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function login($username, $password) +	{ +		// do not allow empty password +		if (!$password) +		{ +			return array( +				'status'	=> LOGIN_ERROR_PASSWORD, +				'error_msg'	=> 'NO_PASSWORD_SUPPLIED', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		if (!$username) +		{ +			return array( +				'status'	=> LOGIN_ERROR_USERNAME, +				'error_msg'	=> 'LOGIN_ERROR_USERNAME', +				'user_row'	=> array('user_id' => ANONYMOUS), +			); +		} + +		if (!@extension_loaded('ldap')) +		{ +			return array( +				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +				'error_msg'		=> 'LDAP_NO_LDAP_EXTENSION', +				'user_row'		=> array('user_id' => ANONYMOUS), +			); +		} + +		$this->config['ldap_port'] = (int) $this->config['ldap_port']; +		if ($this->config['ldap_port']) +		{ +			$ldap = @ldap_connect($this->config['ldap_server'], $this->config['ldap_port']); +		} +		else +		{ +			$ldap = @ldap_connect($this->config['ldap_server']); +		} + +		if (!$ldap) +		{ +			return array( +				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +				'error_msg'		=> 'LDAP_NO_SERVER_CONNECTION', +				'user_row'		=> array('user_id' => ANONYMOUS), +			); +		} + +		@ldap_set_option($ldap, LDAP_OPT_PROTOCOL_VERSION, 3); +		@ldap_set_option($ldap, LDAP_OPT_REFERRALS, 0); + +		if ($this->config['ldap_user'] || $this->config['ldap_password']) +		{ +			if (!@ldap_bind($ldap, htmlspecialchars_decode($this->config['ldap_user']), htmlspecialchars_decode($this->config['ldap_password']))) +			{ +				return array( +					'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +					'error_msg'		=> 'LDAP_NO_SERVER_CONNECTION', +					'user_row'		=> array('user_id' => ANONYMOUS), +				); +			} +		} + +		$search = @ldap_search( +			$ldap, +			htmlspecialchars_decode($this->config['ldap_base_dn']), +			$this->ldap_user_filter($username), +			(empty($this->config['ldap_email'])) ? +				array(htmlspecialchars_decode($this->config['ldap_uid'])) : +				array(htmlspecialchars_decode($this->config['ldap_uid']), htmlspecialchars_decode($this->config['ldap_email'])), +			0, +			1 +		); + +		$ldap_result = @ldap_get_entries($ldap, $search); + +		if (is_array($ldap_result) && sizeof($ldap_result) > 1) +		{ +			if (@ldap_bind($ldap, $ldap_result[0]['dn'], htmlspecialchars_decode($password))) +			{ +				@ldap_close($ldap); + +				$sql ='SELECT user_id, username, user_password, user_passchg, user_email, user_type +					FROM ' . USERS_TABLE . " +					WHERE username_clean = '" . $this->db->sql_escape(utf8_clean_string($username)) . "'"; +				$result = $this->db->sql_query($sql); +				$row = $this->db->sql_fetchrow($result); +				$this->db->sql_freeresult($result); + +				if ($row) +				{ +					unset($ldap_result); + +					// User inactive... +					if ($row['user_type'] == USER_INACTIVE || $row['user_type'] == USER_IGNORE) +					{ +						return array( +							'status'		=> LOGIN_ERROR_ACTIVE, +							'error_msg'		=> 'ACTIVE_ERROR', +							'user_row'		=> $row, +						); +					} + +					// Successful login... set user_login_attempts to zero... +					return array( +						'status'		=> LOGIN_SUCCESS, +						'error_msg'		=> false, +						'user_row'		=> $row, +					); +				} +				else +				{ +					// retrieve default group id +					$sql = 'SELECT group_id +						FROM ' . GROUPS_TABLE . " +						WHERE group_name = '" . $this->db->sql_escape('REGISTERED') . "' +							AND group_type = " . GROUP_SPECIAL; +					$result = $this->db->sql_query($sql); +					$row = $this->db->sql_fetchrow($result); +					$this->db->sql_freeresult($result); + +					if (!$row) +					{ +						trigger_error('NO_GROUP'); +					} + +					// generate user account data +					$ldap_user_row = array( +						'username'		=> $username, +						'user_password'	=> $this->passwords_manager->hash($password), +						'user_email'	=> (!empty($this->config['ldap_email'])) ? utf8_htmlspecialchars($ldap_result[0][htmlspecialchars_decode($this->config['ldap_email'])][0]) : '', +						'group_id'		=> (int) $row['group_id'], +						'user_type'		=> USER_NORMAL, +						'user_ip'		=> $this->user->ip, +						'user_new'		=> ($this->config['new_member_post_limit']) ? 1 : 0, +					); + +					unset($ldap_result); + +					// this is the user's first login so create an empty profile +					return array( +						'status'		=> LOGIN_SUCCESS_CREATE_PROFILE, +						'error_msg'		=> false, +						'user_row'		=> $ldap_user_row, +					); +				} +			} +			else +			{ +				unset($ldap_result); +				@ldap_close($ldap); + +				// Give status about wrong password... +				return array( +					'status'		=> LOGIN_ERROR_PASSWORD, +					'error_msg'		=> 'LOGIN_ERROR_PASSWORD', +					'user_row'		=> array('user_id' => ANONYMOUS), +				); +			} +		} + +		@ldap_close($ldap); + +		return array( +			'status'	=> LOGIN_ERROR_USERNAME, +			'error_msg'	=> 'LOGIN_ERROR_USERNAME', +			'user_row'	=> array('user_id' => ANONYMOUS), +		); +	} + +	/** +	 * {@inheritdoc} +	 */ + +	public function acp() +	{ +		// These are fields required in the config table +		return array( +			'ldap_server', 'ldap_port', 'ldap_base_dn', 'ldap_uid', 'ldap_user_filter', 'ldap_email', 'ldap_user', 'ldap_password', +		); +	} + +	/** +	 * {@inheritdoc} +	 */ +	public function get_acp_template($new_config) +	{ +		return array( +			'TEMPLATE_FILE'	=> 'auth_provider_ldap.html', +			'TEMPLATE_VARS'	=> array( +				'AUTH_LDAP_DN'			=> $new_config['ldap_base_dn'], +				'AUTH_LDAP_EMAIL'		=> $new_config['ldap_email'], +				'AUTH_LDAP_PASSORD'		=> $new_config['ldap_password'], +				'AUTH_LDAP_PORT'		=> $new_config['ldap_port'], +				'AUTH_LDAP_SERVER'		=> $new_config['ldap_server'], +				'AUTH_LDAP_UID'			=> $new_config['ldap_uid'], +				'AUTH_LDAP_USER'		=> $new_config['ldap_user'], +				'AUTH_LDAP_USER_FILTER'	=> $new_config['ldap_user_filter'], +			), +		); +	} + +	/** +	 * Generates a filter string for ldap_search to find a user +	 * +	 * @param	$username	string	Username identifying the searched user +	 * +	 * @return				string	A filter string for ldap_search +	 */ +	private function ldap_user_filter($username) +	{ +		$filter = '(' . $this->config['ldap_uid'] . '=' . $this->ldap_escape(htmlspecialchars_decode($username)) . ')'; +		if ($this->config['ldap_user_filter']) +		{ +			$_filter = ($this->config['ldap_user_filter'][0] == '(' && substr($this->config['ldap_user_filter'], -1) == ')') ? $this->config['ldap_user_filter'] : "({$this->config['ldap_user_filter']})"; +			$filter = "(&{$filter}{$_filter})"; +		} +		return $filter; +	} + +	/** +	 * Escapes an LDAP AttributeValue +	 * +	 * @param	string	$string	The string to be escaped +	 * @return	string	The escaped string +	 */ +	private function ldap_escape($string) +	{ +		return str_replace(array('*', '\\', '(', ')'), array('\\*', '\\\\', '\\(', '\\)'), $string); +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/oauth.php b/phpBB/phpbb/auth/provider/oauth/oauth.php new file mode 100644 index 0000000000..7b71e3c844 --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/oauth.php @@ -0,0 +1,621 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth; + +use OAuth\Common\Consumer\Credentials; + +/** +* OAuth authentication provider for phpBB3 +*/ +class oauth extends \phpbb\auth\provider\base +{ +	/** +	* Database driver +	* +	* @var \phpbb\db\driver\driver_interface +	*/ +	protected $db; + +	/** +	* phpBB config +	* +	* @var \phpbb\config\config +	*/ +	protected $config; + +	/** +	* phpBB passwords manager +	* +	* @var \phpbb\passwords\manager +	*/ +	protected $passwords_manager; + +	/** +	* phpBB request object +	* +	* @var \phpbb\request\request_interface +	*/ +	protected $request; + +	/** +	* phpBB user +	* +	* @var \phpbb\user +	*/ +	protected $user; + +	/** +	* OAuth token table +	* +	* @var string +	*/ +	protected $auth_provider_oauth_token_storage_table; + +	/** +	* OAuth account association table +	* +	* @var string +	*/ +	protected $auth_provider_oauth_token_account_assoc; + +	/** +	* All OAuth service providers +	* +	* @var \phpbb\di\service_collection Contains \phpbb\auth\provider\oauth\service_interface +	*/ +	protected $service_providers; + +	/** +	* Users table +	* +	* @var string +	*/ +	protected $users_table; + +	/** +	* Cached current uri object +	* +	* @var \OAuth\Common\Http\Uri\UriInterface|null +	*/ +	protected $current_uri; + +	/** +	* phpBB root path +	* +	* @var string +	*/ +	protected $phpbb_root_path; + +	/** +	* PHP extenstion +	* +	* @var string +	*/ +	protected $php_ext; + +	/** +	* OAuth Authentication Constructor +	* +	* @param	\phpbb\db\driver\driver_interface	$db +	* @param	\phpbb\config\config	$config +	* @param	\phpbb\passwords\manager	$passwords_manager +	* @param	\phpbb\request\request_interface	$request +	* @param	\phpbb\user		$user +	* @param	string			$auth_provider_oauth_token_storage_table +	* @param	string			$auth_provider_oauth_token_account_assoc +	* @param	\phpbb\di\service_collection	$service_providers Contains \phpbb\auth\provider\oauth\service_interface +	* @param	string			$users_table +	* @param	string			$phpbb_root_path +	* @param	string			$php_ext +	*/ +	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\config\config $config, \phpbb\passwords\manager $passwords_manager, \phpbb\request\request_interface $request, \phpbb\user $user, $auth_provider_oauth_token_storage_table, $auth_provider_oauth_token_account_assoc, \phpbb\di\service_collection $service_providers, $users_table, $phpbb_root_path, $php_ext) +	{ +		$this->db = $db; +		$this->config = $config; +		$this->passwords_manager = $passwords_manager; +		$this->request = $request; +		$this->user = $user; +		$this->auth_provider_oauth_token_storage_table = $auth_provider_oauth_token_storage_table; +		$this->auth_provider_oauth_token_account_assoc = $auth_provider_oauth_token_account_assoc; +		$this->service_providers = $service_providers; +		$this->users_table = $users_table; +		$this->phpbb_root_path = $phpbb_root_path; +		$this->php_ext = $php_ext; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function init() +	{ +		// This does not test whether or not the key and secret provided are valid. +		foreach ($this->service_providers as $service_provider) +		{ +			$credentials = $service_provider->get_service_credentials(); + +			if (($credentials['key'] && !$credentials['secret']) || (!$credentials['key'] && $credentials['secret'])) +			{ +				return $this->user->lang['AUTH_PROVIDER_OAUTH_ERROR_ELEMENT_MISSING']; +			} +		} +		return false; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function login($username, $password) +	{ +		// Temporary workaround for only having one authentication provider available +		if (!$this->request->is_set('oauth_service')) +		{ +			$provider = new \phpbb\auth\provider\db($this->db, $this->config, $this->passwords_manager, $this->request, $this->user, $this->phpbb_root_path, $this->php_ext); +			return $provider->login($username, $password); +		} + +		// Requst the name of the OAuth service +		$service_name_original = $this->request->variable('oauth_service', '', false); +		$service_name = 'auth.provider.oauth.service.' . strtolower($service_name_original); +		if ($service_name_original === '' || !array_key_exists($service_name, $this->service_providers)) +		{ +			return array( +				'status'		=> LOGIN_ERROR_EXTERNAL_AUTH, +				'error_msg'		=> 'LOGIN_ERROR_OAUTH_SERVICE_DOES_NOT_EXIST', +				'user_row'		=> array('user_id' => ANONYMOUS), +			); +		} + +		// Get the service credentials for the given service +		$service_credentials = $this->service_providers[$service_name]->get_service_credentials(); + +		$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table); +		$query = 'mode=login&login=external&oauth_service=' . $service_name_original; +		$service = $this->get_service($service_name_original, $storage, $service_credentials, $query, $this->service_providers[$service_name]->get_auth_scope()); + +		if ($this->request->is_set('code', \phpbb\request\request_interface::GET)) +		{ +			$this->service_providers[$service_name]->set_external_service_provider($service); +			$unique_id = $this->service_providers[$service_name]->perform_auth_login(); + +			// Check to see if this provider is already assosciated with an account +			$data = array( +				'provider'	=> $service_name_original, +				'oauth_provider_id'	=> $unique_id +			); +			$sql = 'SELECT user_id FROM ' . $this->auth_provider_oauth_token_account_assoc . ' +				WHERE ' . $this->db->sql_build_array('SELECT', $data); +			$result = $this->db->sql_query($sql); +			$row = $this->db->sql_fetchrow($result); +			$this->db->sql_freeresult($result); + +			if (!$row) +			{ +				// The user does not yet exist, ask to link or create profile +				return array( +					'status'		=> LOGIN_SUCCESS_LINK_PROFILE, +					'error_msg'		=> 'LOGIN_OAUTH_ACCOUNT_NOT_LINKED', +					'user_row'		=> array(), +					'redirect_data'	=> array( +						'auth_provider'				=> 'oauth', +						'login_link_oauth_service'	=> $service_name_original, +					), +				); +			} + +			// Retrieve the user's account +			$sql = 'SELECT user_id, username, user_password, user_passchg, user_email, user_type, user_login_attempts +				FROM ' . $this->users_table . ' +					WHERE user_id = ' . (int) $row['user_id']; +			$result = $this->db->sql_query($sql); +			$row = $this->db->sql_fetchrow($result); +			$this->db->sql_freeresult($result); + +			if (!$row) +			{ +				throw new \Exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_ENTRY'); +			} + +			// Update token storage to store the user_id +			$storage->set_user_id($row['user_id']); + +			// The user is now authenticated and can be logged in +			return array( +				'status'		=> LOGIN_SUCCESS, +				'error_msg'		=> false, +				'user_row'		=> $row, +			); +		} +		else +		{ +			$url = $service->getAuthorizationUri(); +			header('Location: ' . $url); +		} +	} + +	/** +	* Returns the cached current_uri object or creates and caches it if it is +	* not already created. In each case the query string is updated based on +	* the $query parameter. +	* +	* @param	string	$service_name	The name of the service +	* @param	string	$query			The query string of the current_uri +	*									used in redirects +	* @return	\OAuth\Common\Http\Uri\UriInterface +	*/ +	protected function get_current_uri($service_name, $query) +	{ +		if ($this->current_uri) +		{ +			$this->current_uri->setQuery($query); +			return $this->current_uri; +		} + +		$uri_factory = new \OAuth\Common\Http\Uri\UriFactory(); +		$current_uri = $uri_factory->createFromSuperGlobalArray($this->request->get_super_global(\phpbb\request\request_interface::SERVER)); +		$current_uri->setQuery($query); + +		$this->current_uri = $current_uri; +		return $current_uri; +	} + +	/** +	* Returns a new service object +	* +	* @param	string	$service_name			The name of the service +	* @param	\phpbb\auth\provider\oauth\token_storage $storage +	* @param	array	$service_credentials	{@see \phpbb\auth\provider\oauth\oauth::get_service_credentials} +	* @param	string	$query					The query string of the +	*											current_uri used in redirection +	* @param	array	$scopes					The scope of the request against +	*											the api. +	* @return	\OAuth\Common\Service\ServiceInterface +	* @throws	\Exception +	*/ +	protected function get_service($service_name, \phpbb\auth\provider\oauth\token_storage $storage, array $service_credentials, $query, array $scopes = array()) +	{ +		$current_uri = $this->get_current_uri($service_name, $query); + +		// Setup the credentials for the requests +		$credentials = new Credentials( +			$service_credentials['key'], +			$service_credentials['secret'], +			$current_uri->getAbsoluteUri() +		); + +		$service_factory = new \OAuth\ServiceFactory(); +		$service = $service_factory->createService($service_name, $credentials, $storage, $scopes); + +		if (!$service) +		{ +			throw new \Exception('AUTH_PROVIDER_OAUTH_ERROR_SERVICE_NOT_CREATED'); +		} + +		return $service; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_login_data() +	{ +		$login_data = array( +			'TEMPLATE_FILE'		=> 'login_body_oauth.html', +			'BLOCK_VAR_NAME'	=> 'oauth', +			'BLOCK_VARS'		=> array(), +		); + +		foreach ($this->service_providers as $service_name => $service_provider) +		{ +			// Only include data if the credentials are set +			$credentials = $service_provider->get_service_credentials(); +			if ($credentials['key'] && $credentials['secret']) +			{ +				$actual_name = str_replace('auth.provider.oauth.service.', '', $service_name); +				$redirect_url = build_url(false) . '&login=external&oauth_service=' . $actual_name; +				$login_data['BLOCK_VARS'][$service_name] = array( +					'REDIRECT_URL'	=> redirect($redirect_url, true), +					'SERVICE_NAME'	=> $this->user->lang['AUTH_PROVIDER_OAUTH_SERVICE_' . strtoupper($actual_name)], +				); +			} +		} + +		return $login_data; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function acp() +	{ +		$ret = array(); + +		foreach ($this->service_providers as $service_name => $service_provider) +		{ +			$actual_name = str_replace('auth.provider.oauth.service.', '', $service_name); +			$ret[] = 'auth_oauth_' . $actual_name . '_key'; +			$ret[] = 'auth_oauth_' . $actual_name . '_secret'; +		} + +		return $ret; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_acp_template($new_config) +	{ +		$ret = array( +			'BLOCK_VAR_NAME'	=> 'oauth_services', +			'BLOCK_VARS'		=> array(), +			'TEMPLATE_FILE'		=> 'auth_provider_oauth.html', +			'TEMPLATE_VARS'		=> array(), +		); + +		foreach ($this->service_providers as $service_name => $service_provider) +		{ +			$actual_name = str_replace('auth.provider.oauth.service.', '', $service_name); +			$ret['BLOCK_VARS'][$actual_name] = array( +				'ACTUAL_NAME'	=> $this->user->lang['AUTH_PROVIDER_OAUTH_SERVICE_' . strtoupper($actual_name)], +				'KEY'			=> $new_config['auth_oauth_' . $actual_name . '_key'], +				'NAME'			=> $actual_name, +				'SECRET'		=> $new_config['auth_oauth_' . $actual_name . '_secret'], +			); +		} + +		return $ret; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function login_link_has_necessary_data($login_link_data) +	{ +		if (empty($login_link_data)) +		{ +			return 'LOGIN_LINK_NO_DATA_PROVIDED'; +		} + +		if (!array_key_exists('oauth_service', $login_link_data) || !$login_link_data['oauth_service'] || +			!array_key_exists('link_method', $login_link_data) || !$login_link_data['link_method']) +		{ +			return 'LOGIN_LINK_MISSING_DATA'; +		} + +		return null; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function link_account(array $link_data) +	{ +		// Check for a valid link method (auth_link or login_link) +		if (!array_key_exists('link_method', $link_data) || +			!in_array($link_data['link_method'], array( +				'auth_link', +				'login_link', +			))) +		{ +			return 'LOGIN_LINK_MISSING_DATA'; +		} + +		// We must have an oauth_service listed, check for it two ways +		if (!array_key_exists('oauth_service', $link_data) || !$link_data['oauth_service']) +		{ +			$link_data['oauth_service'] = $this->request->variable('oauth_service', ''); + +			if (!$link_data['oauth_service']) +			{ +				return 'LOGIN_LINK_MISSING_DATA'; +			} +		} + +		$service_name = 'auth.provider.oauth.service.' . strtolower($link_data['oauth_service']); +		if (!array_key_exists($service_name, $this->service_providers)) +		{ +			return 'LOGIN_ERROR_OAUTH_SERVICE_DOES_NOT_EXIST'; +		} + +		switch ($link_data['link_method']) +		{ +			case 'auth_link': +				return $this->link_account_auth_link($link_data, $service_name); +			case 'login_link': +				return $this->link_account_login_link($link_data, $service_name); +		} +	} + +	/** +	* Performs the account linking for login_link +	* +	* @param	array	$link_data		The same variable given to {@see \phpbb\auth\provider\provider_interface::link_account} +	* @param	string	$service_name	The name of the service being used in +	*									linking. +	* @return	string|null	Returns a language constant (string) if an error is +	*						encountered, or null on success. +	*/ +	protected function link_account_login_link(array $link_data, $service_name) +	{ +		$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table); + +		// Check for an access token, they should have one +		if (!$storage->has_access_token_by_session($service_name)) +		{ +			return 'LOGIN_LINK_ERROR_OAUTH_NO_ACCESS_TOKEN'; +		} + +		// Prepare the query string +		$query = 'mode=login_link&login_link_oauth_service=' . strtolower($link_data['oauth_service']); + +		// Prepare for an authentication request +		$service_credentials = $this->service_providers[$service_name]->get_service_credentials(); +		$scopes = $this->service_providers[$service_name]->get_auth_scope(); +		$service = $this->get_service(strtolower($link_data['oauth_service']), $storage, $service_credentials, $query, $scopes); +		$this->service_providers[$service_name]->set_external_service_provider($service); + +		// The user has already authenticated successfully, request to authenticate again +		$unique_id = $this->service_providers[$service_name]->perform_token_auth(); + +		// Insert into table, they will be able to log in after this +		$data = array( +			'user_id'			=> $link_data['user_id'], +			'provider'			=> strtolower($link_data['oauth_service']), +			'oauth_provider_id'	=> $unique_id, +		); + +		$this->link_account_perform_link($data); +		// Update token storage to store the user_id +		$storage->set_user_id($link_data['user_id']); +	} + +	/** +	* Performs the account linking for auth_link +	* +	* @param	array	$link_data		The same variable given to {@see \phpbb\auth\provider\provider_interface::link_account} +	* @param	string	$service_name	The name of the service being used in +	*									linking. +	* @return	string|null	Returns a language constant (string) if an error is +	*						encountered, or null on success. +	*/ +	protected function link_account_auth_link(array $link_data, $service_name) +	{ +		$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table); +		$query = 'i=ucp_auth_link&mode=auth_link&link=1&oauth_service=' . strtolower($link_data['oauth_service']); +		$service_credentials = $this->service_providers[$service_name]->get_service_credentials(); +		$scopes = $this->service_providers[$service_name]->get_auth_scope(); +		$service = $this->get_service(strtolower($link_data['oauth_service']), $storage, $service_credentials, $query, $scopes); + +		if ($this->request->is_set('code', \phpbb\request\request_interface::GET)) +		{ +			$this->service_providers[$service_name]->set_external_service_provider($service); +			$unique_id = $this->service_providers[$service_name]->perform_auth_login(); + +			// Insert into table, they will be able to log in after this +			$data = array( +				'user_id'			=> $this->user->data['user_id'], +				'provider'			=> strtolower($link_data['oauth_service']), +				'oauth_provider_id'	=> $unique_id, +			); + +			$this->link_account_perform_link($data); +		} +		else +		{ +			$url = $service->getAuthorizationUri(); +			header('Location: ' . $url); +		} +	} + +	/** +	* Performs the query that inserts an account link +	* +	* @param	array	$data	This array is passed to db->sql_build_array +	*/ +	protected function link_account_perform_link(array $data) +	{ +		$sql = 'INSERT INTO ' . $this->auth_provider_oauth_token_account_assoc . ' +			' . $this->db->sql_build_array('INSERT', $data); +		$this->db->sql_query($sql); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function logout($data, $new_session) +	{ +		// Clear all tokens belonging to the user +		$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table); +		$storage->clearAllTokens(); + +		return; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_auth_link_data() +	{ +		$block_vars = array(); + +		// Get all external accounts tied to the current user +		$data = array( +			'user_id' => (int) $this->user->data['user_id'], +		); +		$sql = 'SELECT oauth_provider_id, provider FROM ' . $this->auth_provider_oauth_token_account_assoc . ' +			WHERE ' . $this->db->sql_build_array('SELECT', $data); +		$result = $this->db->sql_query($sql); +		$rows = $this->db->sql_fetchrowset($result); +		$this->db->sql_freeresult($result); + +		$oauth_user_ids = array(); + +		if ($rows !== false && sizeof($rows)) +		{ +			foreach ($rows as $row) +			{ +				$oauth_user_ids[$row['provider']] = $row['oauth_provider_id']; +			} +		} +		unset($rows); + +		foreach ($this->service_providers as $service_name => $service_provider) +		{ +			// Only include data if the credentials are set +			$credentials = $service_provider->get_service_credentials(); +			if ($credentials['key'] && $credentials['secret']) +			{ +				$actual_name = str_replace('auth.provider.oauth.service.', '', $service_name); + +				$block_vars[$service_name] = array( +					'HIDDEN_FIELDS'	=> array( +						'link'			=> (!isset($oauth_user_ids[$actual_name])), +						'oauth_service' => $actual_name, +					), + +					'SERVICE_NAME'	=> $this->user->lang['AUTH_PROVIDER_OAUTH_SERVICE_' . strtoupper($actual_name)], +					'UNIQUE_ID'		=> (isset($oauth_user_ids[$actual_name])) ? $oauth_user_ids[$actual_name] : null, +				); +			} +		} + +		return array( +			'BLOCK_VAR_NAME'	=> 'oauth', +			'BLOCK_VARS'		=> $block_vars, + +			'TEMPLATE_FILE'	=> 'ucp_auth_link_oauth.html', +		); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function unlink_account(array $link_data) +	{ +		if (!array_key_exists('oauth_service', $link_data) || !$link_data['oauth_service']) +		{ +			return 'LOGIN_LINK_MISSING_DATA'; +		} + +		// Remove the link +		$sql = 'DELETE FROM ' . $this->auth_provider_oauth_token_account_assoc . " +			WHERE provider = '" . $this->db->sql_escape($link_data['oauth_service']) . "' +				AND user_id = " . (int) $this->user->data['user_id']; +		$this->db->sql_query($sql); + +		// Clear all tokens belonging to the user on this servce +		$service_name = 'auth.provider.oauth.service.' . strtolower($link_data['oauth_service']); +		$storage = new \phpbb\auth\provider\oauth\token_storage($this->db, $this->user, $this->auth_provider_oauth_token_storage_table); +		$storage->clearToken($service_name); +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/base.php b/phpBB/phpbb/auth/provider/oauth/service/base.php new file mode 100644 index 0000000000..6adf64aa30 --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/base.php @@ -0,0 +1,51 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* Base OAuth abstract class that all OAuth services should implement +*/ +abstract class base implements \phpbb\auth\provider\oauth\service\service_interface +{ +	/** +	* External OAuth service provider +	* +	* @var \OAuth\Common\Service\ServiceInterface +	*/ +	protected $service_provider; + +	/** +	* {@inheritdoc} +	*/ +	public function get_external_service_provider() +	{ +		return $this->service_provider; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_auth_scope() +	{ +		return array(); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider) +	{ +		$this->service_provider = $service_provider; +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/bitly.php b/phpBB/phpbb/auth/provider/oauth/service/bitly.php new file mode 100644 index 0000000000..25e731a02c --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/bitly.php @@ -0,0 +1,94 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* Bitly OAuth service +*/ +class bitly extends \phpbb\auth\provider\oauth\service\base +{ +	/** +	* phpBB config +	* +	* @var \phpbb\config\config +	*/ +	protected $config; + +	/** +	* phpBB request +	* +	* @var \phpbb\request\request_interface +	*/ +	protected $request; + +	/** +	* Constructor +	* +	* @param	\phpbb\config\config				$config +	* @param	\phpbb\request\request_interface	$request +	*/ +	public function __construct(\phpbb\config\config $config, \phpbb\request\request_interface $request) +	{ +		$this->config = $config; +		$this->request = $request; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_service_credentials() +	{ +		return array( +			'key'		=> $this->config['auth_oauth_bitly_key'], +			'secret'	=> $this->config['auth_oauth_bitly_secret'], +		); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_auth_login() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Bitly)) +		{ +			throw new \phpbb\auth\provider\oauth\service\exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// This was a callback request from bitly, get the token +		$this->service_provider->requestAccessToken($this->request->variable('code', '')); + +		// Send a request with it +		$result = json_decode($this->service_provider->request('user/info'), true); + +		// Return the unique identifier returned from bitly +		return $result['data']['login']; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_token_auth() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Bitly)) +		{ +			throw new \phpbb\auth\provider\oauth\service\exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// Send a request with it +		$result = json_decode($this->service_provider->request('user/info'), true); + +		// Return the unique identifier returned from bitly +		return $result['data']['login']; +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/exception.php b/phpBB/phpbb/auth/provider/oauth/service/exception.php new file mode 100644 index 0000000000..d3e95bef0d --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/exception.php @@ -0,0 +1,21 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* OAuth service exception class +*/ +class exception extends \RuntimeException +{ +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/facebook.php b/phpBB/phpbb/auth/provider/oauth/service/facebook.php new file mode 100644 index 0000000000..bb98835e07 --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/facebook.php @@ -0,0 +1,94 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* Facebook OAuth service +*/ +class facebook extends base +{ +	/** +	* phpBB config +	* +	* @var \phpbb\config\config +	*/ +	protected $config; + +	/** +	* phpBB request +	* +	* @var \phpbb\request\request_interface +	*/ +	protected $request; + +	/** +	* Constructor +	* +	* @param	\phpbb\config\config				$config +	* @param	\phpbb\request\request_interface 	$request +	*/ +	public function __construct(\phpbb\config\config $config, \phpbb\request\request_interface $request) +	{ +		$this->config = $config; +		$this->request = $request; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_service_credentials() +	{ +		return array( +			'key'		=> $this->config['auth_oauth_facebook_key'], +			'secret'	=> $this->config['auth_oauth_facebook_secret'], +		); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_auth_login() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Facebook)) +		{ +			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// This was a callback request, get the token +		$this->service_provider->requestAccessToken($this->request->variable('code', '')); + +		// Send a request with it +		$result = json_decode($this->service_provider->request('/me'), true); + +		// Return the unique identifier +		return $result['id']; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_token_auth() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Facebook)) +		{ +			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// Send a request with it +		$result = json_decode($this->service_provider->request('/me'), true); + +		// Return the unique identifier +		return $result['id']; +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/google.php b/phpBB/phpbb/auth/provider/oauth/service/google.php new file mode 100644 index 0000000000..cb9f83a94f --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/google.php @@ -0,0 +1,105 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* Google OAuth service +*/ +class google extends base +{ +	/** +	* phpBB config +	* +	* @var \phpbb\config\config +	*/ +	protected $config; + +	/** +	* phpBB request +	* +	* @var \phpbb\request\request_interface +	*/ +	protected $request; + +	/** +	* Constructor +	* +	* @param	\phpbb\config\config				$config +	* @param	\phpbb\request\request_interface 	$request +	*/ +	public function __construct(\phpbb\config\config $config, \phpbb\request\request_interface $request) +	{ +		$this->config = $config; +		$this->request = $request; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_auth_scope() +	{ +		return array( +			'userinfo_email', +			'userinfo_profile', +		); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function get_service_credentials() +	{ +		return array( +			'key'		=> $this->config['auth_oauth_google_key'], +			'secret'	=> $this->config['auth_oauth_google_secret'], +		); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_auth_login() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Google)) +		{ +			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// This was a callback request, get the token +		$this->service_provider->requestAccessToken($this->request->variable('code', '')); + +		// Send a request with it +		$result = json_decode($this->service_provider->request('https://www.googleapis.com/oauth2/v1/userinfo'), true); + +		// Return the unique identifier +		return $result['id']; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function perform_token_auth() +	{ +		if (!($this->service_provider instanceof \OAuth\OAuth2\Service\Google)) +		{ +			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE'); +		} + +		// Send a request with it +		$result = json_decode($this->service_provider->request('https://www.googleapis.com/oauth2/v1/userinfo'), true); + +		// Return the unique identifier +		return $result['id']; +	} +} diff --git a/phpBB/phpbb/auth/provider/oauth/service/service_interface.php b/phpBB/phpbb/auth/provider/oauth/service/service_interface.php new file mode 100644 index 0000000000..e84eb247b6 --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/service/service_interface.php @@ -0,0 +1,73 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth\service; + +/** +* OAuth service interface +*/ +interface service_interface +{ +	/** +	* Returns an array of the scopes necessary for auth +	* +	* @return	array	An array of the required scopes +	*/ +	public function get_auth_scope(); + +	/** +	* Returns the external library service provider once it has been set +	* +	* @param	\OAuth\Common\Service\ServiceInterface|null +	*/ +	public function get_external_service_provider(); + +	/** +	* Returns an array containing the service credentials belonging to requested +	* service. +	* +	* @return	array	An array containing the 'key' and the 'secret' of the +	*					service in the form: +	*						array( +	*							'key'		=> string +	*							'secret'	=> string +	*						) +	*/ +	public function get_service_credentials(); + +	/** +	* Returns the results of the authentication in json format +	* +	* @throws	\phpbb\auth\provider\oauth\service\exception +	* @return	string	The unique identifier returned by the service provider +	*					that is used to authenticate the user with phpBB. +	*/ +	public function perform_auth_login(); + +	/** +	* Returns the results of the authentication in json format +	* Use this function when the user already has an access token +	* +	* @throws	\phpbb\auth\provider\oauth\service\exception +	* @return	string	The unique identifier returned by the service provider +	*					that is used to authenticate the user with phpBB. +	*/ +	public function perform_token_auth(); + +	/** +	* Sets the external library service provider +	* +	* @param	\OAuth\Common\Service\ServiceInterface	$service_provider +	*/ +	public function set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider); +} diff --git a/phpBB/phpbb/auth/provider/oauth/token_storage.php b/phpBB/phpbb/auth/provider/oauth/token_storage.php new file mode 100644 index 0000000000..023cf402ca --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/token_storage.php @@ -0,0 +1,363 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider\oauth; + + +use OAuth\OAuth1\Token\StdOAuth1Token; +use OAuth\Common\Token\TokenInterface; +use OAuth\Common\Storage\TokenStorageInterface; +use OAuth\Common\Storage\Exception\TokenNotFoundException; + +/** +* OAuth storage wrapper for phpbb's cache +*/ +class token_storage implements TokenStorageInterface +{ +	/** +	* Cache driver. +	* +	* @var \phpbb\db\driver\driver_interface +	*/ +	protected $db; + +	/** +	* phpBB user +	* +	* @var \phpbb\user +	*/ +	protected $user; + +	/** +	* OAuth token table +	* +	* @var string +	*/ +	protected $auth_provider_oauth_table; + +	/** +	* @var object|TokenInterface +	*/ +	protected $cachedToken; + +	/** +	* Creates token storage for phpBB. +	* +	* @param	\phpbb\db\driver\driver_interface	$db +	* @param	\phpbb\user		$user +	* @param	string			$auth_provider_oauth_table +	*/ +	public function __construct(\phpbb\db\driver\driver_interface $db, \phpbb\user $user, $auth_provider_oauth_table) +	{ +		$this->db = $db; +		$this->user = $user; +		$this->auth_provider_oauth_table = $auth_provider_oauth_table; +	} + +	/** +	* {@inheritdoc} +	*/ +	public function retrieveAccessToken($service) +	{ +		$service = $this->get_service_name_for_db($service); + +		if ($this->cachedToken instanceof TokenInterface) +		{ +			return $this->cachedToken; +		} + +		$data = array( +			'user_id'	=> (int) $this->user->data['user_id'], +			'provider'	=> $service, +		); + +		if ((int) $this->user->data['user_id'] === ANONYMOUS) +		{ +			$data['session_id']	= $this->user->data['session_id']; +		} + +		return $this->_retrieve_access_token($data); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function storeAccessToken($service, TokenInterface $token) +	{ +		$service = $this->get_service_name_for_db($service); + +		$this->cachedToken = $token; + +		$data = array( +			'user_id'		=> (int) $this->user->data['user_id'], +			'provider'		=> $service, +			'oauth_token'	=> $this->json_encode_token($token), +			'session_id'	=> $this->user->data['session_id'], +		); + +		$sql = 'INSERT INTO ' . $this->auth_provider_oauth_table . ' +			' . $this->db->sql_build_array('INSERT', $data); +		$this->db->sql_query($sql); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function hasAccessToken($service) +	{ +		$service = $this->get_service_name_for_db($service); + +		if ($this->cachedToken) { +			return true; +		} + +		$data = array( +			'user_id'	=> (int) $this->user->data['user_id'], +			'provider'	=> $service, +		); + +		if ((int) $this->user->data['user_id'] === ANONYMOUS) +		{ +			$data['session_id']	= $this->user->data['session_id']; +		} + +		return $this->_has_acess_token($data); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function clearToken($service) +	{ +		$service = $this->get_service_name_for_db($service); + +		$this->cachedToken = null; + +		$sql = 'DELETE FROM ' . $this->auth_provider_oauth_table . ' +			WHERE user_id = ' . (int) $this->user->data['user_id'] . " +				AND provider = '" . $this->db->sql_escape($service) . "'"; + +		if ((int) $this->user->data['user_id'] === ANONYMOUS) +		{ +			$sql .= " AND session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "'"; +		} + +		$this->db->sql_query($sql); +	} + +	/** +	* {@inheritdoc} +	*/ +	public function clearAllTokens() +	{ +		$this->cachedToken = null; + +		$sql = 'DELETE FROM ' . $this->auth_provider_oauth_table . ' +			WHERE user_id = ' . (int) $this->user->data['user_id']; + +		if ((int) $this->user->data['user_id'] === ANONYMOUS) +		{ +			$sql .= " AND session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "'"; +		} + +		$this->db->sql_query($sql); +	} + +	/** +	* Updates the user_id field in the database assosciated with the token +	* +	* @param	int	$user_id +	*/ +	public function set_user_id($user_id) +	{ +		if (!$this->cachedToken) +		{ +			return; +		} + +		$sql = 'UPDATE ' . $this->auth_provider_oauth_table . ' +			SET ' . $this->db->sql_build_array('UPDATE', array( +					'user_id' => (int) $user_id +				)) . ' +				WHERE user_id = ' . (int) $this->user->data['user_id'] . " +					AND session_id = '" . $this->db->sql_escape($this->user->data['session_id']) . "'"; +		$this->db->sql_query($sql); +	} + +	/** +	* Checks to see if an access token exists solely by the session_id of the user +	* +	* @param	string	$service	The name of the OAuth service +	* @return	bool	true if they have token, false if they don't +	*/ +	public function has_access_token_by_session($service) +	{ +		$service = $this->get_service_name_for_db($service); + +		if ($this->cachedToken) +		{ +			return true; +		} + +		$data = array( +			'session_id'	=> $this->user->data['session_id'], +			'provider'		=> $service, +		); + +		return $this->_has_acess_token($data); +	} + +	/** +	* A helper function that performs the query for has access token functions +	* +	* @param	array	$data +	* @return	bool +	*/ +	protected function _has_acess_token($data) +	{ +		return (bool) $this->get_access_token_row($data); +	} + +	public function retrieve_access_token_by_session($service) +	{ +		$service = $this->get_service_name_for_db($service); + +		if ($this->cachedToken instanceof TokenInterface) { +			return $this->cachedToken; +		} + +		$data = array( +			'session_id'	=> $this->user->data['session_id'], +			'provider'	=> $service, +		); + +		return $this->_retrieve_access_token($data); +	} + +	/** +	* A helper function that performs the query for retrieve access token functions +	* Also checks if the token is a valid token +	* +	* @param	array	$data +	* @return	mixed +	* @throws \OAuth\Common\Storage\Exception\TokenNotFoundException +	*/ +	protected function _retrieve_access_token($data) +	{ +		$row = $this->get_access_token_row($data); + +		if (!$row) +		{ +			throw new TokenNotFoundException('AUTH_PROVIDER_OAUTH_TOKEN_ERROR_NOT_STORED'); +		} + +		$token = $this->json_decode_token($row['oauth_token']); + +		// Ensure that the token was serialized/unserialized correctly +		if (!($token instanceof TokenInterface)) +		{ +			$this->clearToken($data['provider']); +			throw new TokenNotFoundException('AUTH_PROVIDER_OAUTH_TOKEN_ERROR_INCORRECTLY_STORED'); +		} + +		$this->cachedToken = $token; +		return $token; +	} + +	/** +	* A helper function that performs the query for retrieving an access token +	* +	* @param	array	$data +	* @return	mixed +	*/ +	protected function get_access_token_row($data) +	{ +		$sql = 'SELECT oauth_token FROM ' . $this->auth_provider_oauth_table . ' +			WHERE ' . $this->db->sql_build_array('SELECT', $data); +		$result = $this->db->sql_query($sql); +		$row = $this->db->sql_fetchrow($result); +		$this->db->sql_freeresult($result); + +		return $row; +	} + +	public function json_encode_token(TokenInterface $token) +	{ +		$members = array( +			'accessToken'	=> $token->getAccessToken(), +			'endOfLife'		=> $token->getEndOfLife(), +			'extraParams'	=> $token->getExtraParams(), +			'refreshToken'	=> $token->getRefreshToken(), + +			'token_class'	=> get_class($token), +		); + +		// Handle additional data needed for OAuth1 tokens +		if ($token instanceof StdOAuth1Token) +		{ +			$members['requestToken']		= $token->getRequestToken(); +			$members['requestTokenSecret']	= $token->getRequestTokenSecret(); +			$members['accessTokenSecret']	= $token->getAccessTokenSecret(); +		} + +		return json_encode($members); +	} + +	public function json_decode_token($json) +	{ +		$token_data = json_decode($json, true); + +		if ($token_data === null) +		{ +			throw new TokenNotFoundException('AUTH_PROVIDER_OAUTH_TOKEN_ERROR_INCORRECTLY_STORED'); +		} + +		$token_class	= $token_data['token_class']; +		$access_token	= $token_data['accessToken']; +		$refresh_token	= $token_data['refreshToken']; +		$endOfLife		= $token_data['endOfLife']; +		$extra_params	= $token_data['extraParams']; + +		// Create the token +		$token = new $token_class($access_token, $refresh_token, TokenInterface::EOL_NEVER_EXPIRES, $extra_params); +		$token->setEndOfLife($endOfLife); + +		// Handle OAuth 1.0 specific elements +		if ($token instanceof StdOAuth1Token) +		{ +			$token->setRequestToken($token_data['requestToken']); +			$token->setRequestTokenSecret($token_data['requestTokenSecret']); +			$token->setAccessTokenSecret($token_data['accessTokenSecret']); +		} + +		return $token; +	} + +	/** +	* Returns the name of the service as it must be stored in the database. +	* +	* @param	string	$service	The name of the OAuth service +	* @return	string	The name of the OAuth service as it needs to be stored +	*					in the database. +	*/ +	protected function get_service_name_for_db($service) +	{ +		// Enforce the naming convention for oauth services +		if (strpos($service, 'auth.provider.oauth.service.') !== 0) +		{ +			$service = 'auth.provider.oauth.service.' . strtolower($service); +		} + +		return $service; +	} +} diff --git a/phpBB/phpbb/auth/provider/provider_interface.php b/phpBB/phpbb/auth/provider/provider_interface.php new file mode 100644 index 0000000000..613297cefc --- /dev/null +++ b/phpBB/phpbb/auth/provider/provider_interface.php @@ -0,0 +1,193 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth\provider; + +/** +* The interface authentication provider classes have to implement. +*/ +interface provider_interface +{ +	/** +	 * Checks whether the user is currently identified to the authentication +	 * provider. +	 * Called in acp_board while setting authentication plugins. +	 * Changing to an authentication provider will not be permitted in acp_board +	 * if there is an error. +	 * +	 * @return 	boolean|string 	False if the user is identified, otherwise an +	 *							error message, or null if not implemented. +	 */ +	public function init(); + +	/** +	 * Performs login. +	 * +	 * @param	string	$username 	The name of the user being authenticated. +	 * @param	string	$password	The password of the user. +	 * @return	array	An associative array of the format: +	 *						array( +	 *							'status' => status constant +	 *							'error_msg' => string +	 *							'user_row' => array +	 *						) +	 *					A fourth key of the array may be present: +	 *					'redirect_data'	This key is only used when 'status' is +	 *					equal to LOGIN_SUCCESS_LINK_PROFILE and its value is an +	 *					associative array that is turned into GET variables on +	 *					the redirect url. +	 */ +	public function login($username, $password); + +	/** +	 * Autologin function +	 * +	 * @return 	array|null	containing the user row, empty if no auto login +	 * 						should take place, or null if not impletmented. +	 */ +	public function autologin(); + +	/** +	 * This function is used to output any required fields in the authentication +	 * admin panel. It also defines any required configuration table fields. +	 * +	 * @return	array|null	Returns null if not implemented or an array of the +	 *						configuration fields of the provider. +	 */ +	public function acp(); + +	/** +	 * This function updates the template with variables related to the acp +	 * options with whatever configuraton values are passed to it as an array. +	 * It then returns the name of the acp file related to this authentication +	 * provider. +	 * @param	array	$new_config Contains the new configuration values that +	 *								have been set in acp_board. +	 * @return	array|null		Returns null if not implemented or an array with +	 *							the template file name and an array of the vars +	 *							that the template needs that must conform to the +	 *							following example: +	 *							array( +	 *								'TEMPLATE_FILE'	=> string, +	 *								'TEMPLATE_VARS'	=> array(...), +	 *							) +	 *							An optional third element may be added to this +	 *							array: 'BLOCK_VAR_NAME'. If this is present, +	 *							then its value should be a string that is used +	 *							to designate the name of the loop used in the +	 *							ACP template file. When this is present, an +	 *							additional key named 'BLOCK_VARS' is required. +	 *							This must be an array containing at least one +	 *							array of variables that will be assigned during +	 *							the loop in the template. An example of this is +	 *							presented below: +	 *							array( +	 *								'BLOCK_VAR_NAME'	=> string, +	 *								'BLOCK_VARS'		=> array( +	 *									'KEY IS UNIMPORTANT' => array(...), +	 *								), +	 *								'TEMPLATE_FILE'	=> string, +	 *								'TEMPLATE_VARS'	=> array(...), +	 *							) +	 */ +	public function get_acp_template($new_config); + +	/** +	* Returns an array of data necessary to build custom elements on the login +	* form. +	* +	* @return	array|null	If this function is not implemented on an auth +	*						provider then it returns null. If it is implemented +	*						it will return an array of up to four elements of +	*						which only 'TEMPLATE_FILE'. If 'BLOCK_VAR_NAME' is +	*						present then 'BLOCK_VARS' must also be present in +	*						the array. The fourth element 'VARS' is also +	*						optional. The array, with all four elements present +	*						looks like the following: +	*						array( +	*							'TEMPLATE_FILE'		=> string, +	*							'BLOCK_VAR_NAME'	=> string, +	*							'BLOCK_VARS'		=> array(...), +	*							'VARS'				=> array(...), +	*						) +	*/ +	public function get_login_data(); + +	/** +	 * Performs additional actions during logout. +	 * +	 * @param 	array	$data			An array corresponding to +	 *									\phpbb\session::data +	 * @param 	boolean	$new_session	True for a new session, false for no new +	 *									session. +	 */ +	public function logout($data, $new_session); + +	/** +	 * The session validation function checks whether the user is still logged +	 * into phpBB. +	 * +	 * @param 	array 	$user +	 * @return 	boolean	true if the given user is authenticated, false if the +	 * 					session should be closed, or null if not implemented. +	 */ +	public function validate_session($user); + +	/** +	* Checks to see if $login_link_data contains all information except for the +	* user_id of an account needed to successfully link an external account to +	* a forum account. +	* +	* @param	array	$login_link_data	Any data needed to link a phpBB account to +	*								an external account. +	* @return	string|null	Returns a string with a language constant if there +	*						is data missing or null if there is no error. +	*/ +	public function login_link_has_necessary_data($login_link_data); + +	/** +	* Links an external account to a phpBB account. +	* +	* @param	array	$link_data	Any data needed to link a phpBB account to +	*								an external account. +	*/ +	public function link_account(array $link_data); + +	/** +	* Returns an array of data necessary to build the ucp_auth_link page +	* +	* @return	array|null	If this function is not implemented on an auth +	*						provider then it returns null. If it is implemented +	*						it will return an array of up to four elements of +	*						which only 'TEMPLATE_FILE'. If 'BLOCK_VAR_NAME' is +	*						present then 'BLOCK_VARS' must also be present in +	*						the array. The fourth element 'VARS' is also +	*						optional. The array, with all four elements present +	*						looks like the following: +	*						array( +	*							'TEMPLATE_FILE'		=> string, +	*							'BLOCK_VAR_NAME'	=> string, +	*							'BLOCK_VARS'		=> array(...), +	*							'VARS'				=> array(...), +	*						) +	*/ +	public function get_auth_link_data(); + +	/** +	* Unlinks an external account from a phpBB account. +	* +	* @param	array	$link_data	Any data needed to unlink a phpBB account +	*								from a phpbb account. +	*/ +	public function unlink_account(array $link_data); +} diff --git a/phpBB/phpbb/auth/provider_collection.php b/phpBB/phpbb/auth/provider_collection.php new file mode 100644 index 0000000000..a74a2135dc --- /dev/null +++ b/phpBB/phpbb/auth/provider_collection.php @@ -0,0 +1,65 @@ +<?php +/** +* +* This file is part of the phpBB Forum Software package. +* +* @copyright (c) phpBB Limited <https://www.phpbb.com> +* @license GNU General Public License, version 2 (GPL-2.0) +* +* For full copyright and license information, please see +* the docs/CREDITS.txt file. +* +*/ + +namespace phpbb\auth; + +use Symfony\Component\DependencyInjection\ContainerInterface; + +/** +* Collection of auth providers to be configured at container compile time. +*/ +class provider_collection extends \phpbb\di\service_collection +{ +	/** @var \phpbb\config\config phpBB Config */ +	protected $config; + +	/** +	* Constructor +	* +	* @param ContainerInterface $container Container object +	* @param \phpbb\config\config $config phpBB config +	*/ +	public function __construct(ContainerInterface $container, \phpbb\config\config $config) +	{ +		$this->container = $container; +		$this->config = $config; +	} + +	/** +	* Get an auth provider. +	* +	* @return object	Default auth provider selected in config if it +	*			does exist. Otherwise the standard db auth +	*			provider. +	* @throws \RuntimeException If neither the auth provider that +	*			is specified by the phpBB config nor the db +	*			auth provider exist. The db auth provider +	*			should always exist in a phpBB installation. +	*/ +	public function get_provider() +	{ +		if ($this->offsetExists('auth.provider.' . basename(trim($this->config['auth_method'])))) +		{ +			return $this->offsetGet('auth.provider.' . basename(trim($this->config['auth_method']))); +		} +		// Revert to db auth provider if selected method does not exist +		else if ($this->offsetExists('auth.provider.db')) +		{ +			return $this->offsetGet('auth.provider.db'); +		} +		else +		{ +			throw new \RuntimeException(sprintf('The authentication provider for the authentication method "%1$s" does not exist. It was not possible to recover from this by reverting to the database authentication provider.', $this->config['auth_method'])); +		} +	} +}  | 
