Skip to content

fix(SetupChecks): allow compatible X-Robots-Tag directives #64573

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
joshtrichards wants to merge 2 commits into from
+48 −3
Open

fix(SetupChecks): allow compatible X-Robots-Tag directives #64573

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
bc1224a
fix(settings): allow compatible X-Robots-Tag directives
joshtrichards Sep 19, 2026
679b2bf
test(settings): cover compatible X-Robots-Tag directives
joshtrichards Sep 19, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
40 changes: 38 additions & 2 deletions apps/settings/lib/SetupChecks/SecurityHeaders.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,29 @@ public function run(): SetupResult {
return implode(',', $values);
};

$parseDirectives = static function (string $value): array {
$directives = array_map(
static fn (string $directive): string => strtolower(trim($directive)),
explode(',', $value)
);
Comment on lines +64 to +67

@come-nc come-nc Sep 19, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should use the same trick as above, why did you implement it different? You can strlower the whole thing.

Suggested change
$directives = array_map(
static fn (string $directive): string => strtolower(trim($directive)),
explode(',', $value)
);
$directives = array_map('trim', explode(',', strtolower($value)));


if (in_array('', $directives, true)) {
return [];
}

return $directives;
};

// These directives can safely co-exist
$allowedRobotsDirectives = [
'noindex',
'nofollow',
'noarchive',
'nosnippet',
'noimageindex',
'notranslate',
];

foreach ($urls as [$verb,$url,$validStatuses]) {
$works = null;
foreach ($this->runRequest($verb, $url, ['httpErrors' => false]) as $response) {
Expand All @@ -71,11 +94,24 @@ public function run(): SetupResult {
$msg = '';
$msgParameters = [];
foreach ($securityHeaders as $header => [$expected, $accepted]) {
$normalizedValue = $normalize($response->getHeader($header));
$headerValue = $response->getHeader($header);
$normalizedValue = $normalize($headerValue);
$normalizedExpected = $normalize($expected);
$normalizedAccepted = $accepted !== null ? $normalize($accepted) : null;

if ($normalizedValue !== $normalizedExpected) {
if ($header === 'X-Robots-Tag') {
$directives = $parseDirectives($headerValue);
$uniqueDirectives = array_unique($directives);

$isValid = $directives !== []
&& count($directives) === count($uniqueDirectives)
&& !array_diff($directives, $allowedRobotsDirectives)
&& !array_diff(['noindex', 'nofollow'], $directives);
} else {
$isValid = $normalizedValue === $normalizedExpected;
}

if (!$isValid) {
if ($normalizedAccepted !== null && $normalizedValue === $normalizedAccepted) {
$msg .= $this->l10n->t(
'- The `%1$s` HTTP header is not set to `%2$s`. Some features might not work correctly, as it is recommended to adjust this setting accordingly.',
Expand Down
11 changes: 10 additions & 1 deletion apps/settings/tests/SetupChecks/SecurityHeadersTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,8 @@ public static function dataSuccess(): array {
'basic' => [[]],
'no-space-in-x-robots' => [['X-Robots-Tag' => 'noindex,nofollow']],
'reordered-x-robots' => [['X-Robots-Tag' => 'nofollow, noindex']],
'x-robots-noarchive' => [['X-Robots-Tag' => 'noindex,nofollow,noarchive']],
'x-robots-all-allowed-directives' => [['X-Robots-Tag' => 'notranslate, noarchive, nofollow, noimageindex, noindex, nosnippet']],
'strict-origin-when-cross-origin' => [['Referrer-Policy' => 'strict-origin-when-cross-origin']],
'referrer-no-referrer-when-downgrade' => [['Referrer-Policy' => 'no-referrer-when-downgrade']],
'referrer-strict-origin' => [['Referrer-Policy' => 'strict-origin']],
Expand Down Expand Up @@ -138,7 +140,14 @@ public static function dataFailure(): array {
return [
// description => modifiedHeaders
'x-robots-none' => [['X-Robots-Tag' => 'none'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-additional-directive' => [['X-Robots-Tag' => 'noindex,nofollow,noarchive'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-missing-noindex' => [['X-Robots-Tag' => 'nofollow'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-missing-nofollow' => [['X-Robots-Tag' => 'noindex'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-conflicting-index' => [['X-Robots-Tag' => 'noindex,nofollow,index'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-conflicting-follow' => [['X-Robots-Tag' => 'noindex,nofollow,follow'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-unknown-directive' => [['X-Robots-Tag' => 'noindex,nofollow,unknown'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-duplicate-directive' => [['X-Robots-Tag' => 'noindex,nofollow,nofollow'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-trailing-comma' => [['X-Robots-Tag' => 'noindex,nofollow,'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'x-robots-empty-directive' => [['X-Robots-Tag' => 'noindex,,nofollow'], "- The `X-Robots-Tag` HTTP header is not set to `noindex,nofollow`. This is a potential security or privacy risk, as it is recommended to adjust this setting accordingly.\n"],
'referrer-origin' => [['Referrer-Policy' => 'origin'], "- The `Referrer-Policy` HTTP header is not set to `no-referrer`, `no-referrer-when-downgrade`, `strict-origin`, `strict-origin-when-cross-origin` or `same-origin`. This can leak referer information. See the {w3c-recommendation}.\n"],
'referrer-origin-when-cross-origin' => [['Referrer-Policy' => 'origin-when-cross-origin'], "- The `Referrer-Policy` HTTP header is not set to `no-referrer`, `no-referrer-when-downgrade`, `strict-origin`, `strict-origin-when-cross-origin` or `same-origin`. This can leak referer information. See the {w3c-recommendation}.\n"],
'referrer-unsafe-url' => [['Referrer-Policy' => 'unsafe-url'], "- The `Referrer-Policy` HTTP header is not set to `no-referrer`, `no-referrer-when-downgrade`, `strict-origin`, `strict-origin-when-cross-origin` or `same-origin`. This can leak referer information. See the {w3c-recommendation}.\n"],
Expand Down
Loading