Skip to content

armgit / floci

Public Imported from GitHub
0

Light, fluffy, and always free - The AWS Local Emulator alternative

fix(ssm): resolve parameter ARNs in public reads (#6713)

Aniket Shuklaf24cab162292
diff --git a/docs/services/ssm.md b/docs/services/ssm.md
index c2477560ce..2b6889817f 100644
--- a/docs/services/ssm.md
+++ b/docs/services/ssm.md
@@ -190,6 +190,14 @@ The CloudFormation `Arn` attribute of an `AWS::SSM::Parameter` is the same ARN,
`AddTagsToResource`, `ListTagsForResource` and `RemoveTagsFromResource` accept it as `ResourceId`.
An ECS container secret's `valueFrom` accepts it too.
+`GetParameter` and `GetParameters` accept the returned ARN, optionally followed by
+`:version` or `:label`, for parameters in the caller's account and request region.
+Batch reads keep unresolved inputs in `InvalidParameters` in their original form.
+ARNs naming another account, region or partition never resolve to a same-name local
+parameter. Cross-account shared parameters are not modeled. Secrets Manager
+references continue to use `/aws/reference/secretsmanager/<secret-id>`, not a
+parameter ARN.
+
## Parameter Types
All AWS parameter types are accepted: `String`, `StringList`, `SecureString`.
diff --git a/src/main/java/io/github/hectorvent/floci/services/ssm/SsmJsonHandler.java b/src/main/java/io/github/hectorvent/floci/services/ssm/SsmJsonHandler.java
index bd51c7e28e..c90def8a90 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ssm/SsmJsonHandler.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ssm/SsmJsonHandler.java
@@ -185,7 +185,8 @@ public class SsmJsonHandler {
}
response.set("Parameters", parametersArray);
response.set("InvalidParameters", invalidParameterNames(names,
- params.stream().map(p -> p.getName() + (p.getSelector() == null ? "" : p.getSelector())).toList()));
+ params.stream().map(p -> p.getName() + (p.getSelector() == null ? "" : p.getSelector())).toList(),
+ name -> ssmService.parameterReadName(name, region)));
return Response.ok(response).build();
}
@@ -276,10 +277,15 @@ public class SsmJsonHandler {
}
private ArrayNode invalidParameterNames(List<String> requestedNames, List<String> returnedNames) {
+ return invalidParameterNames(requestedNames, returnedNames, Function.identity());
+ }
+
+ private ArrayNode invalidParameterNames(List<String> requestedNames, List<String> returnedNames,
+ Function<String, String> resolveName) {
Set<String> returnedNameSet = new HashSet<>(returnedNames);
ArrayNode invalidNames = objectMapper.createArrayNode();
requestedNames.stream()
- .filter(name -> !returnedNameSet.contains(name))
+ .filter(name -> !returnedNameSet.contains(resolveName.apply(name)))
.forEach(invalidNames::add);
return invalidNames;
}
diff --git a/src/main/java/io/github/hectorvent/floci/services/ssm/SsmService.java b/src/main/java/io/github/hectorvent/floci/services/ssm/SsmService.java
index 25a7684f85..46cccb3128 100644
--- a/src/main/java/io/github/hectorvent/floci/services/ssm/SsmService.java
+++ b/src/main/java/io/github/hectorvent/floci/services/ssm/SsmService.java
@@ -350,10 +350,11 @@ public class SsmService implements ResourceProvider {
return getParameter(parameterName(nameOrArn, region), true, region);
}
- public Parameter getParameter(String name, boolean withDecryption, String region) {
- if (name != null && name.startsWith(SECRET_REFERENCE_PREFIX)) {
- return secretReference(name, withDecryption, region);
+ public Parameter getParameter(String nameOrArn, boolean withDecryption, String region) {
+ if (nameOrArn != null && nameOrArn.startsWith(SECRET_REFERENCE_PREFIX)) {
+ return secretReference(nameOrArn, withDecryption, region);
}
+ String name = parameterReadName(nameOrArn, region);
return findParameter(name, region).orElseThrow(() -> {
int separator = name == null ? -1 : name.lastIndexOf(':');
if (separator > 0 && separator < name.length() - 1
@@ -1109,10 +1110,25 @@ public class SsmService implements ResourceProvider {
* label selector after the last colon is kept, but the fallback checks the name without it.
*/
private String parameterName(String nameOrArn, String region) {
+ return parameterName(nameOrArn, region, false);
+ }
+
+ String parameterReadName(String nameOrArn, String region) {
+ return parameterName(nameOrArn, region, true);
+ }
+
+ private String parameterName(String nameOrArn, String region, boolean parameterRead) {
if (nameOrArn != null && nameOrArn.startsWith("arn:")) {
try {
AwsArnUtils.Arn arn = AwsArnUtils.parse(nameOrArn);
if ("ssm".equals(arn.service()) && arn.resource().startsWith("parameter")) {
+ if (parameterRead && (!arn.resource().startsWith("parameter/")
+ || arn.resource().startsWith("parameter" + SECRET_REFERENCE_PREFIX)
+ || !arn.accountId().equals(regionResolver.getAccountId())
+ || !arn.region().equals(region)
+ || !arn.partition().equals(regionResolver.partitionForRegion(region)))) {
+ return nameOrArn;
+ }
String name = arn.resource().substring("parameter".length());
int separator = name.lastIndexOf(':');
String baseName = separator > 0 ? name.substring(0, separator) : name;
diff --git a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIamEnforcementIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIamEnforcementIntegrationTest.java
new file mode 100644
index 0000000000..32a2ff9e42
--- /dev/null
+++ b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIamEnforcementIntegrationTest.java
@@ -0,0 +1,70 @@
+package io.github.hectorvent.floci.services.ssm;
+
+import io.github.hectorvent.floci.testing.EnforcementFixtures;
+import io.github.hectorvent.floci.testing.IamEnforcementProfile;
+import io.github.hectorvent.floci.testing.PartitionCleanup;
+import io.quarkus.test.junit.QuarkusTest;
+import io.quarkus.test.junit.TestProfile;
+import io.restassured.RestAssured;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.api.extension.RegisterExtension;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.ssm.SsmClient;
+import software.amazon.awssdk.services.ssm.model.SsmException;
+
+import java.net.URI;
+import java.util.UUID;
+
+import static io.github.hectorvent.floci.testing.EnforcementFixtures.auth;
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+@QuarkusTest
+@TestProfile(IamEnforcementProfile.class)
+class SsmGetParameterArnIamEnforcementIntegrationTest {
+
+ @RegisterExtension
+ final PartitionCleanup cleanup = new PartitionCleanup();
+
+ @Test
+ void arnReadsStillRequirePermissionForTheRequestedParameter() {
+ String account = "000000000000";
+ String prefix = "/iam-read-arn-" + UUID.randomUUID();
+ String allowed = prefix + "/allowed";
+ String denied = prefix + "/denied";
+ try (SsmClient root = client(account, "test")) {
+ try {
+ root.putParameter(request -> request.name(allowed).type("String").value("allowed-value"));
+ root.putParameter(request -> request.name(denied).type("String").value("denied-value"));
+ String allowedArn = root.getParameter(request -> request.name(allowed)).parameter().arn();
+ String deniedArn = root.getParameter(request -> request.name(denied)).parameter().arn();
+ String userName = "ssm-arn-" + UUID.randomUUID();
+ EnforcementFixtures.UserCredentials credentials = EnforcementFixtures.createUser(
+ cleanup, RestAssured.port, auth(account, "iam"), userName);
+ EnforcementFixtures.putUserPolicy(RestAssured.port, auth(account, "iam"), userName, "read-one", """
+ {"Version":"2012-10-17","Statement":[{"Effect":"Allow",
+ "Action":"ssm:GetParameter","Resource":"%s"}]}""".formatted(allowedArn));
+ try (SsmClient user = client(credentials.accessKeyId(), credentials.secretAccessKey())) {
+ assertEquals("allowed-value", assertDoesNotThrow(() -> user.getParameter(request -> request
+ .name(allowedArn))).parameter().value());
+ SsmException error = assertThrows(SsmException.class,
+ () -> user.getParameter(request -> request.name(deniedArn)));
+ assertEquals("AccessDeniedException", error.awsErrorDetails().errorCode());
+ }
+ } finally {
+ root.deleteParameter(request -> request.name(allowed));
+ root.deleteParameter(request -> request.name(denied));
+ }
+ }
+ }
+
+ private SsmClient client(String accessKey, String secretKey) {
+ return SsmClient.builder().endpointOverride(URI.create("http://localhost:" + RestAssured.port))
+ .httpClientBuilder(UrlConnectionHttpClient.builder()).region(Region.US_EAST_1)
+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(accessKey, secretKey))).build();
+ }
+}
diff --git a/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIntegrationTest.java
new file mode 100644
index 0000000000..c0bcf495f7
--- /dev/null
+++ b/src/test/java/io/github/hectorvent/floci/services/ssm/SsmGetParameterArnIntegrationTest.java
@@ -0,0 +1,178 @@
+package io.github.hectorvent.floci.services.ssm;
+
+import io.quarkus.test.junit.QuarkusTest;
+import io.restassured.RestAssured;
+import org.junit.jupiter.api.Test;
+import org.junit.jupiter.params.ParameterizedTest;
+import org.junit.jupiter.params.provider.CsvSource;
+import software.amazon.awssdk.auth.credentials.AwsBasicCredentials;
+import software.amazon.awssdk.auth.credentials.StaticCredentialsProvider;
+import software.amazon.awssdk.http.urlconnection.UrlConnectionHttpClient;
+import software.amazon.awssdk.regions.Region;
+import software.amazon.awssdk.services.secretsmanager.SecretsManagerClient;
+import software.amazon.awssdk.services.ssm.SsmClient;
+import software.amazon.awssdk.services.ssm.model.GetParametersResponse;
+import software.amazon.awssdk.services.ssm.model.Parameter;
+import software.amazon.awssdk.services.ssm.model.SsmException;
+
+import java.net.URI;
+import java.util.ArrayList;
+import java.util.List;
+import java.util.UUID;
+
+import static org.junit.jupiter.api.Assertions.assertDoesNotThrow;
+import static org.junit.jupiter.api.Assertions.assertEquals;
+import static org.junit.jupiter.api.Assertions.assertThrows;
+
+@QuarkusTest
+class SsmGetParameterArnIntegrationTest {
+
+ private static final String ACCOUNT = "741661400001";
+
+ @ParameterizedTest
+ @CsvSource({"us-east-1", "eu-west-2", "cn-north-1", "us-gov-west-1"})
+ void sdkReadsReturnedArnsWithVersionAndLabelSelectors(String region) {
+ List<String> names = new ArrayList<>();
+ try (SsmClient client = client(ACCOUNT, region)) {
+ try {
+ String prefix = "read-arn-" + UUID.randomUUID();
+ for (String name : List.of(prefix, "/" + prefix + "/config")) {
+ createVersions(client, name, names);
+ String arn = client.getParameter(request -> request.name(name)).parameter().arn();
+ for (String selector : List.of("", ":1", ":stable")) {
+ for (boolean decrypt : List.of(false, true)) {
+ Parameter expected = client.getParameter(request -> request.name(name + selector)
+ .withDecryption(decrypt)).parameter();
+ Parameter actual = assertDoesNotThrow(() -> client.getParameter(request -> request
+ .name(arn + selector).withDecryption(decrypt)).parameter());
+ assertEquals(expected, actual);
+ }
+ }
+ }
+ } finally {
+ names.forEach(name -> client.deleteParameter(request -> request.name(name)));
+ }
+ }
+ }
+
+ @ParameterizedTest
+ @CsvSource({"us-east-1", "eu-west-2", "cn-north-1", "us-gov-west-1"})
+ void batchReadsMixNamesArnsAndSelectorsWithoutMarkingResolvedArnsInvalid(String region) {
+ List<String> names = new ArrayList<>();
+ try (SsmClient client = client(ACCOUNT, region)) {
+ try {
+ String prefix = "batch-arn-" + UUID.randomUUID();
+ createVersions(client, prefix, names);
+ createVersions(client, "/" + prefix + "/config", names);
+ String topArn = client.getParameter(request -> request.name(prefix)).parameter().arn();
+ String pathArn = client.getParameter(request -> request.name(names.get(1))).parameter().arn();
+ List<String> invalid = List.of(topArn + "-missing", pathArn + ":999");
+ GetParametersResponse result = client.getParameters(request -> request.withDecryption(true)
+ .names(topArn, pathArn + ":stable", prefix + ":1", invalid.get(0), invalid.get(1)));
+ assertEquals(invalid, result.invalidParameters());
+ assertEquals(3, result.parameters().size());
+ assertEquals(List.of("v1", "v1", "v2"), result.parameters().stream()
+ .map(Parameter::value).sorted().toList());
+ } finally {
+ names.forEach(name -> client.deleteParameter(request -> request.name(name)));
+ }
+ }
+ }
+
+ @Test
+ void foreignAndMalformedArnsCannotResolveACallerLocalParameter() {
+ String region = "us-east-1";
+ List<String> names = new ArrayList<>();
+ try (SsmClient client = client(ACCOUNT, region)) {
+ try {
+ String name = "scope-arn-" + UUID.randomUUID();
+ createVersions(client, name, names);
+ String arn = client.getParameter(request -> request.name(name)).parameter().arn();
+ List<String> invalid = List.of(arn.replace(ACCOUNT, "741661400002"),
+ arn.replace(region, "eu-west-2"), arn.replace("arn:aws:", "arn:aws-cn:"),
+ arn.replace(":ssm:", ":secretsmanager:"),
+ arn.replace(":parameter/", ":parameter"), "arn:malformed");
+ for (String reference : invalid) {
+ SsmException error = assertThrows(SsmException.class,
+ () -> client.getParameter(request -> request.name(reference)));
+ assertEquals("ParameterNotFound", error.awsErrorDetails().errorCode());
+ }
+ assertEquals(invalid, client.getParameters(request -> request.names(invalid)).invalidParameters());
+ for (String otherAccount : List.of(ACCOUNT, "741661400002")) {
+ String otherRegion = otherAccount.equals(ACCOUNT) ? "eu-west-2" : region;
+ try (SsmClient other = client(otherAccount, otherRegion)) {
+ try {
+ other.putParameter(request -> request.name(name).type("String").value("other-scope"));
+ SsmException error = assertThrows(SsmException.class,
+ () -> other.getParameter(request -> request.name(arn)));
+ assertEquals("ParameterNotFound", error.awsErrorDetails().errorCode());
+ } finally {
+ other.deleteParameter(request -> request.name(name));
+ }
+ }
+ }
+ } finally {
+ names.forEach(name -> client.deleteParameter(request -> request.name(name)));
+ }
+ }
+ }
+
+ @Test
+ void parameterArnsCannotBecomeVirtualSecretsManagerReferences() {
+ String name = "reference-arn-" + UUID.randomUUID();
+ String reference = "/aws/reference/secretsmanager/" + name;
+ String arn = "arn:aws:ssm:us-east-1:" + ACCOUNT + ":parameter" + reference;
+ try (SecretsManagerClient secrets = SecretsManagerClient.builder()
+ .endpointOverride(URI.create("http://localhost:" + RestAssured.port))
+ .httpClientBuilder(UrlConnectionHttpClient.builder()).region(Region.US_EAST_1)
+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(ACCOUNT, "test"))).build();
+ SsmClient client = client(ACCOUNT, "us-east-1")) {
+ try {
+ secrets.createSecret(request -> request.name(name).secretString("secret-value"));
+ assertEquals("secret-value", client.getParameter(request -> request.name(reference)
+ .withDecryption(true)).parameter().value());
+ SsmException error = assertThrows(SsmException.class,
+ () -> client.getParameter(request -> request.name(arn).withDecryption(true)));
+ assertEquals("ParameterNotFound", error.awsErrorDetails().errorCode());
+ GetParametersResponse batch = client.getParameters(request -> request.names(reference, arn)
+ .withDecryption(true));
+ assertEquals(List.of(arn), batch.invalidParameters());
+ assertEquals(1, batch.parameters().size());
+ } finally {
+ secrets.deleteSecret(request -> request.secretId(name).forceDeleteWithoutRecovery(true));
+ }
+ }
+ }
+
+ @Test
+ void missingArnSelectorsKeepTheVersionNotFoundError() {
+ List<String> names = new ArrayList<>();
+ try (SsmClient client = client(ACCOUNT, "us-east-1")) {
+ try {
+ String name = "/selector-arn-" + UUID.randomUUID();
+ createVersions(client, name, names);
+ String arn = client.getParameter(request -> request.name(name)).parameter().arn();
+ for (String selector : List.of(":999", ":missing-label")) {
+ SsmException error = assertThrows(SsmException.class,
+ () -> client.getParameter(request -> request.name(arn + selector)));
+ assertEquals("ParameterVersionNotFound", error.awsErrorDetails().errorCode());
+ }
+ } finally {
+ names.forEach(name -> client.deleteParameter(request -> request.name(name)));
+ }
+ }
+ }
+
+ private void createVersions(SsmClient client, String name, List<String> names) {
+ client.putParameter(request -> request.name(name).type("SecureString").value("v1"));
+ names.add(name);
+ client.putParameter(request -> request.name(name).type("SecureString").value("v2").overwrite(true));
+ client.labelParameterVersion(request -> request.name(name).parameterVersion(1L).labels("stable"));
+ }
+
+ private SsmClient client(String account, String region) {
+ return SsmClient.builder().endpointOverride(URI.create("http://localhost:" + RestAssured.port))
+ .httpClientBuilder(UrlConnectionHttpClient.builder()).region(Region.of(region))
+ .credentialsProvider(StaticCredentialsProvider.create(AwsBasicCredentials.create(account, "test"))).build();
+ }
+}