io.undertow.server.handlers.SameSiteCookieHandler Maven / Gradle / Ivy
Go to download
This artifact provides a single jar that contains all classes required to use remote EJB and JMS, including
all dependencies. It is intended for use by those not using maven, maven users should just import the EJB and
JMS BOM's instead (shaded JAR's cause lots of problems with maven, as it is very easy to inadvertently end up
with different versions on classes on the class path).
/*
* JBoss, Home of Professional Open Source.
* Copyright 2020 Red Hat, Inc., and individual contributors
* as indicated by the @author tags.
*
* 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 io.undertow.server.handlers;
import java.util.Collections;
import java.util.HashMap;
import java.util.Map;
import java.util.Set;
import java.util.regex.Pattern;
import io.undertow.server.HandlerWrapper;
import io.undertow.server.HttpHandler;
import io.undertow.server.HttpServerExchange;
import io.undertow.server.ResponseCommitListener;
import io.undertow.server.handlers.builder.HandlerBuilder;
import io.undertow.util.Headers;
import io.undertow.util.SameSiteNoneIncompatibleClientChecker;
/**
* Handler that will set the SameSite flag to response cookies
* @author Richard Opalka
*/
public class SameSiteCookieHandler implements HttpHandler {
private final HttpHandler next;
private final String mode;
private final Pattern cookiePattern;
private final boolean enableClientChecker;
private final boolean addSecureForNone;
public SameSiteCookieHandler(final HttpHandler next, final String mode) {
this(next, mode, null, true, true, true);
}
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern) {
this(next, mode, cookiePattern, true, true, true);
}
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive) {
this(next, mode, cookiePattern, caseSensitive, true, true);
}
public SameSiteCookieHandler(final HttpHandler next, final String mode, final String cookiePattern, final boolean caseSensitive, final boolean enableClientChecker, final boolean addSecureForNone) {
this.next = next;
this.mode = mode;
if (cookiePattern != null && !cookiePattern.isEmpty()) {
this.cookiePattern = Pattern.compile(cookiePattern, caseSensitive ? 0 : Pattern.CASE_INSENSITIVE);
} else {
this.cookiePattern = null;
}
final boolean modeIsNone = CookieSameSiteMode.NONE.toString().equalsIgnoreCase(mode);
this.enableClientChecker = enableClientChecker && modeIsNone; // client checker is enabled only for SameSite=None
this.addSecureForNone = addSecureForNone && modeIsNone; // Add secure attribute for SameSite=None
}
@Override
public void handleRequest(HttpServerExchange exchange) throws Exception {
if (mode != null) {
exchange.addResponseCommitListener(new ResponseCommitListener() {
@Override
public void beforeCommit(HttpServerExchange exchange) {
// If user-agent is available check it and skip sending "SameSite=None" for incompatible user-agents
String userAgent = exchange.getRequestHeaders().getFirst(Headers.USER_AGENT);
if (enableClientChecker && userAgent != null && !SameSiteNoneIncompatibleClientChecker.shouldSendSameSiteNone(userAgent)) {
return;
}
for (Cookie cookie : exchange.responseCookies()) {
if (cookiePattern == null || cookiePattern.matcher(cookie.getName()).matches()) {
// set SameSite attribute to all response cookies when cookie pattern is not specified.
// or, set SameSite attribute if cookie name matches the specified cookie pattern.
cookie.setSameSiteMode(mode);
if (addSecureForNone) {
// Add secure attribute for "SameSite=None"
cookie.setSecure(true);
}
}
}
}
});
}
next.handleRequest(exchange);
}
public static class Builder implements HandlerBuilder {
@Override
public String name() {
return "samesite-cookie";
}
@Override
public Map> parameters() {
Map> parameters = new HashMap<>();
parameters.put("mode", String.class);
parameters.put("cookie-pattern", String.class);
parameters.put("case-sensitive", Boolean.class);
parameters.put("enable-client-checker", Boolean.class);
parameters.put("add-secure-for-none", Boolean.class);
return parameters;
}
@Override
public Set requiredParameters() {
return Collections.singleton("mode");
}
@Override
public String defaultParameter() {
return "mode";
}
@Override
public HandlerWrapper build(Map config) {
final String mode = (String) config.get("mode");
final String pattern = (String) config.get("cookie-pattern");
final Boolean caseSensitive = (Boolean) config.get("case-sensitive");
final Boolean enableClientChecker = (Boolean) config.get("enable-client-checker");
final Boolean addSecureForNone = (Boolean) config.get("add-secure-for-none");
return new HandlerWrapper() {
@Override
public HttpHandler wrap(HttpHandler handler) {
return new SameSiteCookieHandler(handler, mode, pattern,
caseSensitive == null ? true : caseSensitive,
enableClientChecker == null ? true : enableClientChecker,
addSecureForNone == null ? true : addSecureForNone);
}
};
}
}
}