-
Notifications
You must be signed in to change notification settings - Fork 24.9k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Enable explicitly enforcing bootstrap checks
This commit adds a system property that enables end-users to explicitly enforce the bootstrap checks, independently of the binding of the transport protocol. This can be useful for single-node production systems that do not bind the transport protocol (and thus the bootstrap checks would not be enforced). Relates #23585
- Loading branch information
1 parent
74675c9
commit 4c3cf76
Showing
4 changed files
with
158 additions
and
10 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
116 changes: 116 additions & 0 deletions
116
qa/evil-tests/src/test/java/org/elasticsearch/bootstrap/EvilBootstrapChecksTests.java
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,116 @@ | ||
| /* | ||
| * Licensed to Elasticsearch under one or more contributor | ||
| * license agreements. See the NOTICE file distributed with | ||
| * this work for additional information regarding copyright | ||
| * ownership. Elasticsearch licenses this file to you under | ||
| * the Apache License, Version 2.0 (the "License"); you may | ||
| * not use this file except in compliance with the License. | ||
| * You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| * | ||
| */ | ||
|
|
||
| package org.elasticsearch.bootstrap; | ||
|
|
||
| import org.apache.logging.log4j.Logger; | ||
| import org.elasticsearch.common.SuppressForbidden; | ||
| import org.elasticsearch.node.NodeValidationException; | ||
| import org.elasticsearch.test.ESTestCase; | ||
| import org.hamcrest.Matcher; | ||
| import org.junit.After; | ||
| import org.junit.Before; | ||
|
|
||
| import java.util.Collections; | ||
| import java.util.List; | ||
|
|
||
| import static java.util.Collections.emptyList; | ||
| import static org.elasticsearch.bootstrap.BootstrapChecks.ES_ENFORCE_BOOTSTRAP_CHECKS; | ||
| import static org.hamcrest.Matchers.allOf; | ||
| import static org.hamcrest.Matchers.containsString; | ||
| import static org.hamcrest.Matchers.hasToString; | ||
| import static org.mockito.Mockito.mock; | ||
| import static org.mockito.Mockito.verify; | ||
| import static org.mockito.Mockito.verifyNoMoreInteractions; | ||
|
|
||
| public class EvilBootstrapChecksTests extends ESTestCase { | ||
|
|
||
| private String esEnforceBootstrapChecks = System.getProperty(ES_ENFORCE_BOOTSTRAP_CHECKS); | ||
|
|
||
| @Override | ||
| @Before | ||
| public void setUp() throws Exception { | ||
| super.setUp(); | ||
| } | ||
|
|
||
| @Override | ||
| @After | ||
| public void tearDown() throws Exception { | ||
| setEsEnforceBootstrapChecks(esEnforceBootstrapChecks); | ||
| super.tearDown(); | ||
| } | ||
|
|
||
| public void testEnforceBootstrapChecks() throws NodeValidationException { | ||
| setEsEnforceBootstrapChecks("true"); | ||
| final List<BootstrapCheck> checks = Collections.singletonList( | ||
| new BootstrapCheck() { | ||
| @Override | ||
| public boolean check() { | ||
| return true; | ||
| } | ||
|
|
||
| @Override | ||
| public String errorMessage() { | ||
| return "error"; | ||
| } | ||
| } | ||
| ); | ||
| final Logger logger = mock(Logger.class); | ||
|
|
||
| final NodeValidationException e = expectThrows( | ||
| NodeValidationException.class, | ||
| () -> BootstrapChecks.check(false, checks, logger)); | ||
| final Matcher<String> allOf = | ||
| allOf(containsString("bootstrap checks failed"), containsString("error")); | ||
| assertThat(e, hasToString(allOf)); | ||
| verify(logger).info("explicitly enforcing bootstrap checks"); | ||
| verifyNoMoreInteractions(logger); | ||
| } | ||
|
|
||
| public void testNonEnforcedBootstrapChecks() throws NodeValidationException { | ||
| setEsEnforceBootstrapChecks(null); | ||
| final Logger logger = mock(Logger.class); | ||
| // nothing should happen | ||
| BootstrapChecks.check(false, emptyList(), logger); | ||
| verifyNoMoreInteractions(logger); | ||
| } | ||
|
|
||
| public void testInvalidValue() { | ||
| final String value = randomAsciiOfLength(8); | ||
| setEsEnforceBootstrapChecks(value); | ||
| final boolean enforceLimits = randomBoolean(); | ||
| final IllegalArgumentException e = expectThrows( | ||
| IllegalArgumentException.class, | ||
| () -> BootstrapChecks.check(enforceLimits, emptyList(), "testInvalidValue")); | ||
| final Matcher<String> matcher = containsString( | ||
| "[es.enforce.bootstrap.checks] must be [true] but was [" + value + "]"); | ||
| assertThat(e, hasToString(matcher)); | ||
| } | ||
|
|
||
| @SuppressForbidden(reason = "set or clear system property es.enforce.bootstrap.checks") | ||
| public void setEsEnforceBootstrapChecks(final String value) { | ||
| if (value == null) { | ||
| System.clearProperty(ES_ENFORCE_BOOTSTRAP_CHECKS); | ||
| } else { | ||
| System.setProperty(ES_ENFORCE_BOOTSTRAP_CHECKS, value); | ||
| } | ||
| } | ||
|
|
||
| } |