Skip to content

Commit 37fb1ab

Browse files
MahoneyMahoney
committed
Allow stubbing & recording of forward proxy https traffic
This allows WireMock to act as a forward (browser) proxy for HTTPS as well as HTTP origins whilst stubbing & recording. Step towards implementing wiremock#401.
1 parent 57d932b commit 37fb1ab

File tree

8 files changed

+311
-44
lines changed

8 files changed

+311
-44
lines changed

‎README.md

+16
Original file line numberDiff line numberDiff line change
@@ -54,3 +54,19 @@ To build both JARs (thin and standalone):
5454

5555
The built JAR will be placed under ``java8/build/libs``.
5656

57+
Developing on IntelliJ IDEA
58+
---------------------------
59+
60+
IntelliJ can't import the gradle build script correctly automatically, so run
61+
```bash
62+
./gradlew -c release-settings.gradle :java8:idea
63+
```
64+
65+
Make sure you have no `.idea` directory, the plugin generates old style .ipr,
66+
.iml & .iws metadata files.
67+
68+
You may have to then set up your project SDK to point at your Java 8
69+
installation.
70+
71+
Then edit the module settings. Remove the "null" Source & Test source folders
72+
from all modules. Add `wiremock` as a module dependency to Java 7 & Java 8.

‎java8/src/main/java/com/github/tomakehurst/wiremock/jetty94/Jetty94HttpServer.java

+86-22
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,13 @@
1212
import org.eclipse.jetty.http2.HTTP2Cipher;
1313
import org.eclipse.jetty.http2.server.HTTP2ServerConnectionFactory;
1414
import org.eclipse.jetty.io.NetworkTrafficListener;
15-
import org.eclipse.jetty.server.*;
15+
import org.eclipse.jetty.server.HttpConfiguration;
16+
import org.eclipse.jetty.server.HttpConnectionFactory;
17+
import org.eclipse.jetty.server.SecureRequestCustomizer;
18+
import org.eclipse.jetty.server.Server;
19+
import org.eclipse.jetty.server.ServerConnector;
20+
import org.eclipse.jetty.server.SslConnectionFactory;
21+
import org.eclipse.jetty.server.handler.HandlerCollection;
1622
import org.eclipse.jetty.util.ssl.SslContextFactory;
1723

1824
public class Jetty94HttpServer extends JettyHttpServer {
@@ -27,39 +33,45 @@ protected MultipartRequestConfigurer buildMultipartRequestConfigurer() {
2733
}
2834

2935
@Override
30-
protected ServerConnector createHttpsConnector(Server server, String bindAddress, HttpsSettings httpsSettings, JettySettings jettySettings, NetworkTrafficListener listener) {
31-
SslContextFactory.Server http2SslContextFactory = buildHttp2SslContextFactory(httpsSettings);
32-
33-
HttpConfiguration httpConfig = createHttpConfig(jettySettings);
34-
httpConfig.setSecureScheme("https");
35-
httpConfig.setSecurePort(httpsSettings.port());
36-
httpConfig.setSendXPoweredBy(false);
37-
httpConfig.setSendServerVersion(false);
38-
httpConfig.addCustomizer(new SecureRequestCustomizer());
36+
protected ServerConnector createHttpConnector(String bindAddress, int port, JettySettings jettySettings, NetworkTrafficListener listener) {
3937

40-
HttpConnectionFactory http = new HttpConnectionFactory(httpConfig);
41-
HTTP2ServerConnectionFactory h2 = new HTTP2ServerConnectionFactory(httpConfig);
42-
43-
ALPNServerConnectionFactory alpn = new ALPNServerConnectionFactory();
38+
ConnectionFactories connectionFactories = buildConnectionFactories(jettySettings, 0);
39+
return createServerConnector(
40+
bindAddress,
41+
jettySettings,
42+
port,
43+
listener,
44+
// http needs to be the first (the default)
45+
connectionFactories.http,
46+
// alpn & h2 are included so that HTTPS forward proxying can find them
47+
connectionFactories.alpn,
48+
connectionFactories.h2
49+
);
50+
}
4451

45-
SslConnectionFactory ssl = new SslConnectionFactory(http2SslContextFactory, alpn.getProtocol());
52+
@Override
53+
protected ServerConnector createHttpsConnector(Server server, String bindAddress, HttpsSettings httpsSettings, JettySettings jettySettings, NetworkTrafficListener listener) {
4654

47-
ConnectionFactory[] connectionFactories = new ConnectionFactory[] {
48-
ssl,
49-
alpn,
50-
h2,
51-
http
52-
};
55+
ConnectionFactories connectionFactories = buildConnectionFactories(jettySettings, httpsSettings.port());
56+
SslConnectionFactory ssl = sslConnectionFactory(httpsSettings);
5357

5458
return createServerConnector(
5559
bindAddress,
5660
jettySettings,
5761
httpsSettings.port(),
5862
listener,
59-
connectionFactories
63+
ssl,
64+
connectionFactories.alpn,
65+
connectionFactories.h2,
66+
connectionFactories.http
6067
);
6168
}
6269

70+
private SslConnectionFactory sslConnectionFactory(HttpsSettings httpsSettings) {
71+
SslContextFactory.Server http2SslContextFactory = buildHttp2SslContextFactory(httpsSettings);
72+
return new SslConnectionFactory(http2SslContextFactory, "alpn");
73+
}
74+
6375
private SslContextFactory.Server buildHttp2SslContextFactory(HttpsSettings httpsSettings) {
6476
SslContextFactory.Server sslContextFactory = new SslContextFactory.Server();
6577

@@ -75,4 +87,56 @@ private SslContextFactory.Server buildHttp2SslContextFactory(HttpsSettings https
7587
sslContextFactory.setProvider("Conscrypt");
7688
return sslContextFactory;
7789
}
90+
91+
@Override
92+
protected HttpConfiguration createHttpConfig(JettySettings jettySettings) {
93+
HttpConfiguration httpConfig = super.createHttpConfig(jettySettings);
94+
httpConfig.setSendXPoweredBy(false);
95+
httpConfig.setSendServerVersion(false);
96+
httpConfig.addCustomizer(new SecureRequestCustomizer());
97+
return httpConfig;
98+
}
99+
100+
@Override
101+
protected HandlerCollection createHandler(
102+
Options options,
103+
AdminRequestHandler adminRequestHandler,
104+
StubRequestHandler stubRequestHandler
105+
) {
106+
HandlerCollection handler = super.createHandler(options, adminRequestHandler, stubRequestHandler);
107+
108+
ManInTheMiddleSslConnectHandler manInTheMiddleSslConnectHandler = new ManInTheMiddleSslConnectHandler(
109+
sslConnectionFactory(options.httpsSettings())
110+
);
111+
112+
handler.addHandler(manInTheMiddleSslConnectHandler);
113+
114+
return handler;
115+
}
116+
117+
private ConnectionFactories buildConnectionFactories(
118+
JettySettings jettySettings,
119+
int securePort
120+
) {
121+
HttpConfiguration httpConfig = createHttpConfig(jettySettings);
122+
httpConfig.setSecurePort(securePort);
123+
124+
HttpConnectionFactory http = new HttpConnectionFactory(httpConfig);
125+
HTTP2ServerConnectionFactory h2 = new HTTP2ServerConnectionFactory(httpConfig);
126+
ALPNServerConnectionFactory alpn = new ALPNServerConnectionFactory();
127+
128+
return new ConnectionFactories(http, h2, alpn);
129+
}
130+
131+
private static class ConnectionFactories {
132+
private final HttpConnectionFactory http;
133+
private final HTTP2ServerConnectionFactory h2;
134+
private final ALPNServerConnectionFactory alpn;
135+
136+
private ConnectionFactories(HttpConnectionFactory http, HTTP2ServerConnectionFactory h2, ALPNServerConnectionFactory alpn) {
137+
this.http = http;
138+
this.h2 = h2;
139+
this.alpn = alpn;
140+
}
141+
}
78142
}

‎java8/src/main/java/com/github/tomakehurst/wiremock/jetty94/ManInTheMiddleSslConnectHandler.java

+75
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,75 @@
1+
package com.github.tomakehurst.wiremock.jetty94;
2+
3+
import org.eclipse.jetty.io.Connection;
4+
import org.eclipse.jetty.io.EndPoint;
5+
import org.eclipse.jetty.server.HttpConnection;
6+
import org.eclipse.jetty.server.Request;
7+
import org.eclipse.jetty.server.SslConnectionFactory;
8+
import org.eclipse.jetty.server.handler.AbstractHandler;
9+
10+
import javax.servlet.http.HttpServletRequest;
11+
import javax.servlet.http.HttpServletResponse;
12+
import java.io.IOException;
13+
14+
import static org.eclipse.jetty.http.HttpMethod.CONNECT;
15+
16+
/**
17+
* A Handler for the HTTP CONNECT method that, instead of opening up a
18+
* TCP tunnel between the downstream and upstream sockets,
19+
* 1) captures the
20+
* and
21+
* 2) turns the connection into an SSL connection allowing this server to handle
22+
* it.
23+
*
24+
*
25+
*/
26+
class ManInTheMiddleSslConnectHandler extends AbstractHandler {
27+
28+
private final SslConnectionFactory sslConnectionFactory;
29+
30+
ManInTheMiddleSslConnectHandler(SslConnectionFactory sslConnectionFactory) {
31+
this.sslConnectionFactory = sslConnectionFactory;
32+
}
33+
34+
@Override
35+
protected void doStart() throws Exception {
36+
super.doStart();
37+
sslConnectionFactory.start();
38+
}
39+
40+
@Override
41+
protected void doStop() throws Exception {
42+
super.doStop();
43+
sslConnectionFactory.stop();
44+
}
45+
46+
@Override
47+
public void handle(
48+
String target,
49+
Request baseRequest,
50+
HttpServletRequest request,
51+
HttpServletResponse response
52+
) throws IOException {
53+
if (CONNECT.is(request.getMethod())) {
54+
baseRequest.setHandled(true);
55+
handleConnect(baseRequest, response);
56+
}
57+
}
58+
59+
private void handleConnect(
60+
Request baseRequest,
61+
HttpServletResponse response
62+
) throws IOException {
63+
sendConnectResponse(response);
64+
final HttpConnection transport = (HttpConnection) baseRequest.getHttpChannel().getHttpTransport();
65+
EndPoint endpoint = transport.getEndPoint();
66+
Connection connection = sslConnectionFactory.newConnection(transport.getConnector(), endpoint);
67+
endpoint.setConnection(connection);
68+
connection.onOpen();
69+
}
70+
71+
private void sendConnectResponse(HttpServletResponse response) throws IOException {
72+
response.setStatus(HttpServletResponse.SC_OK);
73+
response.getOutputStream().close();
74+
}
75+
}

‎java8/src/test/java/com/github/tomakehurst/wiremock/Http2BrowserProxyAcceptanceTest.java

+124
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,124 @@
1+
/*
2+
* Copyright (C) 2011 Thomas Akehurst
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package com.github.tomakehurst.wiremock;
17+
18+
import com.github.tomakehurst.wiremock.common.SingleRootFileSource;
19+
import com.github.tomakehurst.wiremock.junit.WireMockClassRule;
20+
import com.github.tomakehurst.wiremock.testsupport.TestFiles;
21+
import com.github.tomakehurst.wiremock.testsupport.WireMockTestClient;
22+
import org.junit.After;
23+
import org.junit.Before;
24+
import org.junit.ClassRule;
25+
import org.junit.Rule;
26+
import org.junit.Test;
27+
28+
import java.io.File;
29+
import java.io.IOException;
30+
31+
import static com.github.tomakehurst.wiremock.client.WireMock.*;
32+
import static com.github.tomakehurst.wiremock.common.Exceptions.throwUnchecked;
33+
import static com.github.tomakehurst.wiremock.core.WireMockApp.FILES_ROOT;
34+
import static com.github.tomakehurst.wiremock.core.WireMockApp.MAPPINGS_ROOT;
35+
import static com.github.tomakehurst.wiremock.core.WireMockConfiguration.wireMockConfig;
36+
import static org.hamcrest.MatcherAssert.assertThat;
37+
import static org.hamcrest.Matchers.is;
38+
39+
public class Http2BrowserProxyAcceptanceTest {
40+
41+
private static final String CERTIFICATE_NOT_TRUSTED_BY_TEST_CLIENT = TestFiles.KEY_STORE_PATH;
42+
43+
@ClassRule
44+
public static WireMockClassRule target = new WireMockClassRule(wireMockConfig()
45+
.httpDisabled(true)
46+
.keystorePath(CERTIFICATE_NOT_TRUSTED_BY_TEST_CLIENT)
47+
.dynamicHttpsPort()
48+
);
49+
50+
@Rule
51+
public WireMockClassRule instanceRule = target;
52+
53+
private WireMockServer proxy;
54+
private WireMockTestClient testClient;
55+
56+
@Before
57+
public void addAResourceToProxy() {
58+
testClient = new WireMockTestClient(target.httpsPort());
59+
60+
proxy = new WireMockServer(wireMockConfig()
61+
.dynamicPort()
62+
.fileSource(new SingleRootFileSource(setupTempFileRoot()))
63+
.enableBrowserProxying(true));
64+
proxy.start();
65+
}
66+
67+
@After
68+
public void stopServer() {
69+
if (proxy.isRunning()) {
70+
proxy.stop();
71+
}
72+
}
73+
74+
@Test
75+
public void canProxyHttpsInBrowserProxyMode() throws Exception {
76+
target.stubFor(get(urlEqualTo("/whatever")).willReturn(aResponse().withBody("Got it")));
77+
78+
assertThat(testClient.getViaProxy(target.url("/whatever"), proxy.port()).content(), is("Got it"));
79+
}
80+
81+
@Test
82+
public void canStubHttpsInBrowserProxyMode() throws Exception {
83+
target.stubFor(get(urlEqualTo("/stubbed")).willReturn(aResponse().withBody("Should Not Be Returned")));
84+
proxy.stubFor(get(urlEqualTo("/stubbed")).willReturn(aResponse().withBody("Stubbed Value")));
85+
target.stubFor(get(urlEqualTo("/not_stubbed")).willReturn(aResponse().withBody("Should be served from target")));
86+
87+
assertThat(testClient.getViaProxy(target.url("/stubbed"), proxy.port()).content(), is("Stubbed Value"));
88+
assertThat(testClient.getViaProxy(target.url("/not_stubbed"), proxy.port()).content(), is("Should be served from target"));
89+
}
90+
91+
@Test
92+
public void canRecordHttpsInBrowserProxyMode() throws Exception {
93+
94+
// given
95+
proxy.startRecording(target.baseUrl());
96+
String recordedEndpoint = target.url("/record_me");
97+
98+
// and
99+
target.stubFor(get(urlEqualTo("/record_me")).willReturn(aResponse().withBody("Target response")));
100+
101+
// then
102+
assertThat(testClient.getViaProxy(recordedEndpoint, proxy.port()).content(), is("Target response"));
103+
104+
// when
105+
proxy.stopRecording();
106+
107+
// and
108+
target.stop();
109+
110+
// then
111+
assertThat(testClient.getViaProxy(recordedEndpoint, proxy.port()).content(), is("Target response"));
112+
}
113+
114+
private static File setupTempFileRoot() {
115+
try {
116+
File root = java.nio.file.Files.createTempDirectory("wiremock").toFile();
117+
new File(root, MAPPINGS_ROOT).mkdirs();
118+
new File(root, FILES_ROOT).mkdirs();
119+
return root;
120+
} catch (IOException e) {
121+
return throwUnchecked(e, File.class);
122+
}
123+
}
124+
}

‎src/main/java/com/github/tomakehurst/wiremock/jetty9/JettyHttpServer.java

-3
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
import org.apache.commons.lang3.ArrayUtils;
3131
import org.eclipse.jetty.http.MimeTypes;
3232
import org.eclipse.jetty.io.NetworkTrafficListener;
33-
import org.eclipse.jetty.proxy.ConnectHandler;
3433
import org.eclipse.jetty.server.*;
3534
import org.eclipse.jetty.server.handler.HandlerCollection;
3635
import org.eclipse.jetty.server.handler.HandlerWrapper;
@@ -129,8 +128,6 @@ protected HandlerCollection createHandler(Options options, AdminRequestHandler a
129128
addGZipHandler(mockServiceContext, handlers);
130129
}
131130

132-
handlers.addHandler(new ConnectHandler());
133-
134131
return handlers;
135132
}
136133

0 commit comments

Comments
 (0)