123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384 |
- <?php
- declare(strict_types = 1);
- /**
- * @copyright 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @author 2018 Christoph Wurst <christoph@winzerhof-wurst.at>
- *
- * @license GNU AGPL version 3 or any later version
- *
- * This program is free software: you can redistribute it and/or modify
- * it under the terms of the GNU Affero General Public License as
- * published by the Free Software Foundation, either version 3 of the
- * License, or (at your option) any later version.
- *
- * This program is distributed in the hope that it will be useful,
- * but WITHOUT ANY WARRANTY; without even the implied warranty of
- * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
- * GNU Affero General Public License for more details.
- *
- * You should have received a copy of the GNU Affero General Public License
- * along with this program. If not, see <http://www.gnu.org/licenses/>.
- *
- */
- namespace OCP\Authentication\TwoFactorAuth;
- use OCP\IUser;
- /**
- * Nextcloud 2FA provider registry for stateful 2FA providers
- *
- * This service keeps track of which providers are currently active for a specific
- * user. Stateful 2FA providers (IStatefulProvider) must use this service to save
- * their enabled/disabled state.
- *
- * @since 14.0.0
- */
- interface IRegistry {
- const EVENT_PROVIDER_ENABLED = self::class . '::enable';
- const EVENT_PROVIDER_DISABLED = self::class . '::disable';
- /**
- * Get a key-value map of providers and their enabled/disabled state for
- * the given user.
- *
- * @since 14.0.0
- * @return string[] where the array key is the provider ID (string) and the
- * value is the enabled state (bool)
- */
- public function getProviderStates(IUser $user): array;
- /**
- * Enable the given 2FA provider for the given user
- *
- * @since 14.0.0
- */
- public function enableProviderFor(IProvider $provider, IUser $user);
- /**
- * Disable the given 2FA provider for the given user
- *
- * @since 14.0.0
- */
- public function disableProviderFor(IProvider $provider, IUser $user);
- /**
- * Cleans up all entries of the provider with the given id. This is only
- * necessary in edge-cases where an admin disabled and/or uninstalled a
- * provider app. Invoking this method will make sure outdated provider
- * associations are removed so that users can log in.
- *
- * @since 15.0.0
- *
- * @param string $providerId
- *
- * @return void
- */
- public function cleanUp(string $providerId);
- }
|