Browse Source

fix: add option to remove the webroot for setup checks and don't check trusted_domains.

1) The checks for well-known urls should always run against the root domain and therefore the option to remove the webroot.

2) For trusted domains, the available protocol is unknown, and thus some guesswork would be needed to make that work. I've decided for now to not consider them anymore to reduce false-positives.

Signed-off-by: Daniel Kesselberg <mail@danielkesselberg.de>
pull/46255/head
Daniel Kesselberg 1 year ago
committed by Côme Chilliet
parent
commit
4ce4d7b9b3
No known key found for this signature in database GPG Key ID: A3E2F658B28C760A
  1. 47
      apps/settings/lib/SetupChecks/CheckServerResponseTrait.php
  2. 2
      apps/settings/lib/SetupChecks/OcxProviders.php
  3. 2
      apps/settings/lib/SetupChecks/WellKnownUrls.php

47
apps/settings/lib/SetupChecks/CheckServerResponseTrait.php

@ -35,26 +35,51 @@ trait CheckServerResponseTrait {
/**
* Get all possible URLs that need to be checked for a local request test.
* This takes all `trusted_domains` and the CLI overwrite URL into account.
*
* @param string $url The relative URL to test
* @return string[] List of possible absolute URLs
*/
protected function getTestUrls(string $url): array {
$hosts = $this->config->getSystemValue('trusted_domains', []);
$cliUrl = $this->config->getSystemValue('overwrite.cli.url', '');
if ($cliUrl !== '') {
$hosts[] = $cliUrl;
protected function getTestUrls(string $url, bool $removeWebroot): array {
$testUrls = [];
$webroot = $this->urlGenerator->getWebroot();
$baseUrl = $this->normalizeUrl(
$this->urlGenerator->getBaseUrl(),
$webroot,
$removeWebroot
);
$testUrls[] = $baseUrl . $url;
$cliUrl = $this->config->getSystemValueString('overwrite.cli.url', '');
if ($cliUrl === '') {
return $testUrls;
}
$testUrls = array_merge(
[$this->urlGenerator->getAbsoluteURL($url)],
array_map(fn (string $host): string => $host . $url, $hosts),
$cliUrl = $this->normalizeUrl(
$cliUrl,
$webroot,
$removeWebroot
);
if ($cliUrl !== $baseUrl) {
$testUrls[] = $cliUrl . $url;
}
return $testUrls;
}
/**
* Strip a trailing slash and remove the webroot if requested.
*/
protected function normalizeUrl(string $url, string $webroot, bool $removeWebroot): string {
if ($removeWebroot && str_contains($url, $webroot)) {
$url = substr($url, -strlen($webroot));
}
return rtrim($url, '/');
}
/**
* Run a HTTP request to check header
* @param string $method The HTTP method to use
@ -69,14 +94,14 @@ trait CheckServerResponseTrait {
*
* @return Generator<int, IResponse>
*/
protected function runRequest(string $method, string $url, array $options = []): Generator {
protected function runRequest(string $method, string $url, array $options = [], bool $removeWebroot = false): Generator {
$options = array_merge(['ignoreSSL' => true, 'httpErrors' => true], $options);
$client = $this->clientService->newClient();
$requestOptions = $this->getRequestOptions($options['ignoreSSL'], $options['httpErrors']);
$requestOptions = array_merge($requestOptions, $options['options'] ?? []);
foreach ($this->getTestUrls($url) as $testURL) {
foreach ($this->getTestUrls($url, $removeWebroot) as $testURL) {
try {
yield $client->request($method, $testURL, $requestOptions);
} catch (\Throwable $e) {

2
apps/settings/lib/SetupChecks/OcxProviders.php

@ -51,7 +51,7 @@ class OcxProviders implements ISetupCheck {
];
foreach ($providers as $provider) {
foreach ($this->runRequest('HEAD', $this->urlGenerator->getWebroot() . $provider, ['httpErrors' => false]) as $response) {
foreach ($this->runRequest('HEAD', $provider, ['httpErrors' => false]) as $response) {
$testedProviders[$provider] = true;
if ($response->getStatusCode() === 200) {
$workingProviders[] = $provider;

2
apps/settings/lib/SetupChecks/WellKnownUrls.php

@ -52,7 +52,7 @@ class WellKnownUrls implements ISetupCheck {
foreach ($urls as [$verb,$url,$validStatuses,$checkCustomHeader]) {
$works = null;
foreach ($this->runRequest($verb, $url, ['httpErrors' => false, 'options' => ['allow_redirects' => ['track_redirects' => true]]]) as $response) {
foreach ($this->runRequest($verb, $url, ['httpErrors' => false, 'options' => ['allow_redirects' => ['track_redirects' => true]]], removeWebroot: true) as $response) {
// Check that the response status matches
$works = in_array($response->getStatusCode(), $validStatuses);
// and (if needed) the custom Nextcloud header is set

Loading…
Cancel
Save