3 * StatusNet, the distributed open-source microblogging tool
5 * Superclass for plugins that do authentication and/or authorization
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.
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.
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/>.
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/
29 if (!defined('STATUSNET') && !defined('LACONICA')) {
34 * Superclass for plugins that do authentication
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/
43 abstract class AuthenticationPlugin extends Plugin
45 //is this plugin authoritative for authentication?
46 public $authoritative = false;
48 //should accounts be automatically created after a successful login attempt?
49 public $autoregistration = false;
51 //can the user change their email address
52 public $password_changeable=true;
54 //unique name for this authentication provider
55 public $provider_name;
57 //------------Auth plugin should implement some (or all) of these methods------------\\
59 * Check if a nickname/password combination is valid
62 * @return boolean true if the credentials are valid, false if they are invalid.
64 function checkPassword($username, $password)
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
73 * @return mixed instance of User, or false (if user couldn't be created)
75 function autoRegister($username)
77 $registration_data = array();
78 $registration_data['nickname'] = $username ;
79 return User::register($registration_data);
83 * Change a user's password
84 * The old password has been verified to be valid by this plugin before this call is made
88 * @return boolean true if the password was changed, false if password changing failed for some reason
90 function changePassword($username,$oldpassword,$newpassword)
96 * Given a username, suggest what the nickname should be
97 * Used during autoregistration
98 * Useful if your usernames are ugly, and you want to suggest
99 * nice looking nicknames when users initially sign on
101 * @return string nickname
103 function suggestNicknameForUsername($username)
108 //------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
109 function onInitializePlugin(){
110 if(!isset($this->provider_name)){
111 throw new Exception("must specify a provider_name for this authentication provider");
116 * Internal AutoRegister event handler
118 * @param provider_name
119 * @param user - the newly registered user
121 function onAutoRegister($nickname, $provider_name, &$user)
123 if($provider_name == $this->provider_name && $this->autoregistration){
124 $suggested_nickname = $this->suggestNicknameForUsername($nickname);
125 $test_user = User::staticGet('nickname', $suggested_nickname);
127 //someone already exists with the suggested nickname, so used the passed nickname
128 $suggested_nickname = $nickname;
130 $test_user = User::staticGet('nickname', $suggested_nickname);
132 //someone already exists with the suggested nickname
133 //not much else we can do
135 $user = $this->autoregister($suggested_nickname);
137 User_username::register($user,$nickname,$this->provider_name);
144 function onStartCheckPassword($nickname, $password, &$authenticatedUser){
145 //map the nickname to a username
146 $user_username = new User_username();
147 $user_username->username=$nickname;
148 $user_username->provider_name=$this->provider_name;
149 if($user_username->find() && $user_username->fetch()){
150 $authenticated = $this->checkPassword($user_username->username, $password);
152 $authenticatedUser = User::staticGet('id', $user_username->user_id);
156 //$nickname is the username used to login
157 //$suggested_nickname is the nickname the auth provider suggests for that username
158 $suggested_nickname = $this->suggestNicknameForUsername($nickname);
159 $user = User::staticGet('nickname', $suggested_nickname);
161 //make sure this user isn't claimed
162 $user_username = new User_username();
163 $user_username->user_id=$user->id;
164 $we_can_handle = false;
165 if($user_username->find()){
166 //either this provider, or another one, has already claimed this user
167 //so we cannot. Let another plugin try.
170 //no other provider claims this user, so it's safe for us to handle it
171 $authenticated = $this->checkPassword($nickname, $password);
173 $authenticatedUser = $user;
174 User_username::register($authenticatedUser,$nickname,$this->provider_name);
179 $authenticated = $this->checkPassword($nickname, $password);
181 if(! Event::handle('AutoRegister', array($nickname, $this->provider_name, &$authenticatedUser))){
182 //unlike most Event::handle lines of code, this one has a ! (not)
183 //we want to do this if the event *was* handled - this isn't a "default" implementation
184 //like most code of this form.
185 if($authenticatedUser){
192 if($this->authoritative){
195 //we're not authoritative, so let other handlers try
200 function onStartChangePassword($user,$oldpassword,$newpassword)
202 if($this->password_changeable){
203 $user_username = new User_username();
204 $user_username->user_id=$user->id;
205 $user_username->provider_name=$this->provider_name;
206 if($user_username->find() && $user_username->fetch()){
207 $authenticated = $this->checkPassword($user_username->username, $oldpassword);
209 $result = $this->changePassword($user_username->username,$oldpassword,$newpassword);
211 //stop handling of other handlers, because what was requested was done
214 throw new Exception(_('Password changing failed'));
217 if($this->authoritative){
218 //since we're authoritative, no other plugin could do this
219 throw new Exception(_('Password changing failed'));
221 //let another handler try
227 if($this->authoritative){
228 //since we're authoritative, no other plugin could do this
229 throw new Exception(_('Password changing is not allowed'));
234 function onStartAccountSettingsPasswordMenuItem($widget)
236 if($this->authoritative && !$this->password_changeable){
237 //since we're authoritative, no other plugin could change passwords, so do not render the menu item
242 function onCheckSchema() {
243 $schema = Schema::get();
244 $schema->ensureTable('user_username',
245 array(new ColumnDef('provider_name', 'varchar',
246 '255', false, 'PRI'),
247 new ColumnDef('username', 'varchar',
248 '255', false, 'PRI'),
249 new ColumnDef('user_id', 'integer',
251 new ColumnDef('created', 'datetime',
253 new ColumnDef('modified', 'timestamp')));
257 function onUserDeleteRelated($user, &$tables)
259 $tables[] = 'User_username';