feat(core/otp): Add test cases for share creation/deletion/retrieval/persistence with OTPs

Signed-off-by: Tobias Knöppler <tobias@knoeppler.org>

Author: theCalcaholic

lib/private/Share20/DefaultShareProvider.php

@@ -1137,8 +1137,6 @@ private function createShare($data): IShare {
 		} elseif ($share->getShareType() === IShare::TYPE_LINK) {
 			$share->setPassword($data['password']);
 			$share->setSendPasswordByTalk((bool)$data['password_by_talk']);
-			$passwordExpirationTime = \DateTime::createFromFormat('Y-m-d H:i:s', $data['password_expiration_time'] ?? '');
-			$share->setPasswordExpirationTime($passwordExpirationTime !== false ? $passwordExpirationTime : null);
 			$share->setToken($data['token']);
 		}
 

tests/lib/Share20/DefaultShareProviderTest.php

@@ -9,6 +9,7 @@
 namespace Test\Share20;
 
 use OC\Files\Node\Node;
+use OC\OneTimePassword\OneTimePassword;
 use OC\Share20\DefaultShareProvider;
 use OC\Share20\Exception\ProviderException;
 use OC\Share20\Share;
@@ -881,6 +882,15 @@ public function testCreateLinkShare(): void {
 		$share->setExpirationDate($expireDate);
 		$share->setTarget('/target');
 
+		$qb = $this->dbConn->getQueryBuilder();
+		$qb->insert('one_time_password')
+			->setValue('provider', $qb->createNamedParameter('mock'))
+			->setValue('recipient', $qb->createNamedParameter('recipient'));
+		$qb->executeStatement();
+		$otpId = $qb->getLastInsertId();
+
+		$share->setOneTimePassword((new OneTimePassword('mock', 'recipient'))->setId($otpId));
+
 		$share2 = $this->provider->create($share);
 
 		$this->assertNotNull($share2->getId());
@@ -896,16 +906,28 @@ public function testCreateLinkShare(): void {
 		$this->assertSame(true, $share2->getSendPasswordByTalk());
 		$this->assertSame('token', $share2->getToken());
 		$this->assertEquals($expireDate->getTimestamp(), $share2->getExpirationDate()->getTimestamp());
+		$this->assertEquals('mock', $share2->getOneTimePassword()->getProviderId());
+		$this->assertEquals('recipient', $share2->getOneTimePassword()->getRecipient());
 	}
 
 	public function testGetShareByToken(): void {
 		$qb = $this->dbConn->getQueryBuilder();
 
+		$qb->insert('one_time_password')
+			->values([
+				'provider' => $qb->expr()->literal('mock'),
+				'recipient' => $qb->expr()->literal('recipient')
+			]);
+		$qb->executeStatement();
+		$otpId = $qb->getLastInsertId();
+
+		$qb = $this->dbConn->getQueryBuilder();
 		$qb->insert('share')
 			->values([
 				'share_type' => $qb->expr()->literal(IShare::TYPE_LINK),
 				'password' => $qb->expr()->literal('password'),
 				'password_by_talk' => $qb->expr()->literal(true),
+				'one_time_password' => $qb->expr()->literal($otpId),
 				'uid_owner' => $qb->expr()->literal('shareOwner'),
 				'uid_initiator' => $qb->expr()->literal('sharedBy'),
 				'item_type' => $qb->expr()->literal('file'),
@@ -922,6 +944,12 @@ public function testGetShareByToken(): void {
 
 		$this->rootFolder->method('getUserFolder')->with('shareOwner')->willReturnSelf();
 		$this->rootFolder->method('getFirstNodeById')->with(42)->willReturn($file);
+		$this->otpManager->method('getOTP')->willReturnCallback(function (int $id) use ($otpId) {
+			if ($id === $otpId) {
+				return (new OneTimePassword('mock', 'recipient'))->setId($id);
+			}
+			throw new \Exception("Unexpected otp id: " . $id);
+		});
 
 		$share = $this->provider->getShareByToken('secrettoken');
 		$this->assertEquals($id, $share->getId());
@@ -932,6 +960,8 @@ public function testGetShareByToken(): void {
 		$this->assertSame('the label', $share->getLabel());
 		$this->assertSame(true, $share->getSendPasswordByTalk());
 		$this->assertSame(null, $share->getSharedWith());
+		$this->assertSame('mock', $share->getOneTimePassword()->getProviderId());
+		$this->assertSame('recipient', $share->getOneTimePassword()->getRecipient());
 	}
 
 	/**

tests/lib/Share20/ManagerTest.php

@@ -11,6 +11,7 @@
 use DateTimeZone;
 use OC\Files\Utils\PathHelper;
 use OC\KnownUser\KnownUserService;
+use OC\OneTimePassword\OneTimePassword;
 use OC\Share20\DefaultShareProvider;
 use OC\Share20\Exception\ProviderException;
 use OC\Share20\Manager;
@@ -222,15 +223,15 @@ public function testDeleteNoShareId(): void {
 
 	public static function dataTestDelete(): array {
 		return [
-			[IShare::TYPE_USER, 'sharedWithUser'],
-			[IShare::TYPE_GROUP, 'sharedWithGroup'],
-			[IShare::TYPE_LINK, ''],
-			[IShare::TYPE_REMOTE, 'foo@bar.com'],
+			[IShare::TYPE_USER, 'sharedWithUser', 1],
+			[IShare::TYPE_GROUP, 'sharedWithGroup', 5],
+			[IShare::TYPE_LINK, '', 2],
+			[IShare::TYPE_REMOTE, 'foo@bar.com', 1],
 		];
 	}
 
 	#[DataProvider('dataTestDelete')]
-	public function testDelete($shareType, $sharedWith): void {
+	public function testDelete($shareType, $sharedWith, $otpId): void {
 		$manager = $this->createManagerMock()
 			->onlyMethods(['getShareById', 'deleteChildren', 'promoteReshares'])
 			->getMock();
@@ -240,17 +241,20 @@ public function testDelete($shareType, $sharedWith): void {
 		$path = $this->createMock(File::class);
 		$path->method('getId')->willReturn(1);
 
+		$otp = (new OneTimePassword('mock', 'rec'))->setId($otpId);
 		$share = $this->manager->newShare();
 		$share->setId(42)
 			->setProviderId('prov')
 			->setShareType($shareType)
 			->setSharedWith($sharedWith)
 			->setSharedBy('sharedBy')
+			->setOneTimePassword($otp)
 			->setNode($path)
 			->setTarget('myTarget');
 
 		$manager->expects($this->once())->method('deleteChildren')->with($share);
 		$manager->expects($this->once())->method('promoteReshares')->with($share);
+		$this->otpManager->expects($this->once())->method('deleteOTP')->with($otpId);
 
 		$this->defaultProvider
 			->expects($this->once())
@@ -3602,6 +3606,35 @@ public function testCheckPasswordUpdateShare(): void {
 		$this->assertTrue($this->manager->checkPassword($share, 'password'));
 	}
 
+	public static function dataTestCheckPasswordOTP() {
+		return [
+			[null, (new OneTimePassword('mock', 'rec'))->setPassword(null), 'password', false],
+			[null, (new OneTimePassword('mock', 'rec'))->setPassword('hashed(password)'), 'password', true],
+			['hashed(password)', (new OneTimePassword('mock', 'rec'))->setPassword(null), 'password', false], // OTP should take precedence
+		];
+	}
+
+	#[DataProvider('dataTestCheckPasswordOTP')]
+	public function testCheckPasswordOTP(?string $pwHash, ?OneTimePassword $otp, string $password, bool $expected): void {
+		$share = $this->manager->newShare()
+			->setShareType(IShare::TYPE_LINK)
+			->setPassword($pwHash)
+			->setOneTimePassword($otp);
+
+		$this->hasher->method('verify')->willReturnCallback(function (string $pwHash, string $pw, &$newHash): bool {
+			return "hashed($pw)" === $pwHash;
+		});
+		$this->otpManager->method('validateOTP')->willReturnCallback(function(OneTimePassword $otp, ?string $password): bool {
+			if ($otp->getPassword() === null) {
+				return false;
+			}
+			return $this->hasher->verify($otp->getPassword(), $password, $newHash);
+		});
+
+		$actual = $this->manager->checkPassword($share, $password);
+		$this->assertEquals($expected, $actual, "Password check " . ($actual ? "succeeded" : "failed") . " unexpectedly");
+	}
+
 	public function testUpdateShareCantChangeShareType(): void {
 		$this->expectException(\Exception::class);
 		$this->expectExceptionMessage('Cannot change share type');