IBackend.php 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2017 Lukas Reschke <lukas@statuscode.ch>
  5. *
  6. * @author Lukas Reschke <lukas@statuscode.ch>
  7. * @author Roeland Jago Douma <roeland@famdouma.nl>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OC\Security\RateLimiting\Backend;
  26. /**
  27. * Interface IBackend defines a storage backend for the rate limiting data. It
  28. * should be noted that writing and reading rate limiting data is an expensive
  29. * operation and one should thus make sure to only use sufficient fast backends.
  30. *
  31. * @package OC\Security\RateLimiting\Backend
  32. */
  33. interface IBackend {
  34. /**
  35. * Gets the number of attempts for the specified method
  36. *
  37. * @param string $methodIdentifier Identifier for the method
  38. * @param string $userIdentifier Identifier for the user
  39. * @return int
  40. */
  41. public function getAttempts(string $methodIdentifier,
  42. string $userIdentifier): int;
  43. /**
  44. * Registers an attempt
  45. *
  46. * @param string $methodIdentifier Identifier for the method
  47. * @param string $userIdentifier Identifier for the user
  48. * @param int $period Period in seconds how long this attempt should be stored
  49. */
  50. public function registerAttempt(string $methodIdentifier,
  51. string $userIdentifier,
  52. int $period);
  53. }