* * @author Lukas Reschke * @author Roeland Jago Douma * * @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 . * */ namespace OC\Security\RateLimiting; use OC\Security\Normalizer\IpAddress; use OC\Security\RateLimiting\Backend\IBackend; use OC\Security\RateLimiting\Exception\RateLimitExceededException; use OCP\IUser; class Limiter { public function __construct( private IBackend $backend, ) { } /** * @param int $period in seconds * @throws RateLimitExceededException */ private function register( string $methodIdentifier, string $userIdentifier, int $period, int $limit, ): void { $existingAttempts = $this->backend->getAttempts($methodIdentifier, $userIdentifier); if ($existingAttempts >= $limit) { throw new RateLimitExceededException(); } $this->backend->registerAttempt($methodIdentifier, $userIdentifier, $period); } /** * Registers attempt for an anonymous request * * @param int $anonPeriod in seconds * @throws RateLimitExceededException */ public function registerAnonRequest( string $identifier, int $anonLimit, int $anonPeriod, string $ip, ): void { $ipSubnet = (new IpAddress($ip))->getSubnet(); $anonHashIdentifier = hash('sha512', 'anon::' . $identifier . $ipSubnet); $this->register($identifier, $anonHashIdentifier, $anonPeriod, $anonLimit); } /** * Registers attempt for an authenticated request * * @param int $userPeriod in seconds * @throws RateLimitExceededException */ public function registerUserRequest( string $identifier, int $userLimit, int $userPeriod, IUser $user, ): void { $userHashIdentifier = hash('sha512', 'user::' . $identifier . $user->getUID()); $this->register($identifier, $userHashIdentifier, $userPeriod, $userLimit); } }