authenticationplugin.php 10.9 KB
Newer Older
1 2 3 4
<?php
/**
 * StatusNet, the distributed open-source microblogging tool
 *
5
 * Superclass for plugins that do authentication and/or authorization
6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24
 *
 * 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  Plugin
 * @package   StatusNet
 * @author    Craig Andrews <candrews@integralblue.com>
25
 * @copyright 2009 Free Software Foundation, Inc http://www.fsf.org
26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42
 * @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') && !defined('LACONICA')) {
    exit(1);
}

/**
 * Superclass for plugins that do authentication
 *
 * @category Plugin
 * @package  StatusNet
 * @author   Craig Andrews <candrews@integralblue.com>
 * @license  http://www.fsf.org/licensing/licenses/agpl-3.0.html GNU Affero General Public License version 3.0
 * @link     http://status.net/
 */
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 50 51 52 53
    public $autoregistration = false;

    //can the user change their email address
    public $password_changeable=true;

54 55 56
    //unique name for this authentication provider
    public $provider_name;

57 58 59
    //------------Auth plugin should implement some (or all) of these methods------------\\
    /**
    * Check if a nickname/password combination is valid
60
    * @param username
61 62 63
    * @param password
    * @return boolean true if the credentials are valid, false if they are invalid.
    */
64
    function checkPassword($username, $password)
65 66 67 68 69 70 71
    {
        return false;
    }

    /**
    * Automatically register a user when they attempt to login with valid credentials.
    * User::register($data) is a very useful method for this implementation
72 73
    * @param username username (that is used to login and find the user in the authentication provider) of the user to be registered
    * @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 79 80
        if(is_null($nickname)){
            $nickname = $username;
        }
81
        $registration_data = array();
82
        $registration_data['nickname'] = $nickname;
83
        return User::register($registration_data);
84 85 86 87 88
    }

    /**
    * Change a user's password
    * The old password has been verified to be valid by this plugin before this call is made
89
    * @param username
90 91
    * @param oldpassword
    * @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 101 102 103
    /**
    * Given a username, suggest what the nickname should be
    * Used during autoregistration
    * Useful if your usernames are ugly, and you want to suggest
    * nice looking nicknames when users initially sign on
104 105
    * All nicknames returned by this function should be valid
    *  implementations may want to use common_nicknamize() to ensure validity
106 107 108 109 110
    * @param username
    * @return string nickname
    */
    function suggestNicknameForUsername($username)
    {
111
        return common_nicknamize($username);
112 113
    }

114
    //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
115 116 117 118
    function onInitializePlugin(){
        if(!isset($this->provider_name)){
            throw new Exception("must specify a provider_name for this authentication provider");
        }
119
    }
120

121 122 123 124 125 126 127 128 129
    /**
    * Internal AutoRegister event handler
    * @param nickname
    * @param provider_name
    * @param user - the newly registered user
    */
    function onAutoRegister($nickname, $provider_name, &$user)
    {
        if($provider_name == $this->provider_name && $this->autoregistration){
130 131 132 133
            $suggested_nickname = $this->suggestNicknameForUsername($nickname);
            $test_user = User::staticGet('nickname', $suggested_nickname);
            if($test_user) {
                //someone already exists with the suggested nickname, so used the passed nickname
134
                $suggested_nickname = common_nicknamize($nickname);
135 136 137 138 139 140
            }
            $test_user = User::staticGet('nickname', $suggested_nickname);
            if($test_user) {
                //someone already exists with the suggested nickname
                //not much else we can do
            }else{
141
                $user = $this->autoRegister($nickname, $suggested_nickname);
142 143 144 145
                if($user){
                    User_username::register($user,$nickname,$this->provider_name);
                    return false;
                }
146 147 148 149
            }
        }
    }

150
    function onStartCheckPassword($nickname, $password, &$authenticatedUser){
151 152 153 154 155
        //map the nickname to a username
        $user_username = new User_username();
        $user_username->username=$nickname;
        $user_username->provider_name=$this->provider_name;
        if($user_username->find() && $user_username->fetch()){
156
            $authenticated = $this->checkPassword($user_username->username, $password);
157
            if($authenticated){
158 159 160 161
                $authenticatedUser = User::staticGet('id', $user_username->user_id);
                return false;
            }
        }else{
162 163 164 165
            //$nickname is the username used to login
            //$suggested_nickname is the nickname the auth provider suggests for that username
            $suggested_nickname = $this->suggestNicknameForUsername($nickname);
            $user = User::staticGet('nickname', $suggested_nickname);
166
            if($user){
167
                //make sure this user isn't claimed
168
                $user_username = new User_username();
169 170 171 172 173 174 175 176
                $user_username->user_id=$user->id;
                $we_can_handle = false;
                if($user_username->find()){
                    //either this provider, or another one, has already claimed this user
                    //so we cannot. Let another plugin try.
                    return;
                }else{
                    //no other provider claims this user, so it's safe for us to handle it
177 178
                    $authenticated = $this->checkPassword($nickname, $password);
                    if($authenticated){
179
                        $authenticatedUser = $user;
180
                        User_username::register($authenticatedUser,$nickname,$this->provider_name);
181
                        return false;
182 183 184
                    }
                }
            }else{
185 186
                $authenticated = $this->checkPassword($nickname, $password);
                if($authenticated){
187 188 189 190
                    if(! Event::handle('AutoRegister', array($nickname, $this->provider_name, &$authenticatedUser))){
                        //unlike most Event::handle lines of code, this one has a ! (not)
                        //we want to do this if the event *was* handled - this isn't a "default" implementation
                        //like most code of this form.
191
                        if($authenticatedUser){
192 193
                            return false;
                        }
194
                    }
195 196
                }
            }
197 198 199
        }
        if($this->authoritative){
            return false;
200
        }else{
201 202
            //we're not authoritative, so let other handlers try
            return;
203 204 205
        }
    }

206
    function onStartChangePassword($user,$oldpassword,$newpassword)
207
    {
208
        if($this->password_changeable){
209 210 211 212 213 214 215 216 217 218 219
            $user_username = new User_username();
            $user_username->user_id=$user->id;
            $user_username->provider_name=$this->provider_name;
            if($user_username->find() && $user_username->fetch()){
                $authenticated = $this->checkPassword($user_username->username, $oldpassword);
                if($authenticated){
                    $result = $this->changePassword($user_username->username,$oldpassword,$newpassword);
                    if($result){
                        //stop handling of other handlers, because what was requested was done
                        return false;
                    }else{
220 221
                        // TRANS: Exception thrown when a password change fails.
                        throw new Exception(_('Password changing failed.'));
222
                    }
223
                }else{
224 225
                    if($this->authoritative){
                        //since we're authoritative, no other plugin could do this
226 227
                        // TRANS: Exception thrown when a password change fails.
                        throw new Exception(_('Password changing failed.'));
228 229 230 231
                    }else{
                        //let another handler try
                        return null;
                    }
232
                }
233 234
            }
        }else{
235
            if($this->authoritative){
236
                //since we're authoritative, no other plugin could do this
237 238
                // TRANS: Exception thrown when a password change attempt fails because it is not allowed.
                throw new Exception(_('Password changing is not allowed.'));
239 240
            }
        }
241 242 243 244
    }

    function onStartAccountSettingsPasswordMenuItem($widget)
    {
245
        if($this->authoritative && !$this->password_changeable){
246 247 248 249 250 251 252
            //since we're authoritative, no other plugin could change passwords, so do not render the menu item
            return false;
        }
    }

    function onCheckSchema() {
        $schema = Schema::get();
253 254 255 256 257 258 259 260 261 262
        $schema->ensureTable('user_username',
                             array(new ColumnDef('provider_name', 'varchar',
                                                 '255', false, 'PRI'),
                                   new ColumnDef('username', 'varchar',
                                                 '255', false, 'PRI'),
                                   new ColumnDef('user_id', 'integer',
                                                 null, false),
                                   new ColumnDef('created', 'datetime',
                                                 null, false),
                                   new ColumnDef('modified', 'timestamp')));
263 264 265 266 267 268 269 270
        return true;
    }

    function onUserDeleteRelated($user, &$tables)
    {
        $tables[] = 'User_username';
        return true;
    }
271
}