ext_authzv3

package
v0.0.0-...-f4ba8c2 Latest Latest
Warning

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

 Go to latest Published: Apr 18, 2024 License: Apache-2.0 Imports: 24 Imported by: 1

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_filters_http_ext_authz_v3_ext_authz_proto protoreflect.FileDescriptor

Functions

This section is empty.

Types

type AuthorizationRequest 

type AuthorizationRequest struct {

	// Authorization request includes the client request headers that have a correspondent match
	// in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`.
	// This field has been deprecated in favor of :ref:`allowed_headers
	// <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.allowed_headers>`.
	//
	// .. note::
	//
	//	In addition to the the user's supplied matchers, “Host“, “Method“, “Path“,
	//	“Content-Length“, and “Authorization“ are **automatically included** to the list.
	//
	// .. note::
	//
	//	By default, “Content-Length“ header is set to “0“ and the request to the authorization
	//	service has no message body. However, the authorization request *may* include the buffered
	//	client request body (controlled by :ref:`with_request_body
	//	<envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
	//	setting) hence the value of its “Content-Length“ reflects the size of its payload size.
	//
	// Deprecated: Do not use.
	AllowedHeaders *v32.ListStringMatcher `protobuf:"bytes,1,opt,name=allowed_headers,json=allowedHeaders,proto3" json:"allowed_headers,omitempty"`
	// Sets a list of headers that will be included to the request to authorization service. Note that
	// client request of the same key will be overridden.
	HeadersToAdd []*v3.HeaderValue `protobuf:"bytes,2,rep,name=headers_to_add,json=headersToAdd,proto3" json:"headers_to_add,omitempty"`
	// contains filtered or unexported fields
}

func (*AuthorizationRequest) Descriptor deprecated 

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

Deprecated: Use AuthorizationRequest.ProtoReflect.Descriptor instead.

func (*AuthorizationRequest) GetAllowedHeaders deprecated 

func (x *AuthorizationRequest) GetAllowedHeaders() *v32.ListStringMatcher

Deprecated: Do not use.

func (*AuthorizationRequest) GetHeadersToAdd 

func (x *AuthorizationRequest) GetHeadersToAdd() []*v3.HeaderValue

func (*AuthorizationRequest) ProtoMessage 

func (*AuthorizationRequest) ProtoMessage()

func (*AuthorizationRequest) ProtoReflect 

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

func (*AuthorizationRequest) Reset 

func (x *AuthorizationRequest) Reset()

func (*AuthorizationRequest) String 

func (x *AuthorizationRequest) String() string

func (*AuthorizationRequest) Validate 

func (m *AuthorizationRequest) Validate() error

Validate checks the field values on AuthorizationRequest 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 (*AuthorizationRequest) ValidateAll 

func (m *AuthorizationRequest) ValidateAll() error

ValidateAll checks the field values on AuthorizationRequest 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 AuthorizationRequestMultiError, or nil if none found.

type AuthorizationRequestMultiError 

type AuthorizationRequestMultiError []error

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

func (AuthorizationRequestMultiError) AllErrors 

func (m AuthorizationRequestMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AuthorizationRequestMultiError) Error 

func (m AuthorizationRequestMultiError) Error() string

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

type AuthorizationRequestValidationError 

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

AuthorizationRequestValidationError is the validation error returned by AuthorizationRequest.Validate if the designated constraints aren't met.

func (AuthorizationRequestValidationError) Cause 

func (e AuthorizationRequestValidationError) Cause() error

Cause function returns cause value.

func (AuthorizationRequestValidationError) Error 

func (e AuthorizationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (AuthorizationRequestValidationError) ErrorName 

func (e AuthorizationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (AuthorizationRequestValidationError) Field 

func (e AuthorizationRequestValidationError) Field() string

Field function returns field value.

func (AuthorizationRequestValidationError) Key 

func (e AuthorizationRequestValidationError) Key() bool

Key function returns key value.

func (AuthorizationRequestValidationError) Reason 

func (e AuthorizationRequestValidationError) Reason() string

Reason function returns reason value.

type AuthorizationResponse 

type AuthorizationResponse struct {

	// When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
	// response headers that have a correspondent match will be added to the original client request.
	// Note that coexistent headers will be overridden.
	AllowedUpstreamHeaders *v32.ListStringMatcher `` /* 129-byte string literal not displayed */
	// When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
	// response headers that have a correspondent match will be added to the original client request.
	// Note that coexistent headers will be appended.
	AllowedUpstreamHeadersToAppend *v32.ListStringMatcher `` /* 157-byte string literal not displayed */
	// When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
	// response headers that have a correspondent match will be added to the client's response. Note
	// that when this list is *not* set, all the authorization response headers, except “Authority
	// (Host)“ will be in the response to the client. When a header is included in this list, “Path“,
	// “Status“, “Content-Length“, “WWWAuthenticate“ and “Location“ are automatically added.
	AllowedClientHeaders *v32.ListStringMatcher `protobuf:"bytes,2,opt,name=allowed_client_headers,json=allowedClientHeaders,proto3" json:"allowed_client_headers,omitempty"`
	// When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
	// response headers that have a correspondent match will be added to the client's response when
	// the authorization response itself is successful, i.e. not failed or denied. When this list is
	// *not* set, no additional headers will be added to the client's response on success.
	AllowedClientHeadersOnSuccess *v32.ListStringMatcher `` /* 154-byte string literal not displayed */
	// When this :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>` is set, authorization
	// response headers that have a correspondent match will be emitted as dynamic metadata to be consumed
	// by the next filter. This metadata lives in a namespace specified by the canonical name of extension filter
	// that requires it:
	//
	// - :ref:`envoy.filters.http.ext_authz <config_http_filters_ext_authz_dynamic_metadata>` for HTTP filter.
	// - :ref:`envoy.filters.network.ext_authz <config_network_filters_ext_authz_dynamic_metadata>` for network filter.
	DynamicMetadataFromHeaders *v32.ListStringMatcher `` /* 143-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 6]

func (*AuthorizationResponse) Descriptor deprecated 

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

Deprecated: Use AuthorizationResponse.ProtoReflect.Descriptor instead.

func (*AuthorizationResponse) GetAllowedClientHeaders 

func (x *AuthorizationResponse) GetAllowedClientHeaders() *v32.ListStringMatcher

func (*AuthorizationResponse) GetAllowedClientHeadersOnSuccess 

func (x *AuthorizationResponse) GetAllowedClientHeadersOnSuccess() *v32.ListStringMatcher

func (*AuthorizationResponse) GetAllowedUpstreamHeaders 

func (x *AuthorizationResponse) GetAllowedUpstreamHeaders() *v32.ListStringMatcher

func (*AuthorizationResponse) GetAllowedUpstreamHeadersToAppend 

func (x *AuthorizationResponse) GetAllowedUpstreamHeadersToAppend() *v32.ListStringMatcher

func (*AuthorizationResponse) GetDynamicMetadataFromHeaders 

func (x *AuthorizationResponse) GetDynamicMetadataFromHeaders() *v32.ListStringMatcher

func (*AuthorizationResponse) ProtoMessage 

func (*AuthorizationResponse) ProtoMessage()

func (*AuthorizationResponse) ProtoReflect 

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

func (*AuthorizationResponse) Reset 

func (x *AuthorizationResponse) Reset()

func (*AuthorizationResponse) String 

func (x *AuthorizationResponse) String() string

func (*AuthorizationResponse) Validate 

func (m *AuthorizationResponse) Validate() error

Validate checks the field values on AuthorizationResponse 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 (*AuthorizationResponse) ValidateAll 

func (m *AuthorizationResponse) ValidateAll() error

ValidateAll checks the field values on AuthorizationResponse 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 AuthorizationResponseMultiError, or nil if none found.

type AuthorizationResponseMultiError 

type AuthorizationResponseMultiError []error

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

func (AuthorizationResponseMultiError) AllErrors 

func (m AuthorizationResponseMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (AuthorizationResponseMultiError) Error 

func (m AuthorizationResponseMultiError) Error() string

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

type AuthorizationResponseValidationError 

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

AuthorizationResponseValidationError is the validation error returned by AuthorizationResponse.Validate if the designated constraints aren't met.

func (AuthorizationResponseValidationError) Cause 

func (e AuthorizationResponseValidationError) Cause() error

Cause function returns cause value.

func (AuthorizationResponseValidationError) Error 

func (e AuthorizationResponseValidationError) Error() string

Error satisfies the builtin error interface

func (AuthorizationResponseValidationError) ErrorName 

func (e AuthorizationResponseValidationError) ErrorName() string

ErrorName returns error name.

func (AuthorizationResponseValidationError) Field 

func (e AuthorizationResponseValidationError) Field() string

Field function returns field value.

func (AuthorizationResponseValidationError) Key 

func (e AuthorizationResponseValidationError) Key() bool

Key function returns key value.

func (AuthorizationResponseValidationError) Reason 

func (e AuthorizationResponseValidationError) Reason() string

Reason function returns reason value.

type BufferSettings 

type BufferSettings struct {

	// Sets the maximum size of a message body that the filter will hold in memory. Envoy will return
	// “HTTP 413“ and will *not* initiate the authorization process when buffer reaches the number
	// set in this field. Note that this setting will have precedence over :ref:`failure_mode_allow
	// <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.failure_mode_allow>`.
	MaxRequestBytes uint32 `protobuf:"varint,1,opt,name=max_request_bytes,json=maxRequestBytes,proto3" json:"max_request_bytes,omitempty"`
	// When this field is true, Envoy will buffer the message until “max_request_bytes“ is reached.
	// The authorization request will be dispatched and no 413 HTTP error will be returned by the
	// filter.
	AllowPartialMessage bool `protobuf:"varint,2,opt,name=allow_partial_message,json=allowPartialMessage,proto3" json:"allow_partial_message,omitempty"`
	// If true, the body sent to the external authorization service is set with raw bytes, it sets
	// the :ref:`raw_body<envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.raw_body>`
	// field of HTTP request attribute context. Otherwise, :ref:`body
	// <envoy_v3_api_field_service.auth.v3.AttributeContext.HttpRequest.body>` will be filled
	// with UTF-8 string request body.
	//
	// This field only affects configurations using a :ref:`grpc_service
	// <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`. In configurations that use
	// an :ref:`http_service <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.http_service>`, this
	// has no effect.
	PackAsBytes bool `protobuf:"varint,3,opt,name=pack_as_bytes,json=packAsBytes,proto3" json:"pack_as_bytes,omitempty"`
	// contains filtered or unexported fields
}

Configuration for buffering the request data.

func (*BufferSettings) Descriptor deprecated 

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

Deprecated: Use BufferSettings.ProtoReflect.Descriptor instead.

func (*BufferSettings) GetAllowPartialMessage 

func (x *BufferSettings) GetAllowPartialMessage() bool

func (*BufferSettings) GetMaxRequestBytes 

func (x *BufferSettings) GetMaxRequestBytes() uint32

func (*BufferSettings) GetPackAsBytes 

func (x *BufferSettings) GetPackAsBytes() bool

func (*BufferSettings) ProtoMessage 

func (*BufferSettings) ProtoMessage()

func (*BufferSettings) ProtoReflect 

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

func (*BufferSettings) Reset 

func (x *BufferSettings) Reset()

func (*BufferSettings) String 

func (x *BufferSettings) String() string

func (*BufferSettings) Validate 

func (m *BufferSettings) Validate() error

Validate checks the field values on BufferSettings 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 (*BufferSettings) ValidateAll 

func (m *BufferSettings) ValidateAll() error

ValidateAll checks the field values on BufferSettings 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 BufferSettingsMultiError, or nil if none found.

type BufferSettingsMultiError 

type BufferSettingsMultiError []error

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

func (BufferSettingsMultiError) AllErrors 

func (m BufferSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BufferSettingsMultiError) Error 

func (m BufferSettingsMultiError) Error() string

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

type BufferSettingsValidationError 

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

BufferSettingsValidationError is the validation error returned by BufferSettings.Validate if the designated constraints aren't met.

func (BufferSettingsValidationError) Cause 

func (e BufferSettingsValidationError) Cause() error

Cause function returns cause value.

func (BufferSettingsValidationError) Error 

func (e BufferSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (BufferSettingsValidationError) ErrorName 

func (e BufferSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (BufferSettingsValidationError) Field 

func (e BufferSettingsValidationError) Field() string

Field function returns field value.

func (BufferSettingsValidationError) Key 

func (e BufferSettingsValidationError) Key() bool

Key function returns key value.

func (BufferSettingsValidationError) Reason 

func (e BufferSettingsValidationError) Reason() string

Reason function returns reason value.

type CheckSettings 

type CheckSettings struct {

	// Context extensions to set on the CheckRequest's
	// :ref:`AttributeContext.context_extensions<envoy_v3_api_field_service.auth.v3.AttributeContext.context_extensions>`
	//
	// You can use this to provide extra context for the external authorization server on specific
	// virtual hosts/routes. For example, adding a context extension on the virtual host level can
	// give the ext-authz server information on what virtual host is used without needing to parse the
	// host header. If CheckSettings is specified in multiple per-filter-configs, they will be merged
	// in order, and the result will be used.
	//
	// Merge semantics for this field are such that keys from more specific configs override.
	//
	// .. note::
	//
	//	These settings are only applied to a filter configured with a
	//	:ref:`grpc_service<envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.grpc_service>`.
	ContextExtensions map[string]string `` /* 200-byte string literal not displayed */
	// When set to true, disable the configured :ref:`with_request_body
	// <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` for a specific route.
	//
	// Please note that only one of *disable_request_body_buffering* or
	// :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.with_request_body>`
	// may be specified.
	DisableRequestBodyBuffering bool `` /* 147-byte string literal not displayed */
	// Enable or override request body buffering, which is configured using the
	// :ref:`with_request_body <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>`
	// option for a specific route.
	//
	// Please note that only only one of *with_request_body* or
	// :ref:`disable_request_body_buffering <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.CheckSettings.disable_request_body_buffering>`
	// may be specified.
	WithRequestBody *BufferSettings `protobuf:"bytes,3,opt,name=with_request_body,json=withRequestBody,proto3" json:"with_request_body,omitempty"`
	// contains filtered or unexported fields
}

Extra settings for the check request.

func (*CheckSettings) Descriptor deprecated 

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

Deprecated: Use CheckSettings.ProtoReflect.Descriptor instead.

func (*CheckSettings) GetContextExtensions 

func (x *CheckSettings) GetContextExtensions() map[string]string

func (*CheckSettings) GetDisableRequestBodyBuffering 

func (x *CheckSettings) GetDisableRequestBodyBuffering() bool

func (*CheckSettings) GetWithRequestBody 

func (x *CheckSettings) GetWithRequestBody() *BufferSettings

func (*CheckSettings) ProtoMessage 

func (*CheckSettings) ProtoMessage()

func (*CheckSettings) ProtoReflect 

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

func (*CheckSettings) Reset 

func (x *CheckSettings) Reset()

func (*CheckSettings) String 

func (x *CheckSettings) String() string

func (*CheckSettings) Validate 

func (m *CheckSettings) Validate() error

Validate checks the field values on CheckSettings 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 (*CheckSettings) ValidateAll 

func (m *CheckSettings) ValidateAll() error

ValidateAll checks the field values on CheckSettings 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 CheckSettingsMultiError, or nil if none found.

type CheckSettingsMultiError 

type CheckSettingsMultiError []error

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

func (CheckSettingsMultiError) AllErrors 

func (m CheckSettingsMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (CheckSettingsMultiError) Error 

func (m CheckSettingsMultiError) Error() string

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

type CheckSettingsValidationError 

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

CheckSettingsValidationError is the validation error returned by CheckSettings.Validate if the designated constraints aren't met.

func (CheckSettingsValidationError) Cause 

func (e CheckSettingsValidationError) Cause() error

Cause function returns cause value.

func (CheckSettingsValidationError) Error 

func (e CheckSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (CheckSettingsValidationError) ErrorName 

func (e CheckSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (CheckSettingsValidationError) Field 

func (e CheckSettingsValidationError) Field() string

Field function returns field value.

func (CheckSettingsValidationError) Key 

func (e CheckSettingsValidationError) Key() bool

Key function returns key value.

func (CheckSettingsValidationError) Reason 

func (e CheckSettingsValidationError) Reason() string

Reason function returns reason value.

type ExtAuthz 

type ExtAuthz struct {

	// External authorization service configuration.
	//
	// Types that are assignable to Services:
	//
	//	*ExtAuthz_GrpcService
	//	*ExtAuthz_HttpService
	Services isExtAuthz_Services `protobuf_oneof:"services"`
	// API version for ext_authz transport protocol. This describes the ext_authz gRPC endpoint and
	// version of messages used on the wire.
	TransportApiVersion v3.ApiVersion `` /* 159-byte string literal not displayed */
	//	Changes filter's behaviour on errors:
	//
	//	1. When set to true, the filter will “accept“ client request even if the communication with
	//	the authorization service has failed, or if the authorization service has returned a HTTP 5xx
	//	error.
	//
	//	2. When set to false, ext-authz will “reject“ client requests and return a “Forbidden“
	//	response if the communication with the authorization service has failed, or if the
	//	authorization service has returned a HTTP 5xx error.
	//
	// Note that errors can be “always“ tracked in the :ref:`stats
	// <config_http_filters_ext_authz_stats>`.
	FailureModeAllow bool `protobuf:"varint,2,opt,name=failure_mode_allow,json=failureModeAllow,proto3" json:"failure_mode_allow,omitempty"`
	// When “failure_mode_allow“ and “failure_mode_allow_header_add“ are both set to true,
	// “x-envoy-auth-failure-mode-allowed: true“ will be added to request headers if the communication
	// with the authorization service has failed, or if the authorization service has returned a
	// HTTP 5xx error.
	FailureModeAllowHeaderAdd bool `` /* 144-byte string literal not displayed */
	// Enables filter to buffer the client request body and send it within the authorization request.
	// A “x-envoy-auth-partial-body: false|true“ metadata header will be added to the authorization
	// request message indicating if the body data is partial.
	WithRequestBody *BufferSettings `protobuf:"bytes,5,opt,name=with_request_body,json=withRequestBody,proto3" json:"with_request_body,omitempty"`
	// Clears route cache in order to allow the external authorization service to correctly affect
	// routing decisions. Filter clears all cached routes when:
	//
	// 1. The field is set to “true“.
	//
	// 2. The status returned from the authorization service is a HTTP 200 or gRPC 0.
	//
	// 3. At least one “authorization response header“ is added to the client request, or is used for
	// altering another client request header.
	ClearRouteCache bool `protobuf:"varint,6,opt,name=clear_route_cache,json=clearRouteCache,proto3" json:"clear_route_cache,omitempty"`
	// Sets the HTTP status that is returned to the client when the authorization server returns an error
	// or cannot be reached. The default status is HTTP 403 Forbidden.
	StatusOnError *v31.HttpStatus `protobuf:"bytes,7,opt,name=status_on_error,json=statusOnError,proto3" json:"status_on_error,omitempty"`
	// Specifies a list of metadata namespaces whose values, if present, will be passed to the
	// ext_authz service. The :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>`
	// is passed as an opaque “protobuf::Struct“.
	//
	// Please note that this field exclusively applies to the gRPC ext_authz service and has no effect on the HTTP service.
	//
	// For example, if the “jwt_authn“ filter is used and :ref:`payload_in_metadata
	// <envoy_v3_api_field_extensions.filters.http.jwt_authn.v3.JwtProvider.payload_in_metadata>` is set,
	// then the following will pass the jwt payload to the authorization server.
	//
	// .. code-block:: yaml
	//
	//	metadata_context_namespaces:
	//	- envoy.filters.http.jwt_authn
	MetadataContextNamespaces []string `` /* 138-byte string literal not displayed */
	// Specifies a list of metadata namespaces whose values, if present, will be passed to the
	// ext_authz service. :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>`
	// is passed as a “protobuf::Any“.
	//
	// Please note that this field exclusively applies to the gRPC ext_authz service and has no effect on the HTTP service.
	//
	// It works in a way similar to “metadata_context_namespaces“ but allows Envoy and ext_authz server to share
	// the protobuf message definition in order to do a safe parsing.
	TypedMetadataContextNamespaces []string `` /* 156-byte string literal not displayed */
	// Specifies a list of route metadata namespaces whose values, if present, will be passed to the
	// ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in
	// :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.
	// :ref:`filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.filter_metadata>` is passed as an opaque “protobuf::Struct“.
	RouteMetadataContextNamespaces []string `` /* 156-byte string literal not displayed */
	// Specifies a list of route metadata namespaces whose values, if present, will be passed to the
	// ext_authz service at :ref:`route_metadata_context <envoy_v3_api_field_service.auth.v3.AttributeContext.route_metadata_context>` in
	// :ref:`CheckRequest <envoy_v3_api_field_service.auth.v3.CheckRequest.attributes>`.
	// :ref:`typed_filter_metadata <envoy_v3_api_field_config.core.v3.Metadata.typed_filter_metadata>` is passed as an “protobuf::Any“.
	RouteTypedMetadataContextNamespaces []string `` /* 173-byte string literal not displayed */
	// Specifies if the 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.
	//
	// If this field is not specified, the filter will be enabled for all requests.
	FilterEnabled *v3.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=filter_enabled,json=filterEnabled,proto3" json:"filter_enabled,omitempty"`
	// Specifies if the filter is enabled with metadata matcher.
	// If this field is not specified, the filter will be enabled for all requests.
	FilterEnabledMetadata *v32.MetadataMatcher `` /* 127-byte string literal not displayed */
	// Specifies whether to deny the requests, when the filter is disabled.
	// If :ref:`runtime_key <envoy_v3_api_field_config.core.v3.RuntimeFeatureFlag.runtime_key>` is specified,
	// Envoy will lookup the runtime key to determine whether to deny request for
	// filter protected path at filter disabling. If filter is disabled in
	// typed_per_filter_config for the path, requests will not be denied.
	//
	// If this field is not specified, all requests will be allowed when disabled.
	//
	// If a request is denied due to this setting, the response code in :ref:`status_on_error
	// <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.status_on_error>` will
	// be returned.
	DenyAtDisable *v3.RuntimeFeatureFlag `protobuf:"bytes,11,opt,name=deny_at_disable,json=denyAtDisable,proto3" json:"deny_at_disable,omitempty"`
	// Specifies if the peer certificate is sent to the external service.
	//
	// When this field is true, Envoy will include the peer X.509 certificate, if available, in the
	// :ref:`certificate<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.certificate>`.
	IncludePeerCertificate bool `` /* 131-byte string literal not displayed */
	// Optional additional prefix to use when emitting statistics. This allows to distinguish
	// emitted statistics between configured “ext_authz“ filters in an HTTP filter chain. For example:
	//
	// .. code-block:: yaml
	//
	//	http_filters:
	//	  - name: envoy.filters.http.ext_authz
	//	    typed_config:
	//	      "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz
	//	      stat_prefix: waf # This emits ext_authz.waf.ok, ext_authz.waf.denied, etc.
	//	  - name: envoy.filters.http.ext_authz
	//	    typed_config:
	//	      "@type": type.googleapis.com/envoy.extensions.filters.http.ext_authz.v3.ExtAuthz
	//	      stat_prefix: blocker # This emits ext_authz.blocker.ok, ext_authz.blocker.denied, etc.
	StatPrefix string `protobuf:"bytes,13,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Optional labels that will be passed to :ref:`labels<envoy_v3_api_field_service.auth.v3.AttributeContext.Peer.labels>` in
	// :ref:`destination<envoy_v3_api_field_service.auth.v3.AttributeContext.destination>`.
	// The labels will be read from :ref:`metadata<envoy_v3_api_msg_config.core.v3.Node>` with the specified key.
	BootstrapMetadataLabelsKey string `` /* 144-byte string literal not displayed */
	// Check request to authorization server will include the client request headers that have a correspondent match
	// in the :ref:`list <envoy_v3_api_msg_type.matcher.v3.ListStringMatcher>`. If this option isn't specified, then
	// all client request headers are included in the check request to a gRPC authorization server, whereas no client request headers
	// (besides the ones allowed by default - see note below) are included in the check request to an HTTP authorization server.
	// This inconsistency between gRPC and HTTP servers is to maintain backwards compatibility with legacy behavior.
	//
	// .. note::
	//
	//  1. For requests to an HTTP authorization server: in addition to the the user's supplied matchers, “Host“, “Method“, “Path“,
	//     “Content-Length“, and “Authorization“ are **additionally included** in the list.
	//
	// .. note::
	//
	//  2. For requests to an HTTP authorization server: *Content-Length* will be set to 0 and the request to the
	//     authorization server will not have a message body. However, the check request can include the buffered
	//     client request body (controlled by :ref:`with_request_body
	//     <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.ExtAuthz.with_request_body>` setting),
	//     consequently the value of *Content-Length* of the authorization request reflects the size of
	//     its payload size.
	AllowedHeaders *v32.ListStringMatcher `protobuf:"bytes,17,opt,name=allowed_headers,json=allowedHeaders,proto3" json:"allowed_headers,omitempty"`
	// Specifies if the TLS session level details like SNI are sent to the external service.
	//
	// When this field is true, Envoy will include the SNI name used for TLSClientHello, if available, in the
	// :ref:`tls_session<envoy_v3_api_field_service.auth.v3.AttributeContext.tls_session>`.
	IncludeTlsSession bool `protobuf:"varint,18,opt,name=include_tls_session,json=includeTlsSession,proto3" json:"include_tls_session,omitempty"`
	// Whether to increment cluster statistics (e.g. cluster.<cluster_name>.upstream_rq_*) on authorization failure.
	// Defaults to true.
	ChargeClusterResponseStats *wrapperspb.BoolValue `` /* 144-byte string literal not displayed */
	// contains filtered or unexported fields
}

[#next-free-field: 23]

func (*ExtAuthz) Descriptor deprecated 

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

Deprecated: Use ExtAuthz.ProtoReflect.Descriptor instead.

func (*ExtAuthz) GetAllowedHeaders 

func (x *ExtAuthz) GetAllowedHeaders() *v32.ListStringMatcher

func (*ExtAuthz) GetBootstrapMetadataLabelsKey 

func (x *ExtAuthz) GetBootstrapMetadataLabelsKey() string

func (*ExtAuthz) GetChargeClusterResponseStats 

func (x *ExtAuthz) GetChargeClusterResponseStats() *wrapperspb.BoolValue

func (*ExtAuthz) GetClearRouteCache 

func (x *ExtAuthz) GetClearRouteCache() bool

func (*ExtAuthz) GetDenyAtDisable 

func (x *ExtAuthz) GetDenyAtDisable() *v3.RuntimeFeatureFlag

func (*ExtAuthz) GetFailureModeAllow 

func (x *ExtAuthz) GetFailureModeAllow() bool

func (*ExtAuthz) GetFailureModeAllowHeaderAdd 

func (x *ExtAuthz) GetFailureModeAllowHeaderAdd() bool

func (*ExtAuthz) GetFilterEnabled 

func (x *ExtAuthz) GetFilterEnabled() *v3.RuntimeFractionalPercent

func (*ExtAuthz) GetFilterEnabledMetadata 

func (x *ExtAuthz) GetFilterEnabledMetadata() *v32.MetadataMatcher

func (*ExtAuthz) GetGrpcService 

func (x *ExtAuthz) GetGrpcService() *v3.GrpcService

func (*ExtAuthz) GetHttpService 

func (x *ExtAuthz) GetHttpService() *HttpService

func (*ExtAuthz) GetIncludePeerCertificate 

func (x *ExtAuthz) GetIncludePeerCertificate() bool

func (*ExtAuthz) GetIncludeTlsSession 

func (x *ExtAuthz) GetIncludeTlsSession() bool

func (*ExtAuthz) GetMetadataContextNamespaces 

func (x *ExtAuthz) GetMetadataContextNamespaces() []string

func (*ExtAuthz) GetRouteMetadataContextNamespaces 

func (x *ExtAuthz) GetRouteMetadataContextNamespaces() []string

func (*ExtAuthz) GetRouteTypedMetadataContextNamespaces 

func (x *ExtAuthz) GetRouteTypedMetadataContextNamespaces() []string

func (*ExtAuthz) GetServices 

func (m *ExtAuthz) GetServices() isExtAuthz_Services

func (*ExtAuthz) GetStatPrefix 

func (x *ExtAuthz) GetStatPrefix() string

func (*ExtAuthz) GetStatusOnError 

func (x *ExtAuthz) GetStatusOnError() *v31.HttpStatus

func (*ExtAuthz) GetTransportApiVersion 

func (x *ExtAuthz) GetTransportApiVersion() v3.ApiVersion

func (*ExtAuthz) GetTypedMetadataContextNamespaces 

func (x *ExtAuthz) GetTypedMetadataContextNamespaces() []string

func (*ExtAuthz) GetWithRequestBody 

func (x *ExtAuthz) GetWithRequestBody() *BufferSettings

func (*ExtAuthz) ProtoMessage 

func (*ExtAuthz) ProtoMessage()

func (*ExtAuthz) ProtoReflect 

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

func (*ExtAuthz) Reset 

func (x *ExtAuthz) Reset()

func (*ExtAuthz) String 

func (x *ExtAuthz) String() string

func (*ExtAuthz) Validate 

func (m *ExtAuthz) Validate() error

Validate checks the field values on ExtAuthz 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 (*ExtAuthz) ValidateAll 

func (m *ExtAuthz) ValidateAll() error

ValidateAll checks the field values on ExtAuthz 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 ExtAuthzMultiError, or nil if none found.

type ExtAuthzMultiError 

type ExtAuthzMultiError []error

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

func (ExtAuthzMultiError) AllErrors 

func (m ExtAuthzMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExtAuthzMultiError) Error 

func (m ExtAuthzMultiError) Error() string

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

type ExtAuthzPerRoute 

type ExtAuthzPerRoute struct {

	// Types that are assignable to Override:
	//
	//	*ExtAuthzPerRoute_Disabled
	//	*ExtAuthzPerRoute_CheckSettings
	Override isExtAuthzPerRoute_Override `protobuf_oneof:"override"`
	// contains filtered or unexported fields
}

Extra settings on a per virtualhost/route/weighted-cluster level.

func (*ExtAuthzPerRoute) Descriptor deprecated 

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

Deprecated: Use ExtAuthzPerRoute.ProtoReflect.Descriptor instead.

func (*ExtAuthzPerRoute) GetCheckSettings 

func (x *ExtAuthzPerRoute) GetCheckSettings() *CheckSettings

func (*ExtAuthzPerRoute) GetDisabled 

func (x *ExtAuthzPerRoute) GetDisabled() bool

func (*ExtAuthzPerRoute) GetOverride 

func (m *ExtAuthzPerRoute) GetOverride() isExtAuthzPerRoute_Override

func (*ExtAuthzPerRoute) ProtoMessage 

func (*ExtAuthzPerRoute) ProtoMessage()

func (*ExtAuthzPerRoute) ProtoReflect 

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

func (*ExtAuthzPerRoute) Reset 

func (x *ExtAuthzPerRoute) Reset()

func (*ExtAuthzPerRoute) String 

func (x *ExtAuthzPerRoute) String() string

func (*ExtAuthzPerRoute) Validate 

func (m *ExtAuthzPerRoute) Validate() error

Validate checks the field values on ExtAuthzPerRoute 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 (*ExtAuthzPerRoute) ValidateAll 

func (m *ExtAuthzPerRoute) ValidateAll() error

ValidateAll checks the field values on ExtAuthzPerRoute 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 ExtAuthzPerRouteMultiError, or nil if none found.

type ExtAuthzPerRouteMultiError 

type ExtAuthzPerRouteMultiError []error

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

func (ExtAuthzPerRouteMultiError) AllErrors 

func (m ExtAuthzPerRouteMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (ExtAuthzPerRouteMultiError) Error 

func (m ExtAuthzPerRouteMultiError) Error() string

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

type ExtAuthzPerRouteValidationError 

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

ExtAuthzPerRouteValidationError is the validation error returned by ExtAuthzPerRoute.Validate if the designated constraints aren't met.

func (ExtAuthzPerRouteValidationError) Cause 

func (e ExtAuthzPerRouteValidationError) Cause() error

Cause function returns cause value.

func (ExtAuthzPerRouteValidationError) Error 

func (e ExtAuthzPerRouteValidationError) Error() string

Error satisfies the builtin error interface

func (ExtAuthzPerRouteValidationError) ErrorName 

func (e ExtAuthzPerRouteValidationError) ErrorName() string

ErrorName returns error name.

func (ExtAuthzPerRouteValidationError) Field 

func (e ExtAuthzPerRouteValidationError) Field() string

Field function returns field value.

func (ExtAuthzPerRouteValidationError) Key 

func (e ExtAuthzPerRouteValidationError) Key() bool

Key function returns key value.

func (ExtAuthzPerRouteValidationError) Reason 

func (e ExtAuthzPerRouteValidationError) Reason() string

Reason function returns reason value.

type ExtAuthzPerRoute_CheckSettings 

type ExtAuthzPerRoute_CheckSettings struct {
	// Check request settings for this route.
	CheckSettings *CheckSettings `protobuf:"bytes,2,opt,name=check_settings,json=checkSettings,proto3,oneof"`
}

type ExtAuthzPerRoute_Disabled 

type ExtAuthzPerRoute_Disabled struct {
	// Disable the ext auth filter for this particular vhost or route.
	// If disabled is specified in multiple per-filter-configs, the most specific one will be used.
	Disabled bool `protobuf:"varint,1,opt,name=disabled,proto3,oneof"`
}

type ExtAuthzValidationError 

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

ExtAuthzValidationError is the validation error returned by ExtAuthz.Validate if the designated constraints aren't met.

func (ExtAuthzValidationError) Cause 

func (e ExtAuthzValidationError) Cause() error

Cause function returns cause value.

func (ExtAuthzValidationError) Error 

func (e ExtAuthzValidationError) Error() string

Error satisfies the builtin error interface

func (ExtAuthzValidationError) ErrorName 

func (e ExtAuthzValidationError) ErrorName() string

ErrorName returns error name.

func (ExtAuthzValidationError) Field 

func (e ExtAuthzValidationError) Field() string

Field function returns field value.

func (ExtAuthzValidationError) Key 

func (e ExtAuthzValidationError) Key() bool

Key function returns key value.

func (ExtAuthzValidationError) Reason 

func (e ExtAuthzValidationError) Reason() string

Reason function returns reason value.

type ExtAuthz_GrpcService 

type ExtAuthz_GrpcService struct {
	// gRPC service configuration (default timeout: 200ms).
	GrpcService *v3.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,proto3,oneof"`
}

type ExtAuthz_HttpService 

type ExtAuthz_HttpService struct {
	// HTTP service configuration (default timeout: 200ms).
	HttpService *HttpService `protobuf:"bytes,3,opt,name=http_service,json=httpService,proto3,oneof"`
}

type HttpService 

type HttpService struct {

	// Sets the HTTP server URI which the authorization requests must be sent to.
	ServerUri *v3.HttpUri `protobuf:"bytes,1,opt,name=server_uri,json=serverUri,proto3" json:"server_uri,omitempty"`
	// Sets a prefix to the value of authorization request header “Path“.
	PathPrefix string `protobuf:"bytes,2,opt,name=path_prefix,json=pathPrefix,proto3" json:"path_prefix,omitempty"`
	// Settings used for controlling authorization request metadata.
	AuthorizationRequest *AuthorizationRequest `protobuf:"bytes,7,opt,name=authorization_request,json=authorizationRequest,proto3" json:"authorization_request,omitempty"`
	// Settings used for controlling authorization response metadata.
	AuthorizationResponse *AuthorizationResponse `protobuf:"bytes,8,opt,name=authorization_response,json=authorizationResponse,proto3" json:"authorization_response,omitempty"`
	// contains filtered or unexported fields
}

HttpService is used for raw HTTP communication between the filter and the authorization service. When configured, the filter will parse the client request and use these attributes to call the authorization server. Depending on the response, the filter may reject or accept the client request. Note that in any of these events, metadata can be added, removed or overridden by the filter:

*On authorization request*, a list of allowed request headers may be supplied. See :ref:`allowed_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.allowed_headers>` for details. Additional headers metadata may be added to the authorization request. See :ref:`headers_to_add <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationRequest.headers_to_add>` for details.

On authorization response status HTTP 200 OK, the filter will allow traffic to the upstream and additional headers metadata may be added to the original client request. See :ref:`allowed_upstream_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_upstream_headers>` for details. Additionally, the filter may add additional headers to the client's response. See :ref:`allowed_client_headers_on_success <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers_on_success>` for details.

On other authorization response statuses, the filter will not allow traffic. Additional headers metadata as well as body may be added to the client's response. See :ref:`allowed_client_headers <envoy_v3_api_field_extensions.filters.http.ext_authz.v3.AuthorizationResponse.allowed_client_headers>` for details. [#next-free-field: 9]

func (*HttpService) Descriptor deprecated 

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

Deprecated: Use HttpService.ProtoReflect.Descriptor instead.

func (*HttpService) GetAuthorizationRequest 

func (x *HttpService) GetAuthorizationRequest() *AuthorizationRequest

func (*HttpService) GetAuthorizationResponse 

func (x *HttpService) GetAuthorizationResponse() *AuthorizationResponse

func (*HttpService) GetPathPrefix 

func (x *HttpService) GetPathPrefix() string

func (*HttpService) GetServerUri 

func (x *HttpService) GetServerUri() *v3.HttpUri

func (*HttpService) ProtoMessage 

func (*HttpService) ProtoMessage()

func (*HttpService) ProtoReflect 

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

func (*HttpService) Reset 

func (x *HttpService) Reset()

func (*HttpService) String 

func (x *HttpService) String() string

func (*HttpService) Validate 

func (m *HttpService) Validate() error

Validate checks the field values on HttpService 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 (*HttpService) ValidateAll 

func (m *HttpService) ValidateAll() error

ValidateAll checks the field values on HttpService 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 HttpServiceMultiError, or nil if none found.

type HttpServiceMultiError 

type HttpServiceMultiError []error

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

func (HttpServiceMultiError) AllErrors 

func (m HttpServiceMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (HttpServiceMultiError) Error 

func (m HttpServiceMultiError) Error() string

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

type HttpServiceValidationError 

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

HttpServiceValidationError is the validation error returned by HttpService.Validate if the designated constraints aren't met.

func (HttpServiceValidationError) Cause 

func (e HttpServiceValidationError) Cause() error

Cause function returns cause value.

func (HttpServiceValidationError) Error 

func (e HttpServiceValidationError) Error() string

Error satisfies the builtin error interface

func (HttpServiceValidationError) ErrorName 

func (e HttpServiceValidationError) ErrorName() string

ErrorName returns error name.

func (HttpServiceValidationError) Field 

func (e HttpServiceValidationError) Field() string

Field function returns field value.

func (HttpServiceValidationError) Key 

func (e HttpServiceValidationError) Key() bool

Key function returns key value.

func (HttpServiceValidationError) Reason 

func (e HttpServiceValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.