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
  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
  56     var $auth_user = null;
  57
  58     /**
  59      * Take arguments for running, and output basic auth header if needed
  60      *
  61      * @param array $args $_REQUEST args
  62      *
  63      * @return boolean success flag
  64      *
  65      */
  66
  67     function prepare($args)
  68     {
  69         parent::prepare($args);
  70
  71         if ($this->requiresAuth()) {
  72             $this->checkBasicAuthUser();
  73         }
  74
  75         return true;
  76     }
  77
  78     /**
  79      * Does this API resource require authentication?
  80      *
  81      * @return boolean true
  82      */
  83
  84     function requiresAuth()
  85     {
  86         return true;
  87     }
  88
  89     /**
  90      * Check for a user specified via HTTP basic auth. If there isn't
  91      * one, try to get one by outputting the basic auth header.
  92      *
  93      * @return boolean true or false
  94      */
  95
  96     function checkBasicAuthUser()
  97     {
  98         $this->basicAuthProcessHeader();
  99
 100         $realm = common_config('site', 'name') . ' API';
 101
 102         if (!isset($this->auth_user)) {
 103             header('WWW-Authenticate: Basic realm="' . $realm . '"');
 104
 105             // show error if the user clicks 'cancel'
 106
 107             $this->showBasicAuthError();
 108             exit;
 109
 110         } else {
 111             $nickname = $this->auth_user;
 112             $password = $this->auth_pw;
 113             $user = common_check_user($nickname, $password);
 114             if (Event::handle('StartSetApiUser', array(&$user))) {
 115                 $this->auth_user = $user;
 116                 Event::handle('EndSetApiUser', array($user));
 117             }
 118
 119             if (empty($this->auth_user)) {
 120
 121                 // basic authentication failed
 122
 123                 list($proxy, $ip) = common_client_ip();
 124                 common_log(
 125                     LOG_WARNING,
 126                     'Failed API auth attempt, nickname = ' .
 127                     "$nickname, proxy = $proxy, ip = $ip."
 128                 );
 129                 $this->showBasicAuthError();
 130                 exit;
 131             }
 132         }
 133         return true;
 134     }
 135
 136     /**
 137      * Read the HTTP headers and set the auth user.  Decodes HTTP_AUTHORIZATION
 138      * param to support basic auth when PHP is running in CGI mode.
 139      *
 140      * @return void
 141      */
 142
 143     function basicAuthProcessHeader()
 144     {
 145         if (isset($_SERVER['AUTHORIZATION'])
 146             || isset($_SERVER['HTTP_AUTHORIZATION'])
 147         ) {
 148                 $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])
 149                 ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
 150         }
 151
 152         if (isset($_SERVER['PHP_AUTH_USER'])) {
 153             $this->auth_user = $_SERVER['PHP_AUTH_USER'];
 154             $this->auth_pw = $_SERVER['PHP_AUTH_PW'];
 155         } elseif (isset($authorization_header)
 156             && strstr(substr($authorization_header, 0, 5), 'Basic')) {
 157
 158             // decode the HTTP_AUTHORIZATION header on php-cgi server self
 159             // on fcgid server the header name is AUTHORIZATION
 160
 161             $auth_hash = base64_decode(substr($authorization_header, 6));
 162             list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);
 163
 164             // set all to null on a empty basic auth request
 165
 166             if ($this->auth_user == "") {
 167                 $this->auth_user = null;
 168                 $this->auth_pw = null;
 169             }
 170         } else {
 171             $this->auth_user = null;
 172             $this->auth_pw = null;
 173         }
 174     }
 175
 176     /**
 177      * Output an authentication error message.  Use XML or JSON if one
 178      * of those formats is specified, otherwise output plain text
 179      *
 180      * @return void
 181      */
 182
 183     function showBasicAuthError()
 184     {
 185         header('HTTP/1.1 401 Unauthorized');
 186         $msg = 'Could not authenticate you.';
 187
 188         if ($this->format == 'xml') {
 189             header('Content-Type: application/xml; charset=utf-8');
 190             $this->startXML();
 191             $this->elementStart('hash');
 192             $this->element('error', null, $msg);
 193             $this->element('request', null, $_SERVER['REQUEST_URI']);
 194             $this->elementEnd('hash');
 195             $this->endXML();
 196         } elseif ($this->format == 'json') {
 197             header('Content-Type: application/json; charset=utf-8');
 198             $error_array = array('error' => $msg,
 199                                  'request' => $_SERVER['REQUEST_URI']);
 200             print(json_encode($error_array));
 201         } else {
 202             header('Content-type: text/plain');
 203             print "$msg\n";
 204         }
 205     }
 206
 207 }