CsrfTokenGenerator.php 1.3 KB

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