summaryrefslogtreecommitdiff
path: root/lib/apiauth.php
blob: f513ed2c9a02af77cf7595172efdd83170db268f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
 * Base class for API actions that require authentication
 *
 * PHP version 5
 *
 * LICENCE: This program is free software: you can redistribute it and/or modify
 * it under the terms of the GNU Affero General Public License as published by
 * the Free Software Foundation, either version 3 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU Affero General Public License for more details.
 *
 * You should have received a copy of the GNU Affero General Public License
 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
 *
 * @category  API
 * @package   StatusNet
 * @author    Adrian Lang <mail@adrianlang.de>
 * @author    Brenda Wallace <shiny@cpan.org>
 * @author    Craig Andrews <candrews@integralblue.com>
 * @author    Dan Moore <dan@moore.cx>
 * @author    Evan Prodromou <evan@status.net>
 * @author    mEDI <medi@milaro.net>
 * @author    Sarven Capadisli <csarven@status.net>
 * @author    Zach Copley <zach@status.net>
 * @copyright 2009 StatusNet, Inc.
 * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link      http://status.net/
 */

if (!defined('STATUSNET')) {
    exit(1);
}

require_once INSTALLDIR . '/lib/api.php';
require_once INSTALLDIR . '/lib/apioauth.php';

/**
 * Actions extending this class will require auth
 *
 * @category API
 * @package  StatusNet
 * @author   Zach Copley <zach@status.net>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */

class ApiAuthAction extends ApiAction
{
    var $access_token;
    var $oauth_access_type;

    /**
     * Take arguments for running, and output basic auth header if needed
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
     *
     */

    function prepare($args)
    {
        parent::prepare($args);

        if ($this->requiresAuth()) {

            $this->consumer_key = $this->arg('oauth_consumer_key');
            $this->access_token = $this->arg('oauth_token');

            if (!empty($this->access_token)) {
                $this->checkOAuthRequest();
            } else {
                $this->checkBasicAuthUser();
                // By default, all basic auth users have read and write access

                $this->access = self::READ_WRITE;
            }
        }

        return true;
    }

    function handle($args)
    {
        parent::handle($args);

        if ($this->isReadOnly($args) == false) {
            if ($this->access == self::READ_ONLY) {
                $this->clientError(_('API method requires write access.'), 401);
                exit();
            }
        }
    }

    function checkOAuthRequest()
    {
        common_debug("We have an OAuth request.");

        $datastore   = new ApiStatusNetOAuthDataStore();
        $server      = new OAuthServer($datastore);
        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();

        $server->add_signature_method($hmac_method);

        ApiOauthAction::cleanRequest();

        try {

            $req  = OAuthRequest::from_request();
            $server->verify_request($req);

            common_debug("Good OAuth request!");

            $app = Oauth_application::getByConsumerKey($this->consumer_key);

            if (empty($app)) {

                // this should really not happen
                common_log(LOG_WARN,
                           "Couldn't find the OAuth app for consumer key: $this->consumer_key");

                throw new OAuthException('No application for that consumer key.');
            }

            $appUser = Oauth_application_user::staticGet('token',
                                                         $this->access_token);

            // XXX: check that app->id and appUser->application_id and consumer all
            // match?

            if (!empty($appUser)) {

                // read or read-write
                $this->oauth_access_type = $appUser->access_type;

                // If access_type == 0 we have either a request token
                // or a bad / revoked access token

                if ($this->oauth_access_type != 0) {

                    // Set the read or read-write access for the api call
                    $this->access = ($appUser->access_type & Oauth_application::$writeAccess)
                      ? self::READ_WRITE : self::READ_ONLY;

                    if (Event::handle('StartSetApiUser', array(&$user))) {
                        $this->auth_user = User::staticGet('id', $appUser->profile_id);
                        Event::handle('EndSetApiUser', array($user));
                    }

                    $msg = "API OAuth authentication for user '%s' (id: %d) on behalf of " .
                      "application '%s' (id: %d).";

                    common_log(LOG_INFO, sprintf($msg,
                                                 $this->auth_user->nickname,
                                                 $this->auth_user->id,
                                                 $app->name,
                                                 $app->id));
                    return true;
                } else {
                    throw new OAuthException('Bad access token.');
                }
            } else {

                // also should not happen
                throw new OAuthException('No user for that token.');
        }

        } catch (OAuthException $e) {
            common_log(LOG_WARN, 'API OAuthException - ' . $e->getMessage());
            common_debug(var_export($req, true));
            $this->showOAuthError($e->getMessage());
            exit();
        }
    }

    function showOAuthError($msg)
    {
        header('HTTP/1.1 401 Unauthorized');
        header('Content-Type: text/html; charset=utf-8');
        print $msg . "\n";
    }

    /**
     * Does this API resource require authentication?
     *
     * @return boolean true
     */

    function requiresAuth()
    {
        return true;
    }

    /**
     * Check for a user specified via HTTP basic auth. If there isn't
     * one, try to get one by outputting the basic auth header.
     *
     * @return boolean true or false
     */

    function checkBasicAuthUser()
    {
        $this->basicAuthProcessHeader();

        $realm = common_config('site', 'name') . ' API';

        if (!isset($this->auth_user)) {
            header('WWW-Authenticate: Basic realm="' . $realm . '"');

            // show error if the user clicks 'cancel'

            $this->showBasicAuthError();
            exit;

        } else {
            $nickname = $this->auth_user;
            $password = $this->auth_pw;
            $user = common_check_user($nickname, $password);
            if (Event::handle('StartSetApiUser', array(&$user))) {
                $this->auth_user = $user;
                Event::handle('EndSetApiUser', array($user));
            }

            if (empty($this->auth_user)) {

                // basic authentication failed

                list($proxy, $ip) = common_client_ip();
                common_log(
                    LOG_WARNING,
                    'Failed API auth attempt, nickname = ' .
                    "$nickname, proxy = $proxy, ip = $ip."
                );
                $this->showBasicAuthError();
                exit;
            }
        }

        return true;
    }

    /**
     * Read the HTTP headers and set the auth user.  Decodes HTTP_AUTHORIZATION
     * param to support basic auth when PHP is running in CGI mode.
     *
     * @return void
     */

    function basicAuthProcessHeader()
    {
        if (isset($_SERVER['AUTHORIZATION'])
            || isset($_SERVER['HTTP_AUTHORIZATION'])
        ) {
                $authorization_header = isset($_SERVER['HTTP_AUTHORIZATION'])
                ? $_SERVER['HTTP_AUTHORIZATION'] : $_SERVER['AUTHORIZATION'];
        }

        if (isset($_SERVER['PHP_AUTH_USER'])) {
            $this->auth_user = $_SERVER['PHP_AUTH_USER'];
            $this->auth_pw = $_SERVER['PHP_AUTH_PW'];
        } elseif (isset($authorization_header)
            && strstr(substr($authorization_header, 0, 5), 'Basic')) {

            // decode the HTTP_AUTHORIZATION header on php-cgi server self
            // on fcgid server the header name is AUTHORIZATION

            $auth_hash = base64_decode(substr($authorization_header, 6));
            list($this->auth_user, $this->auth_pw) = explode(':', $auth_hash);

            // set all to null on a empty basic auth request

            if ($this->auth_user == "") {
                $this->auth_user = null;
                $this->auth_pw = null;
            }
        } else {
            $this->auth_user = null;
            $this->auth_pw = null;
        }
    }

    /**
     * Output an authentication error message.  Use XML or JSON if one
     * of those formats is specified, otherwise output plain text
     *
     * @return void
     */

    function showBasicAuthError()
    {
        header('HTTP/1.1 401 Unauthorized');
        $msg = 'Could not authenticate you.';

        if ($this->format == 'xml') {
            header('Content-Type: application/xml; charset=utf-8');
            $this->startXML();
            $this->elementStart('hash');
            $this->element('error', null, $msg);
            $this->element('request', null, $_SERVER['REQUEST_URI']);
            $this->elementEnd('hash');
            $this->endXML();
        } elseif ($this->format == 'json') {
            header('Content-Type: application/json; charset=utf-8');
            $error_array = array('error' => $msg,
                                 'request' => $_SERVER['REQUEST_URI']);
            print(json_encode($error_array));
        } else {
            header('Content-type: text/plain');
            print "$msg\n";
        }
    }

}