feat: Two Factor API #49443
+350
−0
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
| @@ -0,0 +1,107 @@ | ||||||
| <?php | ||||||
|
|
||||||
| declare(strict_types=1); | ||||||
| /** | ||||||
| * SPDX-FileCopyrightText: 2024 Nextcloud GmbH and Nextcloud contributors | ||||||
| * SPDX-License-Identifier: AGPL-3.0-or-later | ||||||
| */ | ||||||
|
|
||||||
| namespace OC\Core\Controller; | ||||||
|
|
||||||
| use OC\Authentication\TwoFactorAuth\ProviderManager; | ||||||
| use OCP\AppFramework\Http; | ||||||
| use OCP\Authentication\TwoFactorAuth\IRegistry; | ||||||
| use OCP\AppFramework\Http\Attribute\ApiRoute; | ||||||
| use OCP\AppFramework\Http\Attribute\PublicPage; | ||||||
| use OCP\AppFramework\Http\DataResponse; | ||||||
| use OCP\IRequest; | ||||||
| use OCP\IUserManager; | ||||||
|
|
||||||
| class TwoFactorApiController extends \OCP\AppFramework\OCSController { | ||||||
| public function __construct( | ||||||
| string $appName, | ||||||
| IRequest $request, | ||||||
| private ProviderManager $tfManager, | ||||||
| private IRegistry $tfRegistry, | ||||||
| private IUserManager $userManager, | ||||||
| ) { | ||||||
| parent::__construct($appName, $request); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Get two factor authentication provider states | ||||||
| * | ||||||
| * @param list<string> $users collection of system user ids | ||||||
| * | ||||||
| * @return DataResponse<Http::STATUS_OK, list{string: list{string: bool}}, array{}> | ||||||
| * | ||||||
| * 200: user/provider states | ||||||
| */ | ||||||
| #[PublicPage] | ||||||
|
Check failure on line 40 in core/Controller/TwoFactorApiController.php
|
||||||
| #[ApiRoute(verb: 'POST', url: '/state', root: '/twofactor')] | ||||||
| public function state(array $users = []): DataResponse { | ||||||
| $states = []; | ||||||
| foreach ($users as $userId) { | ||||||
| $userObject = $this->userManager->get($userId); | ||||||
| if ($userObject !== null) { | ||||||
| $states[$userId] = $this->tfRegistry->getProviderStates($userObject); | ||||||
| } | ||||||
| } | ||||||
| return new DataResponse($states); | ||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Enable two factor authentication providers for specific user | ||||||
| * | ||||||
| * @param string $user system user identifier | ||||||
| * @param list<string> $providers collection of TFA provider ids | ||||||
| * | ||||||
| * @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, list{string: bool}, array{}> | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| * | ||||||
| * 200: provider states | ||||||
| * 404: user not found | ||||||
| */ | ||||||
| #[PublicPage] | ||||||
|
Check failure on line 64 in core/Controller/TwoFactorApiController.php
|
||||||
| #[ApiRoute(verb: 'POST', url: '/enable', root: '/twofactor')] | ||||||
| public function enable(string $user, array $providers = []): DataResponse { | ||||||
| $userObject = $this->userManager->get($user); | ||||||
| if ($userObject !== null) { | ||||||
| if (is_array($providers)) { | ||||||
|
Check failure on line 69 in core/Controller/TwoFactorApiController.php
|
||||||
| foreach ($providers as $providerId) { | ||||||
| $this->tfManager->tryEnableProviderFor($providerId, $userObject); | ||||||
| } | ||||||
| } | ||||||
| $state = $this->tfRegistry->getProviderStates($userObject); | ||||||
| return new DataResponse($state); | ||||||
| } | ||||||
| return new DataResponse([], Http::STATUS_NOT_FOUND); | ||||||
|
There was a problem hiding this comment. return empty list is illegal 😿
Suggested change
|
||||||
| } | ||||||
|
|
||||||
| /** | ||||||
| * Disable two factor authentication providers for specific user | ||||||
| * | ||||||
| * @param string $user system user identifier | ||||||
| * @param list<string> $providers collection of TFA provider ids | ||||||
| * | ||||||
| * @return DataResponse<Http::STATUS_OK|Http::STATUS_NOT_FOUND, list{string: bool}, array{}> | ||||||
| * | ||||||
| * 200: provider states | ||||||
| * 404: user not found | ||||||
| */ | ||||||
| #[PublicPage] | ||||||
|
Check failure on line 91 in core/Controller/TwoFactorApiController.php
|
||||||
| #[ApiRoute(verb: 'POST', url: '/disable', root: '/twofactor')] | ||||||
| public function disable(string $user, array $providers = []): DataResponse { | ||||||
| $userObject = $this->userManager->get($user); | ||||||
| if ($userObject !== null) { | ||||||
| if (is_array($providers)) { | ||||||
|
Check failure on line 96 in core/Controller/TwoFactorApiController.php
|
||||||
| foreach ($providers as $providerId) { | ||||||
| $this->tfManager->tryDisableProviderFor($providerId, $userObject); | ||||||
| } | ||||||
| } | ||||||
| $state = $this->tfRegistry->getProviderStates($userObject); | ||||||
| return new DataResponse($state); | ||||||
| } | ||||||
| return new DataResponse([], Http::STATUS_NOT_FOUND); | ||||||
| } | ||||||
|
|
||||||
| } | ||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.