io.envoyproxy.envoy.config.filter.http.csrf.v2

Interface CsrfPolicyOrBuilder

All Superinterfaces:

com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder

All Known Implementing Classes:

CsrfPolicy, CsrfPolicy.Builder

public interface CsrfPolicyOrBuilder
extends com.google.protobuf.MessageOrBuilder

Method Summary

Modifier and Type	Method and Description
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.
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.
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.
boolean	hasShadowEnabled() Specifies that CSRF policies will be evaluated and tracked, but not enforced.

Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

isInitialized

Method Detail

hasFilterEnabled

boolean hasFilterEnabled()

 Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.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_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

getFilterEnabled

RuntimeFractionalPercent getFilterEnabled()

 Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.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_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

getFilterEnabledOrBuilder

RuntimeFractionalPercentOrBuilder getFilterEnabledOrBuilder()

 Specifies the % of requests for which the CSRF filter is enabled.
 If :ref:`runtime_key <envoy_api_field_core.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_api_enum_type.FractionalPercent.DenominatorType>`.
 

.envoy.api.v2.core.RuntimeFractionalPercent filter_enabled = 1 [(.validate.rules) = { ... }

hasShadowEnabled

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_api_field_core.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.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

getShadowEnabled

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_api_field_core.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.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

getShadowEnabledOrBuilder

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_api_field_core.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.api.v2.core.RuntimeFractionalPercent shadow_enabled = 2;

getAdditionalOriginsList

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.StringMatcher additional_origins = 3;

getAdditionalOrigins

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.StringMatcher additional_origins = 3;

getAdditionalOriginsCount

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.StringMatcher additional_origins = 3;

getAdditionalOriginsOrBuilderList

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.StringMatcher additional_origins = 3;

getAdditionalOriginsOrBuilder

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.StringMatcher additional_origins = 3;