CsrfTokenGenerator.php 1.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2016, ownCloud, Inc.
  5. *
  6. * @author Lukas Reschke <lukas@statuscode.ch>
  7. *
  8. * @license AGPL-3.0
  9. *
  10. * This code is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License, version 3,
  12. * as published by the Free Software Foundation.
  13. *
  14. * This program is distributed in the hope that it will be useful,
  15. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  16. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  17. * GNU Affero General Public License for more details.
  18. *
  19. * You should have received a copy of the GNU Affero General Public License, version 3,
  20. * along with this program. If not, see <http://www.gnu.org/licenses/>
  21. *
  22. */
  23. namespace OC\Security\CSRF;
  24. use OCP\Security\ISecureRandom;
  25. /**
  26. * Class CsrfTokenGenerator is used to generate a cryptographically secure
  27. * pseudo-random number for the token.
  28. *
  29. * @package OC\Security\CSRF
  30. */
  31. class CsrfTokenGenerator {
  32. /** @var ISecureRandom */
  33. private $random;
  34. /**
  35. * @param ISecureRandom $random
  36. */
  37. public function __construct(ISecureRandom $random) {
  38. $this->random = $random;
  39. }
  40. /**
  41. * Generate a new CSRF token.
  42. *
  43. * @param int $length Length of the token in characters.
  44. * @return string
  45. */
  46. public function generateToken(int $length = 32): string {
  47. return $this->random->generate($length);
  48. }
  49. }