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