3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for API actions that require authentication
9 * LICENCE: This program is free software: you can redistribute it and/or modify
10 * it under the terms of the GNU Affero General Public License as published by
11 * the Free Software Foundation, either version 3 of the License, or
12 * (at your option) any later version.
14 * This program is distributed in the hope that it will be useful,
15 * but WITHOUT ANY WARRANTY; without even the implied warranty of
16 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 * GNU Affero General Public License for more details.
19 * You should have received a copy of the GNU Affero General Public License
20 * along with this program. If not, see <http://www.gnu.org/licenses/>.
24 * @author Adrian Lang <mail@adrianlang.de>
25 * @author Brenda Wallace <shiny@cpan.org>
26 * @author Craig Andrews <candrews@integralblue.com>
27 * @author Dan Moore <dan@moore.cx>
28 * @author Evan Prodromou <evan@status.net>
29 * @author mEDI <medi@milaro.net>
30 * @author Sarven Capadisli <csarven@status.net>
31 * @author Zach Copley <zach@status.net>
32 * @copyright 2009-2010 StatusNet, Inc.
33 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
34 * @link http://status.net/
37 if (!defined('STATUSNET')) {
41 require_once INSTALLDIR . '/lib/apioauth.php';
44 * Actions extending this class will require auth
48 * @author Zach Copley <zach@status.net>
49 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
50 * @link http://status.net/
53 class ApiAuthAction extends ApiAction
55 var $auth_user_nickname = null;
56 var $auth_user_password = null;
59 * Take arguments for running, looks for an OAuth request,
60 * and outputs basic auth header if needed
62 * @param array $args $_REQUEST args
64 * @return boolean success flag
68 function prepare($args)
70 parent::prepare($args);
72 // NOTE: $this->auth_user has to get set in prepare(), not handle(),
73 // because subclasses do stuff with it in their prepares.
75 $oauthReq = $this->getOAuthRequest();
78 if ($this->requiresAuth()) {
79 $this->checkBasicAuthUser(true);
81 // Check to see if a basic auth user is there even
82 // if one's not required
83 $this->checkBasicAuthUser(false);
86 $this->checkOAuthRequest($oauthReq);
89 // Reject API calls with the wrong access level
91 if ($this->isReadOnly($args) == false) {
92 if ($this->access != self::READ_WRITE) {
93 $msg = _('API resource requires read-write access, ' .
94 'but you only have read access.');
95 $this->clientError($msg, 401, $this->format);
104 * Determine whether the request is an OAuth request.
105 * This is to avoid doign any unnecessary DB lookups.
107 * @return mixed the OAuthRequest or false
110 function getOAuthRequest()
112 ApiOauthAction::cleanRequest();
114 $req = OAuthRequest::from_request();
116 $consumer = $req->get_parameter('oauth_consumer_key');
117 $accessToken = $req->get_parameter('oauth_token');
119 // XXX: Is it good enough to assume it's not meant to be an
120 // OAuth request if there is no consumer or token? --Z
122 if (empty($consumer) || empty($accessToken)) {
130 * Verifies the OAuth request signature, sets the auth user
131 * and access type (read-only or read-write)
133 * @param OAuthRequest $request the OAuth Request
138 function checkOAuthRequest($request)
140 $datastore = new ApiStatusNetOAuthDataStore();
141 $server = new OAuthServer($datastore);
142 $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
144 $server->add_signature_method($hmac_method);
148 $server->verify_request($request);
150 $consumer = $request->get_parameter('oauth_consumer_key');
151 $access_token = $request->get_parameter('oauth_token');
153 $app = Oauth_application::getByConsumerKey($consumer);
156 common_log(LOG_WARNING,
157 'Couldn\'t find the OAuth app for consumer key: ' .
159 throw new OAuthException('No application for that consumer key.');
162 // set the source attr
164 $this->source = $app->name;
166 $appUser = Oauth_application_user::staticGet('token', $access_token);
168 if (!empty($appUser)) {
170 // If access_type == 0 we have either a request token
171 // or a bad / revoked access token
173 if ($appUser->access_type != 0) {
175 // Set the access level for the api call
177 $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
178 ? self::READ_WRITE : self::READ_ONLY;
182 if (Event::handle('StartSetApiUser', array(&$user))) {
183 $this->auth_user = User::staticGet('id', $appUser->profile_id);
184 Event::handle('EndSetApiUser', array($user));
187 $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
188 "application '%s' (id: %d) with %s access.";
190 common_log(LOG_INFO, sprintf($msg,
191 $this->auth_user->nickname,
192 $this->auth_user->id,
195 ($this->access = self::READ_WRITE) ?
196 'read-write' : 'read-only'
199 throw new OAuthException('Bad access token.');
203 // Also should not happen
205 throw new OAuthException('No user for that token.');
208 } catch (OAuthException $e) {
209 common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
210 $this->showAuthError();
216 * Does this API resource require authentication?
218 * @return boolean true
221 function requiresAuth()
227 * Check for a user specified via HTTP basic auth. If there isn't
228 * one, try to get one by outputting the basic auth header.
230 * @return boolean true or false
233 function checkBasicAuthUser($required = true)
235 $this->basicAuthProcessHeader();
237 $realm = common_config('api', 'realm');
240 $realm = common_config('site', 'name') . ' API';
243 if (empty($this->auth_user_nickname) && $required) {
244 header('WWW-Authenticate: Basic realm="' . $realm . '"');
246 // show error if the user clicks 'cancel'
248 $this->showAuthError();
253 $user = common_check_user($this->auth_user_nickname,
254 $this->auth_user_password);
256 if (Event::handle('StartSetApiUser', array(&$user))) {
259 $this->auth_user = $user;
262 Event::handle('EndSetApiUser', array($user));
265 // By default, basic auth users have rw access
267 $this->access = self::READ_WRITE;
269 if (empty($this->auth_user) && ($required || isset($_SERVER['PHP_AUTH_USER']))) {
271 // basic authentication failed
273 list($proxy, $ip) = common_client_ip();
275 $msg = sprintf(_('Failed API auth attempt, nickname = %1$s, ' .
276 'proxy = %2$s, ip = %3$s'),
277 $this->auth_user_nickname,
280 common_log(LOG_WARNING, $msg);
281 $this->showAuthError();
288 * Read the HTTP headers and set the auth user. Decodes HTTP_AUTHORIZATION
289 * param to support basic auth when PHP is running in CGI mode.
294 function basicAuthProcessHeader()
296 $authHeaders = array('AUTHORIZATION',
297 'HTTP_AUTHORIZATION',
298 'REDIRECT_HTTP_AUTHORIZATION'); // rewrite for CGI
299 $authorization_header = null;
300 foreach ($authHeaders as $header) {
301 if (isset($_SERVER[$header])) {
302 $authorization_header = $_SERVER[$header];
307 if (isset($_SERVER['PHP_AUTH_USER'])) {
308 $this->auth_user_nickname = $_SERVER['PHP_AUTH_USER'];
309 $this->auth_user_password = $_SERVER['PHP_AUTH_PW'];
310 } elseif (isset($authorization_header)
311 && strstr(substr($authorization_header, 0, 5), 'Basic')) {
313 // Decode the HTTP_AUTHORIZATION header on php-cgi server self
314 // on fcgid server the header name is AUTHORIZATION
316 $auth_hash = base64_decode(substr($authorization_header, 6));
317 list($this->auth_user_nickname,
318 $this->auth_user_password) = explode(':', $auth_hash);
320 // Set all to null on a empty basic auth request
322 if (empty($this->auth_user_nickname)) {
323 $this->auth_user_nickname = null;
324 $this->auth_password = null;
330 * Output an authentication error message. Use XML or JSON if one
331 * of those formats is specified, otherwise output plain text
336 function showAuthError()
338 header('HTTP/1.1 401 Unauthorized');
339 $msg = 'Could not authenticate you.';
341 if ($this->format == 'xml') {
342 header('Content-Type: application/xml; charset=utf-8');
344 $this->elementStart('hash');
345 $this->element('error', null, $msg);
346 $this->element('request', null, $_SERVER['REQUEST_URI']);
347 $this->elementEnd('hash');
349 } elseif ($this->format == 'json') {
350 header('Content-Type: application/json; charset=utf-8');
351 $error_array = array('error' => $msg,
352 'request' => $_SERVER['REQUEST_URI']);
353 print(json_encode($error_array));
355 header('Content-type: text/plain');