Augmentation vers version 3.3.0

install/update/new/phpbb/auth/provider/oauth/service/base.php

@@ -0,0 +1,59 @@
+<?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 service_interface
+{
+	/**
+	 * External OAuth service provider
+	 *
+	 * @var \OAuth\Common\Service\ServiceInterface
+	 */
+	protected $service_provider;
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_auth_scope()
+	{
+		return [];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_external_service_class()
+	{
+		return '';
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_external_service_provider()
+	{
+		return $this->service_provider;
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function set_external_service_provider(\OAuth\Common\Service\ServiceInterface $service_provider)
+	{
+		$this->service_provider = $service_provider;
+	}
+}

install/update/new/phpbb/auth/provider/oauth/service/bitly.php

@@ -0,0 +1,107 @@
+<?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 base
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\request\request_interface */
+	protected $request;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \phpbb\config\config				$config		Config object
+	 * @param \phpbb\request\request_interface	$request	Request object
+	 */
+	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 [
+			'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 exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE');
+		}
+
+		try
+		{
+			// This was a callback request, get the token
+			$this->service_provider->requestAccessToken($this->request->variable('code', ''));
+		}
+		catch (\OAuth\Common\Http\Exception\TokenResponseException $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('user/info'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// 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 exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('user/info'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// Return the unique identifier
+		return $result['data']['login'];
+	}
+}

install/update/new/phpbb/auth/provider/oauth/service/facebook.php

@@ -0,0 +1,107 @@
+<?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
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\request\request_interface */
+	protected $request;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \phpbb\config\config				$config		Config object
+	 * @param \phpbb\request\request_interface	$request	Request object
+	 */
+	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 [
+			'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');
+		}
+
+		try
+		{
+			// This was a callback request, get the token
+			$this->service_provider->requestAccessToken($this->request->variable('code', ''));
+		}
+		catch (\OAuth\Common\Http\Exception\TokenResponseException $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('/me'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// 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');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('/me'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// Return the unique identifier
+		return $result['id'];
+	}
+}

install/update/new/phpbb/auth/provider/oauth/service/google.php

@@ -0,0 +1,118 @@
+<?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
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\request\request_interface */
+	protected $request;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \phpbb\config\config				$config		Config object
+	 * @param \phpbb\request\request_interface	$request	Request object
+	 */
+	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 [
+			'userinfo_email',
+			'userinfo_profile',
+		];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function get_service_credentials()
+	{
+		return [
+			'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');
+		}
+
+		try
+		{
+			// This was a callback request, get the token
+			$this->service_provider->requestAccessToken($this->request->variable('code', ''));
+		}
+		catch (\OAuth\Common\Http\Exception\TokenResponseException $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('https://www.googleapis.com/oauth2/v1/userinfo'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// 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');
+		}
+
+		try
+		{
+			// Send a request with it
+			$result = (array) json_decode($this->service_provider->request('https://www.googleapis.com/oauth2/v1/userinfo'), true);
+		}
+		catch (\OAuth\Common\Exception\Exception $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// Return the unique identifier
+		return $result['id'];
+	}
+}

install/update/new/phpbb/auth/provider/oauth/service/service_interface.php

@@ -0,0 +1,85 @@
+<?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 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();
+
+	/**
+	 * Returns the class of external library service provider that has to be used.
+	 *
+	 * @return string	If the string is a class, it will register the provided string as a class,
+	 *						which later will be generated as the OAuth external service provider.
+	 * 					If the string is not a class, it will use this string,
+	 * 						trying to generate a service for the version 2 and 1 respectively:
+	 * 						\OAuth\OAuth2\Service\<string>
+	 * 					If the string is empty, it will default to OAuth's standard service classes,
+	 * 						trying to generate a service for the version 2 and 1 respectively:
+	 * 						\OAuth\OAuth2\Service\Facebook
+	 */
+	public function get_external_service_class();
+
+	/**
+	 * Returns the external library service provider once it has been set
+	 */
+	public function get_external_service_provider();
+
+	/**
+	 * 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);
+}

install/update/new/phpbb/auth/provider/oauth/service/twitter.php

@@ -0,0 +1,111 @@
+<?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;
+
+/**
+ * Twitter OAuth service
+ */
+class twitter extends base
+{
+	/** @var \phpbb\config\config */
+	protected $config;
+
+	/** @var \phpbb\request\request_interface */
+	protected $request;
+
+	/**
+	 * Constructor.
+	 *
+	 * @param \phpbb\config\config				$config		Config object
+	 * @param \phpbb\request\request_interface	$request	Request object
+	 */
+	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 [
+			'key'		=> $this->config['auth_oauth_twitter_key'],
+			'secret'	=> $this->config['auth_oauth_twitter_secret'],
+		];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function perform_auth_login()
+	{
+		if (!($this->service_provider instanceof \OAuth\OAuth1\Service\Twitter))
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE');
+		}
+
+		$storage = $this->service_provider->getStorage();
+
+		try
+		{
+			/** @var \OAuth\OAuth1\Token\TokenInterface $token */
+			$token = $storage->retrieveAccessToken('Twitter');
+		}
+		catch (\OAuth\Common\Storage\Exception\TokenNotFoundException $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		$secret = $token->getRequestTokenSecret();
+
+		try
+		{
+			// This was a callback request, get the token
+			$this->service_provider->requestAccessToken(
+				$this->request->variable('oauth_token', ''),
+				$this->request->variable('oauth_verifier', ''),
+				$secret
+			);
+		}
+		catch (\OAuth\Common\Http\Exception\TokenResponseException $e)
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_REQUEST');
+		}
+
+		// Send a request with it
+		$result = (array) json_decode($this->service_provider->request('account/verify_credentials.json'), true);
+
+		// Return the unique identifier
+		return $result['id'];
+	}
+
+	/**
+	 * {@inheritdoc}
+	 */
+	public function perform_token_auth()
+	{
+		if (!($this->service_provider instanceof \OAuth\OAuth1\Service\Twitter))
+		{
+			throw new exception('AUTH_PROVIDER_OAUTH_ERROR_INVALID_SERVICE_TYPE');
+		}
+
+		// Send a request with it
+		$result = (array) json_decode($this->service_provider->request('account/verify_credentials.json'), true);
+
+		// Return the unique identifier
+		return $result['id'];
+	}
+}