]> source.dussan.org Git - nextcloud-server.git/commitdiff
Setup warning for invalid LDAP user or group UUIDs.
authorArthur Schiwon <blizzz@arthur-schiwon.de>
Tue, 8 Feb 2022 20:31:32 +0000 (21:31 +0100)
committerbackportbot[bot] <backportbot[bot]@users.noreply.github.com>
Thu, 10 Feb 2022 21:40:24 +0000 (21:40 +0000)
Signed-off-by: Arthur Schiwon <blizzz@arthur-schiwon.de>
apps/settings/composer/composer/autoload_classmap.php
apps/settings/composer/composer/autoload_static.php
apps/settings/lib/Controller/CheckSetupController.php
apps/settings/lib/SetupChecks/LdapInvalidUuids.php [new file with mode: 0644]
apps/settings/tests/Controller/CheckSetupControllerTest.php
core/js/setupchecks.js

index bf15d877fe09eb1b121478b9996c55ddcb4c0753..56c1d7962a8127a20397015202a6fa2eebb686aa 100644 (file)
@@ -58,6 +58,7 @@ return array(
     'OCA\\Settings\\Settings\\Personal\\Security\\WebAuthn' => $baseDir . '/../lib/Settings/Personal/Security/WebAuthn.php',
     'OCA\\Settings\\Settings\\Personal\\ServerDevNotice' => $baseDir . '/../lib/Settings/Personal/ServerDevNotice.php',
     'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => $baseDir . '/../lib/SetupChecks/CheckUserCertificates.php',
+    'OCA\\Settings\\SetupChecks\\LdapInvalidUuids' => $baseDir . '/../lib/SetupChecks/LdapInvalidUuids.php',
     'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => $baseDir . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
     'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => $baseDir . '/../lib/SetupChecks/PhpDefaultCharset.php',
     'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => $baseDir . '/../lib/SetupChecks/PhpOutputBuffering.php',
index 87635f63586ddf93e3d266c8fc162fd17aff8f2b..179ae6fdbca0520c8712563e57f34a5badae5ac6 100644 (file)
@@ -73,6 +73,7 @@ class ComposerStaticInitSettings
         'OCA\\Settings\\Settings\\Personal\\Security\\WebAuthn' => __DIR__ . '/..' . '/../lib/Settings/Personal/Security/WebAuthn.php',
         'OCA\\Settings\\Settings\\Personal\\ServerDevNotice' => __DIR__ . '/..' . '/../lib/Settings/Personal/ServerDevNotice.php',
         'OCA\\Settings\\SetupChecks\\CheckUserCertificates' => __DIR__ . '/..' . '/../lib/SetupChecks/CheckUserCertificates.php',
+        'OCA\\Settings\\SetupChecks\\LdapInvalidUuids' => __DIR__ . '/..' . '/../lib/SetupChecks/LdapInvalidUuids.php',
         'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat' => __DIR__ . '/..' . '/../lib/SetupChecks/LegacySSEKeyFormat.php',
         'OCA\\Settings\\SetupChecks\\PhpDefaultCharset' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpDefaultCharset.php',
         'OCA\\Settings\\SetupChecks\\PhpOutputBuffering' => __DIR__ . '/..' . '/../lib/SetupChecks/PhpOutputBuffering.php',
index e5f9ae31874d613018a5a51eac9abc5a30f50706..e7fcfb6a20b80235a4d74e41a75712963f8b3095 100644 (file)
@@ -47,7 +47,6 @@ use DirectoryIterator;
 use Doctrine\DBAL\Exception;
 use Doctrine\DBAL\Platforms\SqlitePlatform;
 use Doctrine\DBAL\TransactionIsolationLevel;
-use OCP\DB\Types;
 use GuzzleHttp\Exception\ClientException;
 use OC;
 use OC\AppFramework\Http;
@@ -60,14 +59,17 @@ use OC\IntegrityCheck\Checker;
 use OC\Lock\NoopLockingProvider;
 use OC\MemoryInfo;
 use OCA\Settings\SetupChecks\CheckUserCertificates;
+use OCA\Settings\SetupChecks\LdapInvalidUuids;
 use OCA\Settings\SetupChecks\LegacySSEKeyFormat;
 use OCA\Settings\SetupChecks\PhpDefaultCharset;
 use OCA\Settings\SetupChecks\PhpOutputBuffering;
 use OCA\Settings\SetupChecks\SupportedDatabase;
+use OCP\App\IAppManager;
 use OCP\AppFramework\Controller;
 use OCP\AppFramework\Http\DataDisplayResponse;
 use OCP\AppFramework\Http\DataResponse;
 use OCP\AppFramework\Http\RedirectResponse;
+use OCP\DB\Types;
 use OCP\Http\Client\IClientService;
 use OCP\IConfig;
 use OCP\IDateTimeFormatter;
@@ -75,6 +77,7 @@ use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\IRequest;
+use OCP\IServerContainer;
 use OCP\IURLGenerator;
 use OCP\Lock\ILockingProvider;
 use OCP\Security\ISecureRandom;
@@ -110,6 +113,10 @@ class CheckSetupController extends Controller {
        private $iniGetWrapper;
        /** @var IDBConnection */
        private $connection;
+       /** @var IAppManager */
+       private $appManager;
+       /** @var IServerContainer */
+       private $serverContainer;
 
        public function __construct($AppName,
                                                                IRequest $request,
@@ -126,7 +133,10 @@ class CheckSetupController extends Controller {
                                                                MemoryInfo $memoryInfo,
                                                                ISecureRandom $secureRandom,
                                                                IniGetWrapper $iniGetWrapper,
-                                                               IDBConnection $connection) {
+                                                               IDBConnection $connection,
+                                                               IAppManager $appManager,
+                                                               IServerContainer $serverContainer
+       ) {
                parent::__construct($AppName, $request);
                $this->config = $config;
                $this->clientService = $clientService;
@@ -142,6 +152,8 @@ class CheckSetupController extends Controller {
                $this->secureRandom = $secureRandom;
                $this->iniGetWrapper = $iniGetWrapper;
                $this->connection = $connection;
+               $this->appManager = $appManager;
+               $this->serverContainer = $serverContainer;
        }
 
        /**
@@ -728,6 +740,7 @@ Raw output
                $legacySSEKeyFormat = new LegacySSEKeyFormat($this->l10n, $this->config, $this->urlGenerator);
                $checkUserCertificates = new CheckUserCertificates($this->l10n, $this->config, $this->urlGenerator);
                $supportedDatabases = new SupportedDatabase($this->l10n, $this->connection);
+               $ldapInvalidUuids = new LdapInvalidUuids($this->appManager, $this->l10n, $this->serverContainer);
 
                return new DataResponse(
                        [
@@ -775,6 +788,7 @@ Raw output
                                CheckUserCertificates::class => ['pass' => $checkUserCertificates->run(), 'description' => $checkUserCertificates->description(), 'severity' => $checkUserCertificates->severity(), 'elements' => $checkUserCertificates->elements()],
                                'isDefaultPhoneRegionSet' => $this->config->getSystemValueString('default_phone_region', '') !== '',
                                SupportedDatabase::class => ['pass' => $supportedDatabases->run(), 'description' => $supportedDatabases->description(), 'severity' => $supportedDatabases->severity()],
+                               LdapInvalidUuids::class => ['pass' => $ldapInvalidUuids->run(), 'description' => $ldapInvalidUuids->description(), 'severity' => $ldapInvalidUuids->severity()],
                        ]
                );
        }
diff --git a/apps/settings/lib/SetupChecks/LdapInvalidUuids.php b/apps/settings/lib/SetupChecks/LdapInvalidUuids.php
new file mode 100644 (file)
index 0000000..11b0105
--- /dev/null
@@ -0,0 +1,69 @@
+<?php
+
+declare(strict_types=1);
+
+/**
+ * @copyright Copyright (c) 2022 Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
+ *
+ * @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 <https://www.gnu.org/licenses/>.
+ *
+ */
+
+namespace OCA\Settings\SetupChecks;
+
+use OCA\User_LDAP\Mapping\GroupMapping;
+use OCA\User_LDAP\Mapping\UserMapping;
+use OCP\App\IAppManager;
+use OCP\IL10N;
+use OCP\IServerContainer;
+
+class LdapInvalidUuids {
+
+       /** @var IAppManager */
+       private $appManager;
+       /** @var IL10N */
+       private $l10n;
+       /** @var IServerContainer */
+       private $server;
+
+       public function __construct(IAppManager $appManager, IL10N $l10n, IServerContainer $server) {
+               $this->appManager = $appManager;
+               $this->l10n = $l10n;
+               $this->server = $server;
+       }
+
+       public function description(): string {
+               return $this->l10n->t('Invalid UUIDs of LDAP users or groups have been found. Please review your "Override UUID detection" settings in the Expert part of the LDAP configuration and use "occ ldap:update-uuid" to update them.');
+       }
+
+       public function severity(): string {
+               return 'warning';
+       }
+
+       public function run(): bool {
+               if (!$this->appManager->isEnabledForUser('user_ldap')) {
+                       return true;
+               }
+               /** @var UserMapping $userMapping */
+               $userMapping = $this->server->get(UserMapping::class);
+               /** @var GroupMapping $groupMapping */
+               $groupMapping = $this->server->get(GroupMapping::class);
+               return count($userMapping->getList(0, 1, true)) === 0
+                       && count($groupMapping->getList(0, 1, true)) === 0;
+       }
+}
index 426793df60682bf62423152921176899a42b1e09..8bffa4b93050e35ad5f3929e71b5edfee1665a90 100644 (file)
@@ -42,6 +42,7 @@ use OC\IntegrityCheck\Checker;
 use OC\MemoryInfo;
 use OC\Security\SecureRandom;
 use OCA\Settings\Controller\CheckSetupController;
+use OCP\App\IAppManager;
 use OCP\AppFramework\Http;
 use OCP\AppFramework\Http\DataDisplayResponse;
 use OCP\AppFramework\Http\DataResponse;
@@ -53,6 +54,7 @@ use OCP\IDBConnection;
 use OCP\IL10N;
 use OCP\ILogger;
 use OCP\IRequest;
+use OCP\IServerContainer;
 use OCP\IURLGenerator;
 use OCP\Lock\ILockingProvider;
 use PHPUnit\Framework\MockObject\MockObject;
@@ -99,6 +101,10 @@ class CheckSetupControllerTest extends TestCase {
        private $iniGetWrapper;
        /** @var IDBConnection|\PHPUnit\Framework\MockObject\MockObject */
        private $connection;
+       /** @var IAppManager|MockObject */
+       private $appManager;
+       /** @var IServerContainer|MockObject */
+       private $serverContainer;
 
        /**
         * Holds a list of directories created during tests.
@@ -141,6 +147,8 @@ class CheckSetupControllerTest extends TestCase {
                $this->iniGetWrapper = $this->getMockBuilder(IniGetWrapper::class)->getMock();
                $this->connection = $this->getMockBuilder(IDBConnection::class)
                        ->disableOriginalConstructor()->getMock();
+               $this->appManager = $this->createMock(IAppManager::class);
+               $this->serverContainer = $this->createMock(IServerContainer::class);
                $this->checkSetupController = $this->getMockBuilder(CheckSetupController::class)
                        ->setConstructorArgs([
                                'settings',
@@ -159,6 +167,8 @@ class CheckSetupControllerTest extends TestCase {
                                $this->secureRandom,
                                $this->iniGetWrapper,
                                $this->connection,
+                               $this->appManager,
+                               $this->serverContainer,
                        ])
                        ->setMethods([
                                'isReadOnlyConfig',
@@ -617,6 +627,7 @@ class CheckSetupControllerTest extends TestCase {
                                'imageMagickLacksSVGSupport' => false,
                                'isDefaultPhoneRegionSet' => false,
                                'OCA\Settings\SetupChecks\SupportedDatabase' => ['pass' => true, 'description' => '', 'severity' => 'info'],
+                               \OCA\Settings\SetupChecks\LdapInvalidUuids::class => ['pass' => true, 'description' =>  'Invalid UUIDs of LDAP users or groups have been found. Please review your "Override UUID detection" settings in the Expert part of the LDAP configuration and use "occ ldap:update-uuid" to update them.', 'severity' => 'warning'],
                        ]
                );
                $this->assertEquals($expected, $this->checkSetupController->check());
@@ -641,6 +652,8 @@ class CheckSetupControllerTest extends TestCase {
                                $this->secureRandom,
                                $this->iniGetWrapper,
                                $this->connection,
+                               $this->appManager,
+                               $this->serverContainer
                        ])
                        ->setMethods(null)->getMock();
 
@@ -1410,7 +1423,9 @@ Array
                                $this->memoryInfo,
                                $this->secureRandom,
                                $this->iniGetWrapper,
-                               $this->connection
+                               $this->connection,
+                               $this->appManager,
+                               $this->serverContainer
                        );
 
                $this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isMysqlUsedWithoutUTF8MB4'));
@@ -1460,7 +1475,9 @@ Array
                        $this->memoryInfo,
                        $this->secureRandom,
                        $this->iniGetWrapper,
-                       $this->connection
+                       $this->connection,
+                       $this->appManager,
+                       $this->serverContainer
                );
 
                $this->assertSame($expected, $this->invokePrivate($checkSetupController, 'isEnoughTempSpaceAvailableIfS3PrimaryStorageIsUsed'));
index c483454cb9113c5d41cbccb59f023908ff94e01a..9f0209d98db34b04402e6c3f5fcea37291b0d2c5 100644 (file)
                                        OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LegacySSEKeyFormat', messages)
                                        OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\CheckUserCertificates', messages)
                                        OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\SupportedDatabase', messages)
+                                       OC.SetupChecks.addGenericSetupCheck(data, 'OCA\\Settings\\SetupChecks\\LdapInvalidUuids', messages)
 
                                } else {
                                        messages.push({