We are no longer offering accounts on this server. Consider https://gitlab.freedesktop.org/ as a place to host projects.

statusnetoauthstore.php 16.2 KB
Newer Older
1 2 3
<?php
/*
 * StatusNet - the distributed open-source microblogging tool
4
 * Copyright (C) 2008-2011, StatusNet, Inc.
5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21
 *
 * 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/>.
 */

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

22
require_once 'OAuth.php';
23

24 25 26 27
/**
 * @fixme class doc
 */
class ApiStatusNetOAuthDataStore extends OAuthDataStore
28
{
29
    function lookup_consumer($consumerKey)
30
    {
31
        $con = Consumer::staticGet('consumer_key', $consumerKey);
32 33

        if (!$con) {
34 35 36 37

            // Create an anon consumer and anon application if one
            // doesn't exist already
            if ($consumerKey == 'anonymous') {
38 39

                common_debug("API OAuth - creating anonymous consumer");
40 41 42
                $con = new Consumer();
                $con->consumer_key    = $consumerKey;
                $con->consumer_secret = $consumerKey;
43 44
                $con->created         = common_sql_now();

45 46
                $result = $con->insert();
                if (!$result) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
47 48
                    // TRANS: Server error displayed when trying to create an anynymous OAuth consumer.
                    $this->serverError(_('Could not create anonymous consumer.'));
49
                }
50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70

                $app = Oauth_application::getByConsumerKey('anonymous');

                if (!$app) {
                    common_debug("API OAuth - creating anonymous application");
                    $app               = new OAuth_application();
                    $app->owner        = 1; // XXX: What to do here?
                    $app->consumer_key = $con->consumer_key;
                    $app->name         = 'anonymous';
                    $app->icon         = 'default-avatar-stream.png'; // XXX: Fix this!
                    $app->description  = "An anonymous application";
                    // XXX: allow the user to set the access type when
                    // authorizing? Currently we default to r+w for anonymous
                    // OAuth client applications
                    $app->access_type  = 3; // read + write
                    $app->type         = 2; // desktop
                    $app->created      = common_sql_now();

                    $id = $app->insert();

                    if (!$id) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
71
                        // TRANS: Server error displayed when trying to create an anynymous OAuth application.
72 73
                        $this->serverError(_("Could not create anonymous OAuth application."));
                    }
74 75 76 77
                }
            } else {
                return null;
            }
78 79
        }

80 81 82 83
        return new OAuthConsumer(
            $con->consumer_key,
            $con->consumer_secret
        );
84 85
    }

86 87
    function getAppByRequestToken($token_key)
    {
88 89 90 91 92 93
        // Look up the full req token
        $req_token = $this->lookup_token(
            null,
            'request',
            $token_key
        );
94 95

        if (empty($req_token)) {
Siebrand Mazeland's avatar
Siebrand Mazeland committed
96
            common_debug("Couldn't get request token from oauth datastore");
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
            return null;
        }

        // Look up the full Token
        $token = new Token();
        $token->tok = $req_token->key;
        $result = $token->find(true);

        if (empty($result)) {
            common_debug('Couldn\'t find req token in the token table.');
            return null;
        }

        // Look up the app
        $app = new Oauth_application();
        $app->consumer_key = $token->consumer_key;
        $result = $app->find(true);

        if (!empty($result)) {
            return $app;
        } else {
            common_debug("Couldn't find the app!");
            return null;
        }
    }

123
    function new_access_token($token, $consumer, $verifier)
124
    {
125
        common_debug(
Zach Copley's avatar
Zach Copley committed
126
            sprintf(
127
                "New access token from request token %s, consumer %s and verifier %s ",
Zach Copley's avatar
Zach Copley committed
128 129 130
                $token,
                $consumer,
                $verifier
131 132
            ),
            __FILE__
133
        );
134

Zach Copley's avatar
Zach Copley committed
135
        $rt = new Token();
136

137
        $rt->consumer_key = $consumer->key;
138 139
        $rt->tok          = $token->key;
        $rt->type         = 0; // request
140 141

        $app = Oauth_application::getByConsumerKey($consumer->key);
142
        assert(!empty($app));
143

144
        if ($rt->find(true) && $rt->state == 1 && $rt->verifier == $verifier) { // authorized
145

146 147 148
            common_debug('Request token found.', __FILE__);

            // find the app and profile associated with this token
Zach Copley's avatar
Zach Copley committed
149
            $tokenAssoc = Oauth_token_association::staticGet('token', $rt->tok);
150 151 152

            if (!$tokenAssoc) {
                throw new Exception(
153
                    // TRANS: Exception thrown when no token association could be found.
154 155 156 157
                    _('Could not find a profile and application associated with the request token.')
                );
            }

158 159 160 161 162
            // Check to see if we have previously issued an access token for
            // this application and profile; if so we can just return the
            // existing access token. That seems to be the best practice. It
            // makes it so users only have to authorize the app once per
            // machine.
163

Zach Copley's avatar
Zach Copley committed
164
            $appUser = new Oauth_application_user();
165

Zach Copley's avatar
Zach Copley committed
166
            $appUser->application_id = $app->id;
167
            $appUser->profile_id     = $tokenAssoc->profile_id;
168

Zach Copley's avatar
Zach Copley committed
169
            $result = $appUser->find(true);
170

Zach Copley's avatar
Zach Copley committed
171
            if (!empty($result)) {
172

173 174 175 176 177 178 179
                common_log(LOG_INFO,
                     sprintf(
                        "Existing access token found for application %s, profile %s.",
                        $app->id,
                        $tokenAssoc->profile_id
                     )
                );
180

181
                $at = null;
182

183 184 185 186 187 188 189 190 191 192
                // Special case: we used to store request tokens in the
                // Oauth_application_user record, and the access_type would
                // always be 0 (no access) as a failsafe until an access
                // token was issued and replaced the request token. There could
                // be a few old Oauth_application_user records storing request
                // tokens still around, and we don't want to accidentally
                // return a useless request token instead of a new access
                // token. So if we find one, we generate a new access token
                // and update the existing Oauth_application_user record before
                // returning the new access token. This should be rare.
193

194
                if ($appUser->access_type == 0) {
195

196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214
                    $at = $this->generateNewAccessToken($consumer, $rt, $verifier);
                    $this->updateAppUser($appUser, $app, $at);

                } else {

                    $at = new Token();

                    // fetch the full access token
                    $at->consumer_key = $consumer->key;
                    $at->tok          = $appUser->token;

                    $result = $at->find(true);

                    if (!$result) {
                        throw new Exception(
                            // TRANS: Exception thrown when no access token can be issued.
                            _('Could not issue access token.')
                        );
                    }
215
                }
216

217 218
                // Yay, we can re-issue the access token
                return new OAuthToken($at->tok, $at->secret);
Zach Copley's avatar
Zach Copley committed
219

220
            } else {
221

222 223 224 225 226 227 228 229
               common_log(LOG_INFO,
                    sprintf(
                        "Creating new access token for application %s, profile %s.",
                        $app->id,
                        $tokenAssoc->profile_id
                     )
                );

230 231
                $at = $this->generateNewAccessToken($consumer, $rt, $verifier);
                $this->newAppUser($tokenAssoc, $app, $at);
232

Zach Copley's avatar
Zach Copley committed
233 234 235
                // Okay, good
                return new OAuthToken($at->tok, $at->secret);
            }
236

237
        } else {
238 239 240 241 242 243 244 245 246

            // the token was not authorized or not verfied
            common_log(
                LOG_INFO,
                sprintf(
                    "API OAuth - Attempt to exchange unauthorized or unverified request token %s for an access token.",
                     $rt->tok
                )
            );
247 248 249 250
            return null;
        }
    }

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
    /*
     * Generate a new access token and save it to the database
     *
     * @param Consumer $consumer the OAuth consumer
     * @param Token    $rt       the authorized request token
     * @param string   $verifier the OAuth 1.0a verifier
     *
     * @access private
     *
     * @return Token   $at       the new access token
     */
    private function generateNewAccessToken($consumer, $rt, $verifier)
    {
        $at = new Token();

        $at->consumer_key      = $consumer->key;
        $at->tok               = common_good_rand(16);
        $at->secret            = common_good_rand(16);
        $at->type              = 1; // access
        $at->verifier          = $verifier;
        $at->verified_callback = $rt->verified_callback; // 1.0a
        $at->created           = common_sql_now();

        if (!$at->insert()) {
            $e = $at->_lastError;
            common_debug('access token "' . $at->tok . '" not inserted: "' . $e->message . '"', __FILE__);
            return null;
        } else {
            common_debug('access token "' . $at->tok . '" inserted', __FILE__);
            // burn the old one
            $orig_rt   = clone($rt);
            $rt->state = 2; // used
            if (!$rt->update($orig_rt)) {
                return null;
            }
            common_debug('request token "' . $rt->tok . '" updated', __FILE__);
        }

        return $at;
    }

   /*
    * Add a new app user (Oauth_application_user) record
    *
    * @param Oauth_token_association $tokenAssoc token-to-app association
    * @param Oauth_application       $app        the OAuth client app
    * @param Token                   $at         the access token
    *
    * @access private
    *
    * @return void
    */
    private function newAppUser($tokenAssoc, $app, $at)
    {
        $appUser = new Oauth_application_user();

        $appUser->profile_id     = $tokenAssoc->profile_id;
        $appUser->application_id = $app->id;
        $appUser->access_type    = $app->access_type;
        $appUser->token          = $at->tok;
        $appUser->created        = common_sql_now();

        $result = $appUser->insert();

        if (!$result) {
            common_log_db_error($appUser, 'INSERT', __FILE__);

            throw new Exception(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
319
                // TRANS: Exception thrown when a database error occurs.
320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346
                _('Database error inserting OAuth application user.')
            );
        }
    }

   /*
    * Update an existing app user (Oauth_application_user) record
    *
    * @param Oauth_application_user $appUser existing app user rec
    * @param Oauth_application      $app     the OAuth client app
    * @param Token                  $at      the access token
    *
    * @access private
    *
    * @return void
    */
    private function updateAppUser($appUser, $app, $at)
    {
        $original = clone($appUser);
        $appUser->access_type = $app->access_type;
        $appUser->token       = $at->tok;

        $result = $appUser->update($original);

        if (!$result) {
            common_log_db_error($appUser, 'UPDATE', __FILE__);
            throw new Exception(
Siebrand Mazeland's avatar
Siebrand Mazeland committed
347
                // TRANS: Exception thrown when a database error occurs.
348 349 350 351 352
                _('Database error updating OAuth application user.')
            );
        }
    }

Zach Copley's avatar
Zach Copley committed
353 354 355 356 357 358 359 360 361 362 363 364 365 366
    /**
     * Revoke specified access token
     *
     * Revokes the token specified by $token_key.
     * Throws exceptions in case of error.
     *
     * @param string $token_key the token to be revoked
     * @param int    $type      type of token (0 = req, 1 = access)
     *
     * @access public
     *
     * @return void
     */
    public function revoke_token($token_key, $type = 0) {
367 368 369
        $rt        = new Token();
        $rt->tok   = $token_key;
        $rt->type  = $type;
Zach Copley's avatar
Zach Copley committed
370
        $rt->state = 0;
371

Zach Copley's avatar
Zach Copley committed
372
        if (!$rt->find(true)) {
373
            // TRANS: Exception thrown when an attempt is made to revoke an unknown token.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
374
            throw new Exception(_('Tried to revoke unknown token.'));
Zach Copley's avatar
Zach Copley committed
375
        }
376

Zach Copley's avatar
Zach Copley committed
377
        if (!$rt->delete()) {
378
            // TRANS: Exception thrown when an attempt is made to remove a revoked token.
Siebrand Mazeland's avatar
Siebrand Mazeland committed
379
            throw new Exception(_('Failed to delete revoked token.'));
Zach Copley's avatar
Zach Copley committed
380 381
        }
    }
382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399

    /*
     * Create a new request token. Overrided to support OAuth 1.0a callback
     *
     * @param OAuthConsumer $consumer the OAuth Consumer for this token
     * @param string        $callback the verified OAuth callback URL
     *
     * @return OAuthToken   $token a new unauthorized OAuth request token
     */
    function new_request_token($consumer, $callback)
    {
        $t = new Token();
        $t->consumer_key = $consumer->key;
        $t->tok = common_good_rand(16);
        $t->secret = common_good_rand(16);
        $t->type = 0; // request
        $t->state = 0; // unauthorized
        $t->verified_callback = $callback;
400 401 402

        if ($callback === 'oob') {
            // six digit pin
403
            $t->verifier = mt_rand(0, 9999999);
404 405 406 407
        } else {
            $t->verifier = common_good_rand(8);
        }

408 409 410 411 412 413 414
        $t->created = DB_DataObject_Cast::dateTime();
        if (!$t->insert()) {
            return null;
        } else {
            return new OAuthToken($t->tok, $t->secret);
        }
    }
415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505

    /**
     * Authorize specified OAuth token
     *
     * Authorizes the authorization token specified by $token_key.
     * Throws exceptions in case of error.
     *
     * @param string $token_key The token to be authorized
     *
     * @access public
     **/
    public function authorize_token($token_key) {
        $rt = new Token();
        $rt->tok = $token_key;
        $rt->type = 0;
        $rt->state = 0;
        if (!$rt->find(true)) {
            throw new Exception('Tried to authorize unknown token');
        }
        $orig_rt = clone($rt);
        $rt->state = 1; # Authorized but not used
        if (!$rt->update($orig_rt)) {
            throw new Exception('Failed to authorize token');
        }
    }

    /**
     *
     * http://oauth.net/core/1.0/#nonce
     * "The Consumer SHALL then generate a Nonce value that is unique for
     * all requests with that timestamp."
     * XXX: It's not clear why the token is here
     *
     * @param type $consumer
     * @param type $token
     * @param type $nonce
     * @param type $timestamp
     * @return type
     */
    function lookup_nonce($consumer, $token, $nonce, $timestamp)
    {
        $n = new Nonce();
        $n->consumer_key = $consumer->key;
        $n->ts = common_sql_date($timestamp);
        $n->nonce = $nonce;
        if ($n->find(true)) {
            return true;
        } else {
            $n->created = DB_DataObject_Cast::dateTime();
            $n->insert();
            return false;
        }
    }

    /**
     *
     * @param type $consumer
     * @param type $token_type
     * @param type $token_key
     * @return OAuthToken
     */
    function lookup_token($consumer, $token_type, $token_key)
    {
        $t = new Token();
        if (!is_null($consumer)) {
            $t->consumer_key = $consumer->key;
        }
        $t->tok = $token_key;
        $t->type = ($token_type == 'access') ? 1 : 0;
        if ($t->find(true)) {
            return new OAuthToken($t->tok, $t->secret);
        } else {
            return null;
        }
    }

    /**
     *
     * @param type $token_key
     * @return Token 
     */
    function getTokenByKey($token_key)
    {
        $t = new Token();
        $t->tok = $token_key;
        if ($t->find(true)) {
            return $t;
        } else {
            return null;
        }
    }
506
}