1
0

IVerificationToken.php 1.9 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2021 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. *
  8. * @license GNU AGPL version 3 or any later version
  9. *
  10. * This program is free software: you can redistribute it and/or modify
  11. * it under the terms of the GNU Affero General Public License as
  12. * published by the Free Software Foundation, either version 3 of the
  13. * License, or (at your option) any later version.
  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
  21. * along with this program. If not, see <https://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Security\VerificationToken;
  25. use OCP\IUser;
  26. /**
  27. * @since 23.0.0
  28. */
  29. interface IVerificationToken {
  30. /**
  31. * Checks whether the a provided tokent matches a stored token and its
  32. * constraints. An InvalidTokenException is thrown on issues, otherwise
  33. * the check is successful.
  34. *
  35. * null can be passed as $user, but mind that this is for conveniently
  36. * passing the return of IUserManager::getUser() to this method. When
  37. * $user is null, InvalidTokenException is thrown for all the issued
  38. * tokens are user related.
  39. *
  40. * @throws InvalidTokenException
  41. * @since 23.0.0
  42. */
  43. public function check(string $token, ?IUser $user, string $subject, string $passwordPrefix = '', bool $expiresWithLogin = false): void;
  44. /**
  45. * @since 23.0.0
  46. */
  47. public function create(IUser $user, string $subject, string $passwordPrefix = ''): string;
  48. /**
  49. * Deletes the token identified by the provided parameters
  50. *
  51. * @since 23.0.0
  52. */
  53. public function delete(string $token, IUser $user, string $subject): void;
  54. }