Package io.envoyproxy.envoy.extensions.filters.http.oauth2.v3

Interface CookieConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
CookieConfig, CookieConfig.Builder
public interface CookieConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    getPartitioned()
    If true, the ``Partitioned`` attribute will be set on the cookie.
    String
    getPath()
    The path attribute for the cookie.
    com.google.protobuf.ByteString
    getPathBytes()
    The path attribute for the cookie.
    CookieConfig.SameSite
    getSameSite()
    The value used for the SameSite cookie attribute.
    int
    getSameSiteValue()
    The value used for the SameSite cookie attribute.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getSameSiteValue

      int getSameSiteValue()
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Returns:
      The enum numeric value on the wire for sameSite.

    • getSameSite

      CookieConfig.SameSite getSameSite()
       The value used for the SameSite cookie attribute.
      .envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite same_site = 1 [(.validate.rules) = { ... }
      Returns:
      The sameSite.

    • getPath

      String getPath()
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Returns:
      The path.

    • getPathBytes

      com.google.protobuf.ByteString getPathBytes()
       The path attribute for the cookie.

 This controls the scope of the cookie and is useful for path-based routing scenarios
 where different logical boundaries or applications may operate with different OAuth2 clients.
 The CSRF cookie (nonce cookie) can be configured with a different path than session cookies
 to support flows where the callback URL is on a different path.

 If not specified, defaults to ``/``.
      string path = 2 [(.validate.rules) = { ... }
      Returns:
      The bytes for path.

    • getPartitioned

      boolean getPartitioned()
       If true, the ``Partitioned`` attribute will be set on the cookie.

 Modern browsers (Firefox, Chrome with third-party cookie deprecation) warn or block
 "foreign" cookies unless they carry the ``Partitioned`` attribute alongside ``SameSite=None; Secure``.
 When Envoy is used in a gateway/IdP flow that sets OAuth/OIDC cookies for a parent domain
 (e.g., ``Domain=.example.com``) while running on a different host, those cookies are
 considered third-party and will be rejected without ``Partitioned``.

 See `CHIPS <https://developers.google.com/privacy-sandbox/3pcd/chips>`_ for more information.

 Default is false.
      bool partitioned = 3;
      Returns:
      The partitioned.