Skip to content

fix!: support IPv6 address as custom GCE_METADATA_HOST #2592

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

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

fix!: support IPv6 address as custom GCE_METADATA_HOST #2592

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
37 changes: 34 additions & 3 deletions ...le-api-client/src/main/java/com/google/api/client/googleapis/auth/oauth2/OAuth2Utils.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
import com.google.api.client.util.Beta;
import java.io.IOException;
import java.net.SocketTimeoutException;
import java.net.URI;
import java.net.URISyntaxException;
import java.nio.charset.Charset;
import java.util.Collection;
import java.util.logging.Level;
Expand Down Expand Up @@ -103,9 +105,38 @@ public static String getMetadataServerUrl() {
}

static String getMetadataServerUrl(SystemEnvironmentProvider environment) {
String metadataServerAddress = environment.getEnv("GCE_METADATA_HOST");
if (metadataServerAddress != null) {
return "http://" + metadataServerAddress;
String metadataServerHost = environment.getEnv("GCE_METADATA_HOST");
if (metadataServerHost != null) {
try {
int idx = metadataServerHost.indexOf(":");
if (idx >= 0 && idx == metadataServerHost.lastIndexOf(":")) {
// only one occurrence of ':' indicate this is ipv4/domain and port
return new URI(
"http",
null,
metadataServerHost.substring(0, idx),
Integer.parseInt(metadataServerHost.substring(idx + 1)),
null,
null,
null)
.toString();
}
return new URI("http", metadataServerHost, null, null).toString();
} catch (NumberFormatException e) {
LOGGER.log(
Level.WARNING,
"Invalid GCE_METADATA_HOST env provided, falling back to '"
+ DEFAULT_METADATA_SERVER_URL
+ "'.",
e);
} catch (URISyntaxException e) {
LOGGER.log(
Level.WARNING,
"Invalid GCE_METADATA_HOST env provided, falling back to '"
+ DEFAULT_METADATA_SERVER_URL
+ "'.",
e);
}
}
return DEFAULT_METADATA_SERVER_URL;
}
Expand Down
110 changes: 109 additions & 1 deletion ...test/java/com/google/api/client/googleapis/auth/oauth2/DefaultCredentialProviderTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -239,7 +239,33 @@ public void testDefaultCredentialNoGceCheck() throws IOException {
assertEquals(0, transport.getRequestCount());
}

public void testDefaultCredentialWithCustomMetadataServerAddress() throws IOException {
public void testDefaultCredentialWithInvalidCustomMetadataServerAddress() throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "this::domain.contains.invalid.chars");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://169.254.169.254"));
}

public void testDefaultCredentialWithInvalidCustomMetadataServerPort() throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "test.metadata.server.address:portShouldBeANumber");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://169.254.169.254"));
}

public void testDefaultCredentialWithCustomMetadataServerDomainAddress() throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "test.metadata.server.address");
Expand All @@ -252,6 +278,88 @@ public void testDefaultCredentialWithCustomMetadataServerAddress() throws IOExce
assertTrue(transport.urlWasRequested("http://test.metadata.server.address"));
}

public void testDefaultCredentialWithCustomMetadataServerDomainAddressAndCustomPort()
throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "test.metadata.server.address:8080");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://test.metadata.server.address:8080"));
}

public void testDefaultCredentialWithCustomMetadataServerIPv4Address() throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "169.254.0.1");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://169.254.0.1"));
}

public void testDefaultCredentialWithCustomMetadataServerIPv4AddressAndCustomPort()
throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "169.254.0.1:8080");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://169.254.0.1:8080"));
}

public void testDefaultCredentialWithCustomMetadataServerIPv6Address() throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "fe80::1");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://[fe80::1]"));
}

public void testDefaultCredentialWithCustomMetadataServerIPv6AddressProvidedWithBrackets()
throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "[fe80::1]");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://[fe80::1]"));
}

public void testDefaultCredentialWithCustomMetadataServerIPv6AddressAndCustomPort()
throws IOException {
MockRequestUrlRecordingTransport transport = new MockRequestUrlRecordingTransport();
TestDefaultCredentialProvider testProvider = new TestDefaultCredentialProvider();
testProvider.setEnv("GCE_METADATA_HOST", "[fe80::1]:8080");

try {
testProvider.getDefaultCredential(transport, JSON_FACTORY);
fail("No credential expected for default test provider.");
} catch (IOException expected) {
}
assertTrue(transport.urlWasRequested("http://[fe80::1]:8080"));
}

public void testDefaultCredentialNonExistentFileThrows() throws Exception {
File nonExistentFile = new java.io.File(getTempDirectory(), "DefaultCredentialBadFile.json");
assertFalse(nonExistentFile.exists());
Expand Down