-
Notifications
You must be signed in to change notification settings - Fork 3.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[improve][broker] Support X-Forwarded-For and HA Proxy protocol for r…
…esolving the client IP of http/https requests
- Loading branch information
Showing
11 changed files
with
216 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
126 changes: 126 additions & 0 deletions
126
pulsar-broker/src/test/java/org/apache/pulsar/broker/web/WebServiceOriginalClientIPTest.java
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,126 @@ | ||
| /* | ||
| * Licensed to the Apache Software Foundation (ASF) under one | ||
| * or more contributor license agreements. See the NOTICE file | ||
| * distributed with this work for additional information | ||
| * regarding copyright ownership. The ASF licenses this file | ||
| * to you under the Apache License, Version 2.0 (the | ||
| * "License"); you may not use this file except in compliance | ||
| * with the License. You may obtain a copy of the License at | ||
| * | ||
| * http://www.apache.org/licenses/LICENSE-2.0 | ||
| * | ||
| * Unless required by applicable law or agreed to in writing, | ||
| * software distributed under the License is distributed on an | ||
| * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY | ||
| * KIND, either express or implied. See the License for the | ||
| * specific language governing permissions and limitations | ||
| * under the License. | ||
| */ | ||
| package org.apache.pulsar.broker.web; | ||
|
|
||
| import static org.testng.Assert.assertTrue; | ||
| import java.util.Optional; | ||
| import lombok.extern.slf4j.Slf4j; | ||
| import nl.altindag.console.ConsoleCaptor; | ||
| import org.apache.pulsar.broker.auth.MockedPulsarServiceBaseTest; | ||
| import org.awaitility.Awaitility; | ||
| import org.eclipse.jetty.client.HttpClient; | ||
| import org.eclipse.jetty.client.ProxyProtocolClientConnectionFactory.V2; | ||
| import org.eclipse.jetty.client.api.ContentResponse; | ||
| import org.eclipse.jetty.util.ssl.SslContextFactory; | ||
| import org.testng.annotations.AfterClass; | ||
| import org.testng.annotations.BeforeClass; | ||
| import org.testng.annotations.DataProvider; | ||
| import org.testng.annotations.Test; | ||
|
|
||
| @Slf4j | ||
| @Test(groups = "broker") | ||
| public class WebServiceOriginalClientIPTest extends MockedPulsarServiceBaseTest { | ||
| HttpClient httpClient; | ||
|
|
||
| @BeforeClass(alwaysRun = true) | ||
| @Override | ||
| protected void setup() throws Exception { | ||
| super.internalSetup(); | ||
| httpClient = new HttpClient(new SslContextFactory(true)); | ||
| httpClient.start(); | ||
| } | ||
|
|
||
| @AfterClass(alwaysRun = true) | ||
| @Override | ||
| protected void cleanup() throws Exception { | ||
| super.internalCleanup(); | ||
| if (httpClient != null) { | ||
| httpClient.stop(); | ||
| } | ||
| } | ||
|
|
||
| @Override | ||
| protected void doInitConf() throws Exception { | ||
| super.doInitConf(); | ||
| conf.setWebServiceTrustXForwardedFor(true); | ||
| conf.setWebServiceHaProxyProtocolEnabled(true); | ||
| conf.setWebServicePortTls(Optional.of(0)); | ||
| conf.setTlsCertificateFilePath(BROKER_CERT_FILE_PATH); | ||
| conf.setTlsKeyFilePath(BROKER_KEY_FILE_PATH); | ||
| conf.setTlsTrustCertsFilePath(CA_CERT_FILE_PATH); | ||
| } | ||
|
|
||
| @DataProvider(name = "tlsEnabled") | ||
| public Object[][] tlsEnabled() { | ||
| return new Object[][] { { true }, { false } }; | ||
| } | ||
|
|
||
| @Test(dataProvider = "tlsEnabled") | ||
| public void testClientIPIsPickedFromXForwardedForHeaderAndLogged(boolean tlsEnabled) throws Exception { | ||
| String metricsUrl = | ||
| (tlsEnabled ? pulsar.getWebServiceAddressTls() : pulsar.getWebServiceAddress()) + "/metrics/"; | ||
| ConsoleCaptor consoleCaptor = new ConsoleCaptor(); | ||
| try { | ||
| Awaitility.await().untilAsserted(() -> { | ||
| consoleCaptor.clearOutput(); | ||
|
|
||
| // Send a GET request to the metrics URL | ||
| ContentResponse response = httpClient.newRequest(metricsUrl) | ||
| .header("X-Forwarded-For", "11.22.33.44") | ||
| .send(); | ||
|
|
||
| // Validate the response | ||
| assertTrue(response.getContentAsString().contains("process_cpu_seconds_total")); | ||
|
|
||
| // Validate that the client IP passed in HA Proxy protocol is logged | ||
| assertTrue(consoleCaptor.getStandardOutput().stream() | ||
| .anyMatch(line -> line.contains("RequestLog") && line.contains("- 11.22.33.44"))); | ||
| }); | ||
| } finally { | ||
| consoleCaptor.close(); | ||
| } | ||
| } | ||
|
|
||
|
|
||
| @Test(dataProvider = "tlsEnabled") | ||
| public void testClientIPIsPickedFromHAProxyProtocolAndLogged(boolean tlsEnabled) throws Exception { | ||
| String metricsUrl = (tlsEnabled ? pulsar.getWebServiceAddressTls() : pulsar.getWebServiceAddress()) + "/metrics/"; | ||
| ConsoleCaptor consoleCaptor = new ConsoleCaptor(); | ||
| try { | ||
| Awaitility.await().untilAsserted(() -> { | ||
| consoleCaptor.clearOutput(); | ||
|
|
||
| // Send a GET request to the metrics URL | ||
| ContentResponse response = httpClient.newRequest(metricsUrl) | ||
| // Jetty client will add HA Proxy protocol header with the given IP to the request | ||
| .tag(new V2.Tag("99.22.33.44", 1234)) | ||
| .send(); | ||
|
|
||
| // Validate the response | ||
| assertTrue(response.getContentAsString().contains("process_cpu_seconds_total")); | ||
|
|
||
| // Validate that the client IP passed in HA Proxy protocol is logged | ||
| assertTrue(consoleCaptor.getStandardOutput().stream() | ||
| .anyMatch(line -> line.contains("RequestLog") && line.contains("- 99.22.33.44"))); | ||
| }); | ||
| } finally { | ||
| consoleCaptor.close(); | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters