Add Feature IMAP authentication
### Added - Add IMAP Authentication Plugin which stores the IMAP server to a DB field and handles the registration and authentication of IMAP users. ### Changed - Add extra plugin hooks `beforeVerifyUser` & `afterVerifyUser` in `60.plugins.php`. - Change the `login.class.php` by calling the `beforeVerifyUser` & `afterVerifyUser` hooks in order to support more authentication methods.
This commit is contained in:
parent
f928fe84c8
commit
f54e5e65c9
|
|
@ -37,6 +37,9 @@ $plugins = array(
|
|||
'loginBodyBegin'=>array(),
|
||||
'loginBodyEnd'=>array(),
|
||||
|
||||
'beforeVerifyUser'=>array(),
|
||||
'afterVerifyUser'=>array(),
|
||||
|
||||
'all'=>array()
|
||||
);
|
||||
|
||||
|
|
|
|||
|
|
@ -104,6 +104,13 @@ class Login {
|
|||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
Theme::plugins('beforeVerifyUser');
|
||||
} catch (Exception $e) {
|
||||
Log::set($e->getFile().LOG_SEP.$e->getLine().LOG_SEP.$e->getMessage());
|
||||
return false;
|
||||
}
|
||||
|
||||
try {
|
||||
$user = new User($username);
|
||||
} catch (Exception $e) {
|
||||
|
|
@ -117,6 +124,16 @@ class Login {
|
|||
return true;
|
||||
}
|
||||
|
||||
try {
|
||||
Theme::plugins('afterVerifyUser');
|
||||
} catch (Exception $e) {
|
||||
Log::set($e->getFile().LOG_SEP.$e->getLine().LOG_SEP.$e->getMessage());
|
||||
return false;
|
||||
}
|
||||
if ($this->isLogged()) {
|
||||
return true;
|
||||
}
|
||||
|
||||
Log::set(__METHOD__.LOG_SEP.'Password incorrect.');
|
||||
return false;
|
||||
}
|
||||
|
|
|
|||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"plugin-data":
|
||||
{
|
||||
"name": "IMAP-Authentifizierung",
|
||||
"description": "Dieses Plugin ermöglicht die Authentifizierung von Benutzern mit Hilfe eines IMAP-Servers.",
|
||||
"imap-server": "IMAP Server"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,8 @@
|
|||
{
|
||||
"plugin-data":
|
||||
{
|
||||
"name": "IMAP Authentication",
|
||||
"description": "This plugin enables the authentication of users, using an IMAP server.",
|
||||
"imap-server": "IMAP Server"
|
||||
}
|
||||
}
|
||||
|
|
@ -0,0 +1,10 @@
|
|||
{
|
||||
"author": "LeineLab",
|
||||
"email": "",
|
||||
"website": "https://leinelab.org",
|
||||
"version": "0.1.0",
|
||||
"releaseDate": "2020-06-15",
|
||||
"license": "MIT",
|
||||
"compatible": "3.12.0",
|
||||
"notes": ""
|
||||
}
|
||||
|
|
@ -0,0 +1,137 @@
|
|||
<?php
|
||||
|
||||
class pluginImapAuthentication extends Plugin {
|
||||
|
||||
const IMAP_SERVER_DB_FIELD = 'imapServer';
|
||||
|
||||
public function init()
|
||||
{
|
||||
$this->dbFields = array(
|
||||
self::IMAP_SERVER_DB_FIELD=>'',
|
||||
);
|
||||
}
|
||||
|
||||
public function form()
|
||||
{
|
||||
global $L;
|
||||
|
||||
$html = '<div class="alert alert-primary" role="alert">';
|
||||
$html .= $this->description();
|
||||
$html .= '</div>';
|
||||
|
||||
$html .= '<div>';
|
||||
$html .= '<label>'.$L->get('IMAP Server').'</label>';
|
||||
$html .= '<input name="imapServer" id="imapServer" type="text" value="'.$this->getValue(self::IMAP_SERVER_DB_FIELD).'">';
|
||||
$html .= '</div>';
|
||||
|
||||
return $html;
|
||||
}
|
||||
|
||||
/**
|
||||
* Before validating user, check if exists.
|
||||
* If not and the user name is an email
|
||||
* and has an IMAP account create one.
|
||||
* @throws Exception
|
||||
*/
|
||||
public function beforeVerifyUser()
|
||||
{
|
||||
$username = $_POST['username'];
|
||||
$password = $_POST['password'];
|
||||
|
||||
if (false === filter_var($username, FILTER_VALIDATE_EMAIL)) {
|
||||
return;
|
||||
}
|
||||
|
||||
try {
|
||||
new User($username);
|
||||
} catch (Exception $e) {
|
||||
$this->createUser($username, $password);
|
||||
}
|
||||
}
|
||||
|
||||
/**
|
||||
* Validate user using IMAP
|
||||
* @throws Exception
|
||||
*/
|
||||
public function afterVerifyUser()
|
||||
{
|
||||
$username = $_POST['username'];
|
||||
$password = $_POST['password'];
|
||||
|
||||
if (!$this->authenticateUser($this->getValue(self::IMAP_SERVER_DB_FIELD), $username, $password)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$user = new User($username);
|
||||
|
||||
$loginClass = new login();
|
||||
$loginClass->setLogin($username, $user->role());
|
||||
Log::set(__METHOD__.LOG_SEP.'Successful user login using IMAP - Username ['.$username.']');
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $mailbox
|
||||
* @param $username User's mail address
|
||||
* @param $password
|
||||
* @return bool
|
||||
*/
|
||||
private function authenticateUser($mailbox, $username, $password)
|
||||
{
|
||||
if (!function_exists('imap_open')) {
|
||||
Log::set(__METHOD__.LOG_SEP.'ERROR: PHP imap extension is not installed');
|
||||
}
|
||||
|
||||
// Replace escaped @ symbol in uid (which is a mail address)
|
||||
// but only if there is no @ symbol and if there is a %40 inside the uid
|
||||
if (!(strpos($username, '@') !== false) && (strpos($username, '%40') !== false)) {
|
||||
$username = str_replace("%40","@",$username);
|
||||
}
|
||||
|
||||
$imapConnection = @imap_open("{{$mailbox}/imap/ssl}INBOX", $username, $password, OP_HALFOPEN, 1);
|
||||
$imapErrors = imap_errors();
|
||||
$imapAlerts = imap_alerts();
|
||||
if (!empty($imapErrors)) {
|
||||
Log::set(__METHOD__.LOG_SEP."IMAP Error:\n".print_r($imapErrors, true));
|
||||
}
|
||||
if (!empty($imapAlerts)) {
|
||||
Log::set(__METHOD__.LOG_SEP."WARNING: IMAP Warning:\n".print_r($imapAlerts, true));
|
||||
}
|
||||
if($imapConnection !== false) {
|
||||
imap_close($imapConnection);
|
||||
|
||||
return true;
|
||||
}
|
||||
|
||||
return false;
|
||||
}
|
||||
|
||||
/**
|
||||
* @param $username User's mail address
|
||||
* @param $password
|
||||
* @throws Exception
|
||||
*/
|
||||
private function createUser($username, $password)
|
||||
{
|
||||
global $users;
|
||||
|
||||
if (!$this->authenticateUser($this->getValue(self::IMAP_SERVER_DB_FIELD), $username, $password)) {
|
||||
return;
|
||||
}
|
||||
|
||||
$usersClass = new Users();
|
||||
$usersClass->add(array(
|
||||
'username' => $username,
|
||||
'password' => '',
|
||||
'email' => $username,
|
||||
'nickname' => explode('@', $username)[0]
|
||||
));
|
||||
|
||||
$users = new Users();
|
||||
|
||||
$user = new User($username);
|
||||
|
||||
$loginClass = new Login();
|
||||
$loginClass->setLogin($username, $user->role());
|
||||
Log::set(__METHOD__.LOG_SEP.'Successful user creation using IMAP - Username ['.$username.']');
|
||||
}
|
||||
}
|
||||
Loading…
Reference in New Issue