Files
sysPass/lib/SP/Domain/Account/Services/AccountAclService.php
Rubén D 1c8fb0ea1a refactor: [WIP] Use hexagonal architecture and implement interfaces for services and repositories.
Controllers are being splited into commands to better dependency management.

Signed-off-by: Rubén D <nuxsmin@syspass.org>
2022-06-06 08:17:34 +02:00

422 lines
13 KiB
PHP

<?php
/*
* sysPass
*
* @author nuxsmin
* @link https://syspass.org
* @copyright 2012-2022, Rubén Domínguez nuxsmin@$syspass.org
*
* This file is part of sysPass.
*
* sysPass is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* sysPass 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 General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with sysPass. If not, see <http://www.gnu.org/licenses/>.
*/
namespace SP\Domain\Account\Services;
use SP\Core\Acl\Acl;
use SP\Core\Acl\ActionsInterface;
use SP\Core\Application;
use SP\Core\Exceptions\ConstraintException;
use SP\Core\Exceptions\FileNotFoundException;
use SP\Core\Exceptions\QueryException;
use SP\DataModel\Dto\AccountAclDto;
use SP\DataModel\ProfileData;
use SP\Domain\Account\AccountAclServiceInterface;
use SP\Domain\Common\Services\Service;
use SP\Domain\User\Services\UserLoginResponse;
use SP\Domain\User\UserToUserGroupServiceInterface;
use SP\Infrastructure\File\FileCache;
use SP\Infrastructure\File\FileCacheInterface;
use SP\Infrastructure\File\FileException;
use SP\Util\FileUtil;
/**
* Class AccountAclService
*
* @package SP\Domain\Account\Services
*/
final class AccountAclService extends Service implements AccountAclServiceInterface
{
/**
* ACL's file base path
*/
public const ACL_PATH = CACHE_PATH.DIRECTORY_SEPARATOR.'accountAcl'.DIRECTORY_SEPARATOR;
public static bool $useCache = true;
private ?AccountAclDto $accountAclDto = null;
private ?AccountAcl $accountAcl = null;
private Acl $acl;
private UserToUserGroupServiceInterface $userToUserGroupService;
private UserLoginResponse $userData;
public function __construct(Application $application, Acl $acl, UserToUserGroupServiceInterface $userGroupService)
{
parent::__construct($application);
$this->acl = $acl;
$this->userToUserGroupService = $userGroupService;
$this->userData = $this->context->getUserData();
}
/**
* @param $userId
*
* @return bool
*/
public static function clearAcl($userId): bool
{
logger(sprintf('Clearing ACL for user ID: %d', $userId));
try {
if (FileUtil::rmdir_recursive(self::ACL_PATH.$userId) === false) {
logger(sprintf('Unable to delete %s directory', self::ACL_PATH.$userId));
return false;
}
return true;
} catch (FileNotFoundException $e) {
processException($e);
}
return false;
}
/**
* Obtener la ACL de una cuenta
*
* @param int $actionId
* @param AccountAclDto|null $accountAclDto
* @param bool $isHistory
*
* @return AccountAcl
* @throws ConstraintException
* @throws QueryException
*/
public function getAcl(int $actionId, ?AccountAclDto $accountAclDto = null, bool $isHistory = false): AccountAcl
{
$this->accountAcl = new AccountAcl($actionId, $isHistory);
$this->accountAcl->setShowPermission(
self::getShowPermission($this->context->getUserData(), $this->context->getUserProfile())
);
if ($accountAclDto !== null) {
$this->accountAclDto = $accountAclDto;
$accountAcl = $this->getAclFromCache($accountAclDto->getAccountId(), $actionId);
if (self::$useCache && null !== $accountAcl) {
$this->accountAcl->setModified(
(
$accountAclDto->getDateEdit() > $accountAcl->getTime()
|| $this->userData->getLastUpdate() > $accountAcl->getTime()
)
);
if (!$this->accountAcl->isModified()) {
logger('Account ACL HIT');
return $accountAcl;
}
}
logger('Account ACL MISS');
$this->accountAcl->setAccountId($accountAclDto->getAccountId());
return $this->updateAcl();
}
return $this->accountAcl;
}
/**
* Sets grants which don't need the account's data
*
* @param UserLoginResponse $userData
* @param ProfileData $profileData
*
* @return bool
*/
public static function getShowPermission(UserLoginResponse $userData, ProfileData $profileData): bool
{
return $userData->getIsAdminApp()
|| $userData->getIsAdminAcc()
|| $profileData->isAccPermission();
}
/**
* Resturns an stored ACL
*
* @param int $accountId
* @param int $actionId
*
* @return AccountAcl
*/
public function getAclFromCache(int $accountId, int $actionId): ?AccountAcl
{
try {
$acl = FileCache::factory($this->getCacheFileForAcl($accountId, $actionId))->load();
if ($acl instanceof AccountAcl) {
return $acl;
}
} catch (FileException $e) {
logger($e->getMessage());
}
return null;
}
/**
* @param int $accountId
* @param int $actionId
*
* @return string
*/
public function getCacheFileForAcl(int $accountId, int $actionId): string
{
$userId = $this->context->getUserData()->getId();
return self::ACL_PATH
.$userId
.DIRECTORY_SEPARATOR
.$accountId
.DIRECTORY_SEPARATOR
.md5($userId.$accountId.$actionId)
.'.cache';
}
/**
* Actualizar la ACL
*
* @return AccountAcl
* @throws ConstraintException
* @throws QueryException
*/
private function updateAcl(): AccountAcl
{
if ($this->checkComponents()) {
$this->makeAcl();
}
if (self::$useCache) {
$this->saveAclInCache($this->accountAcl);
}
return $this->accountAcl;
}
/**
* @return bool
*/
private function checkComponents(): bool
{
return null !== $this->accountAclDto;
}
/**
* Crear la ACL de una cuenta
*
* @throws ConstraintException
* @throws QueryException
*/
private function makeAcl(): void
{
$this->compileAccountAccess();
$this->accountAcl->setCompiledAccountAccess(true);
$this->compileShowAccess();
$this->accountAcl->setCompiledShowAccess(true);
$this->accountAcl->setTime(time());
}
/**
* @throws ConstraintException
* @throws QueryException
*/
private function compileAccountAccess(): void
{
$this->accountAcl->setResultView(false);
$this->accountAcl->setResultEdit(false);
// Check out if user is admin or owner/maingroup
if ($this->userData->getIsAdminApp()
|| $this->userData->getIsAdminAcc()
|| $this->userData->getId() === $this->accountAclDto->getUserId()
|| $this->userData->getUserGroupId() === $this->accountAclDto->getUserGroupId()
) {
$this->accountAcl->setResultView(true);
$this->accountAcl->setResultEdit(true);
return;
}
// Check out if user is listed in secondary users of the account
$userInUsers = $this->getUserInSecondaryUsers($this->userData->getId());
$this->accountAcl->setUserInUsers(count($userInUsers) > 0);
if ($this->accountAcl->isUserInUsers()) {
$this->accountAcl->setResultView(true);
$this->accountAcl->setResultEdit((int)$userInUsers[0]->isEdit === 1);
return;
}
// Analyze user's groups
// Groups in which the user is listed in
$userGroups = array_map(
static fn($value) => (int)$value->userGroupId,
$this->userToUserGroupService->getGroupsForUser($this->userData->getId())
);
// Check out if user groups match with account's main group
if ($this->getUserGroupsInMainGroup($userGroups)) {
$this->accountAcl->setUserInGroups(true);
$this->accountAcl->setResultView(true);
$this->accountAcl->setResultEdit(true);
return;
}
// Check out if user groups match with account's secondary groups
$userGroupsInSecondaryUserGroups =
$this->getUserGroupsInSecondaryGroups(
$userGroups,
$this->userData->getUserGroupId()
);
$this->accountAcl->setUserInGroups(count($userGroupsInSecondaryUserGroups) > 0);
if ($this->accountAcl->isUserInGroups()) {
$this->accountAcl->setResultView(true);
$this->accountAcl->setResultEdit((int)$userGroupsInSecondaryUserGroups[0]->isEdit === 1);
}
}
/**
* Checks if the user is listed in the account users
*
* @param int $userId
*
* @return array
*/
private function getUserInSecondaryUsers(int $userId): array
{
return array_values(
array_filter(
$this->accountAclDto->getUsersId(),
static function ($value) use ($userId) {
return (int)$value->id === $userId;
}
)
);
}
/**
* Comprobar si los grupos del usuario está vinculado desde el grupo principal de la cuenta
*
* @param array $userGroups
*
* @return bool
*/
private function getUserGroupsInMainGroup(array $userGroups): bool
{
// Comprobar si el usuario está vinculado desde el grupo principal de la cuenta
return in_array($this->accountAclDto->getUserGroupId(), $userGroups, true);
}
/**
* Comprobar si el usuario o el grupo del usuario se encuentran los grupos asociados a la
* cuenta.
*
* @param array $userGroups
* @param int $userGroupId
*
* @return array
*/
private function getUserGroupsInSecondaryGroups(array $userGroups, int $userGroupId): array
{
$isAccountFullGroupAccess = $this->config->getConfigData()->isAccountFullGroupAccess();
// Comprobar si el grupo del usuario está vinculado desde los grupos secundarios de la cuenta
return array_values(
array_filter(
$this->accountAclDto->getUserGroupsId(),
static function ($value) use ($userGroupId, $isAccountFullGroupAccess, $userGroups) {
return (int)$value->id === $userGroupId
// o... permitir los grupos que no sean el principal del usuario?
|| ($isAccountFullGroupAccess
// Comprobar si el usuario está vinculado desde los grupos secundarios de la cuenta
&& in_array((int)$value->id, $userGroups, true));
}
)
);
}
/**
* compileShowAccess
*/
private function compileShowAccess(): void
{
// Mostrar historial
$this->accountAcl->setShowHistory($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_HISTORY_VIEW));
// Mostrar lista archivos
$this->accountAcl->setShowFiles($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_FILE));
// Mostrar acción de ver clave
$this->accountAcl->setShowViewPass($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_VIEW_PASS));
// Mostrar acción de editar
$this->accountAcl->setShowEdit($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_EDIT));
// Mostrar acción de editar clave
$this->accountAcl->setShowEditPass($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_EDIT_PASS));
// Mostrar acción de eliminar
$this->accountAcl->setShowDelete($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_DELETE));
// Mostrar acción de restaurar
$this->accountAcl->setShowRestore($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_EDIT));
// Mostrar acción de enlace público
$this->accountAcl->setShowLink($this->acl->checkUserAccess(ActionsInterface::PUBLICLINK_CREATE));
// Mostrar acción de ver cuenta
$this->accountAcl->setShowView($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_VIEW));
// Mostrar acción de copiar cuenta
$this->accountAcl->setShowCopy($this->acl->checkUserAccess(ActionsInterface::ACCOUNT_COPY));
}
/**
* Saves the ACL
*
* @param AccountAcl $accountAcl
*
* @return null|FileCacheInterface
*/
public function saveAclInCache(AccountAcl $accountAcl): ?FileCacheInterface
{
try {
return FileCache::factory(
$this->getCacheFileForAcl($accountAcl->getAccountId(), $accountAcl->getActionId())
)->save($accountAcl);
} catch (FileException $e) {
return null;
}
}
}