Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP] AWS SDK Cross Version Compatability: env-var http_proxy & https_proxy support #4165

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[WIP] AWS SDK Cross Version Compatability: env-var http_proxy & https_proxy support #4165

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions .changes/next-release/feature-AWSSDKforJavav2-ed33ca1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"type": "feature",
"category": "AWS SDK for Java v2",
"contributor": "Mythra",
"description": "Support checking `http_proxy` & `https_proxy` environment variables for the HTTP clients in tree."
}
17 changes: 10 additions & 7 deletions core/crt-core/src/main/java/software/amazon/awssdk/crtcore/CrtConfigurationUtils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,23 +29,26 @@ private CrtConfigurationUtils() {
}

public static Optional<HttpProxyOptions> resolveProxy(CrtProxyConfiguration proxyConfiguration,
TlsContext tlsContext) {
TlsContext tlsContext,
String scheme) {
if (proxyConfiguration == null) {
return Optional.empty();
}

HttpProxyOptions clientProxyOptions = new HttpProxyOptions();

clientProxyOptions.setHost(proxyConfiguration.host());
clientProxyOptions.setPort(proxyConfiguration.port());
clientProxyOptions.setHost(proxyConfiguration.host(scheme));
clientProxyOptions.setPort(proxyConfiguration.port(scheme));

if ("https".equalsIgnoreCase(proxyConfiguration.scheme())) {
if ("https".equalsIgnoreCase(proxyConfiguration.scheme(scheme))) {
clientProxyOptions.setTlsContext(tlsContext);
}

if (proxyConfiguration.username() != null && proxyConfiguration.password() != null) {
clientProxyOptions.setAuthorizationUsername(proxyConfiguration.username());
clientProxyOptions.setAuthorizationPassword(proxyConfiguration.password());
String username = proxyConfiguration.username(scheme);
String password = proxyConfiguration.password(scheme);
if (username != null && password != null) {
clientProxyOptions.setAuthorizationUsername(username);
clientProxyOptions.setAuthorizationPassword(password);
clientProxyOptions.setAuthorizationType(HttpProxyOptions.HttpProxyAuthorizationType.Basic);
} else {
clientProxyOptions.setAuthorizationType(HttpProxyOptions.HttpProxyAuthorizationType.None);
Expand Down
424 changes: 371 additions & 53 deletions core/crt-core/src/main/java/software/amazon/awssdk/crtcore/CrtProxyConfiguration.java
View file
Open in desktop

Large diffs are not rendered by default.

21 changes: 18 additions & 3 deletions core/crt-core/src/test/java/software/amazon/awssdk/crtcore/CrtConnectionUtilsTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,19 +39,27 @@ void resolveProxy_basicAuthorization() {

TlsContext tlsContext = Mockito.mock(TlsContext.class);

Optional<HttpProxyOptions> httpProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext);
Optional<HttpProxyOptions> httpProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext, "http");
assertThat(httpProxyOptions).hasValueSatisfying(proxy -> {
assertThat(proxy.getTlsContext()).isEqualTo(tlsContext);
assertThat(proxy.getAuthorizationPassword()).isEqualTo("bar");
assertThat(proxy.getAuthorizationUsername()).isEqualTo("foo");
assertThat(proxy.getAuthorizationType()).isEqualTo(HttpProxyOptions.HttpProxyAuthorizationType.Basic);
});
Optional<HttpProxyOptions> httpsProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext, "https");
assertThat(httpsProxyOptions).hasValueSatisfying(proxy -> {
assertThat(proxy.getTlsContext()).isEqualTo(tlsContext);
assertThat(proxy.getAuthorizationPassword()).isEqualTo("bar");
assertThat(proxy.getAuthorizationUsername()).isEqualTo("foo");
assertThat(proxy.getAuthorizationType()).isEqualTo(HttpProxyOptions.HttpProxyAuthorizationType.Basic);
});
}

@Test
void resolveProxy_emptyProxy_shouldReturnEmpty() {
TlsContext tlsContext = Mockito.mock(TlsContext.class);
assertThat(CrtConfigurationUtils.resolveProxy(null, tlsContext)).isEmpty();
assertThat(CrtConfigurationUtils.resolveProxy(null, tlsContext, "http")).isEmpty();
assertThat(CrtConfigurationUtils.resolveProxy(null, tlsContext, "https")).isEmpty();
}

@Test
Expand All @@ -61,13 +69,20 @@ void resolveProxy_noneAuthorization() {
.build();
TlsContext tlsContext = Mockito.mock(TlsContext.class);

Optional<HttpProxyOptions> httpProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext);
Optional<HttpProxyOptions> httpProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext, "http");
assertThat(httpProxyOptions).hasValueSatisfying(proxy -> {
assertThat(proxy.getTlsContext()).isNull();
assertThat(proxy.getAuthorizationPassword()).isNull();
assertThat(proxy.getAuthorizationUsername()).isNull();
assertThat(proxy.getAuthorizationType()).isEqualTo(HttpProxyOptions.HttpProxyAuthorizationType.None);
});
Optional<HttpProxyOptions> httpsProxyOptions = CrtConfigurationUtils.resolveProxy(configuration, tlsContext, "https");
assertThat(httpsProxyOptions).hasValueSatisfying(proxy -> {
assertThat(proxy.getTlsContext()).isNull();
assertThat(proxy.getAuthorizationPassword()).isNull();
assertThat(proxy.getAuthorizationUsername()).isNull();
assertThat(proxy.getAuthorizationType()).isEqualTo(HttpProxyOptions.HttpProxyAuthorizationType.None);
});
}

@Test
Expand Down
30 changes: 18 additions & 12 deletions ...ents/apache-client/src/main/java/software/amazon/awssdk/http/apache/ApacheHttpClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -106,6 +106,8 @@ public final class ApacheHttpClient implements SdkHttpClient {
public static final String CLIENT_NAME = "Apache";

private static final Logger log = Logger.loggerFor(ApacheHttpClient.class);
private static final String HTTPS = "https";
private static final String HTTP = "http";

private final ApacheHttpRequestFactory apacheHttpRequestFactory = new ApacheHttpRequestFactory();
private final ConnectionManagerAwareHttpClient httpClient;
Expand Down Expand Up @@ -174,22 +176,25 @@ private void addProxyConfig(HttpClientBuilder builder,
DefaultBuilder configuration) {
ProxyConfiguration proxyConfiguration = configuration.proxyConfiguration;

boolean isAuthenticatedHttp = isAuthenticatedProxy(proxyConfiguration, HTTP);
boolean isAuthenticatedHttps = isAuthenticatedProxy(proxyConfiguration, HTTPS);
Validate.isTrue(configuration.httpRoutePlanner == null || !isProxyEnabled(proxyConfiguration),
"The httpRoutePlanner and proxyConfiguration can't both be configured.");
Validate.isTrue(configuration.credentialsProvider == null || !isAuthenticatedProxy(proxyConfiguration),
Validate.isTrue(configuration.credentialsProvider == null || (!isAuthenticatedHttp && !isAuthenticatedHttps),
"The credentialsProvider and proxyConfiguration username/password can't both be configured.");

HttpRoutePlanner routePlanner = configuration.httpRoutePlanner;
if (isProxyEnabled(proxyConfiguration)) {
log.debug(() -> "Configuring Proxy. Proxy Host: " + proxyConfiguration.host());
routePlanner = new SdkProxyRoutePlanner(proxyConfiguration.host(),
proxyConfiguration.port(),
proxyConfiguration.scheme(),
proxyConfiguration.nonProxyHosts());
log.debug(() ->
"Configuring Proxy. Proxy Host (HTTP): " +
proxyConfiguration.host("http") +
"Proxy Host (HTTPS): " +
proxyConfiguration.host("https"));
routePlanner = new SdkProxyRoutePlanner(proxyConfiguration);
}

CredentialsProvider credentialsProvider = configuration.credentialsProvider;
if (isAuthenticatedProxy(proxyConfiguration)) {
if (isAuthenticatedHttp || isAuthenticatedHttps) {
credentialsProvider = ApacheUtils.newProxyCredentialsProvider(proxyConfiguration);
}

Expand All @@ -211,13 +216,13 @@ private boolean useIdleConnectionReaper(AttributeMap standardOptions) {
return Boolean.TRUE.equals(standardOptions.get(SdkHttpConfigurationOption.REAP_IDLE_CONNECTIONS));
}

private boolean isAuthenticatedProxy(ProxyConfiguration proxyConfiguration) {
return proxyConfiguration.username() != null && proxyConfiguration.password() != null;
private boolean isAuthenticatedProxy(ProxyConfiguration proxyConfiguration, String scheme) {
return proxyConfiguration.username(scheme) != null && proxyConfiguration.password(scheme) != null;
}

private boolean isProxyEnabled(ProxyConfiguration proxyConfiguration) {
return proxyConfiguration.host() != null
&& proxyConfiguration.port() > 0;
return (proxyConfiguration.host(HTTP) != null && proxyConfiguration.port(HTTP) > 0) ||
(proxyConfiguration.host(HTTPS) != null && proxyConfiguration.port(HTTPS) > 0);
}

@Override
Expand Down Expand Up @@ -420,7 +425,8 @@ public interface Builder extends SdkHttpClient.Builder<ApacheHttpClient.Builder>

/**
* Configuration that defines a custom credential provider for HTTP requests.
* May not be used in conjunction with {@link ProxyConfiguration#username()} and {@link ProxyConfiguration#password()}.
* May not be used in conjunction with {@link ProxyConfiguration#username(String)} and
* {@link ProxyConfiguration#password(String)}.
*/
Builder credentialsProvider(CredentialsProvider credentialsProvider);

Expand Down
Loading