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 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/api.php';
  42 require_once INSTALLDIR . '/lib/apioauth.php';
  43
  44 /**
  45  * Actions extending this class will require auth
  46  *
  47  * @category API
  48  * @package  StatusNet
  49  * @author   Zach Copley <zach@status.net>
  50  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  51  * @link     http://status.net/
  52  */
  53
  54 class ApiAuthAction extends ApiAction
  55 {
  56     var $access_token;
  57     var $oauth_access_type;
  58     var $oauth_source;
  59
  60     /**
  61      * Take arguments for running, and output 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         if ($this->requiresAuth()) {
  74
  75             $this->consumer_key = $this->arg('oauth_consumer_key');
  76             $this->access_token = $this->arg('oauth_token');
  77
  78             if (!empty($this->access_token)) {
  79                 $this->checkOAuthRequest();
  80             } else {
  81                 $this->checkBasicAuthUser();
  82                 // By default, all basic auth users have read and write access
  83
  84                 $this->access = self::READ_WRITE;
  85             }
  86         }
  87
  88         return true;
  89     }
  90
  91     function handle($args)
  92     {
  93         parent::handle($args);
  94     }
  95
  96     function checkOAuthRequest()
  97     {
  98         common_debug("We have an OAuth request.");
  99
 100         $datastore   = new ApiStatusNetOAuthDataStore();
 101         $server      = new OAuthServer($datastore);
 102         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
 103
 104         $server->add_signature_method($hmac_method);
 105
 106         ApiOauthAction::cleanRequest();
 107
 108         try {
 109
 110             $req  = OAuthRequest::from_request();
 111             $server->verify_request($req);
 112
 113             $app = Oauth_application::getByConsumerKey($this->consumer_key);
 114
 115             if (empty($app)) {
 116
 117                 // this should really not happen
 118                 common_log(LOG_WARN,
 119                            "Couldn't find the OAuth app for consumer key: $this->consumer_key");
 120
 121                 throw new OAuthException('No application for that consumer key.');
 122             }
 123
 124             // set the source attr
 125
 126             $this->oauth_source = $app->name;
 127
 128             $appUser = Oauth_application_user::staticGet('token',
 129                                                          $this->access_token);
 130
 131             // XXX: check that app->id and appUser->application_id and consumer all
 132             // match?
 133
 134             if (!empty($appUser)) {
 135
 136                 // read or read-write
 137                 $this->oauth_access_type = $appUser->access_type;
 138
 139                 // If access_type == 0 we have either a request token
 140                 // or a bad / revoked access token
 141
 142                 if ($this->oauth_access_type != 0) {
 143
 144                     // Set the read or read-write access for the api call
 145                     $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
 146                       ? self::READ_WRITE : self::READ_ONLY;
 147
 148                     if (Event::handle('StartSetApiUser', array(&$user))) {
 149                         $this->auth_user = User::staticGet('id', $appUser->profile_id);
 150                         Event::handle('EndSetApiUser', array($user));
 151                     }
 152
 153                     $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
 154                       "application '%s' (id: %d).";
 155
 156                     common_log(LOG_INFO, sprintf($msg,
 157                                                  $this->auth_user->nickname,
 158                                                  $this->auth_user->id,
 159                                                  $app->name,
 160                                                  $app->id));
 161                     return true;
 162                 } else {
 163                     throw new OAuthException('Bad access token.');
 164                 }
 165             } else {
 166
 167                 // also should not happen
 168                 throw new OAuthException('No user for that token.');
 169         }
 170
 171         } catch (OAuthException $e) {
 172             common_log(LOG_WARN, 'API OAuthException - ' . $e->getMessage());
 173             common_debug(var_export($req, true));
 174             $this->showOAuthError($e->getMessage());
 175             exit();
 176         }
 177     }
 178
 179     function showOAuthError($msg)
 180     {
 181         header('HTTP/1.1 401 Unauthorized');
 182         header('Content-Type: text/html; charset=utf-8');
 183         print $msg . "\n";
 184     }
 185
 186     /**
 187      * Does this API resource require authentication?
 188      *
 189      * @return boolean true
 190      */
 191
 192     function requiresAuth()
 193     {
 194         return true;
 195     }
 196
 197     /**
 198      * Check for a user specified via HTTP basic auth. If there isn't
 199      * one, try to get one by outputting the basic auth header.
 200      *
 201      * @return boolean true or false
 202      */
 203
 204     function checkBasicAuthUser()
 205     {
 206         $this->basicAuthProcessHeader();
 207
 208         $realm = common_config('site', 'name') . ' API';
 209
 210         if (!isset($this->auth_user)) {
 211             header('WWW-Authenticate: Basic realm="' . $realm . '"');
 212
 213             // show error if the user clicks 'cancel'
 214
 215             $this->showBasicAuthError();
 216             exit;
 217
 218         } else {
 219             $nickname = $this->auth_user;
 220             $password = $this->auth_pw;
 221             $user = common_check_user($nickname, $password);
 222             if (Event::handle('StartSetApiUser', array(&$user))) {
 223                 $this->auth_user = $user;
 224                 Event::handle('EndSetApiUser', array($user));
 225             }
 226
 227             if (empty($this->auth_user)) {
 228
 229                 // basic authentication failed
 230
 231                 list($proxy, $ip) = common_client_ip();
 232                 common_log(
 233                     LOG_WARNING,
 234                     'Failed API auth attempt, nickname = ' .
 235                     "$nickname, proxy = $proxy, ip = $ip."
 236                 );
 237                 $this->showBasicAuthError();
 238                 exit;
 239             }
 240         }
 241
 242         return true;
 243     }
 244
 245     /**
 246      * Read the HTTP headers and set the auth user.  Decodes HTTP_AUTHORIZATION
 247      * param to support basic auth when PHP is running in CGI mode.
 248      *
 249      * @return void
 250      */
 251
 252     function basicAuthProcessHeader()
 253     {
 254         if (isset($_SERVER['AUTHORIZATION'])
 255             || isset($_SERVER['HTTP_AUTHORIZATION'])
 256         ) {
 257                 $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])
 258                 ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
 259         }
 260
 261         if (isset($_SERVER['PHP_AUTH_USER'])) {
 262             $this->auth_user = $_SERVER['PHP_AUTH_USER'];
 263             $this->auth_pw = $_SERVER['PHP_AUTH_PW'];
 264         } elseif (isset($authorization_header)
 265             && strstr(substr($authorization_header, 0, 5), 'Basic')) {
 266
 267             // decode the HTTP_AUTHORIZATION header on php-cgi server self
 268             // on fcgid server the header name is AUTHORIZATION
 269
 270             $auth_hash = base64_decode(substr($authorization_header, 6));
 271             list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);
 272
 273             // set all to null on a empty basic auth request
 274
 275             if ($this->auth_user == "") {
 276                 $this->auth_user = null;
 277                 $this->auth_pw = null;
 278             }
 279         } else {
 280             $this->auth_user = null;
 281             $this->auth_pw = null;
 282         }
 283     }
 284
 285     /**
 286      * Output an authentication error message.  Use XML or JSON if one
 287      * of those formats is specified, otherwise output plain text
 288      *
 289      * @return void
 290      */
 291
 292     function showBasicAuthError()
 293     {
 294         header('HTTP/1.1 401 Unauthorized');
 295         $msg = 'Could not authenticate you.';
 296
 297         if ($this->format == 'xml') {
 298             header('Content-Type: application/xml; charset=utf-8');
 299             $this->startXML();
 300             $this->elementStart('hash');
 301             $this->element('error', null, $msg);
 302             $this->element('request', null, $_SERVER['REQUEST_URI']);
 303             $this->elementEnd('hash');
 304             $this->endXML();
 305         } elseif ($this->format == 'json') {
 306             header('Content-Type: application/json; charset=utf-8');
 307             $error_array = array('error' => $msg,
 308                                  'request' => $_SERVER['REQUEST_URI']);
 309             print(json_encode($error_array));
 310         } else {
 311             header('Content-type: text/plain');
 312             print "$msg\n";
 313         }
 314     }
 315
 316 }