org.springframework.security.web.server.header.ContentSecurityPolicyServerHttpHeadersWriter Maven / Gradle / Ivy
/*
* Copyright 2002-2018 the original author or authors.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package org.springframework.security.web.server.header;
import reactor.core.publisher.Mono;
import org.springframework.util.Assert;
import org.springframework.web.server.ServerWebExchange;
/**
* Writes the {@code Contet-Security-Policy} response header with configured policy
* directives.
*
* @author Vedran Pavic
* @since 5.1
*/
public final class ContentSecurityPolicyServerHttpHeadersWriter
implements ServerHttpHeadersWriter {
public static final String CONTENT_SECURITY_POLICY = "Content-Security-Policy";
public static final String CONTENT_SECURITY_POLICY_REPORT_ONLY = "Content-Security-Policy-Report-Only";
private String policyDirectives;
private boolean reportOnly;
private ServerHttpHeadersWriter delegate;
@Override
public Mono writeHttpHeaders(ServerWebExchange exchange) {
return (this.delegate != null) ? this.delegate.writeHttpHeaders(exchange)
: Mono.empty();
}
/**
* Set the policy directive(s) to be used in the response header.
* @param policyDirectives the policy directive(s)
* @throws IllegalArgumentException if policyDirectives is {@code null} or empty
*/
public void setPolicyDirectives(String policyDirectives) {
Assert.hasLength(policyDirectives, "policyDirectives must not be null or empty");
this.policyDirectives = policyDirectives;
this.delegate = createDelegate();
}
/**
* Set whether to include the {@code Content-Security-Policy-Report-Only} header in
* the response. Otherwise, defaults to the {@code Content-Security-Policy} header.
* @param reportOnly whether to only report policy violations
*/
public void setReportOnly(boolean reportOnly) {
this.reportOnly = reportOnly;
this.delegate = createDelegate();
}
private ServerHttpHeadersWriter createDelegate() {
if (this.policyDirectives != null) {
// @formatter:off
return StaticServerHttpHeadersWriter.builder()
.header(resolveHeader(this.reportOnly), this.policyDirectives)
.build();
// @formatter:on
}
else {
return null;
}
}
private static String resolveHeader(boolean reportOnly) {
return reportOnly ? CONTENT_SECURITY_POLICY_REPORT_ONLY : CONTENT_SECURITY_POLICY;
}
}