actions/otp.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Allow one-time password login
   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  Login
  23  * @package   StatusNet
  24  * @author    Evan Prodromou <evan@status.net>
  25  * @copyright 2010 StatusNet, Inc.
  26  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  27  * @link      http://status.net/
  28  */
  29
  30 if (!defined('STATUSNET')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Allow one-time password login
  36  *
  37  * This action will automatically log in the user identified by the user_id
  38  * parameter. A login_token record must be constructed beforehand, typically
  39  * by code where the user is already authenticated.
  40  *
  41  * @category  Login
  42  * @package   StatusNet
  43  * @author    Evan Prodromou <evan@status.net>
  44  * @copyright 2010 StatusNet, Inc.
  45  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html AGPLv3
  46  * @link      http://status.net/
  47  */
  48 class OtpAction extends Action
  49 {
  50     var $user;
  51     var $token;
  52     var $rememberme;
  53     var $returnto;
  54     var $lt;
  55
  56     function prepare($args)
  57     {
  58         parent::prepare($args);
  59
  60         if (common_is_real_login()) {
  61             // TRANS: Client error displayed trying to use "one time password login" when already logged in.
  62             $this->clientError(_('Already logged in.'));
  63             return false;
  64         }
  65
  66         $id = $this->trimmed('user_id');
  67
  68         if (empty($id)) {
  69             // TRANS: Client error displayed trying to use "one time password login" without specifying a user.
  70             $this->clientError(_('No user ID specified.'));
  71             return false;
  72         }
  73
  74         $this->user = User::staticGet('id', $id);
  75
  76         if (empty($this->user)) {
  77             // TRANS: Client error displayed trying to use "one time password login" without using an existing user.
  78             $this->clientError(_('No such user.'));
  79             return false;
  80         }
  81
  82         $this->token = $this->trimmed('token');
  83
  84         if (empty($this->token)) {
  85             // TRANS: Client error displayed trying to use "one time password login" without specifying a login token.
  86             $this->clientError(_('No login token specified.'));
  87             return false;
  88         }
  89
  90         $this->lt = Login_token::staticGet('user_id', $id);
  91
  92         if (empty($this->lt)) {
  93             // TRANS: Client error displayed trying to use "one time password login" without requesting a login token.
  94             $this->clientError(_('No login token requested.'));
  95             return false;
  96         }
  97
  98         if ($this->lt->token != $this->token) {
  99             // TRANS: Client error displayed trying to use "one time password login" while specifying an invalid login token.
 100             $this->clientError(_('Invalid login token specified.'));
 101             return false;
 102         }
 103
 104         if ($this->lt->modified > time() + Login_token::TIMEOUT) {
 105             //token has expired
 106             //delete the token as it is useless
 107             $this->lt->delete();
 108             $this->lt = null;
 109             // TRANS: Client error displayed trying to use "one time password login" while specifying an expired login token.
 110             $this->clientError(_('Login token expired.'));
 111             return false;
 112         }
 113
 114         $this->rememberme = $this->boolean('rememberme');
 115         $this->returnto = $this->trimmed('returnto');
 116
 117         return true;
 118     }
 119
 120     function handle($args)
 121     {
 122         parent::handle($args);
 123
 124         // success!
 125         if (!common_set_user($this->user)) {
 126             // TRANS: Server error displayed when a user object could not be created trying to login using "one time password login".
 127             $this->serverError(_('Error setting user. You are probably not authorized.'));
 128             return;
 129         }
 130
 131         // We're now logged in; disable the lt
 132
 133         $this->lt->delete();
 134         $this->lt = null;
 135
 136         common_real_login(true);
 137
 138         if ($this->rememberme) {
 139             common_rememberme($this->user);
 140         }
 141
 142         if (!empty($this->returnto)) {
 143             $url = $this->returnto;
 144             // We don't have to return to it again
 145             common_set_returnto(null);
 146         } else {
 147             $url = common_local_url('all',
 148                                     array('nickname' =>
 149                                           $this->user->nickname));
 150         }
 151
 152         common_redirect($url, 303);
 153     }
 154 }