Skip to content

KAFKA-3578: Allow cross origin HTTP requests on all HTTP methods #1288

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

Closed
Ishiihara wants to merge 3 commits into from
Closed

KAFKA-3578: Allow cross origin HTTP requests on all HTTP methods #1288

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
9388198
Allow specifying allowed cross origin methods
Ishiihara Apr 28, 2016
9ab7991
Add unit test for CORS allow methods
Ishiihara Apr 29, 2016
b5d28ff
Improve unit test and documentation
Ishiihara Apr 29, 2016
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
10 changes: 9 additions & 1 deletion connect/runtime/src/main/java/org/apache/kafka/connect/runtime/WorkerConfig.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -109,6 +109,11 @@ public class WorkerConfig extends AbstractConfig {
" from the domain of the REST API.";
protected static final String ACCESS_CONTROL_ALLOW_ORIGIN_DEFAULT = "";

public static final String ACCESS_CONTROL_ALLOW_METHODS_CONFIG = "access.control.allow.methods";
protected static final String ACCESS_CONTROL_ALLOW_METHODS_DOC =
"Sets the methods supported for cross origin requests by setting the Access-Control-Allow-Methods header. "
+ "The default value of the Access-Control-Allow-Methods header allows cross origin requests for GET, POST and HEAD.";
protected static final String ACCESS_CONTROL_ALLOW_METHODS_DEFAULT = "";

/**
* Get a basic ConfigDef for a WorkerConfig. This includes all the common settings. Subclasses can use this to
Expand Down Expand Up @@ -141,7 +146,10 @@ protected static ConfigDef baseConfigDef() {
.define(REST_ADVERTISED_PORT_CONFIG, Type.INT, null, Importance.LOW, REST_ADVERTISED_PORT_DOC)
.define(ACCESS_CONTROL_ALLOW_ORIGIN_CONFIG, Type.STRING,
ACCESS_CONTROL_ALLOW_ORIGIN_DEFAULT, Importance.LOW,
ACCESS_CONTROL_ALLOW_ORIGIN_DOC);
ACCESS_CONTROL_ALLOW_ORIGIN_DOC)
.define(ACCESS_CONTROL_ALLOW_METHODS_CONFIG, Type.STRING,
ACCESS_CONTROL_ALLOW_METHODS_DEFAULT, Importance.LOW,
ACCESS_CONTROL_ALLOW_METHODS_DOC);
}

public WorkerConfig(ConfigDef definition, Map<String, String> props) {
Expand Down
14 changes: 10 additions & 4 deletions connect/runtime/src/main/java/org/apache/kafka/connect/runtime/rest/RestServer.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,7 @@
import com.fasterxml.jackson.core.type.TypeReference;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.jaxrs.json.JacksonJsonProvider;

import org.apache.kafka.connect.errors.ConnectException;
import org.apache.kafka.connect.runtime.Herder;
import org.apache.kafka.connect.runtime.WorkerConfig;
Expand Down Expand Up @@ -47,9 +48,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.DispatcherType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
Expand All @@ -60,6 +58,10 @@
import java.util.List;
import java.util.Map;

import javax.servlet.DispatcherType;
import javax.ws.rs.core.Response;
import javax.ws.rs.core.UriBuilder;

/**
* Embedded server for the REST API that provides the control plane for Kafka Connect workers.
*/
Expand Down Expand Up @@ -115,7 +117,11 @@ public void start(Herder herder) {
if (allowedOrigins != null && !allowedOrigins.trim().isEmpty()) {
FilterHolder filterHolder = new FilterHolder(new CrossOriginFilter());
filterHolder.setName("cross-origin");
filterHolder.setInitParameter("allowedOrigins", allowedOrigins);
filterHolder.setInitParameter(CrossOriginFilter.ALLOWED_ORIGINS_PARAM, allowedOrigins);
String allowedMethods = config.getString(WorkerConfig.ACCESS_CONTROL_ALLOW_METHODS_CONFIG);
if (allowedMethods != null && !allowedOrigins.trim().isEmpty()) {
filterHolder.setInitParameter(CrossOriginFilter.ALLOWED_METHODS_PARAM, allowedMethods);
}
context.addFilter(filterHolder, "/*", EnumSet.of(DispatcherType.REQUEST));
}

Expand Down
28 changes: 20 additions & 8 deletions connect/runtime/src/test/java/org/apache/kafka/connect/runtime/rest/RestServerTest.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,18 +31,19 @@
import org.powermock.api.easymock.annotation.MockStrict;
import org.powermock.modules.junit4.PowerMockRunner;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
import java.net.URI;
import java.net.URISyntaxException;
import java.util.Arrays;
import java.util.Collection;
import java.util.HashMap;
import java.util.Map;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.Invocation;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;

import static org.junit.Assert.assertEquals;

@RunWith(PowerMockRunner.class)
Expand Down Expand Up @@ -71,15 +72,15 @@ private Map<String, String> baseWorkerProps() {

@Test
public void testCORSEnabled() {
checkCORSRequest("*", "http://bar.com", "http://bar.com");
checkCORSRequest("*", "http://bar.com", "http://bar.com", "PUT");
}

@Test
public void testCORSDisabled() {
checkCORSRequest("", "http://bar.com", null);
checkCORSRequest("", "http://bar.com", null, null);
}

public void checkCORSRequest(String corsDomain, String origin, String expectedHeader) {
public void checkCORSRequest(String corsDomain, String origin, String expectedHeader, String method) {
// To be able to set the Origin, we need to toggle this flag
System.setProperty("sun.net.http.allowRestrictedHeaders", "true");

Expand All @@ -92,10 +93,12 @@ public Object answer() throws Throwable {
return null;
}
});

PowerMock.replayAll();

Map<String, String> workerProps = baseWorkerProps();
workerProps.put(WorkerConfig.ACCESS_CONTROL_ALLOW_ORIGIN_CONFIG, corsDomain);
workerProps.put(WorkerConfig.ACCESS_CONTROL_ALLOW_METHODS_CONFIG, method);
WorkerConfig workerConfig = new StandaloneConfig(workerProps);
server = new RestServer(workerConfig);
server.start(herder);
Expand All @@ -107,6 +110,15 @@ public Object answer() throws Throwable {
assertEquals(200, response.getStatus());

assertEquals(expectedHeader, response.getHeaderString("Access-Control-Allow-Origin"));

response = request("/connector-plugins/FileStreamSource/validate")
.header("Referer", origin + "/page")
.header("Origin", origin)
.header("Access-Control-Request-Method", method)
.options();
assertEquals(404, response.getStatus());
Copy link
Copy Markdown
Contributor

@ewencp ewencp Apr 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 404 seemed odd to me, so I want to make sure I understand why we're seeing it (since I would normally interpret that as an error). It seems that CORS doesn't require that you return a particular HTTP status code, so for the preflighted request it's actually ok if we return any code here. In the case of Jetty, it looks like the CrossOriginFilter's chainPreflight option defaults to true such that the OPTIONS request continues on for normal handling. Since we don't implement OPTIONS for any of our endpoints (and the one under test, specifically), we end up with a 404. Is that correct?

Copy link
Copy Markdown
Contributor Author

@Ishiihara Ishiihara Apr 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That's correct. This is purely for testing purpose and making sure the Access-Control-Allow-Methods header is properly set.

assertEquals(expectedHeader, response.getHeaderString("Access-Control-Allow-Origin"));
assertEquals(method, response.getHeaderString("Access-Control-Allow-Methods"));
Copy link
Copy Markdown
Contributor

@ewencp ewencp Apr 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Should we be checking the Access-Control-Allow-Origin header on this request as well, just as we do with the first request in this method?

Copy link
Copy Markdown
Contributor Author

@Ishiihara Ishiihara Apr 29, 2016

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ack

PowerMock.verifyAll();
}

Expand Down