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.

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

Fix issue for checking if app is running in an OCI instance which causes Instance Principal auth to fail #8197

Merged
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 6 additions & 1 deletion integrations/oci/sdk/runtime/pom.xml
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
<?xml version="1.0" encoding="UTF-8"?>
<!--

Copyright (c) 2018, 2023 Oracle and/or its affiliates.
Copyright (c) 2018, 2024 Oracle and/or its affiliates.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -93,6 +93,11 @@
<artifactId>junit-jupiter-api</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.junit.jupiter</groupId>
<artifactId>junit-jupiter-params</artifactId>
<scope>test</scope>
</dependency>
</dependencies>

<build>
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2023 Oracle and/or its affiliates.
* Copyright (c) 2023, 2024 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand Down Expand Up @@ -28,13 +28,16 @@
import com.oracle.bmc.Region;
import jakarta.inject.Singleton;

import static com.oracle.bmc.auth.AbstractFederationClientAuthenticationDetailsProviderBuilder.METADATA_SERVICE_BASE_URL;

/**
* This (overridable) implementation will check the {@link OciConfig} for {@code IMDS} availability. And if it is found to be
* available, will also perform a secondary check on {@link Region#getRegionFromImds()} to ensure it returns a non-null value.
*/
@Singleton
@Weight(ServiceInfoBasics.DEFAULT_INJECT_WEIGHT)
class OciAvailabilityDefault implements OciAvailability {
private static final String OPC_PATH = getOpcPath(METADATA_SERVICE_BASE_URL);

@Override
public boolean isRunningOnOci(OciConfig ociConfig) {
Expand All @@ -46,7 +49,7 @@ static boolean runningOnOci(OciConfig ociConfig) {
return false;
}

return (Region.getRegionFromImds() != null);
return (Region.getRegionFromImds("http://" + ociConfig.imdsHostName() + OPC_PATH) != null);
}

static boolean canReach(String address,
Expand All @@ -71,4 +74,15 @@ static boolean canReach(String address,
}
}

static String getOpcPath(String metadataServiceBaseURL) {
String input = metadataServiceBaseURL;
int index = -1;
for (int nth = 3; nth > 0; nth--) {
index = input.indexOf("/", index + 1);
if (index == -1) {
klustria marked this conversation as resolved.
Show resolved Hide resolved
throw new IllegalStateException("Unable to find opc path from '" + metadataServiceBaseURL + "'");
}
}
return metadataServiceBaseURL.substring(index);
}
}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
/*
* Copyright (c) 2023 Oracle and/or its affiliates.
* Copyright (c) 2023, 2024 Oracle and/or its affiliates.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
Expand All @@ -19,9 +19,12 @@
import java.util.Objects;

import org.junit.jupiter.api.Test;
import org.junit.jupiter.params.ParameterizedTest;
import org.junit.jupiter.params.provider.ValueSource;

import static org.hamcrest.CoreMatchers.is;
import static org.hamcrest.MatcherAssert.assertThat;
import static org.junit.jupiter.api.Assertions.assertThrows;

class OciAvailabilityTest {

Expand All @@ -32,4 +35,22 @@ void isRunningOnOci() {
is(false));
}

@Test
void getValidOpcPath() {
assertThat(OciAvailabilityDefault.getOpcPath("http://169.254.169.254/opc/v2/"),
is("/opc/v2/"));
}

@ParameterizedTest
@ValueSource(strings = {
"http169.254.169.254opcv2",
"http://169.254.169.254",
})
void getInValidOpcPath(String metadataServiceBaseURL) {
Exception e = assertThrows(IllegalStateException.class, () -> {
OciAvailabilityDefault.getOpcPath(metadataServiceBaseURL);
});
String expectedMessage = "Unable to find opc path from '" + metadataServiceBaseURL + "'";
assertThat(e.getMessage(), is(expectedMessage));
}
}