パッケージ org.springframework.security.web.csrf

クラス CookieCsrfTokenRepository

java.lang.ObjectSE
org.springframework.security.web.csrf.CookieCsrfTokenRepository
実装されたすべてのインターフェース:
CsrfTokenRepository
public final class CookieCsrfTokenRepository extends ObjectSE implements CsrfTokenRepository
CSRF トークンを "XSRF-TOKEN" という名前の Cookie に永続化し、AngularJS の規則に従ってヘッダー "X-XSRF-TOKEN" から読み取る CsrfTokenRepository。AngularJS で使用する場合は、必ず withHttpOnlyFalse() を使用してください。
導入:
4.1

  • コンストラクターの詳細

    • CookieCsrfTokenRepository

      public CookieCsrfTokenRepository()

  • メソッドの詳細

    • setCookieCustomizer

      public void setCookieCustomizer(ConsumerSE<org.springframework.http.ResponseCookie.ResponseCookieBuilder> cookieCustomizer)
      build() の呼び出しの直前に、構築される各 Cookie に対して呼び出される ResponseCookieBuilder の ConsumerSE を追加します。
      パラメーター:
      cookieCustomizer - Cookie ビルダーのコンシューマー
      導入:
      6.1

    • generateToken

      public CsrfToken generateToken(jakarta.servlet.http.HttpServletRequest request)
      インターフェースからコピーされた説明: CsrfTokenRepository
      CsrfToken を生成します
      次で指定:
      インターフェース CsrfTokenRepository の generateToken 
      パラメーター:
      request - 使用する HttpServletRequest 
      戻り値:
      生成された CsrfToken。null にはできません。

    • saveToken

      public void saveToken(CsrfToken token, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
      インターフェースからコピーされた説明: CsrfTokenRepository
      HttpServletRequest および HttpServletResponse を使用して CsrfToken を保存します。CsrfToken が null の場合、削除と同じです。
      次で指定:
      インターフェース CsrfTokenRepository の saveToken 
      パラメーター:
      token - 保存する CsrfToken または削除する null
      request - 使用する HttpServletRequest 
      response - 使用する HttpServletResponse 

    • loadToken

      public CsrfToken loadToken(jakarta.servlet.http.HttpServletRequest request)
      インターフェースからコピーされた説明: CsrfTokenRepository
      HttpServletRequest から予想される CsrfToken をロードします
      次で指定:
      インターフェース CsrfTokenRepository の loadToken 
      パラメーター:
      request - 使用する HttpServletRequest 
      戻り値:
      CsrfToken または存在しない場合は null

    • setParameterName

      public void setParameterName(StringSE parameterName)
      トークンを提供するために使用する必要がある HTTP リクエストパラメーターの名前を設定します。
      パラメーター:
      parameterName - トークンを提供するために使用する必要がある HTTP リクエストパラメーターの名前

    • setHeaderName

      public void setHeaderName(StringSE headerName)
      トークンの提供に使用する HTTP ヘッダーの名前を設定します。
      パラメーター:
      headerName - トークンを提供するために使用される HTTP ヘッダーの名前

    • setCookieName

      public void setCookieName(StringSE cookieName)
      予期される CSRF トークンが保存され、読み取られる Cookie の名前を設定します。
      パラメーター:
      cookieName - 予期される CSRF トークンが保存され、そこから読み取られる Cookie の名前

    • setCookieHttpOnly

      @DeprecatedSE(since="6.1") public void setCookieHttpOnly(boolean cookieHttpOnly)
      使用すべきではありません。
      代わりに setCookieCustomizer(Consumer) を使用してください。

    • withHttpOnlyFalse

      public static CookieCsrfTokenRepository withHttpOnlyFalse()
      Cookie.isHttpOnly() が false に設定されている Cookie を作成するインスタンスを簡単に作成するファクトリメソッド。
      戻り値:
      Cookie.isHttpOnly() が false に設定されている Cookie を作成する CookieCsrfTokenRepository のインスタンス。

    • setCookiePath

      public void setCookiePath(StringSE path)
      Cookie の作成に使用するパスを設定します。これにより、リクエストコンテキストをパスとして使用するデフォルトの機能が上書きされます。
      パラメーター:
      path - 使用するパス

    • getCookiePath

      public StringSE getCookiePath()
      CSRF Cookie が設定されるパスを取得します。
      戻り値:
      使用するパス。

    • setCookieDomain

      @DeprecatedSE(since="6.1") public void setCookieDomain(StringSE cookieDomain)
      使用すべきではありません。
      代わりに setCookieCustomizer(Consumer) を使用してください。
      導入:
      5.2

    • setSecure

      @DeprecatedSE(since="6.1") public void setSecure(BooleanSE secure)
      使用すべきではありません。
      代わりに setCookieCustomizer(Consumer) を使用してください。
      導入:
      5.4

    • setCookieMaxAge

      @DeprecatedSE(since="6.1") public void setCookieMaxAge(int cookieMaxAge)
      使用すべきではありません。
      代わりに setCookieCustomizer(Consumer) を使用してください。
      導入:
      5.5