actions/apioauthrequesttoken.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Issue temporary OAuth credentials (a 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
  36 /**
  37  * Issue temporary OAuth credentials (a request token)
  38  *
  39  * @category API
  40  * @package  StatusNet
  41  * @author   Zach Copley <zach@status.net>
  42  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  43  * @link     http://status.net/
  44  */
  45
  46 class ApiOauthRequestTokenAction extends ApiOauthAction
  47 {
  48     /**
  49      * Take arguments for running
  50      *
  51      * @param array $args $_REQUEST args
  52      *
  53      * @return boolean success flag
  54      *
  55      */
  56
  57     function prepare($args)
  58     {
  59         parent::prepare($args);
  60
  61         // XXX: support "force_login" parameter like Twitter? (Forces the user to enter
  62         // their credentials to ensure the correct users account is authorized.)
  63
  64         return true;
  65     }
  66
  67     /**
  68      * Handle a request for temporary OAuth credentials
  69      *
  70      * Make sure the request is kosher, then emit a set of temporary
  71      * credentials -- AKA an unauthorized request token.
  72      *
  73      * @param array $args array of arguments
  74      *
  75      * @return void
  76      */
  77
  78     function handle($args)
  79     {
  80         parent::handle($args);
  81
  82         $datastore   = new ApiStatusNetOAuthDataStore();
  83         $server      = new OAuthServer($datastore);
  84         $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
  85
  86         $server->add_signature_method($hmac_method);
  87
  88         try {
  89
  90             $req = OAuthRequest::from_request();
  91
  92             // verify callback
  93             if (!$this->verifyCallback($req->get_parameter('oauth_callback'))) {
  94                 throw new OAuthException(
  95                     "You must provide a valid URL or 'oob' in oauth_callback.",
  96                     400
  97                 );
  98             }
  99
 100             // check signature and issue a new request token
 101             $token = $server->fetch_request_token($req);
 102
 103             common_log(
 104                 LOG_INFO,
 105                 sprintf(
 106                     "API OAuth - Issued request token %s for consumer %s with oauth_callback %s",
 107                     $token->key,
 108                     $req->get_parameter('oauth_consumer_key'),
 109                     "'" . $req->get_parameter('oauth_callback') ."'"
 110                 )
 111             );
 112
 113             // return token to the client
 114             $this->showRequestToken($token);
 115
 116         } catch (OAuthException $e) {
 117             common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
 118
 119             // Return 401 for for bad credentials or signature problems,
 120             // and 400 for missing or unsupported parameters
 121
 122             $code = $e->getCode();
 123             $this->clientError($e->getMessage(), empty($code) ? 401 : $code, 'text');
 124         }
 125     }
 126
 127     /*
 128      * Display temporary OAuth credentials
 129      */
 130
 131     function showRequestToken($token)
 132     {
 133         header('Content-Type: application/x-www-form-urlencoded');
 134         print $token;
 135         print '&oauth_callback_confirmed=true';
 136     }
 137
 138     /* Make sure the callback parameter contains either a real URL
 139      * or the string 'oob'.
 140      *
 141      * @todo Check for evil/banned URLs here
 142      *
 143      * @return boolean true or false
 144      */
 145
 146     function verifyCallback($callback)
 147     {
 148         if ($callback == "oob") {
 149             common_debug("OAuth request token requested for out of bounds client.");
 150
 151             // XXX: Should we throw an error if a client is registered as a
 152             // web application but requests the pin based workflow? For now I'm
 153             // allowing the workflow to proceed and issuing a pin. --Zach
 154
 155             return true;
 156         } else {
 157             return Validate::uri(
 158                 $callback,
 159                 array('allowed_schemes' => array('http', 'https'))
 160             );
 161         }
 162     }
 163
 164 }