1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
|
// Copyright Vespa.ai. Licensed under the terms of the Apache 2.0 license. See LICENSE in the project root.
package com.yahoo.jdisc.http.server.jetty;
import com.yahoo.container.logging.ConnectionLogEntry;
import com.yahoo.security.SslContextBuilder;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import javax.net.ssl.SSLContext;
import javax.net.ssl.SSLException;
import javax.net.ssl.SSLHandshakeException;
import java.io.IOException;
import java.net.SocketException;
import java.nio.file.Path;
import java.time.Instant;
import java.time.temporal.ChronoUnit;
import java.util.List;
import java.util.logging.Level;
import java.util.logging.Logger;
import static com.yahoo.jdisc.http.server.jetty.Utils.createSslTestDriver;
import static com.yahoo.jdisc.http.server.jetty.Utils.generatePrivateKeyAndCertificate;
import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.junit.jupiter.api.Assertions.fail;
import static org.junit.jupiter.api.Assumptions.assumeTrue;
import static org.mockito.Mockito.atLeast;
import static org.mockito.Mockito.verify;
/**
* @author bjorncs
*/
class SslHandshakeMetricsTest {
private static final Logger log = Logger.getLogger(SslHandshakeMetricsTest.class.getName());
private static Path privateKeyFile;
private static Path certificateFile;
@BeforeAll
static void generateCrypto(@TempDir Path tmpFolder) throws IOException {
privateKeyFile = tmpFolder.resolve("private-key.pem");
certificateFile = tmpFolder.resolve("certificate.pem");
generatePrivateKeyAndCertificate(privateKeyFile, certificateFile);
}
@Test
void requireThatMetricIsIncrementedWhenClientIsMissingCertificateOnHandshake() throws IOException {
var metricConsumer = new MetricConsumerMock();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslTestDriver(certificateFile, privateKeyFile, metricConsumer, connectionLog);
SSLContext clientCtx = new SslContextBuilder()
.withTrustStore(certificateFile)
.build();
assertHttpsRequestTriggersSslHandshakeException(
driver, clientCtx, null, null, "Received fatal alert: bad_certificate");
verify(metricConsumer.mockitoMock(), atLeast(1))
.add(MetricDefinitions.SSL_HANDSHAKE_FAILURE_MISSING_CLIENT_CERT, 1L, MetricConsumerMock.STATIC_CONTEXT);
assertTrue(driver.close());
assertEquals(1, connectionLog.logEntries().size());
assertSslHandshakeFailurePresent(
connectionLog.logEntries().get(0), SSLHandshakeException.class, SslHandshakeFailure.MISSING_CLIENT_CERT.failureType());
}
@Test
void requireThatMetricIsIncrementedWhenClientUsesIncompatibleTlsVersion() throws IOException {
var metricConsumer = new MetricConsumerMock();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslTestDriver(certificateFile, privateKeyFile, metricConsumer, connectionLog);
SSLContext clientCtx = new SslContextBuilder()
.withTrustStore(certificateFile)
.withKeyStore(privateKeyFile, certificateFile)
.build();
boolean tlsv11Enabled = List.of(clientCtx.getDefaultSSLParameters().getProtocols()).contains("TLSv1.1");
assumeTrue(tlsv11Enabled, "TLSv1.1 must be enabled in installed JDK");
assertHttpsRequestTriggersSslHandshakeException(driver, clientCtx, "TLSv1.1", null, "protocol");
verify(metricConsumer.mockitoMock(), atLeast(1))
.add(MetricDefinitions.SSL_HANDSHAKE_FAILURE_INCOMPATIBLE_PROTOCOLS, 1L, MetricConsumerMock.STATIC_CONTEXT);
assertTrue(driver.close());
assertEquals(1, connectionLog.logEntries().size());
assertSslHandshakeFailurePresent(
connectionLog.logEntries().get(0), SSLHandshakeException.class, SslHandshakeFailure.INCOMPATIBLE_PROTOCOLS.failureType());
}
@Test
void requireThatMetricIsIncrementedWhenClientUsesIncompatibleCiphers() throws IOException {
var metricConsumer = new MetricConsumerMock();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslTestDriver(certificateFile, privateKeyFile, metricConsumer, connectionLog);
SSLContext clientCtx = new SslContextBuilder()
.withTrustStore(certificateFile)
.withKeyStore(privateKeyFile, certificateFile)
.build();
assertHttpsRequestTriggersSslHandshakeException(
driver, clientCtx, null, "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", "Received fatal alert: handshake_failure");
verify(metricConsumer.mockitoMock(), atLeast(1))
.add(MetricDefinitions.SSL_HANDSHAKE_FAILURE_INCOMPATIBLE_CIPHERS, 1L, MetricConsumerMock.STATIC_CONTEXT);
assertTrue(driver.close());
assertEquals(1, connectionLog.logEntries().size());
assertSslHandshakeFailurePresent(
connectionLog.logEntries().get(0), SSLHandshakeException.class, SslHandshakeFailure.INCOMPATIBLE_CIPHERS.failureType());
}
@Test
void requireThatMetricIsIncrementedWhenClientUsesInvalidCertificateInHandshake(@TempDir Path tmpFolder) throws IOException {
var metricConsumer = new MetricConsumerMock();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslTestDriver(certificateFile, privateKeyFile, metricConsumer, connectionLog);
Path clientPrivateKeyFile = tmpFolder.resolve("client-key.pem");
Path clientCertificateFile = tmpFolder.resolve("client-cert.pem");
generatePrivateKeyAndCertificate(clientPrivateKeyFile, clientCertificateFile);
SSLContext clientCtx = new SslContextBuilder()
.withKeyStore(clientPrivateKeyFile, clientCertificateFile)
.withTrustStore(certificateFile)
.build();
assertHttpsRequestTriggersSslHandshakeException(
driver, clientCtx, null, null, "Received fatal alert: certificate_unknown");
verify(metricConsumer.mockitoMock(), atLeast(1))
.add(MetricDefinitions.SSL_HANDSHAKE_FAILURE_INVALID_CLIENT_CERT, 1L, MetricConsumerMock.STATIC_CONTEXT);
assertTrue(driver.close());
assertEquals(1, connectionLog.logEntries().size());
assertSslHandshakeFailurePresent(
connectionLog.logEntries().get(0), SSLHandshakeException.class, SslHandshakeFailure.INVALID_CLIENT_CERT.failureType());
}
@Test
void requireThatMetricIsIncrementedWhenClientUsesExpiredCertificateInHandshake(@TempDir Path tmpFolder) throws IOException {
Path endEntityKeyFile = tmpFolder.resolve("client-key.pem");
Path endEntitycertificateFile = tmpFolder.resolve("client-cert.pem");
Instant notAfter = Instant.now().minus(100, ChronoUnit.DAYS);
generatePrivateKeyAndCertificate(privateKeyFile, certificateFile, endEntityKeyFile, endEntitycertificateFile, notAfter);
var metricConsumer = new MetricConsumerMock();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslTestDriver(certificateFile, privateKeyFile, metricConsumer, connectionLog);
SSLContext clientCtx = new SslContextBuilder()
.withTrustStore(certificateFile)
.withKeyStore(endEntityKeyFile, endEntitycertificateFile)
.build();
assertHttpsRequestTriggersSslHandshakeException(
driver, clientCtx, null, null, "Received fatal alert: certificate_unknown");
verify(metricConsumer.mockitoMock(), atLeast(1))
.add(MetricDefinitions.SSL_HANDSHAKE_FAILURE_EXPIRED_CLIENT_CERT, 1L, MetricConsumerMock.STATIC_CONTEXT);
assertTrue(driver.close());
assertEquals(1, connectionLog.logEntries().size());
}
private static void assertHttpsRequestTriggersSslHandshakeException(
JettyTestDriver testDriver,
SSLContext sslContext,
String protocolOverride,
String cipherOverride,
String expectedExceptionSubstring) throws IOException {
List<String> protocols = protocolOverride != null ? List.of(protocolOverride) : null;
List<String> ciphers = cipherOverride != null ? List.of(cipherOverride) : null;
try (var client = new SimpleHttpClient(sslContext, protocols, ciphers, testDriver.server().getListenPort(), false)) {
client.get("/status.html");
fail("SSLHandshakeException expected");
} catch (SSLHandshakeException e) {
assertTrue(e.getMessage().contains(expectedExceptionSubstring));
} catch (SocketException | SSLException e) {
// This exception is thrown if Apache httpclient's write thread detects the handshake failure before the read thread.
var msg = e.getMessage();
log.log(Level.WARNING, "Client failed to get a proper TLS handshake response: " + msg, e);
// Only ignore a subset of exceptions
assertTrue(msg.contains("readHandshakeRecord") || msg.contains("Broken pipe") || msg.contains("Connection reset"),
e.toString());
}
}
private static void assertSslHandshakeFailurePresent(
ConnectionLogEntry entry, Class<? extends SSLHandshakeException> expectedException, String expectedType) {
assertTrue(entry.sslHandshakeFailure().isPresent());
ConnectionLogEntry.SslHandshakeFailure failure = entry.sslHandshakeFailure().get();
assertEquals(expectedType, failure.type());
ConnectionLogEntry.SslHandshakeFailure.ExceptionEntry exceptionEntry = failure.exceptionChain().get(0);
assertEquals(expectedException.getName(), exceptionEntry.name());
}
}
|
