3 * StatusNet, the distributed open-source microblogging tool
5 * Base class for API actions that require authentication
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.
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.
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/>.
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/
37 if (!defined('STATUSNET')) {
41 require_once INSTALLDIR . '/lib/api.php';
44 * Actions extending this class will require auth
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/
53 class ApiAuthAction extends ApiAction
56 var $auth_user = null;
59 * Take arguments for running, and output basic auth header if needed
61 * @param array $args $_REQUEST args
63 * @return boolean success flag
67 function prepare($args)
69 parent::prepare($args);
71 if ($this->requiresAuth()) {
72 $this->checkBasicAuthUser();
79 * Does this API resource require authentication?
81 * @return boolean true
84 function requiresAuth()
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.
93 * @return boolean true or false
96 function checkBasicAuthUser()
98 $this->basicAuthProcessHeader();
100 $realm = common_config('site', 'name') . ' API';
102 if (!isset($this->auth_user)) {
103 header('WWW-Authenticate: Basic realm="' . $realm . '"');
105 // show error if the user clicks 'cancel'
107 $this->showBasicAuthError();
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));
119 if (empty($this->auth_user)) {
121 // basic authentication failed
123 list($proxy, $ip) = common_client_ip();
126 'Failed API auth attempt, nickname = ' .
127 "$nickname, proxy = $proxy, ip = $ip."
129 $this->showBasicAuthError();
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.
143 function basicAuthProcessHeader()
145 if (isset($_SERVER['AUTHORIZATION'])
146 || isset($_SERVER['HTTP_AUTHORIZATION'])
148 $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])
149 ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
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')) {
158 // decode the HTTP_AUTHORIZATION header on php-cgi server self
159 // on fcgid server the header name is AUTHORIZATION
161 $auth_hash = base64_decode(substr($authorization_header, 6));
162 list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);
164 // set all to null on a empty basic auth request
166 if ($this->auth_user == "") {
167 $this->auth_user = null;
168 $this->auth_pw = null;
171 $this->auth_user = null;
172 $this->auth_pw = null;
177 * Output an authentication error message. Use XML or JSON if one
178 * of those formats is specified, otherwise output plain text
183 function showBasicAuthError()
185 header('HTTP/1.1 401 Unauthorized');
186 $msg = 'Could not authenticate you.';
188 if ($this->format == 'xml') {
189 header('Content-Type: application/xml; charset=utf-8');
191 $this->elementStart('hash');
192 $this->element('error', null, $msg);
193 $this->element('request', null, $_SERVER['REQUEST_URI']);
194 $this->elementEnd('hash');
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));
202 header('Content-type: text/plain');