Basic OAuth class based on oauth-php. WIP

2012-07-31 14:34:45 +01:00 · 2012-07-31 14:34:45 +01:00 · 78bbcc8aea
parent 5922599f48
commit 78bbcc8aea
1 changed files with 128 additions and 0 deletions
--- a/lib/oauth.php
+++ b/lib/oauth.php
@ -0,0 +1,128 @@
+<?php
+/**
+* ownCloud
+*
+* @author Tom Needham 
+* @copyright 2012 Tom Needham tom@owncloud.com 
+* 
+* This library is free software; you can redistribute it and/or
+* modify it under the terms of the GNU AFFERO GENERAL PUBLIC LICENSE
+* License as published by the Free Software Foundation; either 
+* version 3 of the License, or any later version.
+* 
+* This library is distributed in the hope that it will be useful,
+* but WITHOUT ANY WARRANTY; without even the implied warranty of
+* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+* GNU AFFERO GENERAL PUBLIC LICENSE for more details.
+*  
+* You should have received a copy of the GNU Affero General Public 
+* License along with this library.  If not, see <http://www.gnu.org/licenses/>.
+* 
+*/
+
+class OC_OAuth {
+	
+	/**
+	 * the oauth-php server object
+	 */
+	private static $server;
+	
+	/**
+	 * the oauth-php oauthstore object
+	 */
+	private static $store;
+	
+	/**
+	 * initialises the OAuth store and server
+	 */
+	private static function init(){
+		// Include the libraries
+		require_once(OC::$SERVERROOT.'3rdparty/oauth-php/library/OAuthServer.php');
+		require_once(OC::$SERVERROOT.'3rdparty/oauth-php/library/OAuthStore.php');
+		// Create the server object
+		self::$server = new OAuthServer();
+		// Initialise the OAuth store
+		self::$store = OAuthStore::instance('owncloud');
+	}
+	
+	/**
+	 * gets a request token
+	 * TODO save the scopes in the database with this token
+	 */
+	public static function getRequestToken(){
+		self::init();
+		self::$server->requestToken();
+	}
+	
+	/**
+	 * get the scopes requested by this token
+	 * @param string $requesttoken
+	 * @return array scopes
+	 */
+	public static function getScopes($requesttoken){
+		// TODO
+	}
+	
+	/**
+	 * exchanges authorised request token for access token
+	 */
+	public static function getAccessToken(){
+		self::init();
+		self::$server->accessToken();
+	}
+	
+	/**
+	 * registers a new consumer
+	 * @param array $details consumer details, keys requester_name and requester_email required
+	 * @param string $user the owncloud user adding the consumer
+	 * @return array the consumers details including secret and key
+	 */
+	public static function registerConsumer($details, $user=null){
+		self::init();
+		$user = is_null($user) ? OC_User::getUser() : $user;
+		$consumer = self::$store->updateConsumer($details, $user, OC_Group::inGroup($user, 'admin'));
+		return $consumer;	
+	}
+	
+	/**
+	 * gets a list of consumers
+	 * @param string $user
+	 */
+	public static function getConsumers($user=null){
+		$user = is_null($user) ? OC_User::getUser() : $user;
+		return self::$store->listConsumers($user);
+	}
+	
+	/**
+	 * authorises a request token - redirects to callback
+	 * @param string $user
+	 * @param bool $authorised
+	 */
+	public static function authoriseToken($user=null){
+		$user = is_null($user) ? OC_User::getUser() : $user;
+		self::$server->authorizeVerify();
+		self::$server->authorize($authorised, $user);
+	}
+	
+	/**
+	 * checks if request is authorised
+	 * TODO distinguish between failures as one is a 400 error and other is 401
+	 * @return string|int
+	 */
+	public static function isAuthorised(){
+		if(OAuthRequestVerifier::requestIsSigned()){
+			try{
+				$req = new OAuthRequestVerifier();
+				$user = $req->verify();
+				return $user;
+			} catch(OAuthException $e) {
+				// 401 Unauthorised
+				return false;
+			}
+		} else {
+			// Bad request
+			return false;
+		}
+	}
+	
+}