lib/apiauthaction.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  * @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/
  36  */
  37
  38 /* External API usage documentation. Please update when you change how this method works. */
  39
  40 /*! @page authentication Authentication
  41
  42     StatusNet supports HTTP Basic Authentication and OAuth for API calls.
  43
  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.
  47
  48     @section HTTP Basic Auth
  49
  50
  51
  52     @section OAuth
  53
  54 */
  55
  56 if (!defined('GNUSOCIAL')) { exit(1); }
  57
  58 /**
  59  * Actions extending this class will require auth
  60  *
  61  * @category API
  62  * @package  StatusNet
  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/
  66  */
  67 class ApiAuthAction extends ApiAction
  68 {
  69     var $auth_user_nickname = null;
  70     var $auth_user_password = null;
  71
  72     /**
  73      * Take arguments for running, looks for an OAuth request,
  74      * and outputs basic auth header if needed
  75      *
  76      * @param array $args $_REQUEST args
  77      *
  78      * @return boolean success flag
  79      *
  80      */
  81     protected function prepare(array $args=array())
  82     {
  83         parent::prepare($args);
  84
  85         // NOTE: $this->auth_user has to get set in prepare(), not handle(),
  86         // because subclasses do stuff with it in their prepares.
  87
  88         $oauthReq = $this->getOAuthRequest();
  89
  90         if (!$oauthReq) {
  91             if ($this->requiresAuth()) {
  92                 $this->checkBasicAuthUser(true);
  93             } else {
  94                 // Check to see if a basic auth user is there even
  95                 // if one's not required
  96                 $this->checkBasicAuthUser(false);
  97             }
  98         } else {
  99             $this->checkOAuthRequest($oauthReq);
 100         }
 101
 102         // NOTE: Make sure we're scoped properly based on the auths!
 103         if (isset($this->auth_user) && !empty($this->auth_user)) {
 104             $this->scoped = $this->auth_user->getProfile();
 105         } else {
 106             $this->scoped = null;
 107         }
 108
 109         // legacy user transferral
 110         // TODO: remove when sure no extended classes need it
 111         $this->user = $this->auth_user;
 112
 113         // Reject API calls with the wrong access level
 114
 115         if ($this->isReadOnly($args) == false) {
 116             if ($this->access != self::READ_WRITE) {
 117                 // TRANS: Client error 401.
 118                 $msg = _('API resource requires read-write access, ' .
 119                          'but you only have read access.');
 120                 $this->clientError($msg, 401);
 121             }
 122         }
 123
 124         return true;
 125     }
 126
 127     /**
 128      * Determine whether the request is an OAuth request.
 129      * This is to avoid doign any unnecessary DB lookups.
 130      *
 131      * @return mixed the OAuthRequest or false
 132      */
 133     function getOAuthRequest()
 134     {
 135         ApiOAuthAction::cleanRequest();
 136
 137         $req  = OAuthRequest::from_request();
 138
 139         $consumer    = $req->get_parameter('oauth_consumer_key');
 140         $accessToken = $req->get_parameter('oauth_token');
 141
 142         // XXX: Is it good enough to assume it's not meant to be an
 143         // OAuth request if there is no consumer or token? --Z
 144
 145         if (empty($consumer) || empty($accessToken)) {
 146             return false;
 147         }
 148
 149         return $req;
 150     }
 151
 152     /**
 153      * Verifies the OAuth request signature, sets the auth user
 154      * and access type (read-only or read-write)
 155      *
 156      * @param OAuthRequest $request the OAuth Request
 157      *
 158      * @return nothing
 159      */
 160     function checkOAuthRequest($request)
 161     {
 162         $datastore   = new ApiGNUsocialOAuthDataStore();
 163         $server      = new OAuthServer($datastore);
 164         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 165
 166         $server->add_signature_method($hmac_method);
 167
 168         try {
 169             $server->verify_request($request);
 170
 171             $consumer     = $request->get_parameter('oauth_consumer_key');
 172             $access_token = $request->get_parameter('oauth_token');
 173
 174             $app = Oauth_application::getByConsumerKey($consumer);
 175
 176             if (empty($app)) {
 177                 common_log(
 178                     LOG_WARNING,
 179                     'API OAuth - Couldn\'t find the OAuth app for consumer key: ' .
 180                     $consumer
 181                 );
 182                 // TRANS: OAuth exception thrown when no application is found for a given consumer key.
 183                 throw new OAuthException(_('No application for that consumer key.'));
 184             }
 185
 186             // set the source attr
 187             if ($app->name != 'anonymous') {
 188                 $this->source = $app->name;
 189             }
 190
 191
 192             $appUser = Oauth_application_user::getKV('token', $access_token);
 193
 194             if (!empty($appUser)) {
 195                 // If access_type == 0 we have either a request token
 196                 // or a bad / revoked access token
 197
 198                 if ($appUser->access_type != 0) {
 199                     // Set the access level for the api call
 200                     $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
 201                       ? self::READ_WRITE : self::READ_ONLY;
 202
 203                     // Set the auth user
 204                     if (Event::handle('StartSetApiUser', array(&$user))) {
 205                         $user = User::getKV('id', $appUser->profile_id);
 206                         if (!empty($user)) {
 207                             if (!$user->hasRight(Right::API)) {
 208                                 // TRANS: Authorization exception thrown when a user without API access tries to access the API.
 209                                 throw new AuthorizationException(_('Not allowed to use API.'));
 210                             }
 211                         }
 212                         $this->auth_user = $user;
 213                         // FIXME: setting the value returned by common_current_user()
 214                         // There should probably be a better method for this. common_set_user()
 215                         // does lots of session stuff.
 216                         global $_cur;
 217                         $_cur = $this->auth_user;
 218                         Event::handle('EndSetApiUser', array($user));
 219                     }
 220
 221                     $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
 222                         "application '%s' (id: %d) with %s access.";
 223
 224                     common_log(
 225                         LOG_INFO,
 226                         sprintf(
 227                             $msg,
 228                             $this->auth_user->nickname,
 229                             $this->auth_user->id,
 230                             $app->name,
 231                             $app->id,
 232                             ($this->access = self::READ_WRITE) ? 'read-write' : 'read-only'
 233                         )
 234                     );
 235                 } else {
 236                     // TRANS: OAuth exception given when an incorrect access token was given for a user.
 237                     throw new OAuthException(_('Bad access token.'));
 238                 }
 239             } else {
 240                 // Also should not happen.
 241                 // TRANS: OAuth exception given when no user was found for a given token (no token was found).
 242                 throw new OAuthException(_('No user for that token.'));
 243             }
 244
 245         } catch (OAuthException $e) {
 246             $this->logAuthFailure($e->getMessage());
 247             common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
 248             $this->clientError($e->getMessage(), 401);
 249         }
 250     }
 251
 252     /**
 253      * Does this API resource require authentication?
 254      *
 255      * @return boolean true
 256      */
 257     public function requiresAuth()
 258     {
 259         return true;
 260     }
 261
 262     /**
 263      * Check for a user specified via HTTP basic auth. If there isn't
 264      * one, try to get one by outputting the basic auth header.
 265      *
 266      * @return boolean true or false
 267      */
 268     function checkBasicAuthUser($required = true)
 269     {
 270         $this->basicAuthProcessHeader();
 271
 272         $realm = common_config('api', 'realm');
 273
 274         if (empty($realm)) {
 275             $realm = common_config('site', 'name') . ' API';
 276         }
 277
 278         if (empty($this->auth_user_nickname) && $required) {
 279             header('WWW-Authenticate: Basic realm="' . $realm . '"');
 280
 281             // show error if the user clicks 'cancel'
 282             // TRANS: Client error thrown when authentication fails becaus a user clicked "Cancel".
 283             $this->clientError(_('Could not authenticate you.'), 401);
 284
 285         } else {
 286
 287             $user = common_check_user($this->auth_user_nickname,
 288                                       $this->auth_user_password);
 289
 290             if (Event::handle('StartSetApiUser', array(&$user))) {
 291
 292                 if (!empty($user)) {
 293                     if (!$user->hasRight(Right::API)) {
 294                         // TRANS: Authorization exception thrown when a user without API access tries to access the API.
 295                         throw new AuthorizationException(_('Not allowed to use API.'));
 296                     }
 297                     $this->auth_user = $user;
 298                 }
 299
 300                 Event::handle('EndSetApiUser', array($user));
 301             }
 302
 303             // By default, basic auth users have rw access
 304             $this->access = self::READ_WRITE;
 305
 306             if (empty($this->auth_user) && ($required || isset($_SERVER['PHP_AUTH_USER']))) {
 307                 $msg = sprintf(
 308                     "basic auth nickname = %s",
 309                     $this->auth_user_nickname
 310                 );
 311                 $this->logAuthFailure($msg);
 312                 // TRANS: Client error thrown when authentication fails.
 313                 $this->clientError(_('Could not authenticate you.'), 401);
 314             }
 315         }
 316     }
 317
 318     /**
 319      * Read the HTTP headers and set the auth user.  Decodes HTTP_AUTHORIZATION
 320      * param to support basic auth when PHP is running in CGI mode.
 321      *
 322      * @return void
 323      */
 324     function basicAuthProcessHeader()
 325     {
 326         $authHeaders = array('AUTHORIZATION',
 327                              'HTTP_AUTHORIZATION',
 328                              'REDIRECT_HTTP_AUTHORIZATION'); // rewrite for CGI
 329         $authorization_header = null;
 330         foreach ($authHeaders as $header) {
 331             if (isset($_SERVER[$header])) {
 332                 $authorization_header = $_SERVER[$header];
 333                 break;
 334             }
 335         }
 336
 337         if (isset($_SERVER['PHP_AUTH_USER'])) {
 338             $this->auth_user_nickname = $_SERVER['PHP_AUTH_USER'];
 339             $this->auth_user_password = $_SERVER['PHP_AUTH_PW'];
 340         } elseif (isset($authorization_header)
 341             && strstr(substr($authorization_header, 0, 5), 'Basic')) {
 342
 343             // Decode the HTTP_AUTHORIZATION header on php-cgi server self
 344             // on fcgid server the header name is AUTHORIZATION
 345             $auth_hash = base64_decode(substr($authorization_header, 6));
 346             list($this->auth_user_nickname,
 347                  $this->auth_user_password) = explode(':', $auth_hash);
 348
 349             // Set all to null on a empty basic auth request
 350
 351             if (empty($this->auth_user_nickname)) {
 352                 $this->auth_user_nickname = null;
 353                 $this->auth_password = null;
 354             }
 355         }
 356     }
 357
 358     /**
 359      * Log an API authentication failure. Collect the proxy and IP
 360      * and log them
 361      *
 362      * @param string $logMsg additional log message
 363      */
 364      function logAuthFailure($logMsg)
 365      {
 366         list($proxy, $ip) = common_client_ip();
 367
 368         $msg = sprintf(
 369             'API auth failure (proxy = %1$s, ip = %2$s) - ',
 370             $proxy,
 371             $ip
 372         );
 373
 374         common_log(LOG_WARNING, $msg . $logMsg);
 375      }
 376 }