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

Remove OpenApi CORS default support #29666

Merged
merged 1 commit into from
Jan 30, 2023
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
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,6 @@ public void testOpenApiPathAccessResource() {

RestAssured.given()
.when().options(OPEN_API_PATH)
.then().header("Access-Control-Allow-Methods", "GET, HEAD, OPTIONS");
.then().header("Allow", "GET, HEAD, OPTIONS");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -34,20 +34,4 @@ public void testOpenApiPathAccessResource() {
.body("info.title", Matchers.equalTo("quarkus-smallrye-openapi-deployment API"))
.body("paths", Matchers.hasKey("/resource"));
}

@Test
public void testDefaultOpenApiCorsProperties() {
// make sure default CORS properties are present
RestAssured
.given()
.header("Origin", "https://quarkus.io")
.get(OPEN_API_PATH)
.then()
.statusCode(200)
.header("access-control-allow-methods", "GET, HEAD, OPTIONS")
.header("access-control-allow-headers", "Content-Type, Authorization")
.header("access-control-max-age", "86400")
.header("access-control-allow-origin", "*")
.header("access-control-allow-credentials", "true");
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,10 @@
import io.quarkus.arc.Arc;
import io.smallrye.openapi.runtime.io.Format;
import io.vertx.core.Handler;
import io.vertx.core.MultiMap;
import io.vertx.core.buffer.Buffer;
import io.vertx.core.http.HttpMethod;
import io.vertx.core.http.HttpServerRequest;
import io.vertx.core.http.HttpServerResponse;
import io.vertx.core.http.impl.headers.HeadersMultiMap;
import io.vertx.ext.web.RoutingContext;

/**
Expand All @@ -21,20 +19,8 @@ public class OpenApiHandler implements Handler<RoutingContext> {
private volatile OpenApiDocumentService openApiDocumentService;
private static final String ALLOWED_METHODS = "GET, HEAD, OPTIONS";
private static final String QUERY_PARAM_FORMAT = "format";
private static final MultiMap RESPONSE_HEADERS = new HeadersMultiMap();

static {
RESPONSE_HEADERS.add("access-control-allow-origin", "*");
RESPONSE_HEADERS.add("access-control-allow-credentials", "true");
RESPONSE_HEADERS.add("access-control-allow-methods", ALLOWED_METHODS);
RESPONSE_HEADERS.add("access-control-allow-headers", "Content-Type, Authorization");
RESPONSE_HEADERS.add("access-control-max-age", "86400");
}

final boolean corsEnabled;

public OpenApiHandler(boolean corsEnabled) {
this.corsEnabled = corsEnabled;
public OpenApiHandler() {
}

@Override
Expand All @@ -43,10 +29,6 @@ public void handle(RoutingContext event) {
HttpServerResponse resp = event.response();

if (req.method().equals(HttpMethod.OPTIONS)) {
if (!corsEnabled) {
//if the cors filter is enabled we let it set the headers
resp.headers().addAll(RESPONSE_HEADERS);
}
resp.headers().set("Allow", ALLOWED_METHODS);
event.next();
} else {
Expand Down Expand Up @@ -74,10 +56,6 @@ public void handle(RoutingContext event) {
}
}

if (!corsEnabled) {
//if the cors filter is enabled we let it set the headers
resp.headers().addAll(RESPONSE_HEADERS);
}
resp.headers().set("Content-Type", format.getMimeType() + ";charset=UTF-8");
byte[] schemaDocument = getOpenApiDocumentService().getDocument(format);
resp.end(Buffer.buffer(schemaDocument));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,6 @@
import org.eclipse.microprofile.openapi.spi.OASFactoryResolver;
import org.jboss.logging.Logger;

import io.quarkus.runtime.LaunchMode;
import io.quarkus.runtime.RuntimeValue;
import io.quarkus.runtime.ShutdownContext;
import io.quarkus.runtime.annotations.Recorder;
Expand Down Expand Up @@ -44,13 +43,7 @@ public void accept(Route route) {

public Handler<RoutingContext> handler(OpenApiRuntimeConfig runtimeConfig) {
if (runtimeConfig.enable) {
if (!configuration.getValue().corsEnabled && LaunchMode.NORMAL == LaunchMode.current()) {
log.info(
"CORS filtering is disabled and cross-origin resource sharing is allowed without restriction, which is not recommended in production."
+ " Please configure the CORS filter through 'quarkus.http.cors.*' properties."
+ " For more information, see Quarkus HTTP CORS documentation");
}
return new OpenApiHandler(configuration.getValue().corsEnabled);
return new OpenApiHandler();
} else {
return new OpenApiNotFoundHandler();
}
Expand Down