snappymail/plugins/white-list/index.php

58 lines
2.1 KiB
PHP

<?php
class WhiteListPlugin extends \RainLoop\Plugins\AbstractPlugin
{
const
NAME = 'White list',
VERSION = '2.0',
CATEGORY = 'Login',
DESCRIPTION = 'Simple white list plugin (with wildcard and exceptions functionality).';
public function Init() : void
{
$this->addHook('filter.login-credentials', 'FilterLoginCredentials');
}
/**
* @param string $sEmail
* @param string $sLogin
* @param string $sPassword
*
* @throws \RainLoop\Exceptions\ClientException
*/
public function FilterLoginCredentials(&$sEmail, &$sLogin, &$sPassword)
{
$sWhiteList = \trim($this->Config()->Get('plugin', 'white_list', ''));
if (0 < strlen($sWhiteList) && !\RainLoop\Plugins\Helper::ValidateWildcardValues($sEmail, $sWhiteList))
{
$sExceptions = \trim($this->Config()->Get('plugin', 'exceptions', ''));
if (0 === \strlen($sExceptions) || !\RainLoop\Plugins\Helper::ValidateWildcardValues($sEmail, $sExceptions))
{
throw new \RainLoop\Exceptions\ClientException(
$this->Config()->Get('plugin', 'auth_error', true) ?
\RainLoop\Notifications::AuthError : \RainLoop\Notifications::AccountNotAllowed);
}
}
}
/**
* @return array
*/
protected function configMapping() : array
{
return array(
\RainLoop\Plugins\Property::NewInstance('auth_error')->SetLabel('Auth Error')
->SetType(\RainLoop\Enumerations\PluginPropertyType::BOOL)
->SetDescription('Throw an authentication error instead of an access error.')
->SetDefaultValue(true),
\RainLoop\Plugins\Property::NewInstance('white_list')->SetLabel('White List')
->SetType(\RainLoop\Enumerations\PluginPropertyType::STRING_TEXT)
->SetDescription('Emails white list, space as delimiter, wildcard supported.')
->SetDefaultValue('*@domain1.com user@domain2.com'),
\RainLoop\Plugins\Property::NewInstance('exceptions')->SetLabel('Exceptions')
->SetType(\RainLoop\Enumerations\PluginPropertyType::STRING_TEXT)
->SetDescription('Exceptions for white list, space as delimiter, wildcard supported.')
->SetDefaultValue('demo@domain1.com *@domain2.com admin@*')
);
}
}