Qiita Teams that are logged in
You are not logged in to any team

Log in to Qiita Team
Community
OrganizationAdvent CalendarQiitadon (β)
Service
Qiita JobsQiita ZineQiita Blog
7
Help us understand the problem. What is going on with this article?
@backpaper0@github

Spring Boot(Spring Web MVC + Tomcat)におけるSameSite Cookie

More than 1 year has passed since last update.

Spring Boot(Spring Web MVC + Tomcat)でSameSite Cookieを使うにはどのようにすればいいか、調べてみました。

SameSite Cookieとはなにか

MDNのドキュメントを参照してください。

TomcatのSameSite Cookie対応

TomcatではCookieをHTTPレスポンスへ書き出すためjavax.servlet.http.Cookieから文字列へのシリアライズを行います。
シリアライズはorg.apache.tomcat.util.http.CookieProcessorインターフェースを通じて行われます。
実装クラスとしてorg.apache.tomcat.util.http.Rfc6265CookieProcessorが用意されていますが、このRfc6265CookieProcessorクラスのsetSameSiteCookiesメソッドを使用してSameSite属性を付けられます。

SameSite属性を付ける設定をしたRfc6265CookieProcessororg.apache.catalina.Contextへセットしないといけませんが、とりあえずSpring Bootで使えればそれで良いのでTomcat単体でのカスタマイズ方法はスキップします。

Spring BootでCookieProcessorをカスタマイズする

Spring Bootではorg.springframework.boot.web.embedded.tomcat.TomcatContextCustomizerインターフェースをimplementsしたコンポーネントを用意するとTomcatのContextをカスタマイズできます。

次のような実装クラスでCookieへSameSite属性を付けられます。

package com.example;

import org.apache.catalina.Context;
import org.apache.tomcat.util.http.Rfc6265CookieProcessor;
import org.springframework.boot.web.embedded.tomcat.TomcatContextCustomizer;
import org.springframework.stereotype.Component;

@Component
public class SameSiteCookieTomcatContextCustomizer implements TomcatContextCustomizer {

    @Override
    public void customize(final Context context) {
        final Rfc6265CookieProcessor cookieProcessor = new Rfc6265CookieProcessor();
        cookieProcessor.setSameSiteCookies("Lax");
        context.setCookieProcessor(cookieProcessor);
    }
}

Spring SessionはデフォルトでSameSite属性が付く

@tokuhirom さんに教えてもらったのですがSpring Sessionを使用するとデフォルトでSameSite属性が付くようです。

まとめ

Spring Boot(Spring Web MVC + Tomcat)でSameSite Cookieを使うには次に示す2通りの方法があることがわかりました。

  • TomcatContextCustomizerをimplementsしたコンポーネントを用意してContextへカスタマイズしたRfc6265CookieProcessorをセットする
  • Spring Sessionを使用する
7
Help us understand the problem. What is going on with this article?
Why not register and get more from Qiita?
  1. We will deliver articles that match you
    By following users and tags, you can catch up information on technical fields that you are interested in as a whole
  2. you can read useful information later efficiently
    By "stocking" the articles you like, you can search right away
backpaper0@github
Programmer. I ❤️ BotW.
tis
創業50年超のSIerです。

Comments

No comments
Sign up for free and join this conversation.
Sign Up
If you already have a Qiita account Login
7
Help us understand the problem. What is going on with this article?