lib/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  * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
  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') && !defined('LACONICA')) {
  31     exit(1);
  32 }
  33
  34 /**
  35  * Superclass for plugins that do authentication
  36  *
  37  * @category Plugin
  38  * @package  StatusNet
  39  * @author   Craig Andrews <candrews@integralblue.com>
  40  * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
  41  * @link     http://status.net/
  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 username (that is used to login and find the user in the authentication provider) of the user to be registered
  73     * @param nickname nickname of the user in the SN system. If nickname is null, then set nickname = username
  74     * @return mixed instance of User, or false (if user couldn't be created)
  75     */
  76     function autoRegister($username, $nickname = null)
  77     {
  78         if(is_null($nickname)){
  79             $nickname = $username;
  80         }
  81         $registration_data = array();
  82         $registration_data['nickname'] = $nickname;
  83         return User::register($registration_data);
  84     }
  85
  86     /**
  87     * Change a user's password
  88     * The old password has been verified to be valid by this plugin before this call is made
  89     * @param username
  90     * @param oldpassword
  91     * @param newpassword
  92     * @return boolean true if the password was changed, false if password changing failed for some reason
  93     */
  94     function changePassword($username,$oldpassword,$newpassword)
  95     {
  96         return false;
  97     }
  98
  99     /**
 100     * Given a username, suggest what the nickname should be
 101     * Used during autoregistration
 102     * Useful if your usernames are ugly, and you want to suggest
 103     * nice looking nicknames when users initially sign on
 104     * All nicknames returned by this function should be valid
 105     *  implementations may want to use common_nicknamize() to ensure validity
 106     * @param username
 107     * @return string nickname
 108     */
 109     function suggestNicknameForUsername($username)
 110     {
 111         return common_nicknamize($username);
 112     }
 113
 114     //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
 115     function onInitializePlugin(){
 116         if(!isset($this->provider_name)){
 117             throw new Exception("must specify a provider_name for this authentication provider");
 118         }
 119     }
 120
 121     /**
 122     * Internal AutoRegister event handler
 123     * @param nickname
 124     * @param provider_name
 125     * @param user - the newly registered user
 126     */
 127     function onAutoRegister($nickname, $provider_name, &$user)
 128     {
 129         if($provider_name == $this->provider_name && $this->autoregistration){
 130             $suggested_nickname = $this->suggestNicknameForUsername($nickname);
 131             $test_user = User::getKV('nickname', $suggested_nickname);
 132             if($test_user) {
 133                 //someone already exists with the suggested nickname, so used the passed nickname
 134                 $suggested_nickname = common_nicknamize($nickname);
 135             }
 136             $test_user = User::getKV('nickname', $suggested_nickname);
 137             if($test_user) {
 138                 //someone already exists with the suggested nickname
 139                 //not much else we can do
 140             }else{
 141                 $user = $this->autoRegister($nickname, $suggested_nickname);
 142                 if($user){
 143                     User_username::register($user,$nickname,$this->provider_name);
 144                     return false;
 145                 }
 146             }
 147         }
 148     }
 149
 150     function onStartCheckPassword($nickname, $password, &$authenticatedUser){
 151         //map the nickname to a username
 152         $user_username = new User_username();
 153         $user_username->username=$nickname;
 154         $user_username->provider_name=$this->provider_name;
 155         if($user_username->find() && $user_username->fetch()){
 156             $authenticated = $this->checkPassword($user_username->username, $password);
 157             if($authenticated){
 158                 $authenticatedUser = User::getKV('id', $user_username->user_id);
 159                 return false;
 160             }
 161         }else{
 162             //$nickname is the username used to login
 163             //$suggested_nickname is the nickname the auth provider suggests for that username
 164             $suggested_nickname = $this->suggestNicknameForUsername($nickname);
 165             $user = User::getKV('nickname', $suggested_nickname);
 166             if($user){
 167                 //make sure this user isn't claimed
 168                 $user_username = new User_username();
 169                 $user_username->user_id=$user->id;
 170                 $we_can_handle = false;
 171                 if($user_username->find()){
 172                     //either this provider, or another one, has already claimed this user
 173                     //so we cannot. Let another plugin try.
 174                     return;
 175                 }else{
 176                     //no other provider claims this user, so it's safe for us to handle it
 177                     $authenticated = $this->checkPassword($nickname, $password);
 178                     if($authenticated){
 179                         $authenticatedUser = $user;
 180                         User_username::register($authenticatedUser,$nickname,$this->provider_name);
 181                         return false;
 182                     }
 183                 }
 184             }else{
 185                 $authenticated = $this->checkPassword($nickname, $password);
 186                 if($authenticated){
 187                     if(! Event::handle('AutoRegister', array($nickname, $this->provider_name, &$authenticatedUser))){
 188                         //unlike most Event::handle lines of code, this one has a ! (not)
 189                         //we want to do this if the event *was* handled - this isn't a "default" implementation
 190                         //like most code of this form.
 191                         if($authenticatedUser){
 192                             return false;
 193                         }
 194                     }
 195                 }
 196             }
 197         }
 198         if($this->authoritative){
 199             return false;
 200         }else{
 201             //we're not authoritative, so let other handlers try
 202             return;
 203         }
 204     }
 205
 206     function onStartChangePassword($user,$oldpassword,$newpassword)
 207     {
 208         if($this->password_changeable){
 209             $user_username = new User_username();
 210             $user_username->user_id=$user->id;
 211             $user_username->provider_name=$this->provider_name;
 212             if($user_username->find() && $user_username->fetch()){
 213                 $authenticated = $this->checkPassword($user_username->username, $oldpassword);
 214                 if($authenticated){
 215                     $result = $this->changePassword($user_username->username,$oldpassword,$newpassword);
 216                     if($result){
 217                         //stop handling of other handlers, because what was requested was done
 218                         return false;
 219                     }else{
 220                         // TRANS: Exception thrown when a password change fails.
 221                         throw new Exception(_('Password changing failed.'));
 222                     }
 223                 }else{
 224                     if($this->authoritative){
 225                         //since we're authoritative, no other plugin could do this
 226                         // TRANS: Exception thrown when a password change fails.
 227                         throw new Exception(_('Password changing failed.'));
 228                     }else{
 229                         //let another handler try
 230                         return null;
 231                     }
 232                 }
 233             }
 234         }else{
 235             if($this->authoritative){
 236                 //since we're authoritative, no other plugin could do this
 237                 // TRANS: Exception thrown when a password change attempt fails because it is not allowed.
 238                 throw new Exception(_('Password changing is not allowed.'));
 239             }
 240         }
 241     }
 242
 243     function onStartAccountSettingsPasswordMenuItem($widget)
 244     {
 245         if($this->authoritative && !$this->password_changeable){
 246             //since we're authoritative, no other plugin could change passwords, so do not render the menu item
 247             return false;
 248         }
 249     }
 250
 251     function onCheckSchema() {
 252         $schema = Schema::get();
 253         $schema->ensureTable('user_username', User_username::schemaDef());
 254         return true;
 255     }
 256
 257     function onUserDeleteRelated($user, &$tables)
 258     {
 259         $tables[] = 'User_username';
 260         return true;
 261     }
 262 }