apioauthrequesttoken.php 4.66 KB
Newer Older
1 2 3 4
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
5
 * Issue temporary OAuth credentials (a request token)
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
 *
 * 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    Zach Copley <zach@status.net>
 * @copyright 2010 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);
}

/**
35
 * Issue temporary OAuth credentials (a request token)
36 37 38 39 40 41 42
 *
 * @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/
 */
mmn's avatar
mmn committed
43
class ApiOAuthRequestTokenAction extends ApiOAuthAction
44
{
45
    /**
Zach Copley's avatar
Zach Copley committed
46 47 48 49 50
     * Take arguments for running
     *
     * @param array $args $_REQUEST args
     *
     * @return boolean success flag
51
     */
Zach Copley's avatar
Zach Copley committed
52
    function prepare($args)
53
    {
Zach Copley's avatar
Zach Copley committed
54 55
        parent::prepare($args);

56 57
        // XXX: support "force_login" parameter like Twitter? (Forces the user to enter
        // their credentials to ensure the correct users account is authorized.)
Zach Copley's avatar
Zach Copley committed
58 59

        return true;
60 61 62
    }

    /**
63 64 65 66
     * Handle a request for temporary OAuth credentials
     *
     * Make sure the request is kosher, then emit a set of temporary
     * credentials -- AKA an unauthorized request token.
67 68 69 70 71 72 73 74 75
     *
     * @param array $args array of arguments
     *
     * @return void
     */
    function handle($args)
    {
        parent::handle($args);

mmn's avatar
mmn committed
76
        $datastore   = new ApiGNUsocialOAuthDataStore();
77 78
        $server      = new OAuthServer($datastore);
        $hmac_method = new OAuthSignatureMethod_HMAC_SHA1();
79

80 81 82
        $server->add_signature_method($hmac_method);

        try {
83

84
            $req = OAuthRequest::from_request();
85 86 87 88 89 90 91 92 93 94

            // verify callback
            if (!$this->verifyCallback($req->get_parameter('oauth_callback'))) {
                throw new OAuthException(
                    "You must provide a valid URL or 'oob' in oauth_callback.",
                    400
                );
            }

            // check signature and issue a new request token
95
            $token = $server->fetch_request_token($req);
96

97 98 99 100 101 102 103 104 105 106
            common_log(
                LOG_INFO,
                sprintf(
                    "API OAuth - Issued request token %s for consumer %s with oauth_callback %s",
                    $token->key,
                    $req->get_parameter('oauth_consumer_key'),
                    "'" . $req->get_parameter('oauth_callback') ."'"
                )
            );

107 108 109
            // return token to the client
            $this->showRequestToken($token);

110
        } catch (OAuthException $e) {
Zach Copley's avatar
Zach Copley committed
111
            common_log(LOG_WARNING, 'API OAuthException - ' . $e->getMessage());
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

            // Return 401 for for bad credentials or signature problems,
            // and 400 for missing or unsupported parameters

            $code = $e->getCode();
            $this->clientError($e->getMessage(), empty($code) ? 401 : $code, 'text');
        }
    }

    /*
     * Display temporary OAuth credentials
     */
    function showRequestToken($token)
    {
        header('Content-Type: application/x-www-form-urlencoded');
        print $token;
        print '&oauth_callback_confirmed=true';
    }

    /* Make sure the callback parameter contains either a real URL
     * or the string 'oob'.
     *
     * @todo Check for evil/banned URLs here
     *
     * @return boolean true or false
     */
    function verifyCallback($callback)
    {
        if ($callback == "oob") {
Zach Copley's avatar
Zach Copley committed
141
            common_debug("OAuth request token requested for out of band client.");
142 143 144 145 146

            // XXX: Should we throw an error if a client is registered as a
            // web application but requests the pin based workflow? For now I'm
            // allowing the workflow to proceed and issuing a pin. --Zach

147 148
            return true;
        } else {
149
            return filter_var($callback, FILTER_VALIDATE_URL);
150 151
        }
    }
152
}