mirror of
https://github.com/the-djmaze/snappymail.git
synced 2026-09-05 15:37:03 +03:00
542 lines
13 KiB
PHP
542 lines
13 KiB
PHP
<?php
|
|
|
|
/*
|
|
* This file is part of MailSo.
|
|
*
|
|
* (c) 2014 Usenko Timur
|
|
*
|
|
* For the full copyright and license information, please view the LICENSE
|
|
* file that was distributed with this source code.
|
|
*/
|
|
|
|
namespace MailSo\Sieve;
|
|
|
|
/**
|
|
* @category MailSo
|
|
* @package Sieve
|
|
*/
|
|
class ManageSieveClient extends \MailSo\Net\NetClient
|
|
{
|
|
/**
|
|
* @var bool
|
|
*/
|
|
private $bIsLoggined = false;
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $aCapa = array();
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $aAuth = array();
|
|
|
|
/**
|
|
* @var array
|
|
*/
|
|
private $aModules = array();
|
|
|
|
public function IsSupported(string $sCapa) : bool
|
|
{
|
|
return isset($this->aCapa[\strtoupper($sCapa)]);
|
|
}
|
|
|
|
public function IsModuleSupported(string $sModule) : bool
|
|
{
|
|
return $this->IsSupported('SIEVE') && \in_array(\strtolower(\trim($sModule)), $this->aModules);
|
|
}
|
|
|
|
public function Modules() : array
|
|
{
|
|
return $this->aModules;
|
|
}
|
|
|
|
public function IsAuthSupported(string $sAuth) : bool
|
|
{
|
|
return $this->IsSupported('SASL') && \in_array(\strtoupper($sAuth), $this->aAuth);
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
* @throws \MailSo\Sieve\Exceptions\ResponseException
|
|
*/
|
|
public function Connect(\MailSo\Net\ConnectSettings $oSettings) : void
|
|
{
|
|
parent::Connect($oSettings);
|
|
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
$this->parseStartupResponse($aResponse);
|
|
|
|
if ($this->IsSupported('STARTTLS') && \MailSo\Net\Enumerations\ConnectionSecurityType::UseStartTLS($this->iSecurityType))
|
|
{
|
|
$this->sendRequestWithCheck('STARTTLS');
|
|
$this->EnableCrypto();
|
|
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
$this->parseStartupResponse($aResponse);
|
|
}
|
|
else if (\MailSo\Net\Enumerations\ConnectionSecurityType::STARTTLS === $this->iSecurityType)
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Net\Exceptions\SocketUnsuppoterdSecureConnectionException('STARTTLS is not supported'),
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
* @throws \MailSo\Sieve\Exceptions\LoginException
|
|
*/
|
|
public function Login(array $aCredentials) : self
|
|
{
|
|
$sLogin = $aCredentials['Login'];
|
|
$sPassword = $aCredentials['Password'];
|
|
$sLoginAuthKey = '';
|
|
if (!\strlen($sLogin) || !\strlen($sPassword))
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Base\Exceptions\InvalidArgumentException,
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
|
|
if ($this->IsSupported('SASL'))
|
|
{
|
|
$type = '';
|
|
\array_push($aCredentials['SASLMechanisms'], 'PLAIN', 'LOGIN');
|
|
foreach ($aCredentials['SASLMechanisms'] as $sasl_type) {
|
|
if ($this->IsAuthSupported($sasl_type) && \SnappyMail\SASL::isSupported($sasl_type)) {
|
|
$type = $sasl_type;
|
|
break;
|
|
}
|
|
}
|
|
|
|
$SASL = \SnappyMail\SASL::factory($type);
|
|
$SASL->base64 = true;
|
|
|
|
$bAuth = false;
|
|
try
|
|
{
|
|
if (0 === \strpos($type, 'SCRAM-'))
|
|
{
|
|
/*
|
|
$sAuthzid = $this->getResponseValue($this->SendRequestGetResponse('AUTHENTICATE', array($type)), \MailSo\Imap\Enumerations\ResponseType::CONTINUATION);
|
|
$this->sendRaw($SASL->authenticate($sLogin, $sPassword/*, $sAuthzid* /), true);
|
|
$sChallenge = $SASL->challenge($this->getResponseValue($this->getResponse(), \MailSo\Imap\Enumerations\ResponseType::CONTINUATION));
|
|
if ($this->oLogger) {
|
|
$this->oLogger->AddSecret($sChallenge);
|
|
}
|
|
$this->sendRaw($sChallenge, true, '*******');
|
|
$oResponse = $this->getResponse();
|
|
$SASL->verify($this->getResponseValue($oResponse));
|
|
*/
|
|
}
|
|
else if ('PLAIN' === $type || 'OAUTHBEARER' === $type || 'XOAUTH2' === $type)
|
|
{
|
|
$sAuth = $SASL->authenticate($sLogin, $sPassword, $sLoginAuthKey);
|
|
|
|
if ($aCredentials['InitialAuthPlain'])
|
|
{
|
|
$this->sendRaw("AUTHENTICATE \"{$type}\" \"{$sAuth}\"");
|
|
}
|
|
else
|
|
{
|
|
$this->sendRaw("AUTHENTICATE \"{$type}\" {".\strlen($sAuth).'+}');
|
|
$this->sendRaw($sAuth);
|
|
}
|
|
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
$this->parseStartupResponse($aResponse);
|
|
$bAuth = true;
|
|
}
|
|
else if ('LOGIN' === $type)
|
|
{
|
|
$sLogin = $SASL->authenticate($sLogin, $sPassword);
|
|
$sPassword = $SASL->challenge('');
|
|
|
|
$this->sendRaw('AUTHENTICATE "LOGIN"');
|
|
$this->sendRaw('{'.\strlen($sLogin).'+}');
|
|
$this->sendRaw($sLogin);
|
|
$this->sendRaw('{'.\strlen($sPassword).'+}');
|
|
$this->sendRaw($sPassword);
|
|
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
$this->parseStartupResponse($aResponse);
|
|
$bAuth = true;
|
|
}
|
|
}
|
|
catch (\MailSo\Sieve\Exceptions\NegativeResponseException $oException)
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Sieve\Exceptions\LoginBadCredentialsException(
|
|
$oException->GetResponses(), '', 0, $oException),
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
|
|
if (!$bAuth)
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Sieve\Exceptions\LoginBadMethodException,
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Sieve\Exceptions\LoginException,
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
|
|
$this->bIsLoggined = true;
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function Logout() : void
|
|
{
|
|
if ($this->bIsLoggined)
|
|
{
|
|
$this->sendRequestWithCheck('LOGOUT');
|
|
$this->bIsLoggined = false;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function ListScripts() : array
|
|
{
|
|
$this->sendRequest('LISTSCRIPTS');
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
|
|
$aResult = array();
|
|
foreach ($aResponse as $sLine)
|
|
{
|
|
$aTokens = $this->parseLine($sLine);
|
|
if (!$aTokens)
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$aResult[$aTokens[0]] = 'ACTIVE' === substr($sLine, -6);
|
|
}
|
|
|
|
return $aResult;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function Capability() : array
|
|
{
|
|
$this->sendRequest('CAPABILITY');
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
$this->parseStartupResponse($aResponse);
|
|
|
|
return $this->aCapa;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function Noop() : self
|
|
{
|
|
$this->sendRequestWithCheck('NOOP');
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function GetScript(string $sScriptName) : string
|
|
{
|
|
$this->sendRequest('GETSCRIPT "'.$sScriptName.'"');
|
|
$aResponse = $this->parseResponse();
|
|
$this->validateResponse($aResponse);
|
|
|
|
$sScript = '';
|
|
if (\count($aResponse))
|
|
{
|
|
if ('{' === $aResponse[0][0])
|
|
{
|
|
\array_shift($aResponse);
|
|
}
|
|
|
|
if (\in_array(\substr($aResponse[\count($aResponse) - 1], 0, 2), array('OK', 'NO')))
|
|
{
|
|
\array_pop($aResponse);
|
|
}
|
|
|
|
$sScript = \implode("\r\n", $aResponse);
|
|
}
|
|
|
|
return $sScript;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function PutScript(string $sScriptName, string $sScriptSource) : self
|
|
{
|
|
$sScriptSource = \preg_replace('/\r?\n/', "\r\n", $sScriptSource);
|
|
$this->sendRequest('PUTSCRIPT "'.$sScriptName.'" {'.\strlen($sScriptSource).'+}');
|
|
$this->sendRequestWithCheck($sScriptSource);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function CheckScript(string $sScriptSource) : self
|
|
{
|
|
$sScriptSource = \preg_replace('/\r?\n/', "\r\n", $sScriptSource);
|
|
$this->sendRequest('CHECKSCRIPT {'.\strlen($sScriptSource).'+}');
|
|
$this->sendRequestWithCheck($sScriptSource);
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function SetActiveScript(string $sScriptName) : self
|
|
{
|
|
$this->sendRequestWithCheck('SETACTIVE "'.$sScriptName.'"');
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function DeleteScript(string $sScriptName) : self
|
|
{
|
|
$this->sendRequestWithCheck('DELETESCRIPT "'.$sScriptName.'"');
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function RenameScript(string $sOldName, string $sNewName) : self
|
|
{
|
|
$this->sendRequestWithCheck('RENAMESCRIPT "'.$sOldName.'" "'.$sNewName.'"');
|
|
|
|
return $this;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function GetActiveScriptName() : string
|
|
{
|
|
$aList = $this->ListScripts();
|
|
foreach ($aList as $sName => $bIsActive)
|
|
{
|
|
if ($bIsActive)
|
|
{
|
|
return $sName;
|
|
}
|
|
}
|
|
|
|
return '';
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
public function IsActiveScript(string $sScriptName) : bool
|
|
{
|
|
return $sScriptName === $this->GetActiveScriptName();
|
|
}
|
|
|
|
private function parseLine(string $sLine) : ?array
|
|
{
|
|
if (false === $sLine || null === $sLine || \in_array(\substr($sLine, 0, 2), array('OK', 'NO')))
|
|
{
|
|
return null;
|
|
}
|
|
|
|
$iStart = -1;
|
|
$iIndex = 0;
|
|
$aResult = array();
|
|
|
|
for ($iPos = 0; $iPos < \strlen($sLine); $iPos++)
|
|
{
|
|
if ('"' === $sLine[$iPos] && '\\' !== $sLine[$iPos])
|
|
{
|
|
if (-1 === $iStart)
|
|
{
|
|
$iStart = $iPos;
|
|
}
|
|
else
|
|
{
|
|
$aResult[$iIndex++] = \substr($sLine, $iStart + 1, $iPos - $iStart - 1);
|
|
$iStart = -1;
|
|
}
|
|
}
|
|
}
|
|
|
|
return isset($aResult[0]) ? $aResult : null;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
*/
|
|
private function parseStartupResponse(array $aResponse) : void
|
|
{
|
|
foreach ($aResponse as $sLine)
|
|
{
|
|
$aTokens = $this->parseLine($sLine);
|
|
|
|
if (false === $aTokens || !isset($aTokens[0]) ||
|
|
\in_array(\substr($sLine, 0, 2), array('OK', 'NO')))
|
|
{
|
|
continue;
|
|
}
|
|
|
|
$sToken = \strtoupper($aTokens[0]);
|
|
$this->aCapa[$sToken] = isset($aTokens[1]) ? $aTokens[1] : '';
|
|
|
|
if (isset($aTokens[1]))
|
|
{
|
|
switch ($sToken) {
|
|
case 'SASL':
|
|
$this->aAuth = \explode(' ', \strtoupper($aTokens[1]));
|
|
break;
|
|
case 'SIEVE':
|
|
$this->aModules = \explode(' ', \strtolower($aTokens[1]));
|
|
break;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Base\Exceptions\InvalidArgumentException
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
*/
|
|
private function sendRequest(string $sRequest) : void
|
|
{
|
|
if (!\strlen(\trim($sRequest)))
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Base\Exceptions\InvalidArgumentException,
|
|
\MailSo\Log\Enumerations\Type::ERROR, true);
|
|
}
|
|
|
|
$this->IsConnected(true);
|
|
|
|
$this->sendRaw($sRequest);
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Net\Exceptions\Exception
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
private function sendRequestWithCheck(string $sRequest) : void
|
|
{
|
|
$this->sendRequest($sRequest);
|
|
$this->validateResponse($this->parseResponse());
|
|
}
|
|
|
|
private function convertEndOfLine(string $sLine) : string
|
|
{
|
|
$sLine = \trim($sLine);
|
|
if ('}' === \substr($sLine, -1))
|
|
{
|
|
$iPos = \strrpos($sLine, '{');
|
|
if (false !== $iPos)
|
|
{
|
|
$sSunLine = \substr($sLine, $iPos + 1, -1);
|
|
if (\is_numeric($sSunLine) && 0 < (int) $sSunLine)
|
|
{
|
|
$iLen = (int) $sSunLine;
|
|
|
|
$this->getNextBuffer($iLen, true);
|
|
|
|
if (\strlen($this->sResponseBuffer) === $iLen)
|
|
{
|
|
$sLine = \trim(\substr_replace($sLine, $this->sResponseBuffer, $iPos));
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $sLine;
|
|
}
|
|
|
|
private function parseResponse() : array
|
|
{
|
|
$aResult = array();
|
|
do
|
|
{
|
|
$this->getNextBuffer();
|
|
|
|
$sLine = $this->sResponseBuffer;
|
|
if (false === $sLine)
|
|
{
|
|
break;
|
|
}
|
|
else if (\in_array(\substr($sLine, 0, 2), array('OK', 'NO')))
|
|
{
|
|
$aResult[] = $this->convertEndOfLine($sLine);
|
|
break;
|
|
}
|
|
else
|
|
{
|
|
$aResult[] = $this->convertEndOfLine($sLine);
|
|
}
|
|
}
|
|
while (true);
|
|
|
|
return $aResult;
|
|
}
|
|
|
|
/**
|
|
* @throws \MailSo\Sieve\Exceptions\NegativeResponseException
|
|
*/
|
|
private function validateResponse(array $aResponse)
|
|
{
|
|
if (!$aResponse ||
|
|
'OK' !== \substr($aResponse[\count($aResponse) - 1], 0, 2))
|
|
{
|
|
$this->writeLogException(
|
|
new \MailSo\Sieve\Exceptions\NegativeResponseException($aResponse),
|
|
\MailSo\Log\Enumerations\Type::WARNING, true);
|
|
}
|
|
}
|
|
|
|
public function getLogName() : string
|
|
{
|
|
return 'SIEVE';
|
|
}
|
|
|
|
}
|