plugins/Authentication/AuthenticationPlugin.php

   1 <?php
   2 /**
   3  * StatusNet, the distributed open-source microblogging tool
   4  *
   5  * Superclass for plugins that do authentication and/or authorization
   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  Plugin
  23  * @package   StatusNet
  24  * @author    Craig Andrews <candrews@integralblue.com>
  25  * @license   http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  26  * @link      http://status.net/
  27  */
  28
  29 if (!defined('STATUSNET') && !defined('LACONICA')) {
  30     exit(1);
  31 }
  32
  33 /**
  34  * Superclass for plugins that do authentication
  35  *
  36  * @category Plugin
  37  * @package  StatusNet
  38  * @author   Craig Andrews <candrews@integralblue.com>
  39  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  40  * @link     http://status.net/
  41  */
  42
  43 abstract class AuthenticationPlugin extends Plugin
  44 {
  45     //is this plugin authoritative for authentication?
  46     public $authoritative = false;
  47
  48     //should accounts be automatically created after a successful login attempt?
  49     public $autoregistration = false;
  50
  51     //can the user change their email address
  52     public $password_changeable=true;
  53
  54     //unique name for this authentication provider
  55     public $provider_name;
  56
  57     //------------Auth plugin should implement some (or all) of these methods------------\\
  58     /**
  59     * Check if a nickname/password combination is valid
  60     * @param username
  61     * @param password
  62     * @return boolean true if the credentials are valid, false if they are invalid.
  63     */
  64     function checkPassword($username, $password)
  65     {
  66         return false;
  67     }
  68
  69     /**
  70     * Automatically register a user when they attempt to login with valid credentials.
  71     * User::register($data) is a very useful method for this implementation
  72     * @param username
  73     * @return mixed instance of User, or false (if user couldn't be created)
  74     */
  75     function autoRegister($username)
  76     {
  77         $registration_data = array();
  78         $registration_data['nickname'] = $username ;
  79         return User::register($registration_data);
  80     }
  81
  82     /**
  83     * Change a user's password
  84     * The old password has been verified to be valid by this plugin before this call is made
  85     * @param username
  86     * @param oldpassword
  87     * @param newpassword
  88     * @return boolean true if the password was changed, false if password changing failed for some reason
  89     */
  90     function changePassword($username,$oldpassword,$newpassword)
  91     {
  92         return false;
  93     }
  94
  95     //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
  96     function onInitializePlugin(){
  97         if(!isset($this->provider_name)){
  98             throw new Exception("must specify a provider_name for this authentication provider");
  99         }
 100     }
 101
 102     function onStartCheckPassword($nickname, $password, &$authenticatedUser){
 103         //map the nickname to a username
 104         $user_username = new User_username();
 105         $user_username->username=$nickname;
 106         $user_username->provider_name=$this->provider_name;
 107         if($user_username->find() && $user_username->fetch()){
 108             $username = $user_username->username;
 109             $authenticated = $this->checkPassword($username, $password);
 110             if($authenticated){
 111                 $authenticatedUser = User::staticGet('id', $user_username->user_id);
 112                 return false;
 113             }
 114         }else{
 115             $user = User::staticGet('nickname', $nickname);
 116             if($user){
 117                 //make sure a different provider isn't handling this nickname
 118                 $user_username = new User_username();
 119                 $user_username->username=$nickname;
 120                 if(!$user_username->find()){
 121                     //no other provider claims this username, so it's safe for us to handle it
 122                     $authenticated = $this->checkPassword($nickname, $password);
 123                     if($authenticated){
 124                         $authenticatedUser = User::staticGet('nickname', $nickname);
 125                         User_username::register($authenticatedUser,$nickname,$this->provider_name);
 126                         return false;
 127                     }
 128                 }
 129             }else{
 130                 if($this->autoregistration){
 131                     $authenticated = $this->checkPassword($nickname, $password);
 132                     if($authenticated){
 133                         $user = $this->autoregister($nickname);
 134                         if($user){
 135                             $authenticatedUser = $user;
 136                             User_username::register($authenticatedUser,$nickname,$this->provider_name);
 137                             return false;
 138                         }
 139                     }
 140                 }
 141             }
 142         }
 143         if($this->authoritative){
 144             return false;
 145         }else{
 146             //we're not authoritative, so let other handlers try
 147             return;
 148         }
 149     }
 150
 151     function onStartChangePassword($user,$oldpassword,$newpassword)
 152     {
 153         if($this->password_changeable){
 154             $user_username = new User_username();
 155             $user_username->user_id=$user->id;
 156             $user_username->provider_name=$this->provider_name;
 157             if($user_username->find() && $user_username->fetch()){
 158                 $authenticated = $this->checkPassword($user_username->username, $oldpassword);
 159                 if($authenticated){
 160                     $result = $this->changePassword($user_username->username,$oldpassword,$newpassword);
 161                     if($result){
 162                         //stop handling of other handlers, because what was requested was done
 163                         return false;
 164                     }else{
 165                         throw new Exception(_('Password changing failed'));
 166                     }
 167                 }else{
 168                     if($this->authoritative){
 169                         //since we're authoritative, no other plugin could do this
 170                         throw new Exception(_('Password changing failed'));
 171                     }else{
 172                         //let another handler try
 173                         return null;
 174                     }
 175                 }
 176             }
 177         }else{
 178             if($this->authoritative){
 179                 //since we're authoritative, no other plugin could do this
 180                 throw new Exception(_('Password changing is not allowed'));
 181             }
 182         }
 183     }
 184
 185     function onStartAccountSettingsPasswordMenuItem($widget)
 186     {
 187         if($this->authoritative && !$this->password_changeable){
 188             //since we're authoritative, no other plugin could change passwords, so do not render the menu item
 189             return false;
 190         }
 191     }
 192
 193     function onAutoload($cls)
 194     {
 195         switch ($cls)
 196         {
 197          case 'User_username':
 198             require_once(INSTALLDIR.'/plugins/Authentication/User_username.php');
 199             return false;
 200          default:
 201             return true;
 202         }
 203     }
 204
 205     function onCheckSchema() {
 206         $schema = Schema::get();
 207         $schema->ensureTable('user_username',
 208                              array(new ColumnDef('provider_name', 'varchar',
 209                                                  '255', false, 'PRI'),
 210                                    new ColumnDef('username', 'varchar',
 211                                                  '255', false, 'PRI'),
 212                                    new ColumnDef('user_id', 'integer',
 213                                                  null, false),
 214                                    new ColumnDef('created', 'datetime',
 215                                                  null, false),
 216                                    new ColumnDef('modified', 'timestamp')));
 217         return true;
 218     }
 219
 220     function onUserDeleteRelated($user, &$tables)
 221     {
 222         $tables[] = 'User_username';
 223         return true;
 224     }
 225 }
 226