2009-11-11 06:27:20 +09:00
|
|
|
<?php
|
|
|
|
/**
|
|
|
|
* StatusNet, the distributed open-source microblogging tool
|
|
|
|
*
|
|
|
|
* Superclass for plugins that do authentication and/or authorization
|
|
|
|
*
|
|
|
|
* 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>
|
|
|
|
* @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/
|
|
|
|
*/
|
|
|
|
|
2009-11-12 02:16:58 +09:00
|
|
|
abstract class AuthenticationPlugin extends Plugin
|
2009-11-11 06:27:20 +09:00
|
|
|
{
|
|
|
|
//is this plugin authoritative for authentication?
|
2009-11-12 02:16:58 +09:00
|
|
|
public $authoritative = false;
|
2009-11-11 06:27:20 +09:00
|
|
|
|
|
|
|
//should accounts be automatically created after a successful login attempt?
|
2009-11-11 07:54:24 +09:00
|
|
|
public $autoregistration = false;
|
|
|
|
|
|
|
|
//can the user change their email address
|
|
|
|
public $email_changeable=true;
|
|
|
|
|
|
|
|
//can the user change their email address
|
|
|
|
public $password_changeable=true;
|
|
|
|
|
2009-11-11 06:27:20 +09:00
|
|
|
//------------Auth plugin should implement some (or all) of these methods------------\\
|
|
|
|
/**
|
|
|
|
* Check if a nickname/password combination is valid
|
|
|
|
* @param nickname
|
|
|
|
* @param password
|
|
|
|
* @return boolean true if the credentials are valid, false if they are invalid.
|
|
|
|
*/
|
|
|
|
function checkPassword($nickname, $password)
|
|
|
|
{
|
|
|
|
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
|
|
|
|
* @param nickname
|
|
|
|
* @return boolean true if the user was created, false if autoregistration is not allowed, null if this plugin is not responsible for this nickname
|
|
|
|
*/
|
|
|
|
function autoRegister($nickname)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Change a user's password
|
|
|
|
* The old password has been verified to be valid by this plugin before this call is made
|
|
|
|
* @param nickname
|
|
|
|
* @param oldpassword
|
|
|
|
* @param newpassword
|
|
|
|
* @return boolean true if the password was changed, false if password changing failed for some reason, null if this plugin is not responsible for this nickname
|
|
|
|
*/
|
|
|
|
function changePassword($nickname,$oldpassword,$newpassword)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
/**
|
|
|
|
* Can a user change this field in his own profile?
|
|
|
|
* @param nickname
|
|
|
|
* @param field
|
|
|
|
* @return boolean true if the field can be changed, false if not allowed to change it, null if this plugin is not responsible for this nickname
|
|
|
|
*/
|
|
|
|
function canUserChangeField($nickname, $field)
|
|
|
|
{
|
|
|
|
return null;
|
|
|
|
}
|
|
|
|
|
|
|
|
//------------Below are the methods that connect StatusNet to the implementing Auth plugin------------\\
|
|
|
|
function __construct()
|
|
|
|
{
|
|
|
|
parent::__construct();
|
|
|
|
}
|
|
|
|
|
2009-11-12 04:04:32 +09:00
|
|
|
function onStartCheckPassword($nickname, $password, &$authenticatedUser){
|
2009-11-11 07:54:24 +09:00
|
|
|
if($this->password_changeable){
|
|
|
|
$authenticated = $this->checkPassword($nickname, $password);
|
|
|
|
if($authenticated){
|
|
|
|
$authenticatedUser = User::staticGet('nickname', $nickname);
|
|
|
|
if(!$authenticatedUser && $this->autoregistration){
|
|
|
|
if($this->autoregister($nickname)){
|
|
|
|
$authenticatedUser = User::staticGet('nickname', $nickname);
|
|
|
|
}
|
|
|
|
}
|
|
|
|
return false;
|
|
|
|
}else{
|
2009-11-12 02:16:58 +09:00
|
|
|
if($this->authoritative){
|
2009-11-11 07:54:24 +09:00
|
|
|
return false;
|
2009-11-11 06:27:20 +09:00
|
|
|
}
|
|
|
|
}
|
2009-11-11 07:54:24 +09:00
|
|
|
//we're not authoritative, so let other handlers try
|
2009-11-11 06:27:20 +09:00
|
|
|
}else{
|
2009-11-12 02:16:58 +09:00
|
|
|
if($this->authoritative){
|
2009-11-11 07:54:24 +09:00
|
|
|
//since we're authoritative, no other plugin could do this
|
|
|
|
throw new Exception(_('Password changing is not allowed'));
|
2009-11-11 06:27:20 +09:00
|
|
|
}
|
|
|
|
}
|
|
|
|
}
|
|
|
|
|
|
|
|
function onStartChangePassword($nickname,$oldpassword,$newpassword)
|
|
|
|
{
|
2009-11-11 07:54:24 +09:00
|
|
|
if($this->password_changeable){
|
|
|
|
$authenticated = $this->checkPassword($nickname, $oldpassword);
|
|
|
|
if($authenticated){
|
|
|
|
$result = $this->changePassword($nickname,$oldpassword,$newpassword);
|
|
|
|
if($result){
|
|
|
|
//stop handling of other handlers, because what was requested was done
|
|
|
|
return false;
|
|
|
|
}else{
|
|
|
|
throw new Exception(_('Password changing failed'));
|
|
|
|
}
|
2009-11-11 06:27:20 +09:00
|
|
|
}else{
|
2009-11-12 02:16:58 +09:00
|
|
|
if($this->authoritative){
|
2009-11-11 07:54:24 +09:00
|
|
|
//since we're authoritative, no other plugin could do this
|
|
|
|
throw new Exception(_('Password changing failed'));
|
|
|
|
}else{
|
|
|
|
//let another handler try
|
|
|
|
return null;
|
|
|
|
}
|
2009-11-11 06:27:20 +09:00
|
|
|
}
|
|
|
|
}else{
|
2009-11-12 02:16:58 +09:00
|
|
|
if($this->authoritative){
|
2009-11-11 06:27:20 +09:00
|
|
|
//since we're authoritative, no other plugin could do this
|
2009-11-11 07:54:24 +09:00
|
|
|
throw new Exception(_('Password changing is not allowed'));
|
2009-11-11 06:27:20 +09:00
|
|
|
}
|
|
|
|
}
|
2009-11-11 07:54:24 +09:00
|
|
|
}
|
|
|
|
|
|
|
|
function onStartAccountSettingsPasswordMenuItem($widget)
|
|
|
|
{
|
2009-11-12 02:16:58 +09:00
|
|
|
if($this->authoritative && !$this->password_changeable){
|
2009-11-11 07:54:24 +09:00
|
|
|
//since we're authoritative, no other plugin could change passwords, so do render the menu item
|
|
|
|
return false;
|
|
|
|
}
|
2009-11-11 06:27:20 +09:00
|
|
|
}
|
|
|
|
}
|
|
|
|
|