lib/apiauth.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Base class for API actions that require authentication
   6  *
   7  * PHP version 5
   8  *
   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.
  13  *
  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.
  18  *
  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/>.
  21  *
  22  * @category  API
  23  * @package   StatusNet
  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/
  35  */
  36
  37 if (!defined('STATUSNET')) {
  38     exit(1);
  39 }
  40
  41 require_once INSTALLDIR . '/lib/apioauth.php';
  42
  43 /**
  44  * Actions extending this class will require auth
  45  *
  46  * @category API
  47  * @package  StatusNet
  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/
  51  */
  52
  53 class ApiAuthAction extends ApiAction
  54 {
  55     var $auth_user_nickname = null;
  56     var $auth_user_password = null;
  57     var $oauth_source       = null;
  58
  59     /**
  60      * Take arguments for running, looks for an OAuth request,
  61      * and outputs basic auth header if needed
  62      *
  63      * @param array $args $_REQUEST args
  64      *
  65      * @return boolean success flag
  66      *
  67      */
  68
  69     function prepare($args)
  70     {
  71         parent::prepare($args);
  72
  73         // NOTE: $this->auth_user has to get set in prepare(), not handle(),
  74         // because subclasses do stuff with it in their prepares.
  75
  76         $oauthReq = $this->getOAuthRequest();
  77
  78         if (!$oauthReq) {
  79             if ($this->requiresAuth()) {
  80                 $this->checkBasicAuthUser(true);
  81             } else {
  82                 // Check to see if a basic auth user is there even
  83                 // if one's not required
  84                 $this->checkBasicAuthUser(false);
  85             }
  86         } else {
  87             $this->checkOAuthRequest($oauthReq);
  88         }
  89
  90         // Reject API calls with the wrong access level
  91
  92         if ($this->isReadOnly($args) == false) {
  93             if ($this->access != self::READ_WRITE) {
  94                 $msg = _('API resource requires read-write access, ' .
  95                          'but you only have read access.');
  96                 $this->clientError($msg, 401, $this->format);
  97                 exit;
  98             }
  99         }
 100
 101         return true;
 102     }
 103
 104     /**
 105      * Determine whether the request is an OAuth request.
 106      * This is to avoid doign any unnecessary DB lookups.
 107      *
 108      * @return mixed the OAuthRequest or false
 109      */
 110
 111     function getOAuthRequest()
 112     {
 113         ApiOauthAction::cleanRequest();
 114
 115         $req  = OAuthRequest::from_request();
 116
 117         $consumer    = $req->get_parameter('oauth_consumer_key');
 118         $accessToken = $req->get_parameter('oauth_token');
 119
 120         // XXX: Is it good enough to assume it's not meant to be an
 121         // OAuth request if there is no consumer or token? --Z
 122
 123         if (empty($consumer) || empty($accessToken)) {
 124             return false;
 125         }
 126
 127         return $req;
 128     }
 129
 130     /**
 131      * Verifies the OAuth request signature, sets the auth user
 132      * and access type (read-only or read-write)
 133      *
 134      * @param OAuthRequest $request the OAuth Request
 135      *
 136      * @return nothing
 137      */
 138
 139     function checkOAuthRequest($request)
 140     {
 141         $datastore   = new ApiStatusNetOAuthDataStore();
 142         $server      = new OAuthServer($datastore);
 143         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 144
 145         $server->add_signature_method($hmac_method);
 146
 147         try {
 148
 149             $server->verify_request($request);
 150
 151             $consumer     = $request->get_parameter('oauth_consumer_key');
 152             $access_token = $request->get_parameter('oauth_token');
 153
 154             $app = Oauth_application::getByConsumerKey($consumer);
 155
 156             if (empty($app)) {
 157                 common_log(LOG_WARNING,
 158                            'Couldn\'t find the OAuth app for consumer key: ' .
 159                            $consumer);
 160                 throw new OAuthException('No application for that consumer key.');
 161             }
 162
 163             // set the source attr
 164
 165             $this->oauth_source = $app->name;
 166
 167             $appUser = Oauth_application_user::staticGet('token', $access_token);
 168
 169             if (!empty($appUser)) {
 170
 171                 // If access_type == 0 we have either a request token
 172                 // or a bad / revoked access token
 173
 174                 if ($appUser->access_type != 0) {
 175
 176                     // Set the access level for the api call
 177
 178                     $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
 179                       ? self::READ_WRITE : self::READ_ONLY;
 180
 181                     // Set the auth user
 182
 183                     if (Event::handle('StartSetApiUser', array(&$user))) {
 184                         $this->auth_user = User::staticGet('id', $appUser->profile_id);
 185                         Event::handle('EndSetApiUser', array($user));
 186                     }
 187
 188                     $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
 189                       "application '%s' (id: %d) with %s access.";
 190
 191                     common_log(LOG_INFO, sprintf($msg,
 192                                                  $this->auth_user->nickname,
 193                                                  $this->auth_user->id,
 194                                                  $app->name,
 195                                                  $app->id,
 196                                                  ($this->access = self::READ_WRITE) ?
 197                                                  'read-write' : 'read-only'
 198                                                  ));
 199                 } else {
 200                     throw new OAuthException('Bad access token.');
 201                 }
 202             } else {
 203
 204                 // Also should not happen
 205
 206                 throw new OAuthException('No user for that token.');
 207             }
 208
 209         } catch (OAuthException $e) {
 210             common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
 211             $this->showAuthError();
 212             exit;
 213         }
 214     }
 215
 216     /**
 217      * Does this API resource require authentication?
 218      *
 219      * @return boolean true
 220      */
 221
 222     function requiresAuth()
 223     {
 224         return true;
 225     }
 226
 227     /**
 228      * Check for a user specified via HTTP basic auth. If there isn't
 229      * one, try to get one by outputting the basic auth header.
 230      *
 231      * @return boolean true or false
 232      */
 233
 234     function checkBasicAuthUser($required = true)
 235     {
 236         $this->basicAuthProcessHeader();
 237
 238         $realm = common_config('api', 'realm');
 239
 240         if (empty($realm)) {
 241             $realm = common_config('site', 'name') . ' API';
 242         }
 243
 244         if (empty($this->auth_user_nickname) && $required) {
 245             header('WWW-Authenticate: Basic realm="' . $realm . '"');
 246
 247             // show error if the user clicks 'cancel'
 248
 249             $this->showAuthError();
 250             exit;
 251
 252         } else {
 253
 254             $user = common_check_user($this->auth_user_nickname,
 255                                       $this->auth_user_password);
 256
 257             if (Event::handle('StartSetApiUser', array(&$user))) {
 258
 259                 if (!empty($user)) {
 260                     $this->auth_user = $user;
 261                 }
 262
 263                 Event::handle('EndSetApiUser', array($user));
 264             }
 265
 266             // By default, basic auth users have rw access
 267
 268             $this->access = self::READ_WRITE;
 269
 270             if (empty($this->auth_user) && ($required || isset($_SERVER['PHP_AUTH_USER']))) {
 271
 272                 // basic authentication failed
 273
 274                 list($proxy, $ip) = common_client_ip();
 275
 276                 $msg = sprintf(_('Failed API auth attempt, nickname = %1$s, ' .
 277                          'proxy = %2$s, ip = %3$s'),
 278                                $this->auth_user_nickname,
 279                                $proxy,
 280                                $ip);
 281                 common_log(LOG_WARNING, $msg);
 282                 $this->showAuthError();
 283                 exit;
 284             }
 285         }
 286     }
 287
 288     /**
 289      * Read the HTTP headers and set the auth user.  Decodes HTTP_AUTHORIZATION
 290      * param to support basic auth when PHP is running in CGI mode.
 291      *
 292      * @return void
 293      */
 294
 295     function basicAuthProcessHeader()
 296     {
 297         $authHeaders = array('AUTHORIZATION',
 298                              'HTTP_AUTHORIZATION',
 299                              'REDIRECT_HTTP_AUTHORIZATION'); // rewrite for CGI
 300         $authorization_header = null;
 301         foreach ($authHeaders as $header) {
 302             if (isset($_SERVER[$header])) {
 303                 $authorization_header = $_SERVER[$header];
 304                 break;
 305             }
 306         }
 307
 308         if (isset($_SERVER['PHP_AUTH_USER'])) {
 309             $this->auth_user_nickname = $_SERVER['PHP_AUTH_USER'];
 310             $this->auth_user_password = $_SERVER['PHP_AUTH_PW'];
 311         } elseif (isset($authorization_header)
 312             && strstr(substr($authorization_header, 0, 5), 'Basic')) {
 313
 314             // Decode the HTTP_AUTHORIZATION header on php-cgi server self
 315             // on fcgid server the header name is AUTHORIZATION
 316
 317             $auth_hash = base64_decode(substr($authorization_header, 6));
 318             list($this->auth_user_nickname,
 319                  $this->auth_user_password) = explode(':', $auth_hash);
 320
 321             // Set all to null on a empty basic auth request
 322
 323             if (empty($this->auth_user_nickname)) {
 324                 $this->auth_user_nickname = null;
 325                 $this->auth_password = null;
 326             }
 327         }
 328     }
 329
 330     /**
 331      * Output an authentication error message.  Use XML or JSON if one
 332      * of those formats is specified, otherwise output plain text
 333      *
 334      * @return void
 335      */
 336
 337     function showAuthError()
 338     {
 339         header('HTTP/1.1 401 Unauthorized');
 340         $msg = 'Could not authenticate you.';
 341
 342         if ($this->format == 'xml') {
 343             header('Content-Type: application/xml; charset=utf-8');
 344             $this->startXML();
 345             $this->elementStart('hash');
 346             $this->element('error', null, $msg);
 347             $this->element('request', null, $_SERVER['REQUEST_URI']);
 348             $this->elementEnd('hash');
 349             $this->endXML();
 350         } elseif ($this->format == 'json') {
 351             header('Content-Type: application/json; charset=utf-8');
 352             $error_array = array('error' => $msg,
 353                                  'request' => $_SERVER['REQUEST_URI']);
 354             print(json_encode($error_array));
 355         } else {
 356             header('Content-type: text/plain');
 357             print "$msg\n";
 358         }
 359     }
 360
 361 }