IRegistry.php 2.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384
  1. <?php
  2. declare(strict_types = 1);
  3. /**
  4. * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
  5. *
  6. * @author 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
  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 <http://www.gnu.org/licenses/>.
  22. *
  23. */
  24. namespace OCP\Authentication\TwoFactorAuth;
  25. use OCP\IUser;
  26. /**
  27. * Nextcloud 2FA provider registry for stateful 2FA providers
  28. *
  29. * This service keeps track of which providers are currently active for a specific
  30. * user. Stateful 2FA providers (IStatefulProvider) must use this service to save
  31. * their enabled/disabled state.
  32. *
  33. * @since 14.0.0
  34. */
  35. interface IRegistry {
  36. const EVENT_PROVIDER_ENABLED = self::class . '::enable';
  37. const EVENT_PROVIDER_DISABLED = self::class . '::disable';
  38. /**
  39. * Get a key-value map of providers and their enabled/disabled state for
  40. * the given user.
  41. *
  42. * @since 14.0.0
  43. * @return string[] where the array key is the provider ID (string) and the
  44. * value is the enabled state (bool)
  45. */
  46. public function getProviderStates(IUser $user): array;
  47. /**
  48. * Enable the given 2FA provider for the given user
  49. *
  50. * @since 14.0.0
  51. */
  52. public function enableProviderFor(IProvider $provider, IUser $user);
  53. /**
  54. * Disable the given 2FA provider for the given user
  55. *
  56. * @since 14.0.0
  57. */
  58. public function disableProviderFor(IProvider $provider, IUser $user);
  59. /**
  60. * Cleans up all entries of the provider with the given id. This is only
  61. * necessary in edge-cases where an admin disabled and/or uninstalled a
  62. * provider app. Invoking this method will make sure outdated provider
  63. * associations are removed so that users can log in.
  64. *
  65. * @since 15.0.0
  66. *
  67. * @param string $providerId
  68. *
  69. * @return void
  70. */
  71. public function cleanUp(string $providerId);
  72. }