actions/apioauthauthorize.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Authorize an OAuth request token
   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    Zach Copley <zach@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 require_once INSTALLDIR . '/lib/apioauth.php';
  35 require_once INSTALLDIR . '/lib/info.php';
  36
  37 /**
  38  * Authorize an OAuth request token
  39  *
  40  * @category API
  41  * @package  StatusNet
  42  * @author   Zach Copley <zach@status.net>
  43  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  44  * @link     http://status.net/
  45  */
  46 class ApiOauthAuthorizeAction extends Action
  47 {
  48     var $oauthTokenParam;
  49     var $reqToken;
  50     var $callback;
  51     var $app;
  52     var $nickname;
  53     var $password;
  54     var $store;
  55
  56     /**
  57      * Is this a read-only action?
  58      *
  59      * @return boolean false
  60      */
  61
  62     function isReadOnly($args)
  63     {
  64         return false;
  65     }
  66
  67     function prepare($args)
  68     {
  69         parent::prepare($args);
  70
  71         $this->nickname         = $this->trimmed('nickname');
  72         $this->password         = $this->arg('password');
  73         $this->oauthTokenParam  = $this->arg('oauth_token');
  74         $this->callback         = $this->arg('oauth_callback');
  75         $this->store            = new ApiStatusNetOAuthDataStore();
  76
  77         try {
  78             $this->app = $this->store->getAppByRequestToken($this->oauthTokenParam);
  79         } catch (Exception $e) {
  80             $this->clientError($e->getMessage());
  81         }
  82
  83         return true;
  84     }
  85
  86     /**
  87      * Handle input, produce output
  88      *
  89      * Switches on request method; either shows the form or handles its input.
  90      *
  91      * @param array $args $_REQUEST data
  92      *
  93      * @return void
  94      */
  95
  96     function handle($args)
  97     {
  98         parent::handle($args);
  99
 100         if ($_SERVER['REQUEST_METHOD'] == 'POST') {
 101
 102             $this->handlePost();
 103
 104         } else {
 105
 106             // Make sure a oauth_token parameter was provided
 107             if (empty($this->oauthTokenParam)) {
 108                 // TRANS: Client error given when no oauth_token was passed to the OAuth API.
 109                 $this->clientError(_('No oauth_token parameter provided.'));
 110             } else {
 111
 112                 // Check to make sure the token exists
 113                 $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
 114
 115                 if (empty($this->reqToken)) {
 116                     // TRANS: Client error given when an invalid request token was passed to the OAuth API.
 117                     $this->clientError(_('Invalid request token.'));
 118                 } else {
 119
 120                     // Check to make sure we haven't already authorized the token
 121                     if ($this->reqToken->state != 0) {
 122                         // TRANS: Client error given when an invalid request token was passed to the OAuth API.
 123                         $this->clientError(_("Invalid request token."));
 124                     }
 125                 }
 126             }
 127
 128             // make sure there's an app associated with this token
 129             if (empty($this->app)) {
 130                 // TRANS: Client error given when an invalid request token was passed to the OAuth API.
 131                 $this->clientError(_('Invalid request token.'));
 132             }
 133
 134             $name = $this->app->name;
 135
 136             $this->showForm();
 137         }
 138     }
 139
 140     function handlePost()
 141     {
 142         // check session token for CSRF protection.
 143
 144         $token = $this->trimmed('token');
 145
 146         if (!$token || $token != common_session_token()) {
 147             $this->showForm(
 148                 _('There was a problem with your session token. Try again, please.'));
 149             return;
 150         }
 151
 152         // check creds
 153
 154         $user = null;
 155
 156         if (!common_logged_in()) {
 157
 158             // XXX Force credentials check?
 159
 160             // @fixme this should probably use a unified login form handler
 161             $user = null;
 162             if (Event::handle('StartOAuthLoginCheck', array($this, &$user))) {
 163                 $user = common_check_user($this->nickname, $this->password);
 164             }
 165             Event::handle('EndOAuthLoginCheck', array($this, &$user));
 166
 167             if (empty($user)) {
 168                 // TRANS: Form validation error given when an invalid username and/or password was passed to the OAuth API.
 169                 $this->showForm(_("Invalid nickname / password!"));
 170                 return;
 171             }
 172         } else {
 173             $user = common_current_user();
 174         }
 175
 176         if ($this->arg('allow')) {
 177
 178             // fetch the token
 179             $this->reqToken = $this->store->getTokenByKey($this->oauthTokenParam);
 180
 181             // mark the req token as authorized
 182             try {
 183                 $this->store->authorize_token($this->oauthTokenParam);
 184             } catch (Exception $e) {
 185                 $this->serverError($e->getMessage());
 186             }
 187
 188             // XXX: Make sure we have a oauth_token_association table. The table
 189             // is now in the main schema, but because it is being added with
 190             // a point release, it's unlikely to be there. This code can be
 191             // removed as of 1.0.
 192             $this->ensureOauthTokenAssociationTable();
 193
 194             $tokenAssoc = new Oauth_token_association();
 195
 196             $tokenAssoc->profile_id     = $user->id;
 197             $tokenAssoc->application_id = $this->app->id;
 198             $tokenAssoc->token          = $this->oauthTokenParam;
 199             $tokenAssoc->created        = common_sql_now();
 200
 201             $result = $tokenAssoc->insert();
 202
 203             if (!$result) {
 204                 common_log_db_error($tokenAssoc, 'INSERT', __FILE__);
 205                 $this->serverError(_('Database error inserting oauth_token_association.'));
 206             }
 207
 208             // If we have a callback redirect and provide the token
 209
 210             // Note: A callback specified in the app setup overrides whatever
 211             // is passed in with the request.
 212
 213             if (!empty($this->app->callback_url)) {
 214                 $this->callback = $this->app->callback_url;
 215             }
 216
 217             if (!empty($this->callback)) {
 218                 $targetUrl = $this->getCallback(
 219                     $this->callback,
 220                     array(
 221                         'oauth_token'    => $this->oauthTokenParam,
 222                         'oauth_verifier' => $this->reqToken->verifier // 1.0a
 223                     )
 224                 );
 225
 226                 // Redirect the user to the provided OAuth callback
 227                 common_redirect($targetUrl, 303);
 228             } elseif ($this->app->type == 2) {
 229                 // Strangely, a web application seems to want to do the OOB
 230                 // workflow. Because no callback was specified anywhere.
 231                 common_log(
 232                     LOG_WARNING,
 233                     sprintf(
 234                         "API OAuth - No callback provided for OAuth web client ID %s (%s) "
 235                          . "during authorization step. Falling back to OOB workflow.",
 236                         $this->app->id,
 237                         $this->app->name
 238                     )
 239                 );
 240             }
 241
 242             common_log(
 243                 LOG_INFO,
 244                 sprintf(
 245                     "The request token '%s' for OAuth application %s (%s) has been authorized.",
 246                     $this->oauthTokenParam,
 247                     $this->app->id,
 248                     $this->app->name
 249                 )
 250             );
 251
 252             // Otherwise, inform the user that the rt was authorized
 253             $this->showAuthorized();
 254
 255         } else if ($this->arg('cancel')) {
 256
 257             try {
 258                 $this->store->revoke_token($this->oauthTokenParam, 0);
 259                 $this->showCanceled();
 260             } catch (Exception $e) {
 261                 $this->ServerError($e->getMessage());
 262             }
 263
 264         } else {
 265             // TRANS: Client error given on when invalid data was passed through a form in the OAuth API.
 266             $this->clientError(_('Unexpected form submission.'));
 267         }
 268     }
 269
 270     // XXX Remove this function when we hit 1.0
 271     function ensureOauthTokenAssociationTable()
 272     {
 273         $schema = Schema::get();
 274
 275         $reqTokenCols = array(
 276             new ColumnDef('profile_id', 'integer', null, true, 'PRI'),
 277             new ColumnDef('application_id', 'integer', null, true, 'PRI'),
 278             new ColumnDef('token', 'varchar', 255, true, 'PRI'),
 279             new ColumnDef('created', 'datetime', null, false),
 280             new ColumnDef(
 281                 'modified',
 282                 'timestamp',
 283                 null,
 284                 false,
 285                 null,
 286                 'CURRENT_TIMESTAMP',
 287                 'on update CURRENT_TIMESTAMP'
 288             )
 289         );
 290
 291         $schema->ensureTable('oauth_token_association', $reqTokenCols);
 292     }
 293
 294     function showForm($error=null)
 295     {
 296         $this->error = $error;
 297         $this->showPage();
 298     }
 299
 300     function showScripts()
 301     {
 302         parent::showScripts();
 303         if (!common_logged_in()) {
 304             $this->autofocus('nickname');
 305         }
 306     }
 307
 308     /**
 309      * Title of the page
 310      *
 311      * @return string title of the page
 312      */
 313
 314     function title()
 315     {
 316         // TRANS: Title for a page where a user can confirm/deny account access by an external application.
 317         return _('An application would like to connect to your account');
 318     }
 319
 320     /**
 321      * Shows the authorization form.
 322      *
 323      * @return void
 324      */
 325
 326     function showContent()
 327     {
 328         $this->elementStart('form', array('method' => 'post',
 329                                           'id' => 'form_apioauthauthorize',
 330                                           'class' => 'form_settings',
 331                                           'action' => common_local_url('ApiOauthAuthorize')));
 332         $this->elementStart('fieldset');
 333         $this->element('legend', array('id' => 'apioauthauthorize_allowdeny'),
 334                                  // TRANS: Fieldset legend.
 335                                  _('Allow or deny access'));
 336
 337         $this->hidden('token', common_session_token());
 338         $this->hidden('oauth_token', $this->oauthTokenParam);
 339         $this->hidden('oauth_callback', $this->callback);
 340
 341         $this->elementStart('ul', 'form_data');
 342         $this->elementStart('li');
 343         $this->elementStart('p');
 344         if (!empty($this->app->icon)) {
 345             $this->element('img', array('src' => $this->app->icon));
 346         }
 347
 348         $access = ($this->app->access_type & Oauth_application::$writeAccess) ?
 349           'access and update' : 'access';
 350
 351         // TRANS: User notification of external application requesting account access.
 352         // TRANS: %1$s is the application name requesting access, %2$s is the organisation behind the application,
 353         // TRANS: %3$s is the access type requested, %4$s is the StatusNet sitename.
 354         $msg = _('The application <strong>%1$s</strong> by ' .
 355                  '<strong>%2$s</strong> would like the ability ' .
 356                  'to <strong>%3$s</strong> your %4$s account data. ' .
 357                  'You should only give access to your %4$s account ' .
 358                  'to third parties you trust.');
 359
 360         $this->raw(sprintf($msg,
 361                            $this->app->name,
 362                            $this->app->organization,
 363                            $access,
 364                            common_config('site', 'name')));
 365         $this->elementEnd('p');
 366         $this->elementEnd('li');
 367         $this->elementEnd('ul');
 368
 369         // quickie hack
 370         $button = false;
 371         if (!common_logged_in()) {
 372             if (Event::handle('StartOAuthLoginForm', array($this, &$button))) {
 373                 $this->elementStart('fieldset');
 374                 // TRANS: Fieldset legend.
 375                 $this->element('legend', null, _m('LEGEND','Account'));
 376                 $this->elementStart('ul', 'form_data');
 377                 $this->elementStart('li');
 378                 // TRANS: Field label on OAuth API authorisation form.
 379                 $this->input('nickname', _('Nickname'));
 380                 $this->elementEnd('li');
 381                 $this->elementStart('li');
 382                 // TRANS: Field label on OAuth API authorisation form.
 383                 $this->password('password', _('Password'));
 384                 $this->elementEnd('li');
 385                 $this->elementEnd('ul');
 386
 387                 $this->elementEnd('fieldset');
 388             }
 389             Event::handle('EndOAuthLoginForm', array($this, &$button));
 390         }
 391
 392         $this->element('input', array('id' => 'cancel_submit',
 393                                       'class' => 'submit submit form_action-primary',
 394                                       'name' => 'cancel',
 395                                       'type' => 'submit',
 396                                       // TRANS: Button text that when clicked will cancel the process of allowing access to an account
 397                                       // TRANS: by an external application.
 398                                       'value' => _m('BUTTON','Cancel')));
 399
 400         $this->element('input', array('id' => 'allow_submit',
 401                                       'class' => 'submit submit form_action-secondary',
 402                                       'name' => 'allow',
 403                                       'type' => 'submit',
 404                                       // TRANS: Button text that when clicked will allow access to an account by an external application.
 405                                       'value' => $button ? $button : _m('BUTTON','Allow')));
 406
 407         $this->elementEnd('fieldset');
 408         $this->elementEnd('form');
 409     }
 410
 411     /**
 412      * Instructions for using the form
 413      *
 414      * For "remembered" logins, we make the user re-login when they
 415      * try to change settings. Different instructions for this case.
 416      *
 417      * @return void
 418      */
 419     function getInstructions()
 420     {
 421         // TRANS: Form instructions.
 422         return _('Authorize access to your account information.');
 423     }
 424
 425     /**
 426      * A local menu
 427      *
 428      * Shows different login/register actions.
 429      *
 430      * @return void
 431      */
 432     function showLocalNav()
 433     {
 434         // NOP
 435     }
 436
 437     /**
 438      * Show site notice.
 439      *
 440      * @return nothing
 441      */
 442     function showSiteNotice()
 443     {
 444         // NOP
 445     }
 446
 447     /**
 448      * Show notice form.
 449      *
 450      * Show the form for posting a new notice
 451      *
 452      * @return nothing
 453      */
 454     function showNoticeForm()
 455     {
 456         // NOP
 457     }
 458
 459     /*
 460      * Show a nice message confirming the authorization
 461      * operation was canceled.
 462      *
 463      * @return nothing
 464      */
 465     function showCanceled()
 466     {
 467         $info = new InfoAction(
 468             // TRANS: Header for user notification after revoking OAuth access to an application.
 469             _('Authorization canceled.'),
 470             sprintf(
 471                 // TRANS: User notification after revoking OAuth access to an application.
 472                 // TRANS: %s is an OAuth token.
 473                 _('The request token %s has been revoked.'),
 474                 $this->oauthTokenParm
 475             )
 476         );
 477
 478         $info->showPage();
 479     }
 480
 481     /*
 482      * Show a nice message that the authorization was successful.
 483      * If the operation is out-of-band, show a pin.
 484      *
 485      * @return nothing
 486      */
 487     function showAuthorized()
 488     {
 489         $title = sprintf(
 490            // TRANS: Header of user notification after authorising an application access to a profile.
 491            // TRANS: %s is the authorised application name.
 492             _("You have successfully authorized %s."),
 493             $this->app->name
 494         );
 495
 496         $msg = sprintf(
 497             // TRANS: Uer notification after authorising an application access to a profile.
 498             // TRANS: %s is the authorised application name.
 499             _('Please return to %s and enter the following security code to complete the process.'),
 500             $this->app->name
 501         );
 502
 503         if ($this->reqToken->verified_callback == 'oob') {
 504             $pin = new ApiOauthPinAction($title, $msg, $this->reqToken->verifier);
 505             $pin->showPage();
 506         } else {
 507
 508             // NOTE: This would only happen if an application registered as
 509             // a web application but sent in 'oob' for the oauth_callback
 510             // parameter. Usually web apps will send in a callback and
 511             // not use the pin-based workflow.
 512
 513             $info = new InfoAction(
 514                 $title,
 515                 $msg,
 516                 $this->oauthTokenParam,
 517                 $this->reqToken->verifier
 518             );
 519
 520             $info->showPage();
 521         }
 522     }
 523
 524     /*
 525      * Properly format the callback URL and parameters so it's
 526      * suitable for a redirect in the OAuth dance
 527      *
 528      * @param string $url       the URL
 529      * @param array  $params    an array of parameters
 530      *
 531      * @return string $url  a URL to use for redirecting to
 532      */
 533     function getCallback($url, $params)
 534     {
 535         foreach ($params as $k => $v) {
 536             $url = $this->appendQueryVar(
 537                 $url,
 538                 OAuthUtil::urlencode_rfc3986($k),
 539                 OAuthUtil::urlencode_rfc3986($v)
 540             );
 541         }
 542
 543         return $url;
 544     }
 545
 546     /*
 547      * Append a new query parameter after any existing query
 548      * parameters.
 549      *
 550      * @param string $url   the URL
 551      * @prarm string $k     the parameter name
 552      * @param string $v     value of the paramter
 553      *
 554      * @return string $url  the new URL with added parameter
 555      */
 556     function appendQueryVar($url, $k, $v) {
 557         $url = preg_replace('/(.*)(\?|&)' . $k . '=[^&]+?(&)(.*)/i', '$1$2$4', $url . '&');
 558         $url = substr($url, 0, -1);
 559         if (strpos($url, '?') === false) {
 560             return ($url . '?' . $k . '=' . $v);
 561         } else {
 562             return ($url . '&' . $k . '=' . $v);
 563         }
 564     }
 565 }