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
|
// Copyright 2020 Oath Inc. 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.jdisc.Metric;
import com.yahoo.jdisc.http.server.jetty.JettyHttpServer.Metrics;
import org.eclipse.jetty.io.ssl.SslHandshakeListener;
import javax.net.ssl.SSLHandshakeException;
import java.util.HashMap;
import java.util.Map;
import java.util.Optional;
import java.util.function.Predicate;
import java.util.logging.Level;
import java.util.logging.Logger;
import java.util.regex.Pattern;
/**
* A {@link SslHandshakeListener} that reports metrics for SSL handshake failures.
*
* @author bjorncs
*/
class SslHandshakeFailedListener implements SslHandshakeListener {
private final static Logger log = Logger.getLogger(SslHandshakeFailedListener.class.getName());
private final Metric metric;
private final String connectorName;
private final int listenPort;
SslHandshakeFailedListener(Metric metric, String connectorName, int listenPort) {
this.metric = metric;
this.connectorName = connectorName;
this.listenPort = listenPort;
}
@Override
public void handshakeFailed(Event event, Throwable throwable) {
log.log(Level.FINE, throwable, () -> "Ssl handshake failed: " + throwable.getMessage());
String metricName = SslHandshakeFailure.fromSslHandshakeException((SSLHandshakeException) throwable)
.map(SslHandshakeFailure::metricName)
.orElse(Metrics.SSL_HANDSHAKE_FAILURE_UNKNOWN);
metric.add(metricName, 1L, metric.createContext(createDimensions(event)));
}
private Map<String, Object> createDimensions(Event event) {
Map<String, Object> dimensions = new HashMap<>();
dimensions.put(Metrics.NAME_DIMENSION, connectorName);
dimensions.put(Metrics.PORT_DIMENSION, listenPort);
Optional.ofNullable(event.getSSLEngine().getPeerHost())
.ifPresent(clientIp -> dimensions.put(Metrics.CLIENT_IP_DIMENSION, clientIp));
return Map.copyOf(dimensions);
}
private enum SslHandshakeFailure {
INCOMPATIBLE_PROTOCOLS(
Metrics.SSL_HANDSHAKE_FAILURE_INCOMPATIBLE_PROTOCOLS,
"(Client requested protocol \\S+? is not enabled or supported in server context" +
"|The client supported protocol versions \\[\\S+?\\] are not accepted by server preferences \\[\\S+?\\])"),
INCOMPATIBLE_CIPHERS(
Metrics.SSL_HANDSHAKE_FAILURE_INCOMPATIBLE_CIPHERS,
"no cipher suites in common"),
MISSING_CLIENT_CERT(
Metrics.SSL_HANDSHAKE_FAILURE_MISSING_CLIENT_CERT,
"Empty server certificate chain"),
EXPIRED_CLIENT_CERTIFICATE(
Metrics.SSL_HANDSHAKE_FAILURE_EXPIRED_CLIENT_CERT,
// Note: this pattern will match certificates with too late notBefore as well
"PKIX path validation failed: java.security.cert.CertPathValidatorException: validity check failed"),
INVALID_CLIENT_CERT(
Metrics.SSL_HANDSHAKE_FAILURE_INVALID_CLIENT_CERT, // Includes mismatch of client certificate and private key
"(PKIX path (building|validation) failed: .+)|(Invalid CertificateVerify signature)");
private final String metricName;
private final Predicate<String> messageMatcher;
SslHandshakeFailure(String metricName, String messagePattern) {
this.metricName = metricName;
this.messageMatcher = Pattern.compile(messagePattern).asMatchPredicate();
}
String metricName() { return metricName; }
static Optional<SslHandshakeFailure> fromSslHandshakeException(SSLHandshakeException exception) {
String message = exception.getMessage();
if (message == null || message.isBlank()) return Optional.empty();
for (SslHandshakeFailure failure : values()) {
if (failure.messageMatcher.test(message)) {
return Optional.of(failure);
}
}
return Optional.empty();
}
}
}
|