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

Class CookieConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.oauth2.v3.CookieConfig
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CookieConfigOrBuilder, Serializable
public final class CookieConfig extends com.google.protobuf.GeneratedMessageV3 implements CookieConfigOrBuilder
 OAuth cookie configuration attributes.
Protobuf type envoy.extensions.filters.http.oauth2.v3.CookieConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CookieConfig.Builder
    OAuth cookie configuration attributes.
    static enum 
    CookieConfig.SameSite
    Protobuf enum envoy.extensions.filters.http.oauth2.v3.CookieConfig.SameSite

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

    com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    PARTITIONED_FIELD_NUMBER
     
    static final int
    PATH_FIELD_NUMBER
     
    static final int
    SAME_SITE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessageV3

    alwaysUseFieldBuilders, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    static CookieConfig
    getDefaultInstance()
     
    CookieConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Parser<CookieConfig>
    getParserForType()
     
    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.
    int
    getSerializedSize()
     
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CookieConfig.Builder
    newBuilder()
     
    static CookieConfig.Builder
    newBuilder(CookieConfig prototype)
     
    CookieConfig.Builder
    newBuilderForType()
     
    protected CookieConfig.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CookieConfig
    parseDelimitedFrom(InputStream input)
     
    static CookieConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CookieConfig
    parseFrom(byte[] data)
     
    static CookieConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CookieConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static CookieConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CookieConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CookieConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CookieConfig
    parseFrom(InputStream input)
     
    static CookieConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CookieConfig
    parseFrom(ByteBuffer data)
     
    static CookieConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CookieConfig>
    parser()
     
    CookieConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessageV3

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • newInstance

      protected Object newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
      Overrides:
      newInstance in class com.google.protobuf.GeneratedMessageV3

    • getDescriptor

      public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

    • internalGetFieldAccessorTable

      protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
      Specified by:
      internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

    • getSameSiteValue

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

    • getSameSite

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

    • getPath

      public 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) = { ... }
      Specified by:
      getPath in interface CookieConfigOrBuilder
      Returns:
      The path.

    • getPathBytes

      public 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) = { ... }
      Specified by:
      getPathBytes in interface CookieConfigOrBuilder
      Returns:
      The bytes for path.

    • getPartitioned

      public 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;
      Specified by:
      getPartitioned in interface CookieConfigOrBuilder
      Returns:
      The partitioned.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessageV3

    • writeTo

      public void writeTo(com.google.protobuf.CodedOutputStream output) throws IOException
      Specified by:
      writeTo in interface com.google.protobuf.MessageLite
      Overrides:
      writeTo in class com.google.protobuf.GeneratedMessageV3
      Throws:
      IOException

    • getSerializedSize

      public int getSerializedSize()
      Specified by:
      getSerializedSize in interface com.google.protobuf.MessageLite
      Overrides:
      getSerializedSize in class com.google.protobuf.GeneratedMessageV3

    • equals

      public boolean equals(Object obj)
      Specified by:
      equals in interface com.google.protobuf.Message
      Overrides:
      equals in class com.google.protobuf.AbstractMessage

    • hashCode

      public int hashCode()
      Specified by:
      hashCode in interface com.google.protobuf.Message
      Overrides:
      hashCode in class com.google.protobuf.AbstractMessage

    • parseFrom

      public static CookieConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

      public static CookieConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CookieConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CookieConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static CookieConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CookieConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static CookieConfig parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • newBuilderForType

      public CookieConfig.Builder newBuilderForType()
      Specified by:
      newBuilderForType in interface com.google.protobuf.Message
      Specified by:
      newBuilderForType in interface com.google.protobuf.MessageLite

    • newBuilder

      public static CookieConfig.Builder newBuilder()

    • newBuilder

      public static CookieConfig.Builder newBuilder(CookieConfig prototype)

    • toBuilder

      public CookieConfig.Builder toBuilder()
      Specified by:
      toBuilder in interface com.google.protobuf.Message
      Specified by:
      toBuilder in interface com.google.protobuf.MessageLite

    • newBuilderForType

      protected CookieConfig.Builder newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
      Specified by:
      newBuilderForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstance

      public static CookieConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<CookieConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<CookieConfig> getParserForType()
      Specified by:
      getParserForType in interface com.google.protobuf.Message
      Specified by:
      getParserForType in interface com.google.protobuf.MessageLite
      Overrides:
      getParserForType in class com.google.protobuf.GeneratedMessageV3

    • getDefaultInstanceForType

      public CookieConfig getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder