mirror of
https://github.com/nextcloud/server.git
synced 2026-11-21 12:25:08 +01:00
The unified sharing API (behind sharing.unified_api_enable) changed shares, their sources, recipients, permissions, properties and recipient secrets without any audit entry. SharingManager now writes one entry per change, with unified_sharing.* operations, so they can be told apart from the legacy sharing.share.* entries, which carry different parameters. Recipient secrets (the public link token) and property values are never logged. Assisted-by: ClaudeCode:claude-opus-5-5 Signed-off-by: Ghassen kefi <ghassen.kefi.dev@gmail.com>
378 lines
16 KiB
PHP
378 lines
16 KiB
PHP
<?php
|
|
|
|
/*
|
|
* SPDX-FileCopyrightText: 2026 Nextcloud GmbH and Nextcloud contributors
|
|
* SPDX-License-Identifier: AGPL-3.0-or-later
|
|
*/
|
|
|
|
declare(strict_types=1);
|
|
|
|
namespace Test\Sharing;
|
|
|
|
use Exception;
|
|
use NCU\Sharing\Permission\SharePermission;
|
|
use NCU\Sharing\Property\ShareProperty;
|
|
use NCU\Sharing\Recipient\ShareRecipient;
|
|
use NCU\Sharing\Share;
|
|
use NCU\Sharing\ShareAccessContext;
|
|
use NCU\Sharing\ShareState;
|
|
use NCU\Sharing\ShareUserStatus;
|
|
use NCU\Sharing\Source\ShareSource;
|
|
use OC\Sharing\SharingManager;
|
|
use OCP\EventDispatcher\IEventDispatcher;
|
|
use OCP\IURLGenerator;
|
|
use OCP\IUserManager;
|
|
use OCP\L10N\IFactory;
|
|
use OCP\Log\Audit\CriticalActionPerformedEvent;
|
|
use OCP\Server;
|
|
use PHPUnit\Framework\Attributes\Group;
|
|
|
|
#[Group(name: 'DB')]
|
|
final class SharingManagerTest extends AbstractSharingManagerTests {
|
|
private function assertShareSyncedWithDb(ShareAccessContext $accessContext, Share $share): void {
|
|
$retrieved = $this->manager->getShare($accessContext, $share->id);
|
|
// don't compare time at sub-ms accuracy
|
|
$this->assertEquals(SharingManager::timeToMs($retrieved->lastUpdated), SharingManager::timeToMs($share->lastUpdated));
|
|
|
|
// now we compared the lastUpdated, make them the same to not fail the full comparison when there is a sub-ms lastUpdate difference
|
|
$retrieved = new Share(
|
|
$retrieved->id,
|
|
$retrieved->owner,
|
|
$share->lastUpdated,
|
|
$retrieved->state,
|
|
$retrieved->userStatus,
|
|
$retrieved->sources,
|
|
$retrieved->recipients,
|
|
$retrieved->properties,
|
|
$retrieved->permissions
|
|
);
|
|
|
|
// cache the enabled permissions for both
|
|
foreach ([$retrieved, $share] as $item) {
|
|
$item->getEffectiveEnabledPermissions(new ShareAccessContext(overrideChecks: true));
|
|
$item->getEffectiveEnabledPermissions(new ShareAccessContext($this->owner));
|
|
$item->getEffectiveEnabledPermissions(new ShareAccessContext($this->user1));
|
|
$item->getEffectiveEnabledPermissions(new ShareAccessContext($this->user2));
|
|
foreach ($item->recipients as $recipient) {
|
|
$recipient->getDisabledPermissions();
|
|
}
|
|
|
|
// ensure source metadata is loaded
|
|
foreach ($item->sources as $source) {
|
|
$source->format($this->registry, $this->l10nFactory, false);
|
|
}
|
|
}
|
|
|
|
$this->assertEquals($retrieved, $share, 'share object not in sync with database');
|
|
}
|
|
|
|
#[\Override]
|
|
protected function searchRecipients(ShareAccessContext $accessContext, ?array $filterRecipientTypeClasses, string $query, int $limit, int $offset, ?Share $forShare = null): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
if ($forShare instanceof Share) {
|
|
$this->assertShareSyncedWithDb($accessContext, $forShare);
|
|
}
|
|
|
|
/** @psalm-suppress ArgumentTypeCoercion */
|
|
$recipients = ShareRecipient::formatMultiple($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $this->manager->searchRecipients($accessContext, $filterRecipientTypeClasses, $query, $limit, $offset, $forShare));
|
|
$this->dbConnection->commit();
|
|
return $recipients;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function createShare(ShareAccessContext $accessContext): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->createShare($accessContext);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateShareState(ShareAccessContext $accessContext, Share $share, ShareState $state): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateShareState($accessContext, $share, $state);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateShareUserStatus(ShareAccessContext $accessContext, Share $share, ShareUserStatus $userStatus): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateShareUserStatus($accessContext, $share, $userStatus);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function addShareSource(ShareAccessContext $accessContext, Share $share, ShareSource $source): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->addShareSource($accessContext, $share, $source);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function removeShareSource(ShareAccessContext $accessContext, Share $share, ShareSource $source): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $this->manager->removeShareSource($accessContext, $share, $source);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function addShareRecipient(ShareAccessContext $accessContext, Share $share, ShareRecipient $recipient): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->addShareRecipient($accessContext, $share, $recipient);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function removeShareRecipient(ShareAccessContext $accessContext, Share $share, ShareRecipient $recipient): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->removeShareRecipient($accessContext, $share, $recipient);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateShareRecipientSecret(ShareAccessContext $accessContext, Share $share, ShareRecipient $recipient, string $secret): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateShareRecipientSecret($accessContext, $share, $recipient, $secret);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateShareProperty(ShareAccessContext $accessContext, Share $share, ShareProperty $property): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateShareProperty($accessContext, $share, $property);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateSharePermission(ShareAccessContext $accessContext, Share $share, SharePermission $permission): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateSharePermission($accessContext, $share, $permission);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function updateShareRecipientPermission(ShareAccessContext $accessContext, Share $share, ShareRecipient $recipient, SharePermission $permission): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->updateShareRecipientPermission($accessContext, $share, $recipient, $permission);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function selectSharePermissionPreset(ShareAccessContext $accessContext, Share $share, string $permissionPresetClass): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
/** @psalm-suppress ArgumentTypeCoercion */
|
|
$share = $this->manager->selectSharePermissionPreset($accessContext, $share, $permissionPresetClass);
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$share = $share->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function deleteShare(ShareAccessContext $accessContext, Share $share): void {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$this->assertShareSyncedWithDb($accessContext, $share);
|
|
$this->manager->deleteShare($accessContext, $share);
|
|
$this->dbConnection->commit();
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function getShare(ShareAccessContext $accessContext, string $id): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->getShare($accessContext, $id)->format($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext);
|
|
$this->dbConnection->commit();
|
|
return $share;
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
#[\Override]
|
|
protected function getShares(ShareAccessContext $accessContext, ?string $filterSourceTypeClass, ?string $filterSourceTypeValue, ?ShareState $filterState, ?ShareUserStatus $filterUserStatus, ?string $lastShareID, ?int $limit): array {
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
/** @psalm-suppress ArgumentTypeCoercion */
|
|
$shares = $this->manager->getShares($accessContext, $filterSourceTypeClass, $filterSourceTypeValue, $filterState, $filterUserStatus, $lastShareID, $limit);
|
|
$this->dbConnection->commit();
|
|
return Share::formatMultiple($this->registry, Server::get(IFactory::class), Server::get(IURLGenerator::class), Server::get(IUserManager::class), $accessContext, $shares);
|
|
} catch (Exception $exception) {
|
|
$this->dbConnection->rollBack();
|
|
throw $exception;
|
|
}
|
|
}
|
|
|
|
public function testAuditLog(): void {
|
|
$this->registry->registerRecipientType(new TestShareRecipientTypePublicSecret(['recipient1' => 'Recipient 1'], [], true, true));
|
|
|
|
$auditEvents = [];
|
|
$listener = static function (CriticalActionPerformedEvent $event) use (&$auditEvents): void {
|
|
if (str_starts_with($event->getOperation() ?? '', 'unified_sharing.')) {
|
|
$auditEvents[] = $event;
|
|
}
|
|
};
|
|
$eventDispatcher = Server::get(IEventDispatcher::class);
|
|
$eventDispatcher->addListener(CriticalActionPerformedEvent::class, $listener);
|
|
|
|
$accessContext = new ShareAccessContext($this->owner);
|
|
$recipient = new ShareRecipient(TestShareRecipientType1::class, 'recipient1', null);
|
|
$secretRecipient = new ShareRecipient(TestShareRecipientTypePublicSecret::class, 'recipient1', null);
|
|
|
|
try {
|
|
$this->dbConnection->beginTransaction();
|
|
$share = $this->manager->createShare($accessContext);
|
|
$share = $this->manager->addShareSource($accessContext, $share, new ShareSource(TestShareSourceType1::class, 'source1'));
|
|
$share = $this->manager->addShareRecipient($accessContext, $share, $recipient);
|
|
$share = $this->manager->updateSharePermission($accessContext, $share, new SharePermission(TestSharePermissionType1::class, true));
|
|
$share = $this->manager->updateShareProperty($accessContext, $share, new ShareProperty(TestSharePropertyType1::class, 'valid1'));
|
|
$share = $this->manager->updateShareState($accessContext, $share, ShareState::Active);
|
|
$share = $this->manager->addShareRecipient($accessContext, $share, $secretRecipient);
|
|
$share = $this->manager->updateShareRecipientSecret($accessContext, $share, $secretRecipient, 'mysecret');
|
|
$share = $this->manager->updateShareRecipientPermission($accessContext, $share, $recipient, new SharePermission(TestSharePermissionType1::class, false));
|
|
$share = $this->manager->selectSharePermissionPreset($accessContext, $share, TestSharePermissionPreset1::class);
|
|
$recipientContext = new ShareAccessContext($this->user1);
|
|
$this->manager->updateShareUserStatus($recipientContext, $this->manager->getShare($recipientContext, $share->id), ShareUserStatus::Accepted);
|
|
$share = $this->manager->removeShareRecipient($accessContext, $share, $secretRecipient);
|
|
$share = $this->manager->removeShareSource($accessContext, $share, new ShareSource(TestShareSourceType1::class, 'source1'));
|
|
$this->manager->deleteShare($accessContext, $share);
|
|
$this->dbConnection->commit();
|
|
} finally {
|
|
$eventDispatcher->removeListener(CriticalActionPerformedEvent::class, $listener);
|
|
}
|
|
|
|
$this->assertSame([
|
|
'unified_sharing.share.created',
|
|
'unified_sharing.source.added',
|
|
'unified_sharing.recipient.added',
|
|
'unified_sharing.permission.updated',
|
|
'unified_sharing.property.updated',
|
|
'unified_sharing.share.state_updated',
|
|
'unified_sharing.recipient.added',
|
|
'unified_sharing.recipient_secret.updated',
|
|
'unified_sharing.recipient_permission.updated',
|
|
'unified_sharing.permission_preset.selected',
|
|
'unified_sharing.share.user_status_updated',
|
|
'unified_sharing.recipient.removed',
|
|
'unified_sharing.source.removed',
|
|
'unified_sharing.share.deleted',
|
|
], array_map(static fn (CriticalActionPerformedEvent $event): ?string => $event->getOperation(), $auditEvents));
|
|
|
|
$this->assertSame([
|
|
'shareId' => $share->id,
|
|
'recipientClass' => TestShareRecipientType1::class,
|
|
'recipientValue' => 'recipient1',
|
|
'instance' => 'local',
|
|
], $auditEvents[2]->getParameters());
|
|
$this->assertSame(['shareId' => $share->id, 'userStatus' => 'accepted', 'user' => 'user1'], $auditEvents[10]->getParameters());
|
|
$this->assertSame(['shareId' => $share->id, 'owner' => 'owner'], $auditEvents[13]->getParameters());
|
|
|
|
foreach ($auditEvents as $event) {
|
|
$this->assertNotContains('mysecret', $event->getParameters(), 'The recipient secret must not be logged');
|
|
}
|
|
}
|
|
}
|