org.springframework.security.web.server.header.ClearSiteDataServerHttpHeadersWriter Maven / Gradle / Ivy
/*
* Copyright 2002-2019 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
*
* https://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 Clear-Site-Data} response header when the request is secure.
*
*
*
* For further details pleaes consult W3C
* Documentation.
*
*
* @author MD Sayem Ahmed
* @since 5.2
*/
public final class ClearSiteDataServerHttpHeadersWriter implements ServerHttpHeadersWriter {
public static final String CLEAR_SITE_DATA_HEADER = "Clear-Site-Data";
private final StaticServerHttpHeadersWriter headerWriterDelegate;
/**
*
* Constructs a new instance using the given directives.
*
* @param directives directives that will be written as the header value
* @throws IllegalArgumentException if the argument is null or empty
*/
public ClearSiteDataServerHttpHeadersWriter(Directive... directives) {
Assert.notEmpty(directives, "directives cannot be empty or null");
this.headerWriterDelegate = StaticServerHttpHeadersWriter.builder()
.header(CLEAR_SITE_DATA_HEADER, transformToHeaderValue(directives))
.build();
}
@Override
public Mono writeHttpHeaders(ServerWebExchange exchange) {
if (isSecure(exchange)) {
return this.headerWriterDelegate.writeHttpHeaders(exchange);
}
return Mono.empty();
}
/**
*
* Represents the directive values expected by the
* {@link ClearSiteDataServerHttpHeadersWriter}
*
* .
*/
public enum Directive {
CACHE("cache"),
COOKIES("cookies"),
STORAGE("storage"),
EXECUTION_CONTEXTS("executionContexts"),
ALL("*");
private final String headerValue;
Directive(String headerValue) {
this.headerValue = "\"" + headerValue + "\"";
}
public String getHeaderValue() {
return this.headerValue;
}
}
private String transformToHeaderValue(Directive... directives) {
StringBuilder sb = new StringBuilder();
for (int i = 0; i < directives.length - 1; i++) {
sb.append(directives[i].headerValue).append(", ");
}
sb.append(directives[directives.length - 1].headerValue);
return sb.toString();
}
private boolean isSecure(ServerWebExchange exchange) {
String scheme = exchange.getRequest().getURI().getScheme();
return scheme != null && scheme.equalsIgnoreCase("https");
}
}