- Check for read-only vs. read-write access to protected API resources (OAuth)
- Some cleanup
This commit is contained in:
parent
4202ffff91
commit
923b7de3c6
@ -28,7 +28,7 @@
|
|||||||
* @author Mike Cochrane <mikec@mikenz.geek.nz>
|
* @author Mike Cochrane <mikec@mikenz.geek.nz>
|
||||||
* @author Robin Millette <robin@millette.info>
|
* @author Robin Millette <robin@millette.info>
|
||||||
* @author Zach Copley <zach@status.net>
|
* @author Zach Copley <zach@status.net>
|
||||||
* @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
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
* @link http://status.net/
|
* @link http://status.net/
|
||||||
*/
|
*/
|
||||||
@ -79,7 +79,6 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
{
|
{
|
||||||
parent::prepare($args);
|
parent::prepare($args);
|
||||||
|
|
||||||
$this->user = $this->auth_user;
|
|
||||||
$this->status = $this->trimmed('status');
|
$this->status = $this->trimmed('status');
|
||||||
$this->source = $this->trimmed('source');
|
$this->source = $this->trimmed('source');
|
||||||
$this->lat = $this->trimmed('lat');
|
$this->lat = $this->trimmed('lat');
|
||||||
@ -145,7 +144,7 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (empty($this->user)) {
|
if (empty($this->auth_user)) {
|
||||||
$this->clientError(_('No such user.'), 404, $this->format);
|
$this->clientError(_('No such user.'), 404, $this->format);
|
||||||
return;
|
return;
|
||||||
}
|
}
|
||||||
@ -172,7 +171,7 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
// Check for commands
|
// Check for commands
|
||||||
|
|
||||||
$inter = new CommandInterpreter();
|
$inter = new CommandInterpreter();
|
||||||
$cmd = $inter->handle_command($this->user, $status_shortened);
|
$cmd = $inter->handle_command($this->auth_user, $status_shortened);
|
||||||
|
|
||||||
if ($cmd) {
|
if ($cmd) {
|
||||||
|
|
||||||
@ -184,7 +183,7 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
// And, it returns your last status whether the cmd was successful
|
// And, it returns your last status whether the cmd was successful
|
||||||
// or not!
|
// or not!
|
||||||
|
|
||||||
$this->notice = $this->user->getCurrentNotice();
|
$this->notice = $this->auth_user->getCurrentNotice();
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
|
|
||||||
@ -211,7 +210,7 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
$upload = null;
|
$upload = null;
|
||||||
|
|
||||||
try {
|
try {
|
||||||
$upload = MediaFile::fromUpload('media', $this->user);
|
$upload = MediaFile::fromUpload('media', $this->auth_user);
|
||||||
} catch (ClientException $ce) {
|
} catch (ClientException $ce) {
|
||||||
$this->clientError($ce->getMessage());
|
$this->clientError($ce->getMessage());
|
||||||
return;
|
return;
|
||||||
@ -234,19 +233,19 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
|
|
||||||
$options = array('reply_to' => $reply_to);
|
$options = array('reply_to' => $reply_to);
|
||||||
|
|
||||||
if ($this->user->shareLocation()) {
|
if ($this->auth_user->shareLocation()) {
|
||||||
|
|
||||||
$locOptions = Notice::locationOptions($this->lat,
|
$locOptions = Notice::locationOptions($this->lat,
|
||||||
$this->lon,
|
$this->lon,
|
||||||
null,
|
null,
|
||||||
null,
|
null,
|
||||||
$this->user->getProfile());
|
$this->auth_user->getProfile());
|
||||||
|
|
||||||
$options = array_merge($options, $locOptions);
|
$options = array_merge($options, $locOptions);
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->notice =
|
$this->notice =
|
||||||
Notice::saveNew($this->user->id,
|
Notice::saveNew($this->auth_user->id,
|
||||||
$content,
|
$content,
|
||||||
$this->source,
|
$this->source,
|
||||||
$options);
|
$options);
|
||||||
@ -255,7 +254,6 @@ class ApiStatusesUpdateAction extends ApiAuthAction
|
|||||||
$upload->attachToNotice($this->notice);
|
$upload->attachToNotice($this->notice);
|
||||||
}
|
}
|
||||||
|
|
||||||
|
|
||||||
}
|
}
|
||||||
|
|
||||||
$this->showNotice();
|
$this->showNotice();
|
||||||
|
114
lib/apiauth.php
114
lib/apiauth.php
@ -29,7 +29,7 @@
|
|||||||
* @author mEDI <medi@milaro.net>
|
* @author mEDI <medi@milaro.net>
|
||||||
* @author Sarven Capadisli <csarven@status.net>
|
* @author Sarven Capadisli <csarven@status.net>
|
||||||
* @author Zach Copley <zach@status.net>
|
* @author Zach Copley <zach@status.net>
|
||||||
* @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
|
* @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
|
||||||
* @link http://status.net/
|
* @link http://status.net/
|
||||||
*/
|
*/
|
||||||
@ -53,9 +53,11 @@ require_once INSTALLDIR . '/lib/apioauth.php';
|
|||||||
|
|
||||||
class ApiAuthAction extends ApiAction
|
class ApiAuthAction extends ApiAction
|
||||||
{
|
{
|
||||||
var $access_token;
|
var $auth_user_nickname = null;
|
||||||
var $oauth_access_type;
|
var $auth_user_password = null;
|
||||||
var $oauth_source;
|
var $access_token = null;
|
||||||
|
var $oauth_source = null;
|
||||||
|
var $auth_user = null;
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Take arguments for running, and output basic auth header if needed
|
* Take arguments for running, and output basic auth header if needed
|
||||||
@ -70,18 +72,28 @@ class ApiAuthAction extends ApiAction
|
|||||||
{
|
{
|
||||||
parent::prepare($args);
|
parent::prepare($args);
|
||||||
|
|
||||||
if ($this->requiresAuth()) {
|
|
||||||
|
|
||||||
$this->consumer_key = $this->arg('oauth_consumer_key');
|
$this->consumer_key = $this->arg('oauth_consumer_key');
|
||||||
$this->access_token = $this->arg('oauth_token');
|
$this->access_token = $this->arg('oauth_token');
|
||||||
|
|
||||||
|
// NOTE: $this->auth_user has to get set in prepare(), not handle(),
|
||||||
|
// because subclasses do stuff with it in their prepares.
|
||||||
|
|
||||||
|
if ($this->requiresAuth()) {
|
||||||
if (!empty($this->access_token)) {
|
if (!empty($this->access_token)) {
|
||||||
$this->checkOAuthRequest();
|
$this->checkOAuthRequest();
|
||||||
} else {
|
} else {
|
||||||
$this->checkBasicAuthUser();
|
$this->checkBasicAuthUser();
|
||||||
// By default, all basic auth users have read and write access
|
}
|
||||||
|
|
||||||
$this->access = self::READ_WRITE;
|
// Reject API calls with the wrong access level
|
||||||
|
|
||||||
|
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();
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -95,8 +107,6 @@ class ApiAuthAction extends ApiAction
|
|||||||
|
|
||||||
function checkOAuthRequest()
|
function checkOAuthRequest()
|
||||||
{
|
{
|
||||||
common_debug("We have an OAuth request.");
|
|
||||||
|
|
||||||
$datastore = new ApiStatusNetOAuthDataStore();
|
$datastore = new ApiStatusNetOAuthDataStore();
|
||||||
$server = new OAuthServer($datastore);
|
$server = new OAuthServer($datastore);
|
||||||
$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
|
$hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
|
||||||
@ -114,9 +124,10 @@ class ApiAuthAction extends ApiAction
|
|||||||
|
|
||||||
if (empty($app)) {
|
if (empty($app)) {
|
||||||
|
|
||||||
// this should really not happen
|
// this should probably not happen
|
||||||
common_log(LOG_WARN,
|
common_log(LOG_WARNING,
|
||||||
"Couldn't find the OAuth app for consumer key: $this->consumer_key");
|
'Couldn\'t find the OAuth app for consumer key: ' .
|
||||||
|
$this->consumer_key);
|
||||||
|
|
||||||
throw new OAuthException('No application for that consumer key.');
|
throw new OAuthException('No application for that consumer key.');
|
||||||
}
|
}
|
||||||
@ -128,20 +139,18 @@ class ApiAuthAction extends ApiAction
|
|||||||
$appUser = Oauth_application_user::staticGet('token',
|
$appUser = Oauth_application_user::staticGet('token',
|
||||||
$this->access_token);
|
$this->access_token);
|
||||||
|
|
||||||
// XXX: check that app->id and appUser->application_id and consumer all
|
// XXX: Check that app->id and appUser->application_id and consumer all
|
||||||
// match?
|
// match?
|
||||||
|
|
||||||
if (!empty($appUser)) {
|
if (!empty($appUser)) {
|
||||||
|
|
||||||
// read or read-write
|
|
||||||
$this->oauth_access_type = $appUser->access_type;
|
|
||||||
|
|
||||||
// If access_type == 0 we have either a request token
|
// If access_type == 0 we have either a request token
|
||||||
// or a bad / revoked access token
|
// or a bad / revoked access token
|
||||||
|
|
||||||
if ($this->oauth_access_type != 0) {
|
if ($appUser->access_type != 0) {
|
||||||
|
|
||||||
|
// Set the access level for the api call
|
||||||
|
|
||||||
// Set the read or read-write access for the api call
|
|
||||||
$this->access = ($appUser->access_type & Oauth_application::$writeAccess)
|
$this->access = ($appUser->access_type & Oauth_application::$writeAccess)
|
||||||
? self::READ_WRITE : self::READ_ONLY;
|
? self::READ_WRITE : self::READ_ONLY;
|
||||||
|
|
||||||
@ -151,38 +160,34 @@ class ApiAuthAction extends ApiAction
|
|||||||
}
|
}
|
||||||
|
|
||||||
$msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
|
$msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
|
||||||
"application '%s' (id: %d).";
|
"application '%s' (id: %d) with %s access.";
|
||||||
|
|
||||||
common_log(LOG_INFO, sprintf($msg,
|
common_log(LOG_INFO, sprintf($msg,
|
||||||
$this->auth_user->nickname,
|
$this->auth_user->nickname,
|
||||||
$this->auth_user->id,
|
$this->auth_user->id,
|
||||||
$app->name,
|
$app->name,
|
||||||
$app->id));
|
$app->id,
|
||||||
|
($this->access = self::READ_WRITE) ?
|
||||||
|
'read-write' : 'read-only'
|
||||||
|
));
|
||||||
return true;
|
return true;
|
||||||
} else {
|
} else {
|
||||||
throw new OAuthException('Bad access token.');
|
throw new OAuthException('Bad access token.');
|
||||||
}
|
}
|
||||||
} else {
|
} else {
|
||||||
|
|
||||||
// also should not happen
|
// Also should not happen
|
||||||
|
|
||||||
throw new OAuthException('No user for that token.');
|
throw new OAuthException('No user for that token.');
|
||||||
}
|
}
|
||||||
|
|
||||||
} catch (OAuthException $e) {
|
} catch (OAuthException $e) {
|
||||||
common_log(LOG_WARN, 'API OAuthException - ' . $e->getMessage());
|
common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
|
||||||
common_debug(var_export($req, true));
|
$this->showAuthError();
|
||||||
$this->showOAuthError($e->getMessage());
|
exit;
|
||||||
exit();
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function showOAuthError($msg)
|
|
||||||
{
|
|
||||||
header('HTTP/1.1 401 Unauthorized');
|
|
||||||
header('Content-Type: text/html; charset=utf-8');
|
|
||||||
print $msg . "\n";
|
|
||||||
}
|
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* Does this API resource require authentication?
|
* Does this API resource require authentication?
|
||||||
*
|
*
|
||||||
@ -207,39 +212,44 @@ class ApiAuthAction extends ApiAction
|
|||||||
|
|
||||||
$realm = common_config('site', 'name') . ' API';
|
$realm = common_config('site', 'name') . ' API';
|
||||||
|
|
||||||
if (!isset($this->auth_user)) {
|
if (!isset($this->auth_user_nickname)) {
|
||||||
header('WWW-Authenticate: Basic realm="' . $realm . '"');
|
header('WWW-Authenticate: Basic realm="' . $realm . '"');
|
||||||
|
|
||||||
// show error if the user clicks 'cancel'
|
// show error if the user clicks 'cancel'
|
||||||
|
|
||||||
$this->showBasicAuthError();
|
$this->showAuthError();
|
||||||
exit;
|
exit;
|
||||||
|
|
||||||
} else {
|
} else {
|
||||||
$nickname = $this->auth_user;
|
|
||||||
$password = $this->auth_pw;
|
$user = common_check_user($this->auth_user_nickname,
|
||||||
$user = common_check_user($nickname, $password);
|
$this->auth_user_password);
|
||||||
|
|
||||||
if (Event::handle('StartSetApiUser', array(&$user))) {
|
if (Event::handle('StartSetApiUser', array(&$user))) {
|
||||||
$this->auth_user = $user;
|
$this->auth_user = $user;
|
||||||
Event::handle('EndSetApiUser', array($user));
|
Event::handle('EndSetApiUser', array($user));
|
||||||
}
|
}
|
||||||
|
|
||||||
|
// By default, basic auth users have rw access
|
||||||
|
|
||||||
|
$this->access = self::READ_WRITE;
|
||||||
|
|
||||||
if (empty($this->auth_user)) {
|
if (empty($this->auth_user)) {
|
||||||
|
|
||||||
// basic authentication failed
|
// basic authentication failed
|
||||||
|
|
||||||
list($proxy, $ip) = common_client_ip();
|
list($proxy, $ip) = common_client_ip();
|
||||||
|
|
||||||
common_log(
|
common_log(
|
||||||
LOG_WARNING,
|
LOG_WARNING,
|
||||||
'Failed API auth attempt, nickname = ' .
|
'Failed API auth attempt, nickname = ' .
|
||||||
"$nickname, proxy = $proxy, ip = $ip."
|
"$nickname, proxy = $proxy, ip = $ip."
|
||||||
);
|
);
|
||||||
$this->showBasicAuthError();
|
|
||||||
|
$this->showAuthError();
|
||||||
exit;
|
exit;
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return true;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
@ -259,26 +269,24 @@ class ApiAuthAction extends ApiAction
|
|||||||
}
|
}
|
||||||
|
|
||||||
if (isset($_SERVER['PHP_AUTH_USER'])) {
|
if (isset($_SERVER['PHP_AUTH_USER'])) {
|
||||||
$this->auth_user = $_SERVER['PHP_AUTH_USER'];
|
$this->auth_user_nickname = $_SERVER['PHP_AUTH_USER'];
|
||||||
$this->auth_pw = $_SERVER['PHP_AUTH_PW'];
|
$this->auth_user_password = $_SERVER['PHP_AUTH_PW'];
|
||||||
} elseif (isset($authorization_header)
|
} elseif (isset($authorization_header)
|
||||||
&& strstr(substr($authorization_header, 0, 5), 'Basic')) {
|
&& 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
|
// on fcgid server the header name is AUTHORIZATION
|
||||||
|
|
||||||
$auth_hash = base64_decode(substr($authorization_header, 6));
|
$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 == "") {
|
if (empty($this->auth_user_nickname)) {
|
||||||
$this->auth_user = null;
|
$this->auth_user_nickname = null;
|
||||||
$this->auth_pw = null;
|
$this->auth_password = null;
|
||||||
}
|
}
|
||||||
} else {
|
|
||||||
$this->auth_user = null;
|
|
||||||
$this->auth_pw = null;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@ -289,7 +297,7 @@ class ApiAuthAction extends ApiAction
|
|||||||
* @return void
|
* @return void
|
||||||
*/
|
*/
|
||||||
|
|
||||||
function showBasicAuthError()
|
function showAuthError()
|
||||||
{
|
{
|
||||||
header('HTTP/1.1 401 Unauthorized');
|
header('HTTP/1.1 401 Unauthorized');
|
||||||
$msg = 'Could not authenticate you.';
|
$msg = 'Could not authenticate you.';
|
||||||
|
Loading…
Reference in New Issue
Block a user