66835476b5
This allows adding rate limiting via annotations to controllers, as one example: ``` @UserRateThrottle(limit=5, period=100) @AnonRateThrottle(limit=1, period=100) ``` Would mean that logged-in users can access the page 5 times within 100 seconds, and anonymous users 1 time within 100 seconds. If only an AnonRateThrottle is specified that one will also be applied to logged-in users. Signed-off-by: Lukas Reschke <lukas@statuscode.ch>
50 lines
1.6 KiB
PHP
50 lines
1.6 KiB
PHP
<?php
|
|
/**
|
|
* @copyright Copyright (c) 2017 Lukas Reschke <lukas@statuscode.ch>
|
|
*
|
|
* @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\Security\RateLimiting\Backend;
|
|
|
|
/**
|
|
* Interface IBackend defines a storage backend for the rate limiting data. It
|
|
* should be noted that writing and reading rate limiting data is an expensive
|
|
* operation and one should thus make sure to only use sufficient fast backends.
|
|
*
|
|
* @package OC\Security\RateLimiting\Backend
|
|
*/
|
|
interface IBackend {
|
|
/**
|
|
* Gets the amount of attempts within the last specified seconds
|
|
*
|
|
* @param string $methodIdentifier
|
|
* @param string $userIdentifier
|
|
* @param int $seconds
|
|
* @return int
|
|
*/
|
|
public function getAttempts($methodIdentifier, $userIdentifier, $seconds);
|
|
|
|
/**
|
|
* Registers an attempt
|
|
*
|
|
* @param string $methodIdentifier
|
|
* @param string $userIdentifier
|
|
* @param int $timestamp
|
|
*/
|
|
public function registerAttempt($methodIdentifier, $userIdentifier, $timestamp);
|
|
}
|