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

Class CsrfPolicy

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessageV3
io.envoyproxy.envoy.extensions.filters.http.csrf.v3.CsrfPolicy
All Implemented Interfaces:
com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, CsrfPolicyOrBuilder, Serializable
public final class CsrfPolicy extends com.google.protobuf.GeneratedMessageV3 implements CsrfPolicyOrBuilder
 CSRF filter config.
Protobuf type envoy.extensions.filters.http.csrf.v3.CsrfPolicy
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    CsrfPolicy.Builder
    CSRF filter config.

    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
    ADDITIONAL_ORIGINS_FIELD_NUMBER
     
    static final int
    FILTER_ENABLED_FIELD_NUMBER
     
    static final int
    SHADOW_ENABLED_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)
     
    StringMatcher
    getAdditionalOrigins(int index)
    Specifies additional source origins that will be allowed in addition to the destination origin.
    int
    getAdditionalOriginsCount()
    Specifies additional source origins that will be allowed in addition to the destination origin.
    List<StringMatcher>
    getAdditionalOriginsList()
    Specifies additional source origins that will be allowed in addition to the destination origin.
    StringMatcherOrBuilder
    getAdditionalOriginsOrBuilder(int index)
    Specifies additional source origins that will be allowed in addition to the destination origin.
    List<? extends StringMatcherOrBuilder>
    getAdditionalOriginsOrBuilderList()
    Specifies additional source origins that will be allowed in addition to the destination origin.
    static CsrfPolicy
    getDefaultInstance()
     
    CsrfPolicy
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    RuntimeFractionalPercent
    getFilterEnabled()
    Specifies the % of requests for which the CSRF filter is enabled.
    RuntimeFractionalPercentOrBuilder
    getFilterEnabledOrBuilder()
    Specifies the % of requests for which the CSRF filter is enabled.
    com.google.protobuf.Parser<CsrfPolicy>
    getParserForType()
     
    int
    getSerializedSize()
     
    RuntimeFractionalPercent
    getShadowEnabled()
    Specifies that CSRF policies will be evaluated and tracked, but not enforced.
    RuntimeFractionalPercentOrBuilder
    getShadowEnabledOrBuilder()
    Specifies that CSRF policies will be evaluated and tracked, but not enforced.
    boolean
    hasFilterEnabled()
    Specifies the % of requests for which the CSRF filter is enabled.
    int
    hashCode()
     
    boolean
    hasShadowEnabled()
    Specifies that CSRF policies will be evaluated and tracked, but not enforced.
    protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static CsrfPolicy.Builder
    newBuilder()
     
    static CsrfPolicy.Builder
    newBuilder(CsrfPolicy prototype)
     
    CsrfPolicy.Builder
    newBuilderForType()
     
    protected CsrfPolicy.Builder
    newBuilderForType(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
     
    protected Object
    newInstance(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
     
    static CsrfPolicy
    parseDelimitedFrom(InputStream input)
     
    static CsrfPolicy
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CsrfPolicy
    parseFrom(byte[] data)
     
    static CsrfPolicy
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CsrfPolicy
    parseFrom(com.google.protobuf.ByteString data)
     
    static CsrfPolicy
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CsrfPolicy
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static CsrfPolicy
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CsrfPolicy
    parseFrom(InputStream input)
     
    static CsrfPolicy
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static CsrfPolicy
    parseFrom(ByteBuffer data)
     
    static CsrfPolicy
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<CsrfPolicy>
    parser()
     
    CsrfPolicy.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

    • FILTER_ENABLED_FIELD_NUMBER

      public static final int FILTER_ENABLED_FIELD_NUMBER
      See Also:

    • SHADOW_ENABLED_FIELD_NUMBER

      public static final int SHADOW_ENABLED_FIELD_NUMBER
      See Also:

    • ADDITIONAL_ORIGINS_FIELD_NUMBER

      public static final int ADDITIONAL_ORIGINS_FIELD_NUMBER
      See Also:

  • 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

    • hasFilterEnabled

      public boolean hasFilterEnabled()
       Specifies the % of requests for which the CSRF filter is enabled.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
      Specified by:
      hasFilterEnabled in interface CsrfPolicyOrBuilder
      Returns:
      Whether the filterEnabled field is set.

    • getFilterEnabled

      public RuntimeFractionalPercent getFilterEnabled()
       Specifies the % of requests for which the CSRF filter is enabled.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilterEnabled in interface CsrfPolicyOrBuilder
      Returns:
      The filterEnabled.

    • getFilterEnabledOrBuilder

      public RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()
       Specifies the % of requests for which the CSRF filter is enabled.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests to filter.

 .. note::

   This field defaults to 100/:ref:`HUNDRED
   <envoy_v3_api_enum_type.v3.FractionalPercent.DenominatorType>`.
      .envoy.config.core.v3.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }
      Specified by:
      getFilterEnabledOrBuilder in interface CsrfPolicyOrBuilder

    • hasShadowEnabled

      public boolean hasShadowEnabled()
       Specifies that CSRF policies will be evaluated and tracked, but not enforced.

 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's ``Origin`` and ``Destination`` to determine if it's valid, but will not
 enforce any policies.
      .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 2;
      Specified by:
      hasShadowEnabled in interface CsrfPolicyOrBuilder
      Returns:
      Whether the shadowEnabled field is set.

    • getShadowEnabled

      public RuntimeFractionalPercent getShadowEnabled()
       Specifies that CSRF policies will be evaluated and tracked, but not enforced.

 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's ``Origin`` and ``Destination`` to determine if it's valid, but will not
 enforce any policies.
      .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 2;
      Specified by:
      getShadowEnabled in interface CsrfPolicyOrBuilder
      Returns:
      The shadowEnabled.

    • getShadowEnabledOrBuilder

      public RuntimeFractionalPercentOrBuilder getShadowEnabledOrBuilder()
       Specifies that CSRF policies will be evaluated and tracked, but not enforced.

 This is intended to be used when ``filter_enabled`` is off and will be ignored otherwise.

 If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFractionalPercent.runtime_key>` is specified,
 Envoy will lookup the runtime key to get the percentage of requests for which it will evaluate
 and track the request's ``Origin`` and ``Destination`` to determine if it's valid, but will not
 enforce any policies.
      .envoy.config.core.v3.RuntimeFractionalPercent shadow_enabled = 2;
      Specified by:
      getShadowEnabledOrBuilder in interface CsrfPolicyOrBuilder

    • getAdditionalOriginsList

      public List<StringMatcher> getAdditionalOriginsList()
       Specifies additional source origins that will be allowed in addition to
 the destination origin.

 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
      repeated .envoy.type.matcher.v3.StringMatcher additional_origins = 3;
      Specified by:
      getAdditionalOriginsList in interface CsrfPolicyOrBuilder

    • getAdditionalOriginsOrBuilderList

      public List<? extends StringMatcherOrBuilder> getAdditionalOriginsOrBuilderList()
       Specifies additional source origins that will be allowed in addition to
 the destination origin.

 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
      repeated .envoy.type.matcher.v3.StringMatcher additional_origins = 3;
      Specified by:
      getAdditionalOriginsOrBuilderList in interface CsrfPolicyOrBuilder

    • getAdditionalOriginsCount

      public int getAdditionalOriginsCount()
       Specifies additional source origins that will be allowed in addition to
 the destination origin.

 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
      repeated .envoy.type.matcher.v3.StringMatcher additional_origins = 3;
      Specified by:
      getAdditionalOriginsCount in interface CsrfPolicyOrBuilder

    • getAdditionalOrigins

      public StringMatcher getAdditionalOrigins(int index)
       Specifies additional source origins that will be allowed in addition to
 the destination origin.

 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
      repeated .envoy.type.matcher.v3.StringMatcher additional_origins = 3;
      Specified by:
      getAdditionalOrigins in interface CsrfPolicyOrBuilder

    • getAdditionalOriginsOrBuilder

      public StringMatcherOrBuilder getAdditionalOriginsOrBuilder(int index)
       Specifies additional source origins that will be allowed in addition to
 the destination origin.

 More information on how this can be configured via runtime can be found
 :ref:`here <csrf-configuration>`.
      repeated .envoy.type.matcher.v3.StringMatcher additional_origins = 3;
      Specified by:
      getAdditionalOriginsOrBuilder in interface CsrfPolicyOrBuilder

    • 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 CsrfPolicy parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static CsrfPolicy.Builder newBuilder()

    • newBuilder

      public static CsrfPolicy.Builder newBuilder(CsrfPolicy prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static CsrfPolicy getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<CsrfPolicy> 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 CsrfPolicy getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder