Documentation

Index

Constants

This section is empty.

Variables

View Source
var File_envoy_extensions_filters_http_csrf_v4alpha_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_config.core.v4alpha.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.v3.FractionalPercent.DenominatorType>`.
	FilterEnabled *v4alpha.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_config.core.v4alpha.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 *v4alpha.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 []*v4alpha1.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

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

      Deprecated: Use CsrfPolicy.ProtoReflect.Descriptor instead.

      func (*CsrfPolicy) GetAdditionalOrigins

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

      func (*CsrfPolicy) GetFilterEnabled

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

      func (*CsrfPolicy) GetShadowEnabled

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

      func (*CsrfPolicy) ProtoMessage

      func (*CsrfPolicy) ProtoMessage()

      func (*CsrfPolicy) ProtoReflect

      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, an error is returned.

        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.