Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
WIP - add check-group command in user_ldap
Signed-off-by: Côme Chilliet <[email protected]>
- Loading branch information
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,146 @@ | ||
| <?php | ||
| /** | ||
| * @copyright Copyright (c) 2016, ownCloud, Inc. | ||
| * | ||
| * @author Arthur Schiwon <[email protected]> | ||
| * @author Christoph Wurst <[email protected]> | ||
| * @author Côme Chilliet <[email protected]> | ||
| * @author Joas Schilling <[email protected]> | ||
| * @author Morris Jobke <[email protected]> | ||
| * @author Roeland Jago Douma <[email protected]> | ||
| * | ||
| * @license AGPL-3.0 | ||
| * | ||
| * This code is free software: you can redistribute it and/or modify | ||
| * it under the terms of the GNU Affero General Public License, version 3, | ||
| * as published by the Free Software Foundation. | ||
| * | ||
| * 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, version 3, | ||
| * along with this program. If not, see <http://www.gnu.org/licenses/> | ||
| * | ||
| */ | ||
| namespace OCA\User_LDAP\Command; | ||
|
|
||
| use OCA\User_LDAP\Helper; | ||
| use OCA\User_LDAP\Mapping\UserMapping; | ||
| use OCA\User_LDAP\Group_Proxy; | ||
| use Symfony\Component\Console\Command\Command; | ||
| use Symfony\Component\Console\Input\InputArgument; | ||
| use Symfony\Component\Console\Input\InputInterface; | ||
| use Symfony\Component\Console\Input\InputOption; | ||
| use Symfony\Component\Console\Output\OutputInterface; | ||
|
|
||
| class CheckGroup extends Command { | ||
| public function __construct( | ||
| protected Group_Proxy $backend, | ||
| protected Helper $helper, | ||
| protected UserMapping $mapping | ||
| ) { | ||
| parent::__construct(); | ||
| } | ||
|
|
||
| protected function configure(): void { | ||
| $this | ||
| ->setName('ldap:check-group') | ||
| ->setDescription('checks whether a group exists on LDAP.') | ||
| ->addArgument( | ||
| 'ocName', | ||
| InputArgument::REQUIRED, | ||
| 'the group name as used in Nextcloud, or the LDAP DN' | ||
| ) | ||
| ->addOption( | ||
| 'force', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'ignores disabled LDAP configuration' | ||
| ) | ||
| ->addOption( | ||
| 'update', | ||
| null, | ||
| InputOption::VALUE_NONE, | ||
| 'syncs values from LDAP' | ||
| ) | ||
| ; | ||
| } | ||
|
|
||
| protected function execute(InputInterface $input, OutputInterface $output): int { | ||
| try { | ||
| $this->assertAllowed($input->getOption('force')); | ||
| $gid = $input->getArgument('ocName'); | ||
| if ($this->backend->getLDAPAccess($gid)->stringResemblesDN($gid)) { | ||
| $groupname = $this->backend->dn2GroupName($gid); | ||
| if ($groupname !== false) { | ||
| $gid = $groupname; | ||
| } | ||
| } | ||
| $wasMapped = $this->groupWasMapped($gid); | ||
| $exists = $this->backend->groupExistsOnLDAP($gid, true); | ||
| if ($exists === true) { | ||
| $output->writeln('The group is still available on LDAP.'); | ||
| if ($input->getOption('update')) { | ||
| $this->updateGroup($gid, $output); | ||
| } | ||
| return 0; | ||
| } elseif ($wasMapped) { | ||
| $output->writeln('The group does not exists on LDAP anymore.'); | ||
| return 0; | ||
| } else { | ||
| throw new \Exception('The given group is not a recognized LDAP group.'); | ||
| } | ||
| } catch (\Exception $e) { | ||
| $output->writeln('<error>' . $e->getMessage(). '</error>'); | ||
| return 1; | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * checks whether a group is actually mapped | ||
| * @param string $ocName the groupname as used in Nextcloud | ||
| */ | ||
| protected function groupWasMapped(string $ocName): bool { | ||
| $dn = $this->mapping->getDNByName($ocName); | ||
| return $dn !== false; | ||
| } | ||
|
|
||
| /** | ||
| * checks whether the setup allows reliable checking of LDAP group existence | ||
| * @throws \Exception | ||
| */ | ||
| protected function assertAllowed(bool $force): void { | ||
| if ($this->helper->haveDisabledConfigurations() && !$force) { | ||
| throw new \Exception('Cannot check group existence, because ' | ||
| . 'disabled LDAP configurations are present.'); | ||
| } | ||
|
|
||
| // we don't check ldapUserCleanupInterval from config.php because this | ||
| // action is triggered manually, while the setting only controls the | ||
| // background job. | ||
| } | ||
|
|
||
| private function updateGroup(string $gid, OutputInterface $output): void { | ||
| try { | ||
| $access = $this->backend->getLDAPAccess($gid); | ||
| $attrs = $access->userManager->getAttributes(); | ||
| $user = $access->userManager->get($gid); | ||
| $avatarAttributes = $access->getConnection()->resolveRule('avatar'); | ||
| $result = $access->search('objectclass=*', $user->getDN(), $attrs, 1, 0); | ||
|
Check notice Code scanning / Psalm PossiblyNullReference Note |
||
| foreach ($result[0] as $attribute => $valueSet) { | ||
| $output->writeln(' ' . $attribute . ': '); | ||
| foreach ($valueSet as $value) { | ||
| if (in_array($attribute, $avatarAttributes)) { | ||
| $value = '{ImageData}'; | ||
| } | ||
| $output->writeln(' ' . $value); | ||
| } | ||
| } | ||
| $access->batchApplyUserAttributes($result); | ||
| } catch (\Exception $e) { | ||
| $output->writeln('<error>Error while trying to lookup and update attributes from LDAP</error>'); | ||
| } | ||
| } | ||
| } | ||
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
