envoy_config_filter_http_csrf_v2

package
Version: v0.10.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Nov 15, 2021 License: Apache-2.0 Imports: 21 Imported by: 4

Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_config_filter_http_csrf_v2_csrf_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type CsrfPolicy

type CsrfPolicy struct {

	// 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>`.
	FilterEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,1,opt,name=filter_enabled,json=filterEnabled,proto3" json:"filter_enabled,omitempty"`
	// 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.
	ShadowEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,2,opt,name=shadow_enabled,json=shadowEnabled,proto3" json:"shadow_enabled,omitempty"`
	// 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>`.
	AdditionalOrigins []*matcher.StringMatcher `protobuf:"bytes,3,rep,name=additional_origins,json=additionalOrigins,proto3" json:"additional_origins,omitempty"`
	// contains filtered or unexported fields
}

CSRF filter config.

func (*CsrfPolicy) Descriptor deprecated

func (*CsrfPolicy) Descriptor() ([]byte, []int)

Deprecated: Use CsrfPolicy.ProtoReflect.Descriptor instead.

func (*CsrfPolicy) GetAdditionalOrigins added in v0.8.2

func (x *CsrfPolicy) GetAdditionalOrigins() []*matcher.StringMatcher

func (*CsrfPolicy) GetFilterEnabled

func (x *CsrfPolicy) GetFilterEnabled() *core.RuntimeFractionalPercent

func (*CsrfPolicy) GetShadowEnabled

func (x *CsrfPolicy) GetShadowEnabled() *core.RuntimeFractionalPercent

func (*CsrfPolicy) ProtoMessage

func (*CsrfPolicy) ProtoMessage()

func (*CsrfPolicy) ProtoReflect added in v0.9.6

func (x *CsrfPolicy) ProtoReflect() protoreflect.Message

func (*CsrfPolicy) Reset

func (x *CsrfPolicy) Reset()

func (*CsrfPolicy) String

func (x *CsrfPolicy) String() string

func (*CsrfPolicy) Validate

func (m *CsrfPolicy) Validate() error

Validate checks the field values on CsrfPolicy with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*CsrfPolicy) ValidateAll added in v0.10.0

func (m *CsrfPolicy) ValidateAll() error

ValidateAll checks the field values on CsrfPolicy with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in CsrfPolicyMultiError, or nil if none found.

type CsrfPolicyMultiError added in v0.10.0

type CsrfPolicyMultiError []error

CsrfPolicyMultiError is an error wrapping multiple validation errors returned by CsrfPolicy.ValidateAll() if the designated constraints aren't met.

func (CsrfPolicyMultiError) AllErrors added in v0.10.0

func (m CsrfPolicyMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CsrfPolicyMultiError) Error added in v0.10.0

func (m CsrfPolicyMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type CsrfPolicyValidationError

type CsrfPolicyValidationError struct {
	// contains filtered or unexported fields
}

CsrfPolicyValidationError is the validation error returned by CsrfPolicy.Validate if the designated constraints aren't met.

func (CsrfPolicyValidationError) Cause

func (e CsrfPolicyValidationError) Cause() error

Cause function returns cause value.

func (CsrfPolicyValidationError) Error

Error satisfies the builtin error interface

func (CsrfPolicyValidationError) ErrorName

func (e CsrfPolicyValidationError) ErrorName() string

ErrorName returns error name.

func (CsrfPolicyValidationError) Field

Field function returns field value.

func (CsrfPolicyValidationError) Key

Key function returns key value.

func (CsrfPolicyValidationError) Reason

func (e CsrfPolicyValidationError) Reason() string

Reason function returns reason value.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL