-
-
Notifications
You must be signed in to change notification settings - Fork 4.1k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #43908 from nextcloud/feat/migrate-data-directory-…
…setup-check feat(settings): Migrate data directory protection check to `SetupCheck`
- Loading branch information
Showing
11 changed files
with
230 additions
and
78 deletions.
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
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
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,80 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2024 Ferdinand Thiessen <opensource@fthiessen.de> | ||
| * | ||
| * @author Ferdinand Thiessen <opensource@fthiessen.de> | ||
| * | ||
| * @license AGPL-3.0-or-later | ||
| * | ||
| * 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 OCA\Settings\SetupChecks; | ||
|
|
||
| use OCP\Http\Client\IClientService; | ||
| use OCP\IConfig; | ||
| use OCP\IL10N; | ||
| use OCP\IURLGenerator; | ||
| use OCP\SetupCheck\ISetupCheck; | ||
| use OCP\SetupCheck\SetupResult; | ||
| use Psr\Log\LoggerInterface; | ||
|
|
||
| /** | ||
| * Checks if the data directory can not be accessed from outside | ||
| */ | ||
| class DataDirectoryProtected implements ISetupCheck { | ||
| use CheckServerResponseTrait; | ||
|
|
||
| public function __construct( | ||
| protected IL10N $l10n, | ||
| protected IConfig $config, | ||
| protected IURLGenerator $urlGenerator, | ||
| protected IClientService $clientService, | ||
| protected LoggerInterface $logger, | ||
| ) { | ||
| } | ||
|
|
||
| public function getCategory(): string { | ||
| return 'network'; | ||
| } | ||
|
|
||
| public function getName(): string { | ||
| return $this->l10n->t('Data directory protected'); | ||
| } | ||
|
|
||
| public function run(): SetupResult { | ||
| $datadir = str_replace(\OC::$SERVERROOT . '/', '', $this->config->getSystemValue('datadirectory', '')); | ||
|
|
||
| $dataUrl = $this->urlGenerator->getWebroot() . '/' . $datadir . '/.ocdata'; | ||
|
|
||
| $noResponse = true; | ||
| foreach ($this->runHEAD($dataUrl, httpErrors:false) as $response) { | ||
| $noResponse = false; | ||
| if ($response->getStatusCode() === 200) { | ||
| return SetupResult::error($this->l10n->t('Your data directory and files are probably accessible from the internet. The .htaccess file is not working. It is strongly recommended that you configure your web server so that the data directory is no longer accessible, or move the data directory outside the web server document root.')); | ||
| } else { | ||
| $this->logger->debug('[expected] Could not access data directory from outside.', ['url' => $dataUrl]); | ||
| } | ||
| } | ||
|
|
||
| if ($noResponse) { | ||
| return SetupResult::warning($this->l10n->t('Could not check that the data directory is protected. Please check manually that your server does not allow access to the data directory.') . "\n" . $this->serverConfigHelp()); | ||
| } | ||
| return SetupResult::success(); | ||
|
|
||
| } | ||
| } |
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
136 changes: 136 additions & 0 deletions
136
apps/settings/tests/SetupChecks/DataDirectoryProtectedTest.php
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,136 @@ | ||
| <?php | ||
|
|
||
| declare(strict_types=1); | ||
|
|
||
| /** | ||
| * @copyright Copyright (c) 2024 Ferdinand Thiessen <opensource@fthiessen.de> | ||
| * | ||
| * @author Ferdinand Thiessen <opensource@fthiessen.de> | ||
| * | ||
| * @license AGPL-3.0-or-later | ||
| * | ||
| * 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 OCA\Settings\Tests; | ||
|
|
||
| use OCA\Settings\SetupChecks\DataDirectoryProtected; | ||
| use OCP\Http\Client\IClientService; | ||
| use OCP\Http\Client\IResponse; | ||
| use OCP\IConfig; | ||
| use OCP\IL10N; | ||
| use OCP\IURLGenerator; | ||
| use OCP\SetupCheck\SetupResult; | ||
| use PHPUnit\Framework\MockObject\MockObject; | ||
| use Psr\Log\LoggerInterface; | ||
| use Test\TestCase; | ||
|
|
||
| class DataDirectoryProtectedTest extends TestCase { | ||
| private IL10N|MockObject $l10n; | ||
| private IConfig|MockObject $config; | ||
| private IURLGenerator|MockObject $urlGenerator; | ||
| private IClientService|MockObject $clientService; | ||
| private LoggerInterface|MockObject $logger; | ||
| private DataDirectoryProtected|MockObject $setupcheck; | ||
|
|
||
| protected function setUp(): void { | ||
| parent::setUp(); | ||
|
|
||
| /** @var IL10N|MockObject */ | ||
| $this->l10n = $this->getMockBuilder(IL10N::class) | ||
| ->disableOriginalConstructor()->getMock(); | ||
| $this->l10n->expects($this->any()) | ||
| ->method('t') | ||
| ->willReturnCallback(function ($message, array $replace) { | ||
| return vsprintf($message, $replace); | ||
| }); | ||
|
|
||
| $this->config = $this->createMock(IConfig::class); | ||
| $this->urlGenerator = $this->createMock(IURLGenerator::class); | ||
| $this->clientService = $this->createMock(IClientService::class); | ||
| $this->logger = $this->createMock(LoggerInterface::class); | ||
|
|
||
| $this->setupcheck = $this->getMockBuilder(DataDirectoryProtected::class) | ||
| ->onlyMethods(['runHEAD']) | ||
| ->setConstructorArgs([ | ||
| $this->l10n, | ||
| $this->config, | ||
| $this->urlGenerator, | ||
| $this->clientService, | ||
| $this->logger, | ||
| ]) | ||
| ->getMock(); | ||
| } | ||
|
|
||
| /** | ||
| * @dataProvider dataTestStatusCode | ||
| */ | ||
| public function testStatusCode(array $status, string $expected): void { | ||
| $responses = array_map(function ($state) { | ||
| $response = $this->createMock(IResponse::class); | ||
| $response->expects($this->any())->method('getStatusCode')->willReturn($state); | ||
| return $response; | ||
| }, $status); | ||
|
|
||
| $this->setupcheck | ||
| ->expects($this->once()) | ||
| ->method('runHEAD') | ||
| ->will($this->generate($responses)); | ||
|
|
||
| $this->config | ||
| ->expects($this->once()) | ||
| ->method('getSystemValue') | ||
| ->willReturn(''); | ||
|
|
||
| $result = $this->setupcheck->run(); | ||
| $this->assertEquals($expected, $result->getSeverity()); | ||
| } | ||
|
|
||
| public function dataTestStatusCode(): array { | ||
| return [ | ||
| 'success: forbidden access' => [[403], SetupResult::SUCCESS], | ||
| 'error: can access' => [[200], SetupResult::ERROR], | ||
| 'error: one forbidden one can access' => [[403, 200], SetupResult::ERROR], | ||
| 'warning: connection issue' => [[], SetupResult::WARNING], | ||
| ]; | ||
| } | ||
|
|
||
| public function testNoResponse(): void { | ||
| $response = $this->createMock(IResponse::class); | ||
| $response->expects($this->any())->method('getStatusCode')->willReturn(200); | ||
|
|
||
| $this->setupcheck | ||
| ->expects($this->once()) | ||
| ->method('runHEAD') | ||
| ->will($this->generate([])); | ||
|
|
||
| $this->config | ||
| ->expects($this->once()) | ||
| ->method('getSystemValue') | ||
| ->willReturn(''); | ||
|
|
||
| $result = $this->setupcheck->run(); | ||
| $this->assertEquals(SetupResult::WARNING, $result->getSeverity()); | ||
| $this->assertMatchesRegularExpression('/^Could not check/', $result->getDescription()); | ||
| } | ||
|
|
||
| /** | ||
| * Helper function creates a nicer interface for mocking Generator behavior | ||
| */ | ||
| protected function generate(array $yield_values) { | ||
| return $this->returnCallback(function () use ($yield_values) { | ||
| yield from $yield_values; | ||
| }); | ||
| } | ||
| } |
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.