X-Git-Url: https://git.mxchange.org/?a=blobdiff_plain;f=lib%2Fapiauth.php;h=99500404f94712673848b84f46e459c3521cc312;hb=cc256aaa67a2fe009f818874a79901d921085905;hp=3229ab19fda77008691e703e8fe4e8ba5f425694;hpb=8e91e053923f395d4dc0ad7f3f328953c9b17145;p=quix0rs-gnu-social.git diff --git a/lib/apiauth.php b/lib/apiauth.php index 3229ab19fd..99500404f9 100644 --- a/lib/apiauth.php +++ b/lib/apiauth.php @@ -29,7 +29,7 @@ * @author mEDI * @author Sarven Capadisli * @author Zach Copley - * @copyright 2009 StatusNet, Inc. + * @copyright 2009-2010 StatusNet, Inc. * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0 * @link http://status.net/ */ @@ -39,7 +39,7 @@ if (!defined('STATUSNET')) { } require_once INSTALLDIR . '/lib/api.php'; -require_once INSTALLDIR . '/lib/apioauthstore.php'; +require_once INSTALLDIR . '/lib/apioauth.php'; /** * Actions extending this class will require auth @@ -53,11 +53,12 @@ require_once INSTALLDIR . '/lib/apioauthstore.php'; class ApiAuthAction extends ApiAction { - var $access_token; - var $oauth_access_type; + var $auth_user_nickname = null; + var $auth_user_password = null; /** - * Take arguments for running, and output basic auth header if needed + * Take arguments for running, looks for an OAuth request, + * and outputs basic auth header if needed * * @param array $args $_REQUEST args * @@ -69,118 +70,151 @@ class ApiAuthAction extends ApiAction { parent::prepare($args); + // NOTE: $this->auth_user has to get set in prepare(), not handle(), + // because subclasses do stuff with it in their prepares. + if ($this->requiresAuth()) { - $this->consumer_key = $this->arg('oauth_consumer_key'); - $this->access_token = $this->arg('oauth_token'); + $oauthReq = $this->getOAuthRequest(); + + if (!$oauthReq) { + $this->checkBasicAuthUser(true); + } else { + $this->checkOAuthRequest($oauthReq); + } + } else { + + // Check to see if a basic auth user is there even + // if one's not required + $this->checkBasicAuthUser(false); + } + + // Reject API calls with the wrong access level - if (!empty($this->access_token)) { - $this->checkOAuthRequest(); - } else { - $this->checkBasicAuthUser(); - } + if ($this->isReadOnly($args) == false) { + if ($this->access != self::READ_WRITE) { + $msg = _('API resource requires read-write access, ' . + 'but you only have read access.'); + $this->clientError($msg, 401, $this->format); + exit; + } } return true; } - function checkOAuthRequest() + /** + * Determine whether the request is an OAuth request. + * This is to avoid doign any unnecessary DB lookups. + * + * @return mixed the OAuthRequest or false + * + */ + + function getOAuthRequest() { - common_debug("We have an OAuth request."); + ApiOauthAction::cleanRequest(); + + $req = OAuthRequest::from_request(); - $datastore = new ApiStatusNetOAuthDataStore(); - $server = new OAuthServer($datastore); - $hmac_method = new OAuthSignatureMethod_HMAC_SHA1(); + $consumer = $req->get_parameter('oauth_consumer_key'); + $accessToken = $req->get_parameter('oauth_token'); - $server->add_signature_method($hmac_method); + // XXX: Is it good enough to assume it's not meant to be an + // OAuth request if there is no consumer or token? --Z - $this->cleanRequest(); + if (empty($consumer) || empty($accessToken)) { + return false; + } - try { + return $req; + } - $req = OAuthRequest::from_request(); - $server->verify_request($req); + /** + * Verifies the OAuth request signature, sets the auth user + * and access type (read-only or read-write) + * + * @param OAuthRequest $request the OAuth Request + * + * @return nothing + * + */ - common_debug("Good OAuth request!"); + function checkOAuthRequest($request) + { + $datastore = new ApiStatusNetOAuthDataStore(); + $server = new OAuthServer($datastore); + $hmac_method = new OAuthSignatureMethod_HMAC_SHA1(); - $app = Oauth_application::getByConsumerKey($this->consumer_key); + $server->add_signature_method($hmac_method); - if (empty($app)) { + try { - // this should really not happen - common_log(LOG_WARN, - "Couldn't find the OAuth app for consumer key: $this->consumer_key"); + $server->verify_request($request); - throw new OAuthException('No application for that consumer key.'); - } + $consumer = $request->get_parameter('oauth_consumer_key'); + $access_token = $request->get_parameter('oauth_token'); - $appUser = Oauth_application_user::staticGet('token', - $this->access_token); + $app = Oauth_application::getByConsumerKey($consumer); - // XXX: check that app->id and appUser->application_id and consumer all - // match? + if (empty($app)) { + common_log(LOG_WARNING, + 'Couldn\'t find the OAuth app for consumer key: ' . + $consumer); + throw new OAuthException('No application for that consumer key.'); + } - if (!empty($appUser)) { + // set the source attr - // read or read-write - $this->oauth_access_type = $appUser->access_type; + $this->oauth_source = $app->name; - // If access_type == 0 we have either a request token - // or a bad / revoked access token + $appUser = Oauth_application_user::staticGet('token', $access_token); - if ($this->oauth_access_type != 0) { + if (!empty($appUser)) { - $this->auth_user = User::staticGet('id', $appUser->profile_id); + // If access_type == 0 we have either a request token + // or a bad / revoked access token - $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " . - "application '%s' (id: %d)."; + if ($appUser->access_type != 0) { - common_log(LOG_INFO, sprintf($msg, - $this->auth_user->nickname, - $this->auth_user->id, - $app->name, - $app->id)); - return true; - } else { - throw new OAuthException('Bad access token.'); - } - } else { + // Set the access level for the api call - // also should not happen - throw new OAuthException('No user for that token.'); - } + $this->access = ($appUser->access_type & Oauth_application::$writeAccess) + ? self::READ_WRITE : self::READ_ONLY; - } catch (OAuthException $e) { - common_log(LOG_WARN, 'API OAuthException - ' . $e->getMessage()); - common_debug(var_export($req, true)); - $this->showOAuthError($e->getMessage()); - exit(); - } - } + // Set the auth user - function showOAuthError($msg) - { - header('HTTP/1.1 401 Unauthorized'); - header('Content-Type: text/html; charset=utf-8'); - print $msg . "\n"; - } + if (Event::handle('StartSetApiUser', array(&$user))) { + $this->auth_user = User::staticGet('id', $appUser->profile_id); + Event::handle('EndSetApiUser', array($user)); + } - function cleanRequest() - { - // kill evil effects of magical slashing + $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " . + "application '%s' (id: %d) with %s access."; - if(get_magic_quotes_gpc() == 1) { - $_POST = array_map('stripslashes', $_POST); - $_GET = array_map('stripslashes', $_GET); - } + common_log(LOG_INFO, sprintf($msg, + $this->auth_user->nickname, + $this->auth_user->id, + $app->name, + $app->id, + ($this->access = self::READ_WRITE) ? + 'read-write' : 'read-only' + )); + } else { + throw new OAuthException('Bad access token.'); + } + } else { - // strip out the p param added in index.php + // Also should not happen - // XXX: should we strip anything else? Or alternatively - // only allow a known list of params? + throw new OAuthException('No user for that token.'); + } - unset($_GET['p']); - unset($_POST['p']); + } catch (OAuthException $e) { + common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage()); + $this->showAuthError(); + exit; + } } /** @@ -201,44 +235,54 @@ class ApiAuthAction extends ApiAction * @return boolean true or false */ - function checkBasicAuthUser() + function checkBasicAuthUser($required = true) { $this->basicAuthProcessHeader(); $realm = common_config('site', 'name') . ' API'; - if (!isset($this->auth_user)) { + if (!isset($this->auth_user_nickname) && $required) { header('WWW-Authenticate: Basic realm="' . $realm . '"'); // show error if the user clicks 'cancel' - $this->showBasicAuthError(); + $this->showAuthError(); exit; } else { - $nickname = $this->auth_user; - $password = $this->auth_pw; - $user = common_check_user($nickname, $password); + + $user = common_check_user($this->auth_user_nickname, + $this->auth_user_password); + if (Event::handle('StartSetApiUser', array(&$user))) { - $this->auth_user = $user; + + if (!empty($user)) { + $this->auth_user = $user; + } + Event::handle('EndSetApiUser', array($user)); } - if (empty($this->auth_user)) { + // By default, basic auth users have rw access + + $this->access = self::READ_WRITE; + + if (empty($this->auth_user) && $required) { // basic authentication failed list($proxy, $ip) = common_client_ip(); - common_log( - LOG_WARNING, - 'Failed API auth attempt, nickname = ' . - "$nickname, proxy = $proxy, ip = $ip." - ); - $this->showBasicAuthError(); + + $msg = sprintf(_('Failed API auth attempt, nickname = %1$s, ' . + 'proxy = %2$s, ip = %3$s'), + $this->auth_user_nickname, + $proxy, + $ip); + common_log(LOG_WARNING, $msg); + $this->showAuthError(); exit; } } - return true; } /** @@ -252,32 +296,30 @@ class ApiAuthAction extends ApiAction { if (isset($_SERVER['AUTHORIZATION']) || isset($_SERVER['HTTP_AUTHORIZATION']) - ) { - $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION']) - ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION']; + ) { + $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION']) + ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION']; } if (isset($_SERVER['PHP_AUTH_USER'])) { - $this->auth_user = $_SERVER['PHP_AUTH_USER']; - $this->auth_pw = $_SERVER['PHP_AUTH_PW']; + $this->auth_user_nickname = $_SERVER['PHP_AUTH_USER']; + $this->auth_user_password = $_SERVER['PHP_AUTH_PW']; } elseif (isset($authorization_header) && strstr(substr($authorization_header, 0, 5), 'Basic')) { - // decode the HTTP_AUTHORIZATION header on php-cgi server self + // Decode the HTTP_AUTHORIZATION header on php-cgi server self // on fcgid server the header name is AUTHORIZATION $auth_hash = base64_decode(substr($authorization_header, 6)); - list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash); + list($this->auth_user_nickname, + $this->auth_user_password) = explode(':', $auth_hash); - // set all to null on a empty basic auth request + // Set all to null on a empty basic auth request - if ($this->auth_user == "") { - $this->auth_user = null; - $this->auth_pw = null; + if (empty($this->auth_user_nickname)) { + $this->auth_user_nickname = null; + $this->auth_password = null; } - } else { - $this->auth_user = null; - $this->auth_pw = null; } } @@ -288,7 +330,7 @@ class ApiAuthAction extends ApiAction * @return void */ - function showBasicAuthError() + function showAuthError() { header('HTTP/1.1 401 Unauthorized'); $msg = 'Could not authenticate you.';