Skip to content

Commit 9d34164

Browse files
tvernumtvernum
authored
Add build utility to check cluster health over ssl (#40713)
By default, in integ tests we wait for the standalone cluster to start by using the ant Get task to retrieve the cluster health endpoint. However the ant task has no facilities for customising the trusted CAs for a https resource, so if the integ test cluster has TLS enabled on the http interface (using a custom CA) we need a separate utility for that purpose. Backport of: #40573
1 parent d16f86f commit 9d34164

File tree

7 files changed

+333
-97
lines changed

7 files changed

+333
-97
lines changed

‎buildSrc/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -245,6 +245,7 @@ if (project != rootProject) {
245245

246246
forbiddenPatterns {
247247
exclude '**/*.wav'
248+
exclude '**/*.p12'
248249
// the file that actually defines nocommit
249250
exclude '**/ForbiddenPatternsTask.java'
250251
}

‎buildSrc/src/main/java/org/elasticsearch/gradle/http/WaitForHttpResource.java‎

Lines changed: 233 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,233 @@
1+
/*
2+
* Licensed to Elasticsearch under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.elasticsearch.gradle.http;
21+
22+
import org.gradle.api.logging.Logger;
23+
import org.gradle.api.logging.Logging;
24+
25+
import javax.net.ssl.HttpsURLConnection;
26+
import javax.net.ssl.KeyManager;
27+
import javax.net.ssl.SSLContext;
28+
import javax.net.ssl.TrustManagerFactory;
29+
import java.io.File;
30+
import java.io.FileInputStream;
31+
import java.io.IOException;
32+
import java.io.InputStream;
33+
import java.net.HttpURLConnection;
34+
import java.net.MalformedURLException;
35+
import java.net.URL;
36+
import java.nio.charset.StandardCharsets;
37+
import java.security.GeneralSecurityException;
38+
import java.security.KeyStore;
39+
import java.security.KeyStoreException;
40+
import java.security.SecureRandom;
41+
import java.security.cert.Certificate;
42+
import java.security.cert.CertificateFactory;
43+
import java.util.Arrays;
44+
import java.util.Base64;
45+
import java.util.Collections;
46+
import java.util.Enumeration;
47+
import java.util.HashSet;
48+
import java.util.Set;
49+
import java.util.concurrent.TimeUnit;
50+
51+
/**
52+
* A utility to wait for a specific HTTP resource to be available, optionally with customized TLS trusted CAs.
53+
* This is logically similar to using the Ant Get task to retrieve a resource, but with the difference that it can
54+
* access resources that do not use the JRE's default trusted CAs.
55+
*/
56+
public class WaitForHttpResource {
57+
58+
private static final Logger logger = Logging.getLogger(WaitForHttpResource.class);
59+
60+
private Set<Integer> validResponseCodes = Collections.singleton(200);
61+
private URL url;
62+
private Set<File> certificateAuthorities;
63+
private File trustStoreFile;
64+
private String trustStorePassword;
65+
private String username;
66+
private String password;
67+
68+
public WaitForHttpResource(String protocol, String host, int numberOfNodes) throws MalformedURLException {
69+
this(new URL(protocol + "://" + host + "/_cluster/health?wait_for_nodes=>=" + numberOfNodes + "&wait_for_status=yellow"));
70+
}
71+
72+
public WaitForHttpResource(URL url) {
73+
this.url = url;
74+
}
75+
76+
public void setValidResponseCodes(int... validResponseCodes) {
77+
this.validResponseCodes = new HashSet<>(validResponseCodes.length);
78+
for (int rc : validResponseCodes) {
79+
this.validResponseCodes.add(rc);
80+
}
81+
}
82+
83+
public void setCertificateAuthorities(File... certificateAuthorities) {
84+
this.certificateAuthorities = new HashSet<>(Arrays.asList(certificateAuthorities));
85+
}
86+
87+
public void setTrustStoreFile(File trustStoreFile) {
88+
this.trustStoreFile = trustStoreFile;
89+
}
90+
91+
public void setTrustStorePassword(String trustStorePassword) {
92+
this.trustStorePassword = trustStorePassword;
93+
}
94+
95+
public void setUsername(String username) {
96+
this.username = username;
97+
}
98+
99+
public void setPassword(String password) {
100+
this.password = password;
101+
}
102+
103+
public boolean wait(int durationInMs) throws GeneralSecurityException, InterruptedException, IOException {
104+
final long waitUntil = System.nanoTime() + TimeUnit.MILLISECONDS.toNanos(durationInMs);
105+
final long sleep = Long.max(durationInMs / 10, 100);
106+
107+
final SSLContext ssl;
108+
final KeyStore trustStore = buildTrustStore();
109+
if (trustStore != null) {
110+
ssl = createSslContext(trustStore);
111+
} else {
112+
ssl = null;
113+
}
114+
IOException failure = null;
115+
for (; ; ) {
116+
try {
117+
checkResource(ssl);
118+
return true;
119+
} catch (IOException e) {
120+
logger.debug("Failed to access resource [{}]", url, e);
121+
failure = e;
122+
}
123+
if (System.nanoTime() < waitUntil) {
124+
Thread.sleep(sleep);
125+
} else {
126+
logger.error("Failed to access url [{}]", url, failure);
127+
return false;
128+
}
129+
}
130+
}
131+
132+
protected void checkResource(SSLContext ssl) throws IOException {
133+
try {
134+
final HttpURLConnection connection = buildConnection(ssl);
135+
connection.connect();
136+
final Integer response = connection.getResponseCode();
137+
if (validResponseCodes.contains(response)) {
138+
logger.info("Got successful response [{}] from URL [{}]", response, url);
139+
return;
140+
} else {
141+
throw new IOException(response + " " + connection.getResponseMessage());
142+
}
143+
} catch (IOException e) {
144+
throw e;
145+
}
146+
}
147+
148+
HttpURLConnection buildConnection(SSLContext ssl) throws IOException {
149+
final HttpURLConnection connection = (HttpURLConnection) this.url.openConnection();
150+
configureSslContext(connection, ssl);
151+
configureBasicAuth(connection);
152+
connection.setRequestMethod("GET");
153+
return connection;
154+
}
155+
156+
private void configureSslContext(HttpURLConnection connection, SSLContext ssl) {
157+
if (ssl != null) {
158+
if (connection instanceof HttpsURLConnection) {
159+
((HttpsURLConnection) connection).setSSLSocketFactory(ssl.getSocketFactory());
160+
} else {
161+
throw new IllegalStateException("SSL trust has been configured, but [" + url + "] is not a 'https' URL");
162+
}
163+
}
164+
}
165+
166+
private void configureBasicAuth(HttpURLConnection connection) {
167+
if (username != null) {
168+
if (password == null) {
169+
throw new IllegalStateException("Basic Auth user [" + username
170+
+ "] has been set, but no password has been configured");
171+
}
172+
connection.setRequestProperty("Authorization",
173+
"Basic " + Base64.getEncoder().encodeToString((username + ":" + password).getBytes(StandardCharsets.UTF_8)));
174+
}
175+
}
176+
177+
KeyStore buildTrustStore() throws GeneralSecurityException, IOException {
178+
if (this.certificateAuthorities != null) {
179+
if (trustStoreFile != null) {
180+
throw new IllegalStateException("Cannot specify both truststore and CAs");
181+
}
182+
return buildTrustStoreFromCA();
183+
} else if (trustStoreFile != null) {
184+
return buildTrustStoreFromFile();
185+
} else {
186+
return null;
187+
}
188+
}
189+
190+
private KeyStore buildTrustStoreFromFile() throws GeneralSecurityException, IOException {
191+
KeyStore keyStore = KeyStore.getInstance(trustStoreFile.getName().endsWith(".jks") ? "JKS" : "PKCS12");
192+
try (InputStream input = new FileInputStream(trustStoreFile)) {
193+
keyStore.load(input, trustStorePassword == null ? null : trustStorePassword.toCharArray());
194+
}
195+
return keyStore;
196+
}
197+
198+
private KeyStore buildTrustStoreFromCA() throws GeneralSecurityException, IOException {
199+
final KeyStore store = KeyStore.getInstance(KeyStore.getDefaultType());
200+
store.load(null, null);
201+
final CertificateFactory certFactory = CertificateFactory.getInstance("X.509");
202+
int counter = 0;
203+
for (File ca : certificateAuthorities) {
204+
try (InputStream input = new FileInputStream(ca)) {
205+
for (Certificate certificate : certFactory.generateCertificates(input)) {
206+
store.setCertificateEntry("cert-" + counter, certificate);
207+
counter++;
208+
}
209+
}
210+
}
211+
return store;
212+
}
213+
214+
private SSLContext createSslContext(KeyStore trustStore) throws GeneralSecurityException {
215+
checkForTrustEntry(trustStore);
216+
TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
217+
tmf.init(trustStore);
218+
SSLContext sslContext = SSLContext.getInstance("TLSv1.2");
219+
sslContext.init(new KeyManager[0], tmf.getTrustManagers(), new SecureRandom());
220+
return sslContext;
221+
}
222+
223+
private void checkForTrustEntry(KeyStore trustStore) throws KeyStoreException {
224+
Enumeration<String> enumeration = trustStore.aliases();
225+
while (enumeration.hasMoreElements()) {
226+
if (trustStore.isCertificateEntry(enumeration.nextElement())) {
227+
// found trusted cert entry
228+
return;
229+
}
230+
}
231+
throw new IllegalStateException("Trust-store does not contain any trusted certificate entries");
232+
}
233+
}

‎buildSrc/src/test/java/org/elasticsearch/gradle/http/WaitForHttpResourceTests.java‎

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,60 @@
1+
/*
2+
* Licensed to Elasticsearch under one or more contributor
3+
* license agreements. See the NOTICE file distributed with
4+
* this work for additional information regarding copyright
5+
* ownership. Elasticsearch licenses this file to you under
6+
* the Apache License, Version 2.0 (the "License"); you may
7+
* not use this file except in compliance with the License.
8+
* You may obtain a copy of the License at
9+
*
10+
* http://www.apache.org/licenses/LICENSE-2.0
11+
*
12+
* Unless required by applicable law or agreed to in writing,
13+
* software distributed under the License is distributed on an
14+
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15+
* KIND, either express or implied. See the License for the
16+
* specific language governing permissions and limitations
17+
* under the License.
18+
*/
19+
20+
package org.elasticsearch.gradle.http;
21+
22+
import org.elasticsearch.gradle.test.GradleUnitTestCase;
23+
24+
import java.io.File;
25+
import java.net.URL;
26+
import java.security.KeyStore;
27+
import java.security.cert.Certificate;
28+
import java.security.cert.X509Certificate;
29+
30+
import static org.hamcrest.CoreMatchers.equalTo;
31+
import static org.hamcrest.CoreMatchers.instanceOf;
32+
import static org.hamcrest.CoreMatchers.notNullValue;
33+
34+
public class WaitForHttpResourceTests extends GradleUnitTestCase {
35+
36+
public void testBuildTrustStoreFromFile() throws Exception {
37+
final WaitForHttpResource http = new WaitForHttpResource(new URL("https://localhost/"));
38+
final URL ca = getClass().getResource("/ca.p12");
39+
assertThat(ca, notNullValue());
40+
http.setTrustStoreFile(new File(ca.getPath()));
41+
http.setTrustStorePassword("password");
42+
final KeyStore store = http.buildTrustStore();
43+
final Certificate certificate = store.getCertificate("ca");
44+
assertThat(certificate, notNullValue());
45+
assertThat(certificate, instanceOf(X509Certificate.class));
46+
assertThat(((X509Certificate)certificate).getSubjectDN().toString(), equalTo("CN=Elastic Certificate Tool Autogenerated CA"));
47+
}
48+
49+
public void testBuildTrustStoreFromCA() throws Exception {
50+
final WaitForHttpResource http = new WaitForHttpResource(new URL("https://localhost/"));
51+
final URL ca = getClass().getResource("/ca.pem");
52+
assertThat(ca, notNullValue());
53+
http.setCertificateAuthorities(new File(ca.getPath()));
54+
final KeyStore store = http.buildTrustStore();
55+
final Certificate certificate = store.getCertificate("cert-0");
56+
assertThat(certificate, notNullValue());
57+
assertThat(certificate, instanceOf(X509Certificate.class));
58+
assertThat(((X509Certificate)certificate).getSubjectDN().toString(), equalTo("CN=Elastic Certificate Tool Autogenerated CA"));
59+
}
60+
}

‎buildSrc/src/test/resources/ca.p12‎

1.1 KB
Binary file not shown.

‎buildSrc/src/test/resources/ca.pem‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
Bag Attributes
2+
friendlyName: ca
3+
localKeyID: 54 69 6D 65 20 31 35 35 33 37 34 33 38 39 30 38 33 35
4+
subject=/CN=Elastic Certificate Tool Autogenerated CA
5+
issuer=/CN=Elastic Certificate Tool Autogenerated CA
6+
-----BEGIN CERTIFICATE-----
7+
MIIDSjCCAjKgAwIBAgIVAMQMmDRcXfXLaTp6ep1H8rC3tOrwMA0GCSqGSIb3DQEB
8+
CwUAMDQxMjAwBgNVBAMTKUVsYXN0aWMgQ2VydGlmaWNhdGUgVG9vbCBBdXRvZ2Vu
9+
ZXJhdGVkIENBMB4XDTE5MDMyODAzMzEyNloXDTIyMDMyNzAzMzEyNlowNDEyMDAG
10+
A1UEAxMpRWxhc3RpYyBDZXJ0aWZpY2F0ZSBUb29sIEF1dG9nZW5lcmF0ZWQgQ0Ew
11+
ggEiMA0GCSqGSIb3DQEBAQUAA4IBDwAwggEKAoIBAQDT73N6JZeBPyzahc0aNcra
12+
BpUROVGB9wXQqf8JeU4GtH+1qfqUKYKUJTe/DZWc+5Qz1WAKGZEvBySAlgbuncuq
13+
VpLzWxpEui1vRW8JB3gjZgeY3vfErrEWWr95YM0e8rWu4AoAchzqsrG0/+po2eui
14+
cN+8hI6jRKiBv/ZeQqja6KZ8y4Wt4VaNVL53+I7+eWA/aposu6/piUg2wZ/FNhVK
15+
hypcJwDdp3fQaugtPj3y76303jTRgutgd3rtWFuy3MCDLfs3mSQUjO10s93zwLdC
16+
XokyIywijS5CpO8mEuDRu9rb5J1DzwUpUfk+GMObb6rHjFKzSqnM3s+nasypQQ9L
17+
AgMBAAGjUzBRMB0GA1UdDgQWBBQZEW88R95zSzO2tLseEWgI7ugvLzAfBgNVHSME
18+
GDAWgBQZEW88R95zSzO2tLseEWgI7ugvLzAPBgNVHRMBAf8EBTADAQH/MA0GCSqG
19+
SIb3DQEBCwUAA4IBAQBEJN0UbL77usVnzIvxKa3GpLBgJQAZtD1ifZppC4w46Bul
20+
1G7Fdc+XMbzZlI4K6cWEdd5dfEssKA8btEtRzdNOqgggBpqrUU0mNlQ+vC22XORU
21+
ykHAu2TsRwoHmuxkd9Et/QyuTFXR4fTiU8rsJuLFOgn+RdEblA0J0gJeIqdWI5Z1
22+
z13OyZEl6BCQFyrntu2eERxaHEfsJOSBZE4RcecnLNGhIJBXE0Pk4iTiViJF/h7d
23+
+kUUegKx0qewZif2eEZgrz12Vuen9a6bh2i2pNS95vABVVMr8uB+J1BGkNA5YT7J
24+
qtZA2tN//Evng7YDiR+KkB1kvXVZVIi2WPDLD/zu
25+
-----END CERTIFICATE-----

‎x-pack/qa/reindex-tests-with-security/build.gradle‎

Lines changed: 7 additions & 50 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,4 @@
1-
import javax.net.ssl.HttpsURLConnection
2-
import javax.net.ssl.KeyManager
3-
import javax.net.ssl.SSLContext
4-
import javax.net.ssl.TrustManagerFactory
5-
import java.nio.charset.StandardCharsets
6-
import java.security.KeyStore
7-
import java.security.SecureRandom
1+
import org.elasticsearch.gradle.http.WaitForHttpResource
82

93
apply plugin: 'elasticsearch.standalone-rest-test'
104
apply plugin: 'elasticsearch.rest-test'
@@ -57,48 +51,11 @@ integTestCluster {
5751
'bin/elasticsearch-users', 'useradd', user, '-p', 'x-pack-test-password', '-r', role
5852
}
5953
waitCondition = { node, ant ->
60-
// Load the CA PKCS#12 file as a truststore
61-
KeyStore ks = KeyStore.getInstance("PKCS12");
62-
ks.load(caFile.newInputStream(), 'password'.toCharArray());
63-
TrustManagerFactory tmf = TrustManagerFactory.getInstance(TrustManagerFactory.getDefaultAlgorithm());
64-
tmf.init(ks);
65-
66-
// Configre a SSL context for TLS1.2 using our CA trust manager
67-
SSLContext sslContext = SSLContext.getInstance("TLSv1.2");
68-
sslContext.init(new KeyManager[0], tmf.getTrustManagers(), new SecureRandom());
69-
70-
// Check whether the cluster has started
71-
URL url = new URL("https://${node.httpUri()}/_cluster/health?wait_for_nodes=${numNodes}&wait_for_status=yellow");
72-
for (int i = 20; i >= 0; i--) {
73-
// we use custom wait logic here for HTTPS
74-
HttpsURLConnection httpURLConnection = null;
75-
try {
76-
logger.info("Trying ${url}");
77-
httpURLConnection = (HttpsURLConnection) url.openConnection();
78-
httpURLConnection.setSSLSocketFactory(sslContext.getSocketFactory());
79-
httpURLConnection.setRequestProperty("Authorization",
80-
"Basic " + Base64.getEncoder().encodeToString("test_admin:x-pack-test-password".getBytes(StandardCharsets.UTF_8)));
81-
httpURLConnection.setRequestMethod("GET");
82-
httpURLConnection.connect();
83-
if (httpURLConnection.getResponseCode() == 200) {
84-
logger.info("Cluster has started");
85-
return true;
86-
} else {
87-
logger.debug("HTTP response was [{}]", httpURLConnection.getResponseCode());
88-
}
89-
} catch (IOException e) {
90-
if (i == 0) {
91-
logger.error("Failed to call cluster health - " + e)
92-
}
93-
logger.debug("Call to [{}] threw an exception", url, e)
94-
} finally {
95-
if (httpURLConnection != null) {
96-
httpURLConnection.disconnect();
97-
}
98-
}
99-
// did not start, so wait a bit before trying again
100-
Thread.sleep(750L);
101-
}
102-
return false;
54+
WaitForHttpResource http = new WaitForHttpResource("https", node.httpUri(), numNodes)
55+
http.setTrustStoreFile(caFile)
56+
http.setTrustStorePassword("password")
57+
http.setUsername("test_admin")
58+
http.setPassword("x-pack-test-password")
59+
return http.wait(5000)
10360
}
10461
}

0 commit comments

Comments
 (0)