Ubiquity\controllers\auth\AuthControllerValidationTrait

Complexity

Total Complexity

43

Size/Duplication

Total Lines	318
Duplicated Lines	0 %

Test Coverage

Coverage

0%

Importance

Changes	4
Bugs	0	Features	3

17 Methods

Rating	Name	Duplication	Size	Complexity
A	submitCode()	0	13	5
A	bad2FACode()	0	7	1
A	save2FACode()	0	6	1
A	check2FACode()	0	2	1
A	generateEmailAccountRecoveryUrl()	0	7	1
A	prepareEmailValidation()	0	4	1
A	send2FACode()	0	4	1
A	prepareEmailAccountRecovery()	0	4	1
A	recoveryInfo()	0	12	3
A	confirm()	0	11	2
A	sendNew2FACode()	0	5	1
A	recoveryInit()	0	10	2
A	generateEmailValidationUrl()	0	7	1
A	validateEmail()	0	2	1
A	checkEmail()	0	22	6
B	recovery()	0	28	7
B	recoverySubmit()	0	29	8

<?php

namespace Ubiquity\controllers\auth;

use Ubiquity\utils\base\UDateTime;
use Ubiquity\utils\flash\FlashMessage;
use Ubiquity\utils\http\UCookie;
use Ubiquity\utils\http\USession;
use Ubiquity\utils\http\URequest;
use Ubiquity\cache\CacheManager;

/**
 * 
 * Ubiquity\controllers\auth$AuthControllerValidationTrait
 * This class is part of Ubiquity
 * @author jc
 * @version 1.0.0
 * 
 * @property bool $_invalid
 *
 */
trait AuthControllerValidationTrait {

	private static $TWO_FA_KEY='2FA-infos';

	protected static $TOKENS_VALIDATE_EMAIL='email.validation';

	protected static $TOKENS_RECOVERY_ACCOUNT='account.recovery';

	abstract protected function twoFABadCodeMessage(FlashMessage $fMessage);
	
	abstract protected function fMessage(FlashMessage $fMessage, $id = null):string;
	
	abstract protected function _getFiles(): AuthFiles;
	
	abstract protected function getBaseUrl():string;
	
	abstract protected function authLoadView($viewName, $vars = [ ]):void;
	
	abstract protected function twoFAMessage(FlashMessage $fMessage);
	
	abstract protected function useAjax():bool;
	
	abstract public function _getBodySelector():string;
	
	abstract protected function generate2FACode():string;
	
	abstract public function _getUserSessionKey():string;
	
	abstract protected function onConnect($connected);
	
	abstract protected function initializeAuth();
	
	abstract protected function finalizeAuth();
	
	abstract protected function onBad2FACode():void;
	
	abstract protected function _send2FACode(string $code,$connected):void;
	
	abstract protected function newTwoFACodeMessage(FlashMessage $fMessage);
	
	abstract protected function emailValidationDuration():\DateInterval;
	
	abstract protected function _sendEmailValidation(string $email,string $validationURL,string $expire):void;
	
	abstract protected function emailValidationSuccess(FlashMessage $fMessage);
	
	abstract protected function emailValidationError(FlashMessage $fMessage);
	
	abstract protected function towFACodePrefix():string;

	abstract protected function twoFACodeDuration():\DateInterval;

	abstract protected function getAuthTokensEmailValidation():AuthTokens;

	abstract protected function isValidEmailForRecovery(string $email):bool;

	abstract protected function recoveryEmailSendMessage(FlashMessage $fMessage);

	abstract protected function _sendEmailAccountRecovery(string $email,string $url,string $expire):bool;

	abstract protected function recoveryEmailErrorMessage(FlashMessage $fMessage);

	abstract protected function accountRecoveryDuration():\DateInterval;

	abstract protected function getAuthTokensAccountRecovery():AuthTokens;

	abstract protected function passwordResetAction(string $email,string $newPasswordHash):bool;

	abstract protected function resetPasswordSuccessMessage(FlashMessage $fMessage);

	abstract protected function resetPasswordErrorMessage(FlashMessage $fMessage);

	/**
	 * @noRoute
	 */
	#[\Ubiquity\attributes\items\router\NoRoute]
	public function bad2FACode():void{
		$this->confirm();
		$fMessage = new FlashMessage ( 'Invalid 2FA code!', 'Two Factor Authentification', 'warning', 'warning circle' );
		$this->twoFABadCodeMessage( $fMessage );
		$message = $this->fMessage ( $fMessage, 'bad-code' );
		$this->authLoadView ( $this->_getFiles ()->getViewBadTwoFACode(), [ '_message' => $message,'url' => $this->getBaseUrl ().'/sendNew2FACode','bodySelector' => '#bad-two-fa','_btCaption' => 'Send new code' ] );
	}

	/**
	 * @noRoute
	 */
	#[\Ubiquity\attributes\items\router\NoRoute]
	public function confirm(){
		$fMessage = new FlashMessage( 'Enter the rescue code and validate.', 'Two factor Authentification', 'info', 'key' );
		$this->twoFAMessage ( $fMessage );
		$message = $this->fMessage ( $fMessage );
		if($this->useAjax()){
			$frm=$this->jquery->semantic()->htmlForm('frm-valid-code');
			$frm->addExtraFieldRule('code','empty');
			$frm->setValidationParams(['inline'=>true,'on'=>'blur']);
		}
		$this->authLoadView ( $this->_getFiles ()->getViewStepTwo(), [ '_message' => $message,'submitURL' => $this->getBaseUrl ().'/submitCode','bodySelector' => $this->_getBodySelector(),'prefix'=>$this->towFACodePrefix() ] );
	}
	
	protected function save2FACode():array{
		$code=$this->generate2FACode();
		$expire=(new \DateTime())->add($this->twoFACodeDuration());
		$codeInfos=USession::get(self::$TWO_FA_KEY,compact('code','expire'));
		USession::set(self::$TWO_FA_KEY,$codeInfos);
		return $codeInfos;
	}
	
	/**
	 * Submits the 2FA code in post request.
	 * 
	 * @post
	 */
	#[\Ubiquity\attributes\items\router\Post]
	public function submitCode(){
		if(URequest::isPost() && USession::exists(self::$TWO_FA_KEY)){
			$twoFAInfos=USession::get(self::$TWO_FA_KEY);
			$expired=$twoFAInfos['expire']<new \DateTime();
			if(!$expired && $this->check2FACode($twoFAInfos['code'],URequest::post('code'))){

It seems like Ubiquity\utils\http\URequest::post('code') can also be of type null; however, parameter $userInput of Ubiquity\controllers\auth\AuthControllerValidationTrait::check2FACode() does only seem to accept string, maybe add an additional type check?

				$this->onConnect(USession::get($this->_getUserSessionKey().'-2FA'));
			}
			else{
				$this->_invalid=true;
				$this->initializeAuth();
				$this->onBad2FACode();
				$this->finalizeAuth();
			}
		}
	}

	/**
	 * @noRoute
	 */
	#[\Ubiquity\attributes\items\router\NoRoute]
	public function send2FACode(){
		$codeInfos=$this->save2FACode();
		$this->_send2FACode($codeInfos['code'], USession::get($this->_getUserSessionKey().'-2FA'));
	}
	
	public function sendNew2FACode(){
		$this->send2FACode();
		$fMessage = new FlashMessage ( 'A new code was submited.', 'Two factor Authentification', 'success', 'key' );
		$this->newTwoFACodeMessage ( $fMessage );
		echo $this->fMessage ( $fMessage );
	}
	
	protected function generateEmailValidationUrl($email):array {
		$duration=$this->emailValidationDuration();
		$tokens=$this->getAuthTokensEmailValidation();
		$d=new \DateTime();
		$dExpire=$d->add($duration);
		$key=$tokens->store(['email'=>$email]);
		return ['url'=>$key.'/'.\md5($email),'expire'=>$dExpire];
	}
	
	protected function prepareEmailValidation(string $email){
		$data=$this->generateEmailValidationUrl($email);
		$validationURL=$this->getBaseUrl().'/checkEmail/'.$data['url'];
		$this->_sendEmailValidation($email, $validationURL,UDateTime::elapsed($data['expire']));
	}
	
	/**
	 * To override
	 * Checks an email.
	 *
	 * @param string $mail
	 * @return bool
	 */
	protected function validateEmail(string $mail):bool{
		return true;
	}

	/**
	 * To override for a more secure 2FA code.
	 * @param string $secret
	 * @param string $userInput
	 * @return bool
	 */
	protected function check2FACode(string $secret,string $userInput):bool{
		return $secret===$userInput;
	}
	
	/**
	 * Route for email validation checking when creating a new account.
	 * @param string $key
	 * @param string $hashMail
	 */
	public function checkEmail(string $key,string $hashMail){
		$isValid=false;
		$tokens=$this->getAuthTokensEmailValidation();
		if($tokens->exists($key)){
			if(!$tokens->expired($key)){
				$data=$tokens->fetch($key);
				$email=$data['email'];
				if(\md5($email)===$hashMail && $this->validateEmail($email)){
					$fMessage = new FlashMessage ( "Your email <b>$email</b> has been validated.", 'Account creation', 'success', 'user' );
					$this->emailValidationSuccess($fMessage);
					$isValid=true;
				}
				$msg='This validation link is not valid!';
			}else{
				$msg='This validation link is no longer active!';
			}
		}
		if(!$isValid){
			$fMessage = new FlashMessage ( $msg??'This validation link is not valid!', 'Account creation', 'error', 'user' );
			$this->emailValidationError($fMessage);
		}
		echo $this->fMessage($fMessage);
	}

	public function recoveryInit(){
		$fMessage = new FlashMessage( 'Enter the email associated with your account to receive a password reset link.', 'Account recovery', 'info', 'user' );
		$this->recoveryInitMessage ( $fMessage );

The method recoveryInitMessage() does not exist on Ubiquity\controllers\auth\AuthControllerValidationTrait. Did you maybe mean recoveryInit()?

		$message = $this->fMessage ( $fMessage );
		if($this->useAjax()){
			$frm=$this->jquery->semantic()->htmlForm('frm-account-recovery');
			$frm->addExtraFieldRules('email',['empty','email']);
			$frm->setValidationParams(['inline'=>true,'on'=>'blur']);
		}
		$this->authLoadView ( $this->_getFiles ()->getViewInitRecovery(), [ '_message' => $message,'submitURL' => $this->getBaseUrl ().'/recoveryInfo','bodySelector' => $this->_getBodySelector()] );
	}

	/**
	 * @post
	 */
	#[\Ubiquity\attributes\items\router\Post]
	public function recoveryInfo(){
		if(URequest::isPost()){
			if($this->isValidEmailForRecovery($email=URequest::filterPost('email',FILTER_VALIDATE_EMAIL))) {

It seems like $email = Ubiquity\utils\http\URequest::filterPost('email', Ubiquity\controllers\auth\FILTER_VALIDATE_EMAIL) can also be of type null; however, parameter $email of Ubiquity\controllers\auth\AuthControllerValidationTrait::isValidEmailForRecovery() does only seem to accept string, maybe add an additional type check?

				$this->prepareEmailAccountRecovery($email);

It seems like $email can also be of type null; however, parameter $email of Ubiquity\controllers\auth\AuthControllerValidationTrait::prepareEmailAccountRecovery() does only seem to accept string, maybe add an additional type check?

				$fMessage = new FlashMessage (sprintf('A password reset email has been sent to <b>%s</b>.<br>You can only use this link temporarily, from the same machine, on this browser.',$email), 'Account recovery', 'success', 'email');
				$this->recoveryEmailSendMessage($fMessage);
			}else{
				$fMessage = new FlashMessage (sprintf('No account is associated with the email address <b>%s</b>.<br><a href="%s" data-target="%s">Try again.</a>.',$email,$this->getBaseUrl().'/recoveryInit',$this->_getBodySelector()), 'Account recovery', 'error', 'user');
				$this->recoveryEmailErrorMessage($fMessage);
			}
			echo $this->fMessage ( $fMessage );
		}
	}

	public function recovery(string $key,string $hashMail) {
		$tokens = $this->getAuthTokensAccountRecovery();
		if ($tokens->exists($key)) {
			if (!$tokens->expired($key)) {
				$data = $tokens->fetch($key);
				if(\is_array($data)) {
					$email = $data['email'];
					if (\md5($email) === $hashMail && $this->validateEmail($email)) {
						$fMessage = new FlashMessage ("Enter a new password associated to the account <b>$email</b>.", 'Account recovery', 'success', 'user');
						$this->emailAccountRecoverySuccess($fMessage);

It seems like emailAccountRecoverySuccess() must be provided by classes using this trait. How about adding it as abstract method to this trait?

						$message=$this->fMessage($fMessage);
						if($this->useAjax()) {
							$frm = $this->_addFrmAjaxBehavior('frm-account-recovery');

It seems like _addFrmAjaxBehavior() must be provided by classes using this trait. How about adding it as abstract method to this trait?

							$passwordInputName = $this->_getPasswordInputName();

It seems like _getPasswordInputName() must be provided by classes using this trait. How about adding it as abstract method to this trait?

							$frm->addExtraFieldRules($passwordInputName . '-conf', ['empty', "match[$passwordInputName]"]);
						}
						$this->authLoadView ( $this->_getFiles ()->getViewRecovery(), [ 'key'=>$key,'email'=>$email,'_message' => $message,'submitURL' => $this->getBaseUrl ().'/recoverySubmit','bodySelector' => $this->_getBodySelector(),'passwordInputName' => $this->_getPasswordInputName (),'passwordLabel' => $this->passwordLabel (),'passwordConfLabel'=>$this->passwordConfLabel()] );

It seems like passwordConfLabel() must be provided by classes using this trait. How about adding it as abstract method to this trait?

It seems like passwordLabel() must be provided by classes using this trait. How about adding it as abstract method to this trait?

						return ;
					}
				}
				$msg = 'This recovery link was not generated on this device!';
			} else {
				$msg = 'This recovery link is no longer active!';
			}
		}
		$fMessage = new FlashMessage ($msg ?? 'This account recovery link is not valid!', 'Account recovery', 'error', 'user');
		$this->emailAccountRecoveryError($fMessage);

It seems like emailAccountRecoveryError() must be provided by classes using this trait. How about adding it as abstract method to this trait?

		echo $this->fMessage($fMessage);
	}

	protected function generateEmailAccountRecoveryUrl($email):array {
		$duration=$this->accountRecoveryDuration();
		$tokens=$this->getAuthTokensAccountRecovery();
		$d=new \DateTime();
		$dExpire=$d->add($duration);
		$key=$tokens->store(['email'=>$email]);
		return ['url'=>$key.'/'.\md5($email),'expire'=>$dExpire];
	}

	protected function prepareEmailAccountRecovery(string $email){
		$data=$this->generateEmailAccountRecoveryUrl($email);
		$validationURL=$this->getBaseUrl().'/recovery/'.$data['url'];
		$this->_sendEmailAccountRecovery($email, $validationURL,UDateTime::elapsed($data['expire']));
	}

	/**
	 * @post
	 */
	#[\Ubiquity\attributes\items\router\Post]
	public function recoverySubmit(){
		if(URequest::isPost() && URequest::has('key')){
			$tokens = $this->getAuthTokensAccountRecovery();
			$key=URequest::post('key');
			if ($tokens->exists($key)) {

It seems like $key can also be of type null; however, parameter $token of Ubiquity\controllers\auth\AuthTokens::exists() does only seem to accept string, maybe add an additional type check?

				if(!$tokens->expired($key)){

It seems like $key can also be of type null; however, parameter $token of Ubiquity\controllers\auth\AuthTokens::expired() does only seem to accept string, maybe add an additional type check?

					$data=$tokens->fetch($key);
					$email=$data['email'];
					if($email===URequest::post('email')){
						if($this->passwordResetAction($email,URequest::password_hash('password'))){
							$fMessage = new FlashMessage ("Your password has been updated correctly for the account associated with <b>$email</b>.", 'Account recovery', 'success', 'user');
							$this->resetPasswordSuccessMessage($fMessage);
							echo $this->info(true);

It seems like info() must be provided by classes using this trait. How about adding it as abstract method to this trait?

							$isValid=true;
						}else{
							$msg='An error occurs when updating your password!';
						}
					}
				}else{
					$msg='This account recovery link is expired!';
				}
				$tokens->remove($key);

It seems like $key can also be of type null; however, parameter $token of Ubiquity\controllers\auth\AuthTokens::remove() does only seem to accept string, maybe add an additional type check?

			}
			if(!$isValid){

The variable $isValid does not seem to be defined for all execution paths leading up to this point.

				$fMessage = new FlashMessage ($msg, 'Account recovery', 'error', 'user');

The variable $msg does not seem to be defined for all execution paths leading up to this point.

				$this->resetPasswordErrorMessage($fMessage);
			}
			echo $this->fMessage($fMessage);

The variable $fMessage does not seem to be defined for all execution paths leading up to this point.

		}
	}
}