lib/apioauthstore.php

   1 <?php
   2 /*
   3  * StatusNet - the distributed open-source microblogging tool
   4  * Copyright (C) 2008, 2009, StatusNet, Inc.
   5  *
   6  * This program is free software: you can redistribute it and/or modify
   7  * it under the terms of the GNU Affero General Public License as published by
   8  * the Free Software Foundation, either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * This program is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU Affero General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU Affero General Public License
  17  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  18  */
  19
  20 if (!defined('STATUSNET') && !defined('LACONICA')) { exit(1); }
  21
  22 require_once INSTALLDIR . '/lib/oauthstore.php';
  23
  24 class ApiStatusNetOAuthDataStore extends StatusNetOAuthDataStore
  25 {
  26     function lookup_consumer($consumerKey)
  27     {
  28         $con = Consumer::staticGet('consumer_key', $consumerKey);
  29
  30         if (!$con) {
  31
  32             // Create an anon consumer and anon application if one
  33             // doesn't exist already
  34             if ($consumerKey == 'anonymous') {
  35
  36                 common_debug("API OAuth - creating anonymous consumer");
  37                 $con = new Consumer();
  38                 $con->consumer_key    = $consumerKey;
  39                 $con->consumer_secret = $consumerKey;
  40                 $con->created         = common_sql_now();
  41
  42                 $result = $con->insert();
  43                 if (!$result) {
  44                     // TRANS: Server error displayed when trying to create an anynymous OAuth consumer.
  45                     $this->serverError(_('Could not create anonymous consumer.'));
  46                 }
  47
  48                 $app = Oauth_application::getByConsumerKey('anonymous');
  49
  50                 if (!$app) {
  51                     common_debug("API OAuth - creating anonymous application");
  52                     $app               = new OAuth_application();
  53                     $app->owner        = 1; // XXX: What to do here?
  54                     $app->consumer_key = $con->consumer_key;
  55                     $app->name         = 'anonymous';
  56                     $app->icon         = 'default-avatar-stream.png'; // XXX: Fix this!
  57                     $app->description  = "An anonymous application";
  58                     // XXX: allow the user to set the access type when
  59                     // authorizing? Currently we default to r+w for anonymous
  60                     // OAuth client applications
  61                     $app->access_type  = 3; // read + write
  62                     $app->type         = 2; // desktop
  63                     $app->created      = common_sql_now();
  64
  65                     $id = $app->insert();
  66
  67                     if (!$id) {
  68                         // TRANS: Server error displayed when trying to create an anynymous OAuth application.
  69                         $this->serverError(_("Could not create anonymous OAuth application."));
  70                     }
  71                 }
  72             } else {
  73                 return null;
  74             }
  75         }
  76
  77         return new OAuthConsumer(
  78             $con->consumer_key,
  79             $con->consumer_secret
  80         );
  81     }
  82
  83     function getAppByRequestToken($token_key)
  84     {
  85         // Look up the full req token
  86         $req_token = $this->lookup_token(
  87             null,
  88             'request',
  89             $token_key
  90         );
  91
  92         if (empty($req_token)) {
  93             common_debug("couldn't get request token from oauth datastore");
  94             return null;
  95         }
  96
  97         // Look up the full Token
  98         $token = new Token();
  99         $token->tok = $req_token->key;
 100         $result = $token->find(true);
 101
 102         if (empty($result)) {
 103             common_debug('Couldn\'t find req token in the token table.');
 104             return null;
 105         }
 106
 107         // Look up the app
 108         $app = new Oauth_application();
 109         $app->consumer_key = $token->consumer_key;
 110         $result = $app->find(true);
 111
 112         if (!empty($result)) {
 113             return $app;
 114         } else {
 115             common_debug("Couldn't find the app!");
 116             return null;
 117         }
 118     }
 119
 120     function new_access_token($token, $consumer, $verifier)
 121     {
 122         common_debug(
 123             sprintf(
 124                 "New access token from request token %s, consumer %s and verifier %s ",
 125                 $token,
 126                 $consumer,
 127                 $verifier
 128             ),
 129             __FILE__
 130         );
 131
 132         $rt = new Token();
 133
 134         $rt->consumer_key = $consumer->key;
 135         $rt->tok          = $token->key;
 136         $rt->type         = 0; // request
 137
 138         $app = Oauth_application::getByConsumerKey($consumer->key);
 139         assert(!empty($app));
 140
 141         if ($rt->find(true) && $rt->state == 1 && $rt->verifier == $verifier) { // authorized
 142
 143             common_debug('Request token found.', __FILE__);
 144
 145             // find the app and profile associated with this token
 146
 147             $tokenAssoc = OAuth_token_association::staticGet('token', $rt->tok);
 148
 149             if (!$tokenAssoc) {
 150                 throw new Exception(
 151                     // TRANS: Exception thrown when no token association could be found.
 152                     _('Could not find a profile and application associated with the request token.')
 153                 );
 154             }
 155
 156             // check to see if we have previously issued an access token for this application
 157             // and profile
 158
 159             $appUser = new Oauth_application_user();
 160
 161             $appUser->application_id = $app->id;
 162             $appUser->profile_id     = $tokenAssoc->profile_id;
 163
 164             $result = $appUser->find(true);
 165
 166             if (!empty($result)) {
 167
 168                 common_log(LOG_INFO,
 169                      sprintf(
 170                         "Existing access token found for application %s, profile %s.",
 171                         $app->id,
 172                         $tokenAssoc->profile_id
 173                      )
 174                 );
 175
 176                 $at = new Token();
 177
 178                 // fetch the full access token
 179                 $at->consumer_key = $consumer->key;
 180                 $at->tok          = $appUser->token;
 181
 182                 $result = $at->find(true);
 183
 184                 if (!$result) {
 185                     throw new Exception(
 186                         // TRANS: Exception thrown when no access token can be issued.
 187                         _('Could not issue access token.')
 188                     );
 189                 }
 190
 191                 // Yay, we can re-issue the access token
 192                 return new OAuthToken($at->tok, $at->secret);
 193
 194             } else {
 195
 196                common_log(LOG_INFO,
 197                     sprintf(
 198                         "Creating new access token for application %s, profile %s.",
 199                         $app->id,
 200                         $tokenAssoc->profile_id
 201                      )
 202                 );
 203
 204                 // make a brand new access token
 205                 $at = new Token();
 206
 207                 $at->consumer_key      = $consumer->key;
 208                 $at->tok               = common_good_rand(16);
 209                 $at->secret            = common_good_rand(16);
 210                 $at->type              = 1; // access
 211                 $at->verifier          = $verifier;
 212                 $at->verified_callback = $rt->verified_callback; // 1.0a
 213                 $at->created           = common_sql_now();
 214
 215                 if (!$at->insert()) {
 216                     $e = $at->_lastError;
 217                     common_debug('access token "' . $at->tok . '" not inserted: "' . $e->message . '"', __FILE__);
 218                     return null;
 219                 } else {
 220                     common_debug('access token "' . $at->tok . '" inserted', __FILE__);
 221                     // burn the old one
 222                     $orig_rt   = clone($rt);
 223                     $rt->state = 2; // used
 224                     if (!$rt->update($orig_rt)) {
 225                         return null;
 226                     }
 227                     common_debug('request token "' . $rt->tok . '" updated', __FILE__);
 228                 }
 229
 230                 // insert a new Oauth_application_user record w/access token
 231                 $appUser = new Oauth_application_user();
 232
 233                 $appUser->profile_id     = $tokenAssoc->profile_id;;
 234                 $appUser->application_id = $app->id;
 235                 $appUser->access_type    = $app->access_type;
 236                 $appUser->token          = $at->tok;
 237                 $appUser->created        = common_sql_now();
 238
 239                 $result = $appUser->insert();
 240
 241                 if (!$result) {
 242                     common_log_db_error($appUser, 'INSERT', __FILE__);
 243                     // TRANS: Server error displayed when a database error occurs.
 244                     $this->serverError(_('Database error inserting OAuth application user.'));
 245                 }
 246
 247                 // Okay, good
 248                 return new OAuthToken($at->tok, $at->secret);
 249             }
 250
 251         } else {
 252
 253             // the token was not authorized or not verfied
 254             common_log(
 255                 LOG_INFO,
 256                 sprintf(
 257                     "API OAuth - Attempt to exchange unauthorized or unverified request token %s for an access token.",
 258                      $rt->tok
 259                 )
 260             );
 261             return null;
 262         }
 263     }
 264
 265     /**
 266      * Revoke specified access token
 267      *
 268      * Revokes the token specified by $token_key.
 269      * Throws exceptions in case of error.
 270      *
 271      * @param string $token_key the token to be revoked
 272      * @param int    $type      type of token (0 = req, 1 = access)
 273      *
 274      * @access public
 275      *
 276      * @return void
 277      */
 278     public function revoke_token($token_key, $type = 0) {
 279         $rt        = new Token();
 280         $rt->tok   = $token_key;
 281         $rt->type  = $type;
 282         $rt->state = 0;
 283
 284         if (!$rt->find(true)) {
 285             // TRANS: Exception thrown when an attempt is made to revoke an unknown token.
 286             throw new Exception(_('Tried to revoke unknown token.'));
 287         }
 288
 289         if (!$rt->delete()) {
 290             // TRANS: Exception thrown when an attempt is made to remove a revoked token.
 291             throw new Exception(_('Failed to delete revoked token.'));
 292         }
 293     }
 294
 295     /*
 296      * Create a new request token. Overrided to support OAuth 1.0a callback
 297      *
 298      * @param OAuthConsumer $consumer the OAuth Consumer for this token
 299      * @param string        $callback the verified OAuth callback URL
 300      *
 301      * @return OAuthToken   $token a new unauthorized OAuth request token
 302      */
 303     function new_request_token($consumer, $callback)
 304     {
 305         $t = new Token();
 306         $t->consumer_key = $consumer->key;
 307         $t->tok = common_good_rand(16);
 308         $t->secret = common_good_rand(16);
 309         $t->type = 0; // request
 310         $t->state = 0; // unauthorized
 311         $t->verified_callback = $callback;
 312
 313         if ($callback === 'oob') {
 314             // six digit pin
 315             $t->verifier = mt_rand(0, 9999999);
 316         } else {
 317             $t->verifier = common_good_rand(8);
 318         }
 319
 320         $t->created = DB_DataObject_Cast::dateTime();
 321         if (!$t->insert()) {
 322             return null;
 323         } else {
 324             return new OAuthToken($t->tok, $t->secret);
 325         }
 326     }
 327 }