Skip to content
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
@@ -1,10 +1,10 @@
package org.prebid.cache.builders;

import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.prebid.cache.model.ErrorResponse;
import org.prebid.cache.model.PayloadWrapper;
import org.prebid.cache.model.ResponseObject;
import org.prebid.cache.routers.ApiConfig;
import org.prebid.cache.translators.ThrowableTranslator;
import org.springframework.http.CacheControl;
import org.springframework.http.MediaType;
Expand All @@ -25,14 +25,15 @@
import static org.springframework.web.reactive.function.BodyInserters.fromValue;
import static org.springframework.web.reactive.function.server.ServerResponse.status;

@Slf4j
@Component
@RequiredArgsConstructor
public class PrebidServerResponseBuilder {

private static final String HEADER_CONNECTION_KEEPALIVE = "keep-alive";
private static final String HEADER_CONNECTION_CLOSE = "close";

private final ApiConfig apiConfig;

public Mono<ServerResponse> createResponseMono(final ServerRequest request,
final MediaType mediaType,
final PayloadWrapper wrapper) {
Expand All @@ -52,7 +53,10 @@ private ServerResponse.BodyBuilder ok(final ServerRequest request, final MediaTy
.header(DATE, now)
.varyBy(ACCEPT_ENCODING)
.cacheControl(CacheControl.noCache());
applyHeaders(builder, request);

applyConnectionHeaders(builder, request);
applySandboxingHeaders(builder, mediaType);
Comment thread
Net-burst marked this conversation as resolved.
Resolved

return builder;
}

Expand All @@ -73,18 +77,18 @@ public <T extends Throwable> Mono<ServerResponse> error(final Mono<T> monoError,
);
}

private static ServerResponse.BodyBuilder addHeaders(final ServerResponse.BodyBuilder builder,
final ServerRequest request) {
private ServerResponse.BodyBuilder addHeaders(final ServerResponse.BodyBuilder builder,
final ServerRequest request) {
ServerResponse.BodyBuilder headers =
builder.header(DATE, ZonedDateTime.now().format(DateTimeFormatter.RFC_1123_DATE_TIME))
.varyBy(ACCEPT_ENCODING)
.cacheControl(CacheControl.noCache());

return applyHeaders(headers, request);
return applyConnectionHeaders(headers, request);
}

private static ServerResponse.BodyBuilder applyHeaders(final ServerResponse.BodyBuilder builder,
final ServerRequest request) {
private ServerResponse.BodyBuilder applyConnectionHeaders(final ServerResponse.BodyBuilder builder,
final ServerRequest request) {

final List<String> connectionHeaders = request.headers().header(CONNECTION);
if (hasConnectionValue(connectionHeaders, HEADER_CONNECTION_KEEPALIVE)) {
Expand All @@ -102,4 +106,11 @@ private static boolean hasConnectionValue(List<String> connectionHeaders, String
.allMatch(Predicate.isEqual(value));
}

private void applySandboxingHeaders(ServerResponse.BodyBuilder builder, MediaType mediaType) {
if (MediaType.APPLICATION_XML.equals(mediaType) && apiConfig.isSandboxXmlResponses()) {
builder.header("Content-Security-Policy", "sandbox; default-src 'none'");
builder.header("X-Content-Type-Options", "nosniff");
}
}

}
2 changes: 2 additions & 0 deletions src/main/java/org/prebid/cache/routers/ApiConfig.java
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@ public class ApiConfig {
private boolean cacheWriteSecured;
private boolean externalUUIDSecured;

private boolean sandboxXmlResponses;

@NotEmpty
private String storagePath;

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
import org.springframework.http.MediaType;
import org.springframework.mock.web.reactive.function.server.MockServerRequest;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.bean.override.mockito.MockitoBean;
import org.springframework.web.reactive.function.server.ServerRequest;
import org.springframework.web.reactive.function.server.ServerResponse;
import reactor.core.publisher.Mono;
Expand All @@ -24,15 +25,18 @@
import java.util.function.Consumer;

import static org.junit.jupiter.api.Assertions.assertEquals;
import static org.junit.jupiter.api.Assertions.assertTrue;
import static org.mockito.BDDMockito.given;
import static org.springframework.http.MediaType.APPLICATION_JSON;
import static org.springframework.http.MediaType.APPLICATION_JSON_UTF8;
import static org.springframework.http.MediaType.APPLICATION_XML;

@ContextConfiguration(classes={PrebidServerResponseBuilder.class, ApiConfig.class})
@ContextConfiguration(classes = {PrebidServerResponseBuilder.class, ApiConfig.class})
@SpringBootTest
class PrebidServerResponseBuilderTests extends PayloadWrapperResponseTests {

@MockitoBean
ApiConfig apiConfig;

@Autowired
PrebidServerResponseBuilder builder;

Expand All @@ -42,7 +46,7 @@ private Mono<ServerResponse> createResponseMono(final ServerRequest request,
return builder.createResponseMono(request, mediaType, jsonPayloadWrapper);
} else if (isJsonUTF8(mediaType)) {
return builder.createResponseMono(request, mediaType, jsonUTF8PayloadWrapper);
}else if (isXml(mediaType)) {
} else if (isXml(mediaType)) {
return builder.createResponseMono(request, mediaType, xmlPayloadWrapper);
}
return null;
Expand All @@ -61,24 +65,29 @@ private void subscribeAndVerify(final Mono<ServerResponse> mono,

private void verifyServerResponse(MediaType mediaType, HttpHeaders requestHeaders, HttpHeaders expectedHeaders) {
final var request = MockServerRequest.builder().headers(requestHeaders).build();
final Consumer<Signal<ServerResponse>> consumer = signal -> {
assertTrue(signal.isOnComplete());

final ServerResponse response = signal.get();
assertEquals(200, response.statusCode().value());
assertEquals(response.headers().getContentType(), expectedHeaders.getContentType());
assertEquals(response.headers().getConnection(), expectedHeaders.getConnection());
};

subscribeAndVerify(createResponseMono(request, mediaType), consumer);
StepVerifier.create(createResponseMono(request, mediaType))
.assertNext(response -> {
assertEquals(200,
response.statusCode().value());
assertEquals(expectedHeaders.getContentType(),
response.headers().getContentType());
assertEquals(expectedHeaders.getConnection(),
response.headers().getConnection());
assertEquals(expectedHeaders.get("Content-Security-Policy"),
response.headers().get("Content-Security-Policy"));
assertEquals(expectedHeaders.get("X-Content-Type-Options"),
response.headers().get("X-Content-Type-Options"));
})
.verifyComplete();
}

private void verifyErrorResponse(HttpStatus status) {
final MockServerRequest request = MockServerRequest.builder().build();
final Consumer<Signal<ServerResponse>> consumer =
signal -> assertEquals(status.value(), signal.get().statusCode().value());

subscribeAndVerify(createErrorMono(request, status), consumer);
StepVerifier.create(createErrorMono(request, status))
.assertNext(response -> assertEquals(status.value(), response.statusCode().value()))
.verifyComplete();
}

private Mono<ServerResponse> createErrorMono(final ServerRequest request, final HttpStatus status) {
Expand Down Expand Up @@ -129,13 +138,32 @@ void verifyJsonUTF8ServerResponse() {
}

@Test
void verifyNotFound() { verifyErrorResponse(HttpStatus.NOT_FOUND); }
void verifySandboxedXmlServerResponse() {
given(apiConfig.isSandboxXmlResponses()).willReturn(true);

final HttpHeaders requestHeaders = new HttpHeaders();

final HttpHeaders responseHeaders = new HttpHeaders();
responseHeaders.add(HttpHeaders.CONTENT_TYPE, APPLICATION_XML.toString());
responseHeaders.add("Content-Security-Policy", "sandbox; default-src 'none'");
responseHeaders.add("X-Content-Type-Options", "nosniff");
verifyServerResponse(APPLICATION_XML, requestHeaders, responseHeaders);
}

@Test
void verifyNotFound() {
verifyErrorResponse(HttpStatus.NOT_FOUND);
}

@Test
void verifyBadRequest() { verifyErrorResponse(HttpStatus.BAD_REQUEST); }
void verifyBadRequest() {
verifyErrorResponse(HttpStatus.BAD_REQUEST);
}

@Test
void verifyRepoError() { verifyErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR); }
void verifyRepoError() {
verifyErrorResponse(HttpStatus.INTERNAL_SERVER_ERROR);
}

@SpringBootTest
public abstract static class PayloadTests {
Expand Down
Loading