Skip to content

[#2198] Added support for ACME challenge in Shield. #2254

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

Merged
AlexSkrypnyk merged 1 commit into from
Feb 8, 2026
Merged

[#2198] Added support for ACME challenge in Shield. #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
84 changes: 84 additions & 0 deletions .../tests/Fixtures/handler_process/_baseline/tests/phpunit/Drupal/SwitchableSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -529,6 +529,90 @@ public static function dataProviderShield(): array {
'shield.settings' => ['shield_enable' => FALSE],
],
],

// ACME challenge passthrough tests.
[
self::ENVIRONMENT_DEV,
[
'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
],
[
'shield.settings' => [
'shield_enable' => TRUE,
'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
'method' => 0,
'paths' => '/.well-known/acme-challenge/*',
],
],
],
[
self::ENVIRONMENT_LOCAL,
[
'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
],
[
'shield.settings' => [
'shield_enable' => FALSE,
'method' => 0,
'paths' => '/.well-known/acme-challenge/*',
],
],
],
// ACME challenge disabled - verify settings are absent.
[
self::ENVIRONMENT_DEV,
[
'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
],
[
'shield.settings' => [
'shield_enable' => TRUE,
'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
],
],
[
'shield.settings' => ['method' => NULL, 'paths' => NULL],
],
],
// ACME challenge with empty value - should not set.
[
self::ENVIRONMENT_DEV,
[
'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => '',
],
[
'shield.settings' => [
'shield_enable' => TRUE,
'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
],
],
[
'shield.settings' => ['method' => NULL, 'paths' => NULL],
],
],
// ACME challenge with 0 value - should not set.
[
self::ENVIRONMENT_DEV,
[
'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 0,
],
[
'shield.settings' => [
'shield_enable' => TRUE,
'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
],
],
[
'shield.settings' => ['method' => NULL, 'paths' => NULL],
],
],
];
}

Expand Down
6 changes: 6 additions & 0 deletions ...Fixtures/handler_process/_baseline/web/sites/default/includes/modules/settings.shield.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@
if (!empty(getenv('DRUPAL_SHIELD_DISABLED'))) {
$config['shield.settings']['shield_enable'] = FALSE;
}

// Allow ACME challenge path for Let's Encrypt certificate generation.
if (!empty(getenv('DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE'))) {
$config['shield.settings']['method'] = 0;
$config['shield.settings']['paths'] = '/.well-known/acme-challenge/*';
}
6 changes: 6 additions & 0 deletions ...handler_process/hosting_acquia/docroot/sites/default/includes/modules/settings.shield.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@
if (!empty(getenv('DRUPAL_SHIELD_DISABLED'))) {
$config['shield.settings']['shield_enable'] = FALSE;
}

// Allow ACME challenge path for Let's Encrypt certificate generation.
if (!empty(getenv('DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE'))) {
$config['shield.settings']['method'] = 0;
$config['shield.settings']['paths'] = '/.well-known/acme-challenge/*';
}
6 changes: 6 additions & 0 deletions .../hosting_project_name___acquia/docroot/sites/default/includes/modules/settings.shield.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,3 +45,9 @@
if (!empty(getenv('DRUPAL_SHIELD_DISABLED'))) {
$config['shield.settings']['shield_enable'] = FALSE;
}

// Allow ACME challenge path for Let's Encrypt certificate generation.
if (!empty(getenv('DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE'))) {
$config['shield.settings']['method'] = 0;
$config['shield.settings']['paths'] = '/.well-known/acme-challenge/*';
}
86 changes: 85 additions & 1 deletion ...modules_no_seckit_shield_stage_file_proxy/tests/phpunit/Drupal/SwitchableSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -301,365 +301,6 @@
@@ -301,449 +301,6 @@
}

/**
Expand Down Expand Up @@ -230,6 +230,90 @@
- 'shield.settings' => ['shield_enable' => FALSE],
- ],
- ],
-
- // ACME challenge passthrough tests.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- 'method' => 0,
- 'paths' => '/.well-known/acme-challenge/*',
- ],
- ],
- ],
- [
- self::ENVIRONMENT_LOCAL,
- [
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => FALSE,
- 'method' => 0,
- 'paths' => '/.well-known/acme-challenge/*',
- ],
- ],
- ],
- // ACME challenge disabled - verify settings are absent.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- // ACME challenge with empty value - should not set.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => '',
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- // ACME challenge with 0 value - should not set.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 0,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- ];
- }
-
Expand Down
86 changes: 85 additions & 1 deletion ...ixtures/handler_process/modules_no_shield/tests/phpunit/Drupal/SwitchableSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -301,238 +301,6 @@
@@ -301,322 +301,6 @@
}

/**
Expand Down Expand Up @@ -230,6 +230,90 @@
- 'shield.settings' => ['shield_enable' => FALSE],
- ],
- ],
-
- // ACME challenge passthrough tests.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- 'method' => 0,
- 'paths' => '/.well-known/acme-challenge/*',
- ],
- ],
- ],
- [
- self::ENVIRONMENT_LOCAL,
- [
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 1,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => FALSE,
- 'method' => 0,
- 'paths' => '/.well-known/acme-challenge/*',
- ],
- ],
- ],
- // ACME challenge disabled - verify settings are absent.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- // ACME challenge with empty value - should not set.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => '',
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- // ACME challenge with 0 value - should not set.
- [
- self::ENVIRONMENT_DEV,
- [
- 'DRUPAL_SHIELD_USER' => 'drupal_shield_user',
- 'DRUPAL_SHIELD_PASS' => 'drupal_shield_pass',
- 'DRUPAL_SHIELD_ALLOW_ACME_CHALLENGE' => 0,
- ],
- [
- 'shield.settings' => [
- 'shield_enable' => TRUE,
- 'credentials' => ['shield' => ['user' => 'drupal_shield_user', 'pass' => 'drupal_shield_pass']],
- ],
- ],
- [
- 'shield.settings' => ['method' => NULL, 'paths' => NULL],
- ],
- ],
- ];
- }
-
Expand Down
2 changes: 1 addition & 1 deletion ...ndler_process/modules_no_stage_file_proxy/tests/phpunit/Drupal/SwitchableSettingsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
@@ -533,133 +533,6 @@
@@ -617,133 +617,6 @@
}

/**
Expand Down
Loading