IProvideUserSecretBackend.php 1.2 KB

1234567891011121314151617181920212223242526272829303132333435363738394041
  1. <?php
  2. /**
  3. * @copyright Copyright (c) 2021, MichaIng <micha@dietpi.com>
  4. *
  5. * @author MichaIng <micha@dietpi.com>
  6. *
  7. * @license AGPL-3.0
  8. *
  9. * This code is free software: you can redistribute it and/or modify
  10. * it under the terms of the GNU Affero General Public License, version 3,
  11. * as published by the Free Software Foundation.
  12. *
  13. * This program is distributed in the hope that it will be useful,
  14. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  15. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  16. * GNU Affero General Public License for more details.
  17. *
  18. * You should have received a copy of the GNU Affero General Public License, version 3,
  19. * along with this program. If not, see <http://www.gnu.org/licenses/>
  20. *
  21. */
  22. // use OCP namespace for all classes that are considered public.
  23. // This means that they should be used by apps instead of the internal ownCloud classes
  24. namespace OCP\Authentication;
  25. /**
  26. * Interface IProvideUserSecretBackend
  27. *
  28. * @since 23.0.0
  29. */
  30. interface IProvideUserSecretBackend {
  31. /**
  32. * Optionally returns a stable per-user secret. This secret is for
  33. * instance used to secure file encryption keys.
  34. * @return string
  35. * @since 23.0.0
  36. */
  37. public function getCurrentUserSecret(): string;
  38. }