diff options
Diffstat (limited to 'phpBB/phpbb/auth/provider')
| -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 | 239 | ||||
| -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 | 630 | ||||
| -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 | 
14 files changed, 2594 insertions, 0 deletions
| diff --git a/phpBB/phpbb/auth/provider/apache.php b/phpBB/phpbb/auth/provider/apache.php new file mode 100644 index 0000000000..aa5bf64335 --- /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		Database object +	 * @param	\phpbb\config\config 		$config		Config object +	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords Manager object +	 * @param	\phpbb\request\request 		$request		Request object +	 * @param	\phpbb\user 			$user		User object +	 * @param	string 				$phpbb_root_path		Relative path to phpBB root +	 * @param	string 				$php_ext		PHP file extension +	 */ +	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'		=> $this->user_row($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($this->user_row($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..d8c5fb72de --- /dev/null +++ b/phpBB/phpbb/auth/provider/db.php @@ -0,0 +1,239 @@ +<?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; + +	/** +	* DI container +	* +	* @var \Symfony\Component\DependencyInjection\ContainerInterface +	*/ +	protected $phpbb_container; + +	/** +	 * 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	\Symfony\Component\DependencyInjection\ContainerInterface $phpbb_container DI container +	 * @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, \Symfony\Component\DependencyInjection\ContainerInterface $phpbb_container, $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; +		$this->phpbb_container = $phpbb_container; +	} + +	/** +	 * {@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 * +			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); +			$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) +		{ +			$captcha_factory = $this->phpbb_container->get('captcha.factory'); +			$captcha = $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'], $row)) +		{ +			// 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'		=> '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..c71950c698 --- /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		Database object +	 * @param	\phpbb\config\config		$config		Config object +	 * @param	\phpbb\passwords\manager	$passwords_manager		Passwords manager object +	 * @param	\phpbb\user			$user		User object +	 */ +	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_BASE_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..c0ce3f1fba --- /dev/null +++ b/phpBB/phpbb/auth/provider/oauth/oauth.php @@ -0,0 +1,630 @@ +<?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; + +	/** +	* DI container +	* +	* @var \Symfony\Component\DependencyInjection\ContainerInterface +	*/ +	protected $phpbb_container; + +	/** +	* phpBB root path +	* +	* @var string +	*/ +	protected $phpbb_root_path; + +	/** +	* PHP file extension +	* +	* @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	\Symfony\Component\DependencyInjection\ContainerInterface $phpbb_container DI container +	* @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, \Symfony\Component\DependencyInjection\ContainerInterface $phpbb_container, $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_container = $phpbb_container; +		$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_container, $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); +} | 
