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
192
193
194
195
196
197
198
|
// Copyright Verizon Media. 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.ConnectionLog;
import com.yahoo.container.logging.ConnectionLogEntry;
import com.yahoo.container.logging.RequestLog;
import com.yahoo.container.logging.RequestLogEntry;
import com.yahoo.jdisc.http.ConnectorConfig;
import com.yahoo.jdisc.http.ServerConfig;
import com.yahoo.security.SslContextBuilder;
import org.apache.hc.client5.http.ssl.NoopHostnameVerifier;
import org.assertj.core.api.Assertions;
import org.eclipse.jetty.client.HttpClient;
import org.eclipse.jetty.client.ProxyProtocolClientConnectionFactory;
import org.eclipse.jetty.client.api.ContentResponse;
import org.eclipse.jetty.util.ssl.SslContextFactory;
import org.junit.jupiter.api.BeforeAll;
import org.junit.jupiter.api.BeforeEach;
import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.io.TempDir;
import java.io.IOException;
import java.net.URI;
import java.nio.file.Path;
import java.util.concurrent.ExecutionException;
import java.util.logging.Level;
import java.util.logging.Logger;
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.assertNotEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
/**
* @author bjorncs
*/
class ProxyProtocolTest {
private static final Logger log = Logger.getLogger(ProxyProtocolTest.class.getName());
private static Path privateKeyFile;
private static Path certificateFile;
private InMemoryConnectionLog connectionLog;
private InMemoryRequestLog requestLogMock;
private JettyTestDriver driver;
@BeforeAll
static void generateCrypto(@TempDir Path tmpFolder) throws IOException {
privateKeyFile = tmpFolder.resolve("key.pem");
certificateFile = tmpFolder.resolve("cert.pem");
generatePrivateKeyAndCertificate(privateKeyFile, certificateFile);
}
@BeforeEach
void initializeServer() {
requestLogMock = new InMemoryRequestLog();
connectionLog = new InMemoryConnectionLog();
driver = createSslWithProxyProtocolTestDriver(certificateFile, privateKeyFile, requestLogMock, /*mixedMode*/connectionLog, false);
}
@Test
void requireThatProxyProtocolIsAcceptedAndActualRemoteAddressStoredInAccessLog() throws Exception {
String proxiedRemoteAddress = "192.168.0.100";
int proxiedRemotePort = 12345;
sendJettyClientRequest(driver, certificateFile, new ProxyProtocolClientConnectionFactory.V1.Tag(proxiedRemoteAddress, proxiedRemotePort));
sendJettyClientRequest(driver, certificateFile, new ProxyProtocolClientConnectionFactory.V2.Tag(proxiedRemoteAddress, proxiedRemotePort));
assertTrue(driver.close());
assertEquals(2, requestLogMock.entries().size());
assertLogEntryHasRemote(requestLogMock.entries().get(0), proxiedRemoteAddress, proxiedRemotePort);
assertLogEntryHasRemote(requestLogMock.entries().get(1), proxiedRemoteAddress, proxiedRemotePort);
Assertions.assertThat(connectionLog.logEntries()).hasSize(2);
assertLogEntryHasRemote(connectionLog.logEntries().get(0), proxiedRemoteAddress, proxiedRemotePort);
assertEquals("v1", connectionLog.logEntries().get(0).proxyProtocolVersion().get());
assertLogEntryHasRemote(connectionLog.logEntries().get(1), proxiedRemoteAddress, proxiedRemotePort);
assertEquals("v2", connectionLog.logEntries().get(1).proxyProtocolVersion().get());
}
@Test
void requireThatConnectorWithProxyProtocolMixedEnabledAcceptsBothProxyProtocolAndHttps() throws Exception {
generatePrivateKeyAndCertificate(privateKeyFile, certificateFile);
InMemoryRequestLog requestLogMock = new InMemoryRequestLog();
InMemoryConnectionLog connectionLog = new InMemoryConnectionLog();
JettyTestDriver driver = createSslWithProxyProtocolTestDriver(certificateFile, privateKeyFile, requestLogMock, /*mixedMode*/connectionLog, true);
String proxiedRemoteAddress = "192.168.0.100";
sendJettyClientRequest(driver, certificateFile, null);
sendJettyClientRequest(driver, certificateFile, new ProxyProtocolClientConnectionFactory.V1.Tag(proxiedRemoteAddress, 12345));
sendJettyClientRequest(driver, certificateFile, new ProxyProtocolClientConnectionFactory.V2.Tag(proxiedRemoteAddress, 12345));
assertTrue(driver.close());
assertEquals(3, requestLogMock.entries().size());
assertLogEntryHasRemote(requestLogMock.entries().get(0), "127.0.0.1", 0);
assertLogEntryHasRemote(requestLogMock.entries().get(1), proxiedRemoteAddress, 0);
assertLogEntryHasRemote(requestLogMock.entries().get(2), proxiedRemoteAddress, 0);
Assertions.assertThat(connectionLog.logEntries()).hasSize(3);
assertLogEntryHasRemote(connectionLog.logEntries().get(0), null, 0);
assertLogEntryHasRemote(connectionLog.logEntries().get(1), proxiedRemoteAddress, 12345);
assertLogEntryHasRemote(connectionLog.logEntries().get(2), proxiedRemoteAddress, 12345);
}
@Test
void requireThatJdiscLocalPortPropertyIsNotOverriddenByProxyProtocol() throws Exception {
String proxiedRemoteAddress = "192.168.0.100";
int proxiedRemotePort = 12345;
String proxyLocalAddress = "10.0.0.10";
int proxyLocalPort = 23456;
ProxyProtocolClientConnectionFactory.V2.Tag v2Tag = new ProxyProtocolClientConnectionFactory.V2.Tag(ProxyProtocolClientConnectionFactory.V2.Tag.Command.PROXY, null, ProxyProtocolClientConnectionFactory.V2.Tag.Protocol.STREAM,
proxiedRemoteAddress, proxiedRemotePort, proxyLocalAddress, proxyLocalPort, null);
ContentResponse response = sendJettyClientRequest(driver, certificateFile, v2Tag);
assertTrue(driver.close());
int clientPort = Integer.parseInt(response.getHeaders().get("Jdisc-Local-Port"));
assertNotEquals(proxyLocalPort, clientPort);
assertNotEquals(proxyLocalPort, connectionLog.logEntries().get(0).localPort().get().intValue());
}
private static JettyTestDriver createSslWithProxyProtocolTestDriver(
Path certificateFile, Path privateKeyFile, RequestLog requestLog,
ConnectionLog connectionLog, boolean mixedMode) {
ConnectorConfig.Builder connectorConfig = new ConnectorConfig.Builder()
.http2Enabled(true)
.proxyProtocol(new ConnectorConfig.ProxyProtocol.Builder()
.enabled(true)
.mixedMode(mixedMode))
.ssl(new ConnectorConfig.Ssl.Builder()
.enabled(true)
.privateKeyFile(privateKeyFile.toString())
.certificateFile(certificateFile.toString())
.caCertificateFile(certificateFile.toString()));
return JettyTestDriver.newConfiguredInstance(
new EchoRequestHandler(),
new ServerConfig.Builder().connectionLog(new ServerConfig.ConnectionLog.Builder().enabled(true)),
connectorConfig,
binder -> {
binder.bind(RequestLog.class).toInstance(requestLog);
binder.bind(ConnectionLog.class).toInstance(connectionLog);
});
}
private ContentResponse sendJettyClientRequest(JettyTestDriver testDriver, Path certificateFile, Object tag)
throws Exception {
HttpClient client = createJettyHttpClient(certificateFile);
try {
int maxAttempts = 3;
for (int attempt = 0; attempt < maxAttempts; attempt++) {
try {
ContentResponse response = client.newRequest(URI.create("https://localhost:" + testDriver.server().getListenPort() + "/"))
.tag(tag)
.send();
assertEquals(200, response.getStatus());
return response;
} catch (ExecutionException e) {
// Retry when the server closes the connection before the TLS handshake is completed. This have been observed in CI.
// We have been unable to reproduce this locally. The cause is therefor currently unknown.
log.log(Level.WARNING, String.format("Attempt %d failed: %s", attempt, e.getMessage()), e);
Thread.sleep(10);
}
}
throw new AssertionError("Failed to send request, see log for details");
} finally {
client.stop();
}
}
// Using Jetty's http client as Apache httpclient does not support the proxy-protocol v1/v2.
private static HttpClient createJettyHttpClient(Path certificateFile) throws Exception {
SslContextFactory.Client clientSslCtxFactory = new SslContextFactory.Client();
clientSslCtxFactory.setHostnameVerifier(NoopHostnameVerifier.INSTANCE);
clientSslCtxFactory.setSslContext(new SslContextBuilder().withTrustStore(certificateFile).build());
HttpClient client = new HttpClient(clientSslCtxFactory);
client.start();
return client;
}
private static void assertLogEntryHasRemote(RequestLogEntry entry, String expectedAddress, int expectedPort) {
assertEquals(expectedAddress, entry.peerAddress().get());
if (expectedPort > 0) {
assertEquals(expectedPort, entry.peerPort().getAsInt());
}
}
private static void assertLogEntryHasRemote(ConnectionLogEntry entry, String expectedAddress, int expectedPort) {
if (expectedAddress != null) {
Assertions.assertThat(entry.remoteAddress()).hasValue(expectedAddress);
} else {
Assertions.assertThat(entry.remoteAddress()).isEmpty();
}
if (expectedPort > 0) {
Assertions.assertThat(entry.remotePort()).hasValue(expectedPort);
} else {
Assertions.assertThat(entry.remotePort()).isEmpty();
}
}
}
|
