-
-
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.
fix(dav): Rate limit address book creation
Signed-off-by: Hamza Mahjoubi <[email protected]>
- Loading branch information
Showing
6 changed files
with
274 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
108 changes: 108 additions & 0 deletions
108
apps/dav/lib/CardDAV/Security/CardDavRateLimitingPlugin.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,108 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\CardDAV\Security; | ||
|
|
||
| use OC\Security\RateLimiting\Exception\RateLimitExceededException; | ||
| use OC\Security\RateLimiting\Limiter; | ||
| use OCA\DAV\CardDAV\CardDavBackend; | ||
| use OCA\DAV\Connector\Sabre\Exception\TooManyRequests; | ||
| use OCP\IConfig; | ||
| use OCP\IUserManager; | ||
| use Psr\Log\LoggerInterface; | ||
| use Sabre\DAV; | ||
| use Sabre\DAV\Exception\Forbidden; | ||
| use Sabre\DAV\ServerPlugin; | ||
| use function count; | ||
| use function explode; | ||
|
|
||
| class CardDavRateLimitingPlugin extends ServerPlugin { | ||
| private ?string $userId; | ||
|
|
||
| /** @var Limiter */ | ||
| private $limiter; | ||
| /** @var IUserManager */ | ||
| private $userManager; | ||
| /** @var CardDavBackend */ | ||
| private $cardDavBackend; | ||
| /** @var LoggerInterface */ | ||
| private $logger; | ||
| /** @var IConfig */ | ||
| private $config; | ||
|
|
||
| /** | ||
| * CardDavRateLimitingPlugin constructor. | ||
| * | ||
| * @param Limiter $limiter | ||
| * @param IUserManager $userManager | ||
| * @param CardDavBackend $cardDavBackend | ||
| * @param LoggerInterface $logger | ||
| * @param IConfig $config | ||
| * @param string|null $userId | ||
| */ | ||
| public function __construct(Limiter $limiter, | ||
| IUserManager $userManager, | ||
| CardDavBackend $cardDavBackend, | ||
| LoggerInterface $logger, | ||
| IConfig $config, | ||
| ?string $userId) { | ||
| $this->limiter = $limiter; | ||
| $this->userManager = $userManager; | ||
| $this->cardDavBackend = $cardDavBackend; | ||
| $this->config = $config; | ||
| $this->logger = $logger; | ||
| $this->userId = $userId; | ||
| } | ||
|
|
||
| public function initialize(DAV\Server $server): void { | ||
| $server->on('beforeBind', [$this, 'beforeBind'], 1); | ||
| } | ||
|
|
||
| public function beforeBind(string $path): void { | ||
| if ($this->userId === null) { | ||
| // We only care about authenticated users here | ||
| return; | ||
| } | ||
| $user = $this->userManager->get($this->userId); | ||
| if ($user === null) { | ||
| // We only care about authenticated users here | ||
| return; | ||
| } | ||
|
|
||
| $pathParts = explode('/', $path); | ||
| if (count($pathParts) === 4 && $pathParts[0] === 'addressbooks') { | ||
| // Path looks like addressbooks/users/username/addressbooksname so a new addressbook is created | ||
| try { | ||
| $this->limiter->registerUserRequest( | ||
| 'carddav-create-address-book', | ||
| (int) $this->config->getAppValue('dav', 'rateLimitAddressBookCreation', '10'), | ||
| (int) $this->config->getAppValue('dav', 'rateLimitPeriodAddressBookCreation', '3600'), | ||
| $user | ||
| ); | ||
| } catch (RateLimitExceededException $e) { | ||
| throw new TooManyRequests('Too many addressbooks created', 0, $e); | ||
| } | ||
|
|
||
| $addressBookLimit =(int) $this->config->getAppValue('dav', 'maximumAdressbooks', '10'); | ||
| if ($addressBookLimit === -1) { | ||
| return; | ||
| } | ||
| $numAddressbooks = $this->cardDavBackend->getAddressBooksForUserCount('principals/users/' . $user->getUID()); | ||
|
|
||
| if ($numAddressbooks >= $addressBookLimit) { | ||
| $this->logger->warning('Maximum number of address books reached', [ | ||
| 'addressbooks' => $numAddressbooks, | ||
| 'addressBookLimit' => $addressBookLimit, | ||
| ]); | ||
| throw new Forbidden('AddressBook limit reached', 0); | ||
| } | ||
| } | ||
| } | ||
|
|
||
| } |
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
159 changes: 159 additions & 0 deletions
159
apps/dav/tests/unit/CardDAV/Security/CardDavRateLimitingPluginTest.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,159 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /* | ||
| * SPDX-FileCopyrightText: 2016 Nextcloud GmbH and Nextcloud contributors | ||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||
| */ | ||
|
|
||
| namespace OCA\DAV\Tests\unit\CardDAV\Security; | ||
|
|
||
| use OC\Security\RateLimiting\Exception\RateLimitExceededException; | ||
| use OC\Security\RateLimiting\Limiter; | ||
| use OCA\DAV\CardDAV\CardDavBackend; | ||
| use OCA\DAV\CardDAV\Security\CardDavRateLimitingPlugin; | ||
| use OCA\DAV\Connector\Sabre\Exception\TooManyRequests; | ||
| use OCP\IConfig; | ||
| use OCP\IUser; | ||
| use OCP\IUserManager; | ||
| use PHPUnit\Framework\MockObject\MockObject; | ||
| use Psr\Log\LoggerInterface; | ||
| use Sabre\DAV\Exception\Forbidden; | ||
| use Test\TestCase; | ||
|
|
||
| class CardDavRateLimitingPluginTest extends TestCase { | ||
|
|
||
| /** @var Limiter|MockObject */ | ||
| private $limiter; | ||
|
|
||
| /** @var CardDavBackend|MockObject */ | ||
| private $cardDavBackend; | ||
|
|
||
| /** @var IUserManager|MockObject */ | ||
| private $userManager; | ||
|
|
||
| /** @var LoggerInterface|MockObject */ | ||
| private $logger; | ||
|
|
||
| /** @var IConfig|MockObject */ | ||
| private $config; | ||
|
|
||
| /** @var string */ | ||
| private $userId = 'user123'; | ||
|
|
||
| /** @var CardDavRateLimitingPlugin */ | ||
| private $plugin; | ||
|
|
||
| protected function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| $this->limiter = $this->createMock(Limiter::class); | ||
| $this->userManager = $this->createMock(IUserManager::class); | ||
| $this->cardDavBackend = $this->createMock(CardDavBackend::class); | ||
| $this->logger = $this->createMock(LoggerInterface::class); | ||
| $this->config = $this->createMock(IConfig::class); | ||
| $this->plugin = new CardDavRateLimitingPlugin( | ||
| $this->limiter, | ||
| $this->userManager, | ||
| $this->cardDavBackend, | ||
| $this->logger, | ||
| $this->config, | ||
| $this->userId, | ||
| ); | ||
| } | ||
|
|
||
| public function testNoUserObject(): void { | ||
| $this->limiter->expects(self::never()) | ||
| ->method('registerUserRequest'); | ||
|
|
||
| $this->plugin->beforeBind('addressbooks/users/foo/addressbookname'); | ||
| } | ||
|
|
||
| public function testUnrelated(): void { | ||
| $user = $this->createMock(IUser::class); | ||
| $this->userManager->expects(self::once()) | ||
| ->method('get') | ||
| ->with($this->userId) | ||
| ->willReturn($user); | ||
| $this->limiter->expects(self::never()) | ||
| ->method('registerUserRequest'); | ||
|
|
||
| $this->plugin->beforeBind('foo/bar'); | ||
| } | ||
|
|
||
| public function testRegisterAddressBookrCreation(): void { | ||
| $user = $this->createMock(IUser::class); | ||
| $this->userManager->expects(self::once()) | ||
| ->method('get') | ||
| ->with($this->userId) | ||
| ->willReturn($user); | ||
| $this->config | ||
| ->method('getAppValue') | ||
| ->with('dav') | ||
| ->willReturnArgument(2); | ||
| $this->limiter->expects(self::once()) | ||
| ->method('registerUserRequest') | ||
| ->with( | ||
| 'carddav-create-address-book', | ||
| 10, | ||
| 3600, | ||
| $user, | ||
| ); | ||
|
|
||
| $this->plugin->beforeBind('addressbooks/users/foo/addressbookname'); | ||
| } | ||
|
|
||
| public function testAddressBookCreationRateLimitExceeded(): void { | ||
| $user = $this->createMock(IUser::class); | ||
| $this->userManager->expects(self::once()) | ||
| ->method('get') | ||
| ->with($this->userId) | ||
| ->willReturn($user); | ||
| $this->config | ||
| ->method('getAppValue') | ||
| ->with('dav') | ||
| ->willReturnArgument(2); | ||
| $this->limiter->expects(self::once()) | ||
| ->method('registerUserRequest') | ||
| ->with( | ||
| 'carddav-create-address-book', | ||
| 10, | ||
| 3600, | ||
| $user, | ||
| ) | ||
| ->willThrowException(new RateLimitExceededException()); | ||
| $this->expectException(TooManyRequests::class); | ||
|
|
||
| $this->plugin->beforeBind('addressbooks/users/foo/addressbookname'); | ||
| } | ||
|
|
||
| public function testAddressBookLimitReached(): void { | ||
| $user = $this->createMock(IUser::class); | ||
| $this->userManager->expects(self::once()) | ||
| ->method('get') | ||
| ->with($this->userId) | ||
| ->willReturn($user); | ||
| $user->method('getUID')->willReturn('user123'); | ||
| $this->config | ||
| ->method('getAppValue') | ||
| ->with('dav') | ||
| ->willReturnArgument(2); | ||
| $this->limiter->expects(self::once()) | ||
| ->method('registerUserRequest') | ||
| ->with( | ||
| 'carddav-create-address-book', | ||
| 10, | ||
| 3600, | ||
| $user, | ||
| ); | ||
| $this->cardDavBackend->expects(self::once()) | ||
| ->method('getAddressBooksForUserCount') | ||
| ->with('principals/users/user123') | ||
| ->willReturn(11); | ||
| $this->expectException(Forbidden::class); | ||
|
|
||
| $this->plugin->beforeBind('addressbooks/users/foo/addressbookname'); | ||
| } | ||
|
|
||
| } |