actions/apioauthaccesstoken.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Action for getting OAuth token credentials (exchange an authorized
   6  * request token for an access token)
   7  *
   8  * PHP version 5
   9  *
  10  * LICENCE: This program is free software: you can redistribute it and/or modify
  11  * it under the terms of the GNU Affero General Public License as published by
  12  * the Free Software Foundation, either version 3 of the License, or
  13  * (at your option) any later version.
  14  *
  15  * This program is distributed in the hope that it will be useful,
  16  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  17  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  18  * GNU Affero General Public License for more details.
  19  *
  20  * You should have received a copy of the GNU Affero General Public License
  21  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  22  *
  23  * @category  API
  24  * @package   StatusNet
  25  * @author    Zach Copley <zach@status.net>
  26  * @copyright 2010 StatusNet, Inc.
  27  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  28  * @link      http://status.net/
  29  */
  30
  31 if (!defined('STATUSNET')) {
  32     exit(1);
  33 }
  34
  35 require_once INSTALLDIR . '/lib/apioauth.php';
  36
  37 /**
  38  * Action for getting OAuth token credentials (exchange an authorized
  39  * request token for an access token)
  40  *
  41  * @category API
  42  * @package  StatusNet
  43  * @author   Zach Copley <zach@status.net>
  44  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  45  * @link     http://status.net/
  46  */
  47 class ApiOauthAccessTokenAction extends ApiOauthAction
  48 {
  49     protected $reqToken = null;
  50     protected $verifier = null;
  51
  52     /**
  53      * Class handler.
  54      *
  55      * @param array $args array of arguments
  56      *
  57      * @return void
  58      */
  59     function handle($args)
  60     {
  61         parent::handle($args);
  62
  63         $datastore   = new ApiStatusNetOAuthDataStore();
  64         $server      = new OAuthServer($datastore);
  65         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
  66
  67         $server->add_signature_method($hmac_method);
  68
  69         $atok = $app = null;
  70
  71         // XXX: Insist that oauth_token and oauth_verifier be populated?
  72         // Spec doesn't say they MUST be.
  73
  74         try {
  75             $req  = OAuthRequest::from_request();
  76
  77             $this->reqToken = $req->get_parameter('oauth_token');
  78             $this->verifier = $req->get_parameter('oauth_verifier');
  79
  80             $app  = $datastore->getAppByRequestToken($this->reqToken);
  81             $atok = $server->fetch_access_token($req);
  82
  83         } catch (Exception $e) {
  84             common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
  85             common_debug(var_export($req, true));
  86             $code = $e->getCode();
  87             $this->clientError($e->getMessage(), empty($code) ? 401 : $code, 'text');
  88         }
  89
  90         if (empty($atok)) {
  91
  92             // Token exchange failed -- log it
  93
  94             $msg = sprintf(
  95                 'API OAuth - Failure exchanging OAuth request token for access token, '
  96                     . 'request token = %s, verifier = %s',
  97                 $this->reqToken,
  98                 $this->verifier
  99             );
 100
 101             common_log(LOG_WARNING, $msg);
 102             // TRANS: Client error given from the OAuth API when the request token or verifier is invalid.
 103             $this->clientError(_("Invalid request token or verifier.", 400, 'text'));
 104
 105         } else {
 106             common_log(
 107                 LOG_INFO,
 108                 sprintf(
 109                     "Issued access token '%s' for application %d (%s).",
 110                     $atok->key,
 111                     $app->id,
 112                     $app->name
 113                 )
 114             );
 115             $this->showAccessToken($atok);
 116         }
 117     }
 118
 119     /*
 120      * Display OAuth token credentials
 121      *
 122      * @param OAuthToken token the access token
 123      */
 124
 125     function showAccessToken($token)
 126     {
 127         header('Content-Type: application/x-www-form-urlencoded');
 128         print $token;
 129     }
 130 }