-
-
Notifications
You must be signed in to change notification settings - Fork 4k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #21416 from nextcloud/fix/user-deleted-token-cleanup
Clean up auth tokens when user is deleted
- Loading branch information
Showing
5 changed files
with
193 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
72 changes: 72 additions & 0 deletions
72
lib/private/Authentication/Listeners/UserDeletedTokenCleanupListener.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,72 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/** | ||
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at> | ||
* | ||
* @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program 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 Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
namespace OC\Authentication\Listeners; | ||
|
||
use OC\Authentication\Token\Manager; | ||
use OCP\EventDispatcher\Event; | ||
use OCP\EventDispatcher\IEventListener; | ||
use OCP\ILogger; | ||
use OCP\User\Events\UserDeletedEvent; | ||
use Throwable; | ||
|
||
class UserDeletedTokenCleanupListener implements IEventListener { | ||
|
||
/** @var Manager */ | ||
private $manager; | ||
|
||
/** @var ILogger */ | ||
private $logger; | ||
|
||
public function __construct(Manager $manager, | ||
ILogger $logger) { | ||
$this->manager = $manager; | ||
$this->logger = $logger; | ||
} | ||
|
||
public function handle(Event $event): void { | ||
if (!($event instanceof UserDeletedEvent)) { | ||
// Unrelated | ||
return; | ||
} | ||
|
||
/** | ||
* Catch any exception during this process as any failure here shouldn't block the | ||
* user deletion. | ||
*/ | ||
try { | ||
$uid = $event->getUser()->getUID(); | ||
$tokens = $this->manager->getTokenByUser($uid); | ||
foreach ($tokens as $token) { | ||
$this->manager->invalidateTokenById($uid, $token->getId()); | ||
} | ||
} catch (Throwable $e) { | ||
$this->logger->logException($e, [ | ||
'message' => 'Could not clean up auth tokens after user deletion: ' . $e->getMessage(), | ||
'error' => ILogger::ERROR, | ||
]); | ||
} | ||
} | ||
} |
117 changes: 117 additions & 0 deletions
117
tests/lib/Authentication/Listeners/UserDeletedTokenCleanupListenerTest.php
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,117 @@ | ||
<?php | ||
|
||
declare(strict_types=1); | ||
|
||
/** | ||
* @copyright 2020 Christoph Wurst <christoph@winzerhof-wurst.at> | ||
* | ||
* @author 2020 Christoph Wurst <christoph@winzerhof-wurst.at> | ||
* | ||
* @license GNU AGPL version 3 or any later version | ||
* | ||
* This program is free software: you can redistribute it and/or modify | ||
* it under the terms of the GNU Affero General Public License as | ||
* published by the Free Software Foundation, either version 3 of the | ||
* License, or (at your option) any later version. | ||
* | ||
* This program 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 Affero General Public License for more details. | ||
* | ||
* You should have received a copy of the GNU Affero General Public License | ||
* along with this program. If not, see <http://www.gnu.org/licenses/>. | ||
*/ | ||
|
||
namespace Test\Authentication\Listeners; | ||
|
||
use Exception; | ||
use OC\Authentication\Listeners\UserDeletedTokenCleanupListener; | ||
use OC\Authentication\Token\IToken; | ||
use OC\Authentication\Token\Manager; | ||
use OCP\EventDispatcher\Event; | ||
use OCP\ILogger; | ||
use OCP\IUser; | ||
use OCP\User\Events\UserDeletedEvent; | ||
use PHPUnit\Framework\MockObject\MockObject; | ||
use Test\TestCase; | ||
|
||
class UserDeletedTokenCleanupListenerTest extends TestCase { | ||
|
||
|
||
/** @var Manager|MockObject */ | ||
private $manager; | ||
|
||
/** @var ILogger|MockObject */ | ||
private $logger; | ||
|
||
/** @var UserDeletedTokenCleanupListener */ | ||
private $listener; | ||
|
||
protected function setUp(): void { | ||
parent::setUp(); | ||
|
||
$this->manager = $this->createMock(Manager::class); | ||
$this->logger = $this->createMock(ILogger::class); | ||
|
||
$this->listener = new UserDeletedTokenCleanupListener( | ||
$this->manager, | ||
$this->logger | ||
); | ||
} | ||
|
||
public function testHandleUnrelated(): void { | ||
$event = new Event(); | ||
$this->manager->expects($this->never())->method('getTokenByUser'); | ||
$this->logger->expects($this->never())->method('logException'); | ||
|
||
$this->listener->handle($event); | ||
} | ||
|
||
public function testHandleWithErrors(): void { | ||
$user = $this->createMock(IUser::class); | ||
$user->method('getUID')->willReturn('user123'); | ||
$event = new UserDeletedEvent($user); | ||
$exception = new Exception('nope'); | ||
$this->manager->expects($this->once()) | ||
->method('getTokenByUser') | ||
->with('user123') | ||
->willThrowException($exception); | ||
$this->logger->expects($this->once()) | ||
->method('logException') | ||
->with($exception, $this->anything()); | ||
|
||
$this->listener->handle($event); | ||
} | ||
|
||
public function testHandle(): void { | ||
$user = $this->createMock(IUser::class); | ||
$user->method('getUID')->willReturn('user123'); | ||
$event = new UserDeletedEvent($user); | ||
$token1 = $this->createMock(IToken::class); | ||
$token1->method('getId')->willReturn(1); | ||
$token2 = $this->createMock(IToken::class); | ||
$token2->method('getId')->willReturn(2); | ||
$token3 = $this->createMock(IToken::class); | ||
$token3->method('getId')->willReturn(3); | ||
$this->manager->expects($this->once()) | ||
->method('getTokenByUser') | ||
->with('user123') | ||
->willReturn([ | ||
$token1, | ||
$token2, | ||
$token3, | ||
]); | ||
$this->manager->expects($this->exactly(3)) | ||
->method('invalidateTokenById') | ||
->withConsecutive( | ||
['user123', 1], | ||
['user123', 2], | ||
['user123', 3] | ||
); | ||
$this->logger->expects($this->never()) | ||
->method('logException'); | ||
|
||
$this->listener->handle($event); | ||
} | ||
} |