Light, fluffy, and always free - The AWS Local Emulator alternative
feat: add global CORS filter for browser-based local development (#849)
Fred Peña76edd1f78b40
diff --git a/docs/configuration/environment-variables.md b/docs/configuration/environment-variables.mdindex 4071cc3eed..ded893c80c 100644--- a/docs/configuration/environment-variables.md+++ b/docs/configuration/environment-variables.md@@ -25,6 +25,15 @@ Floci is configured exclusively through environment variables. Every option belo| `FLOCI_AUTH_VALIDATE_SIGNATURES` | `false` | When `true`, verifies AWS Signature V4 on every request. Leave `false` for local development || `FLOCI_AUTH_PRESIGN_SECRET` | `local-emulator-secret` | Secret used to sign and verify pre-signed URLs |+## Browser CORS++| Variable | Default | Description |+|---|---|---|+| `FLOCI_SECURITY_EXTRA_CORS_ALLOWED_ORIGINS` | _(none)_ | Comma-separated browser origins allowed to call Floci directly. Alias: `EXTRA_CORS_ALLOWED_ORIGINS` |+| `FLOCI_SECURITY_EXTRA_CORS_ALLOWED_HEADERS` | _(none)_ | Additional header names to include in `Access-Control-Allow-Headers`. Alias: `EXTRA_CORS_ALLOWED_HEADERS` |+| `FLOCI_SECURITY_EXTRA_CORS_EXPOSE_HEADERS` | _(none)_ | Additional header names to include in `Access-Control-Expose-Headers`. Alias: `EXTRA_CORS_EXPOSE_HEADERS` |+| `FLOCI_SECURITY_DISABLE_CORS_HEADERS` | `false` | Disable Floci's global CORS response headers. Alias: `DISABLE_CORS_HEADERS` |+---## TLS / HTTPSdiff --git a/src/main/java/io/github/hectorvent/floci/config/EmulatorConfig.java b/src/main/java/io/github/hectorvent/floci/config/EmulatorConfig.javaindex 017ca0c285..dd798ddc1f 100644--- a/src/main/java/io/github/hectorvent/floci/config/EmulatorConfig.java+++ b/src/main/java/io/github/hectorvent/floci/config/EmulatorConfig.java@@ -62,6 +62,8 @@ public interface EmulatorConfig {AuthConfig auth();+ SecurityConfig security();+ServicesConfig services();DockerConfig docker();@@ -91,6 +93,15 @@ public interface EmulatorConfig {Optional<List<String>> extraSuffixes();}+ interface SecurityConfig {+ Optional<List<String>> extraCorsAllowedOrigins();+ Optional<List<String>> extraCorsAllowedHeaders();+ Optional<List<String>> extraCorsExposeHeaders();++ @WithDefault("false")+ boolean disableCorsHeaders();+ }+interface StorageConfig {@WithDefault("hybrid")String mode();diff --git a/src/main/java/io/github/hectorvent/floci/core/common/GlobalCorsFilter.java b/src/main/java/io/github/hectorvent/floci/core/common/GlobalCorsFilter.javanew file mode 100644index 0000000000..fa180ebfcd--- /dev/null+++ b/src/main/java/io/github/hectorvent/floci/core/common/GlobalCorsFilter.java@@ -0,0 +1,187 @@+package io.github.hectorvent.floci.core.common;++import io.github.hectorvent.floci.config.EmulatorConfig;+import jakarta.annotation.Priority;+import jakarta.inject.Inject;+import jakarta.ws.rs.Priorities;+import jakarta.ws.rs.container.ContainerRequestContext;+import jakarta.ws.rs.container.ContainerRequestFilter;+import jakarta.ws.rs.container.ContainerResponseContext;+import jakarta.ws.rs.container.ContainerResponseFilter;+import jakarta.ws.rs.container.PreMatching;+import jakarta.ws.rs.core.MediaType;+import jakarta.ws.rs.core.MultivaluedMap;+import jakarta.ws.rs.core.Response;+import jakarta.ws.rs.ext.Provider;++import java.util.Arrays;+import java.util.LinkedHashSet;+import java.util.List;+import java.util.Optional;+import java.util.Set;+import java.util.stream.Collectors;++/**+ * Global CORS support for browser-based local development.+ *+ * <p>Configured via {@code EXTRA_CORS_ALLOWED_ORIGINS} (or the equivalent+ * {@code FLOCI_SECURITY_EXTRA_CORS_ALLOWED_ORIGINS}). Service-level CORS+ * responses, such as S3 bucket CORS rules or API Gateway integrations, keep+ * precedence because this filter only fills missing CORS headers.</p>+ */+@Provider+@PreMatching+@Priority(Priorities.HEADER_DECORATOR)+public class GlobalCorsFilter implements ContainerRequestFilter, ContainerResponseFilter {++ private static final String ORIGIN = "Origin";+ private static final String REQUEST_METHOD = "Access-Control-Request-Method";+ private static final String REQUEST_HEADERS = "Access-Control-Request-Headers";+ private static final String ALLOW_ORIGIN = "Access-Control-Allow-Origin";+ private static final String ALLOW_METHODS = "Access-Control-Allow-Methods";+ private static final String ALLOW_HEADERS = "Access-Control-Allow-Headers";+ private static final String EXPOSE_HEADERS = "Access-Control-Expose-Headers";+ private static final String VARY = "Vary";+ private static final String MAX_AGE = "Access-Control-Max-Age";+ private static final String DEFAULT_ALLOW_METHODS = "GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS";+ private static final String DEFAULT_ALLOW_HEADERS = String.join(", ",+ "authorization",+ "content-type",+ "x-amz-content-sha256",+ "x-amz-date",+ "x-amz-security-token",+ "x-amz-target",+ "x-amz-user-agent");++ private final jakarta.inject.Provider<EmulatorConfig> configProvider;+ private volatile CorsSettings settings;++ @Inject+ public GlobalCorsFilter(jakarta.inject.Provider<EmulatorConfig> configProvider) {+ this.configProvider = configProvider;+ }++ private CorsSettings settings() {+ CorsSettings s = settings;+ if (s == null) {+ synchronized (this) {+ s = settings;+ if (s == null) {+ s = settings = CorsSettings.from(configProvider.get().security());+ }+ }+ }+ return s;+ }++ @Override+ public void filter(ContainerRequestContext requestContext) {+ CorsSettings s = settings();+ if (!s.enabled()) {+ return;+ }++ String origin = requestContext.getHeaderString(ORIGIN);+ if (origin == null || !s.matchesOrigin(origin)) {+ return;+ }++ if ("OPTIONS".equalsIgnoreCase(requestContext.getMethod())+ && requestContext.getHeaderString(REQUEST_METHOD) != null) {+ Response.ResponseBuilder builder = Response.noContent()+ .type(MediaType.TEXT_PLAIN_TYPE)+ .header(ALLOW_ORIGIN, s.allowOriginHeader(origin))+ .header(ALLOW_METHODS, DEFAULT_ALLOW_METHODS)+ .header(ALLOW_HEADERS, s.allowHeaders(requestContext.getHeaderString(REQUEST_HEADERS)))+ .header(MAX_AGE, "86400")+ .header(VARY, ORIGIN);++ s.exposeHeaders().ifPresent(value -> builder.header(EXPOSE_HEADERS, value));+ requestContext.abortWith(builder.build());+ }+ }++ @Override+ public void filter(ContainerRequestContext requestContext, ContainerResponseContext responseContext) {+ CorsSettings s = settings();+ if (!s.enabled()) {+ return;+ }++ String origin = requestContext.getHeaderString(ORIGIN);+ if (origin == null || !s.matchesOrigin(origin)) {+ return;+ }++ MultivaluedMap<String, Object> headers = responseContext.getHeaders();+ headers.putIfAbsent(ALLOW_ORIGIN, List.of(s.allowOriginHeader(origin)));+ s.exposeHeaders().ifPresent(value -> headers.putIfAbsent(EXPOSE_HEADERS, List.of(value)));+ addVaryOrigin(headers);+ }++ private static void addVaryOrigin(MultivaluedMap<String, Object> headers) {+ boolean hasOrigin = Optional.ofNullable(headers.get(VARY))+ .orElse(List.of())+ .stream()+ .flatMap(value -> Arrays.stream(String.valueOf(value).split(",")))+ .map(String::trim)+ .anyMatch(ORIGIN::equalsIgnoreCase);+ if (!hasOrigin) {+ headers.add(VARY, ORIGIN);+ }+ }++ private record CorsSettings(boolean disabled,+ Set<String> allowedOrigins,+ Set<String> extraAllowedHeaders,+ Set<String> extraExposeHeaders) {++ static CorsSettings from(EmulatorConfig.SecurityConfig security) {+ Set<String> origins = security.extraCorsAllowedOrigins()+ .map(list -> (Set<String>) new LinkedHashSet<>(list))+ .orElse(Set.of());+ Set<String> allowedHeaders = security.extraCorsAllowedHeaders()+ .map(list -> (Set<String>) new LinkedHashSet<>(list))+ .orElse(Set.of());+ Set<String> exposeHeaders = security.extraCorsExposeHeaders()+ .map(list -> (Set<String>) new LinkedHashSet<>(list))+ .orElse(Set.of());+ return new CorsSettings(security.disableCorsHeaders(), origins, allowedHeaders, exposeHeaders);+ }++ boolean enabled() {+ return !disabled && !allowedOrigins.isEmpty();+ }++ boolean matchesOrigin(String origin) {+ return allowedOrigins.contains("*")+ || allowedOrigins.stream().anyMatch(allowed -> allowed.equalsIgnoreCase(origin));+ }++ String allowOriginHeader(String origin) {+ return allowedOrigins.contains("*") ? "*" : origin;+ }++ String allowHeaders(String requestedHeaders) {+ LinkedHashSet<String> headers = new LinkedHashSet<>();+ headers.addAll(splitCsv(DEFAULT_ALLOW_HEADERS));+ headers.addAll(extraAllowedHeaders);+ headers.addAll(splitCsv(requestedHeaders));+ return String.join(", ", headers);+ }++ Optional<String> exposeHeaders() {+ return extraExposeHeaders.isEmpty() ? Optional.empty() : Optional.of(String.join(", ", extraExposeHeaders));+ }++ private static LinkedHashSet<String> splitCsv(String value) {+ if (value == null || value.isBlank()) {+ return new LinkedHashSet<>();+ }+ return Arrays.stream(value.split(","))+ .map(String::trim)+ .filter(part -> !part.isEmpty())+ .collect(Collectors.toCollection(LinkedHashSet::new));+ }+ }+}diff --git a/src/main/resources/application.yml b/src/main/resources/application.ymlindex b71764360d..ed02c02215 100644--- a/src/main/resources/application.yml+++ b/src/main/resources/application.yml@@ -84,7 +84,6 @@ floci:rds:# Override storage mode for RDS (memory = no Docker volumes; hybrid/persistent = named volume per instance)# mode: memory- cloudfront:dns:# Extra hostname suffixes resolved to Floci's container IP by the embedded DNS server.@@ -98,6 +97,15 @@ floci:validate-signatures: falsepresign-secret: local-emulator-secret+ security:+ # Comma-separated browser origins allowed by the global CORS filter.+ # Env var: EXTRA_CORS_ALLOWED_ORIGINS=http://localhost:3000+ # extra-cors-allowed-origins:+ # Extra request/response CORS header names for browser clients.+ # extra-cors-allowed-headers:+ # extra-cors-expose-headers:+ disable-cors-headers: false+tls:enabled: false # FLOCI_TLS_ENABLED (default: false)# cert-path: "" # FLOCI_TLS_CERT_PATH (PEM certificate file)@@ -194,7 +202,6 @@ floci:enabled: truecloudformation:enabled: true- deleted-stack-retention-seconds: 30acm:enabled: truevalidation-wait-seconds: 0diff --git a/src/test/java/io/github/hectorvent/floci/core/common/GlobalCorsFilterIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/core/common/GlobalCorsFilterIntegrationTest.javanew file mode 100644index 0000000000..7f1d75c2cb--- /dev/null+++ b/src/test/java/io/github/hectorvent/floci/core/common/GlobalCorsFilterIntegrationTest.java@@ -0,0 +1,83 @@+package io.github.hectorvent.floci.core.common;++import io.quarkus.test.junit.QuarkusTest;+import io.quarkus.test.junit.QuarkusTestProfile;+import io.quarkus.test.junit.TestProfile;+import io.github.hectorvent.floci.testing.RestAssuredJsonUtils;+import org.junit.jupiter.api.BeforeAll;+import org.junit.jupiter.api.Test;++import java.util.Map;++import static io.restassured.RestAssured.given;+import static org.hamcrest.Matchers.containsString;+import static org.hamcrest.Matchers.equalTo;+import static org.hamcrest.Matchers.nullValue;++@QuarkusTest+@TestProfile(GlobalCorsFilterIntegrationTest.CorsProfile.class)+class GlobalCorsFilterIntegrationTest {++ @BeforeAll+ static void configureRestAssured() {+ RestAssuredJsonUtils.configureAwsContentTypes();+ }++ @Test+ void preflightFromExtraAllowedOriginReturnsCorsHeaders() {+ given()+ .header("Origin", "http://localhost:3000")+ .header("Access-Control-Request-Method", "POST")+ .header("Access-Control-Request-Headers", "x-custom-header, x-amz-target")+ .when()+ .options("/")+ .then()+ .statusCode(204)+ .header("Access-Control-Allow-Origin", equalTo("http://localhost:3000"))+ .header("Access-Control-Allow-Methods", containsString("POST"))+ .header("Access-Control-Allow-Headers", containsString("x-custom-header"))+ .header("Access-Control-Allow-Headers", containsString("x-added-header"))+ .header("Access-Control-Expose-Headers", containsString("x-visible-header"))+ .header("Vary", containsString("Origin"));+ }++ @Test+ void actualRequestFromExtraAllowedOriginGetsCorsHeaders() {+ given()+ .header("Origin", "https://ui.example.test")+ .header("X-Amz-Target", "DynamoDB_20120810.ListTables")+ .contentType("application/x-amz-json-1.0")+ .body("{}")+ .when()+ .post("/")+ .then()+ .statusCode(200)+ .header("Access-Control-Allow-Origin", equalTo("https://ui.example.test"))+ .header("Access-Control-Expose-Headers", containsString("x-visible-header"))+ .header("Vary", containsString("Origin"));+ }++ @Test+ void requestFromUnlistedOriginGetsNoGlobalCorsHeaders() {+ given()+ .header("Origin", "https://not-allowed.example.test")+ .header("X-Amz-Target", "DynamoDB_20120810.ListTables")+ .contentType("application/x-amz-json-1.0")+ .body("{}")+ .when()+ .post("/")+ .then()+ .statusCode(200)+ .header("Access-Control-Allow-Origin", nullValue());+ }++ public static final class CorsProfile implements QuarkusTestProfile {+ @Override+ public Map<String, String> getConfigOverrides() {+ return Map.of(+ "floci.security.extra-cors-allowed-origins", "http://localhost:3000,https://ui.example.test",+ "floci.security.extra-cors-allowed-headers", "x-added-header",+ "floci.security.extra-cors-expose-headers", "x-visible-header");+ }+ }+}diff --git a/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeSchedulerIntegrationTest.java b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeSchedulerIntegrationTest.javaindex 9eed399d46..469508e056 100644--- a/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeSchedulerIntegrationTest.java+++ b/src/test/java/io/github/hectorvent/floci/services/eventbridge/EventBridgeSchedulerIntegrationTest.java@@ -303,6 +303,8 @@ class EventBridgeSchedulerIntegrationTest {@Overridepublic AuthConfig auth() { return null; }@Override+ public SecurityConfig security() { return null; }+ @Overridepublic ServicesConfig services() { return null; }@Overridepublic DockerConfig docker() { return null; }diff --git a/src/test/resources/application.yml b/src/test/resources/application.ymlindex 612cb6eb72..98c8b869a5 100644--- a/src/test/resources/application.yml+++ b/src/test/resources/application.yml@@ -40,6 +40,9 @@ floci:validate-signatures: falsepresign-secret: test-secret+ security:+ disable-cors-headers: false+init-hooks:shell-executable: /bin/shtimeout-seconds: 5