1 files changed, 73 insertions, 0 deletions
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);
+}