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 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
34 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
35 * @link http://status.net/
38 /* External API usage documentation. Please update when you change how this method works. */
40 /*! @page authentication Authentication
42 StatusNet supports HTTP Basic Authentication and OAuth for API calls.
44 @warning Currently, users who have created accounts without setting a
45 password via OpenID, Facebook Connect, etc., cannot use the API until
46 they set a password with their account settings panel.
48 @section HTTP Basic Auth
56 if (!defined('GNUSOCIAL')) { exit(1); }
59 * Actions extending this class will require auth
63 * @author Zach Copley <zach@status.net>
64 * @license http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
65 * @link http://status.net/
67 class ApiAuthAction extends ApiAction
69 var $auth_user_nickname = null;
70 var $auth_user_password = null;
73 * Take arguments for running, looks for an OAuth request,
74 * and outputs basic auth header if needed
76 * @param array $args $_REQUEST args
78 * @return boolean success flag
81 protected function prepare(array $args=array())
83 parent::prepare($args);
85 // NOTE: $this->scoped and $this->auth_user has to get set in
86 // prepare(), not handle(), as subclasses use them in prepares.
88 // Allow regular login session
89 if (common_logged_in()) {
90 $this->scoped = Profile::current();
91 $this->auth_user = $this->scoped->getUser();
92 if (!$this->auth_user->hasRight(Right::API)) {
93 // TRANS: Authorization exception thrown when a user without API access tries to access the API.
94 throw new AuthorizationException(_('Not allowed to use API.'));
96 // Let's run this in the same way as if we've just authenticated the user (basic/oauth auth)
97 Event::handle('EndSetApiUser', array($this->auth_user));
98 $this->access = self::READ_WRITE;
100 $oauthReq = $this->getOAuthRequest();
102 if ($oauthReq instanceof OAuthRequest) {
103 $this->checkOAuthRequest($oauthReq);
105 // If not using OAuth, check if there is a basic auth
106 // and require it if the current action requires it.
107 $this->checkBasicAuthUser($this->requiresAuth());
110 // NOTE: Make sure we're scoped properly based on the auths!
111 if (isset($this->auth_user) && $this->auth_user instanceof User) {
112 $this->scoped = $this->auth_user->getProfile();
114 $this->scoped = null;
118 // legacy user transferral
119 // TODO: remove when sure no extended classes need it
120 $this->user = $this->auth_user;
122 // Reject API calls with the wrong access level
124 if ($this->isReadOnly($args) == false) {
125 if ($this->access != self::READ_WRITE) {
126 // TRANS: Client error 401.
127 $msg = _('API resource requires read-write access, ' .
128 'but you only have read access.');
129 $this->clientError($msg, 401);
137 * Determine whether the request is an OAuth request.
138 * This is to avoid doign any unnecessary DB lookups.
140 * @return mixed the OAuthRequest or false
142 function getOAuthRequest()
144 ApiOAuthAction::cleanRequest();
146 $req = OAuthRequest::from_request();
148 $consumer = $req->get_parameter('oauth_consumer_key');
149 $accessToken = $req->get_parameter('oauth_token');
151 // XXX: Is it good enough to assume it's not meant to be an
152 // OAuth request if there is no consumer or token? --Z
154 if (empty($consumer) || empty($accessToken)) {
162 * Verifies the OAuth request signature, sets the auth user
163 * and access type (read-only or read-write)
165 * @param OAuthRequest $request the OAuth Request
169 function checkOAuthRequest($request)
171 $datastore = new ApiGNUsocialOAuthDataStore();
172 $server = new OAuthServer($datastore);
173 $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
175 $server->add_signature_method($hmac_method);
178 $server->verify_request($request);
180 $consumer = $request->get_parameter('oauth_consumer_key');
181 $access_token = $request->get_parameter('oauth_token');
183 $app = Oauth_application::getByConsumerKey($consumer);
188 'API OAuth - Couldn\'t find the OAuth app for consumer key: ' .
191 // TRANS: OAuth exception thrown when no application is found for a given consumer key.
192 throw new OAuthException(_('No application for that consumer key.'));
195 // set the source attr
196 if ($app->name != 'anonymous') {
197 $this->source = $app->name;
201 $appUser = Oauth_application_user::getKV('token', $access_token);
203 if (!empty($appUser)) {
204 // If access_type == 0 we have either a request token
205 // or a bad / revoked access token
207 if ($appUser->access_type != 0) {
208 // Set the access level for the api call
209 $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
210 ? self::READ_WRITE : self::READ_ONLY;
213 if (Event::handle('StartSetApiUser', array(&$user))) {
214 $user = User::getKV('id', $appUser->profile_id);
216 if (!$user->hasRight(Right::API)) {
217 // TRANS: Authorization exception thrown when a user without API access tries to access the API.
218 throw new AuthorizationException(_('Not allowed to use API.'));
221 $this->auth_user = $user;
222 // FIXME: setting the value returned by common_current_user()
223 // There should probably be a better method for this. common_set_user()
224 // does lots of session stuff.
226 $_cur = $this->auth_user;
227 Event::handle('EndSetApiUser', array($user));
230 $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
231 "application '%s' (id: %d) with %s access.";
237 $this->auth_user->nickname,
238 $this->auth_user->id,
241 ($this->access = self::READ_WRITE) ? 'read-write' : 'read-only'
245 // TRANS: OAuth exception given when an incorrect access token was given for a user.
246 throw new OAuthException(_('Bad access token.'));
249 // Also should not happen.
250 // TRANS: OAuth exception given when no user was found for a given token (no token was found).
251 throw new OAuthException(_('No user for that token.'));
254 } catch (OAuthException $e) {
255 $this->logAuthFailure($e->getMessage());
256 common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
257 $this->clientError($e->getMessage(), 401);
262 * Does this API resource require authentication?
264 * @return boolean true
266 public function requiresAuth()
272 * Check for a user specified via HTTP basic auth. If there isn't
273 * one, try to get one by outputting the basic auth header.
275 * @return boolean true or false
277 function checkBasicAuthUser($required = true)
279 $this->basicAuthProcessHeader();
281 $realm = common_config('api', 'realm');
284 $realm = common_config('site', 'name') . ' API';
287 if (empty($this->auth_user_nickname) && $required) {
288 header('WWW-Authenticate: Basic realm="' . $realm . '"');
290 // show error if the user clicks 'cancel'
291 // TRANS: Client error thrown when authentication fails because a user clicked "Cancel".
292 $this->clientError(_('Could not authenticate you.'), 401);
294 } elseif ($required) {
295 // $this->auth_user_nickname - i.e. PHP_AUTH_USER - will have a value since it was not empty
297 $user = common_check_user($this->auth_user_nickname,
298 $this->auth_user_password);
300 if (Event::handle('StartSetApiUser', array(&$user))) {
302 if ($user instanceof User) {
303 if (!$user->hasRight(Right::API)) {
304 // TRANS: Authorization exception thrown when a user without API access tries to access the API.
305 throw new AuthorizationException(_('Not allowed to use API.'));
307 $this->auth_user = $user;
310 Event::handle('EndSetApiUser', array($user));
313 // By default, basic auth users have rw access
314 $this->access = self::READ_WRITE;
316 if (!$this->auth_user instanceof User) {
318 "basic auth nickname = %s",
319 $this->auth_user_nickname
321 $this->logAuthFailure($msg);
323 // We must present WWW-Authenticate in accordance to HTTP status code 401
324 header('WWW-Authenticate: Basic realm="' . $realm . '"');
325 // TRANS: Client error thrown when authentication fails.
326 $this->clientError(_('Could not authenticate you.'), 401);
329 // all get rw access for actions that don't require auth
330 $this->access = self::READ_WRITE;
335 * Read the HTTP headers and set the auth user. Decodes HTTP_AUTHORIZATION
336 * param to support basic auth when PHP is running in CGI mode.
340 function basicAuthProcessHeader()
342 $authHeaders = array('AUTHORIZATION',
343 'HTTP_AUTHORIZATION',
344 'REDIRECT_HTTP_AUTHORIZATION'); // rewrite for CGI
345 $authorization_header = null;
346 foreach ($authHeaders as $header) {
347 if (isset($_SERVER[$header])) {
348 $authorization_header = $_SERVER[$header];
353 if (isset($_SERVER['PHP_AUTH_USER'])) {
354 $this->auth_user_nickname = $_SERVER['PHP_AUTH_USER'];
355 $this->auth_user_password = $_SERVER['PHP_AUTH_PW'];
356 } elseif (isset($authorization_header)
357 && strstr(substr($authorization_header, 0, 5), 'Basic')) {
359 // Decode the HTTP_AUTHORIZATION header on php-cgi server self
360 // on fcgid server the header name is AUTHORIZATION
361 $auth_hash = base64_decode(substr($authorization_header, 6));
362 list($this->auth_user_nickname,
363 $this->auth_user_password) = explode(':', $auth_hash);
365 // Set all to null on a empty basic auth request
367 if (empty($this->auth_user_nickname)) {
368 $this->auth_user_nickname = null;
369 $this->auth_password = null;
375 * Log an API authentication failure. Collect the proxy and IP
378 * @param string $logMsg additional log message
380 function logAuthFailure($logMsg)
382 list($proxy, $ip) = common_client_ip();
385 'API auth failure (proxy = %1$s, ip = %2$s) - ',
390 common_log(LOG_WARNING, $msg . $logMsg);