go-control-plane: github.com/envoyproxy/go-control-plane/envoy/config/filter/http/ext_authz/v2 Index | Files

package envoy_config_filter_http_ext_authz_v2

import "github.com/envoyproxy/go-control-plane/envoy/config/filter/http/ext_authz/v2"

Index

Package Files

ext_authz.pb.go ext_authz.pb.validate.go

Variables

var File_envoy_config_filter_http_ext_authz_v2_ext_authz_proto protoreflect.FileDescriptor

type AuthorizationRequest Uses

type AuthorizationRequest struct {

    // Authorization request will include the client request headers that have a correspondent match
    // in the :ref:`list <envoy_api_msg_type.matcher.ListStringMatcher>`. Note that in addition to the
    // user's supplied matchers:
    //
    // 1. *Host*, *Method*, *Path* and *Content-Length* are automatically included to the list.
    //
    // 2. *Content-Length* will be set to 0 and the request to the authorization service will not have
    // a message body. However, the authorization request can include the buffered client request body
    // (controlled by :ref:`with_request_body
    // <envoy_api_field_config.filter.http.ext_authz.v2.ExtAuthz.with_request_body>` setting),
    // consequently the value of *Content-Length* of the authorization request reflects the size of
    // its payload size.
    //
    AllowedHeaders *matcher.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 []*core.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 Uses

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

Deprecated: Use AuthorizationRequest.ProtoReflect.Descriptor instead.

func (*AuthorizationRequest) GetAllowedHeaders Uses

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

func (*AuthorizationRequest) GetHeadersToAdd Uses

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

func (*AuthorizationRequest) ProtoMessage Uses

func (*AuthorizationRequest) ProtoMessage()

func (*AuthorizationRequest) ProtoReflect Uses

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

func (*AuthorizationRequest) Reset Uses

func (x *AuthorizationRequest) Reset()

func (*AuthorizationRequest) String Uses

func (x *AuthorizationRequest) String() string

func (*AuthorizationRequest) Validate Uses

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

type AuthorizationRequestValidationError Uses

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 Uses

func (e AuthorizationRequestValidationError) Cause() error

Cause function returns cause value.

func (AuthorizationRequestValidationError) Error Uses

func (e AuthorizationRequestValidationError) Error() string

Error satisfies the builtin error interface

func (AuthorizationRequestValidationError) ErrorName Uses

func (e AuthorizationRequestValidationError) ErrorName() string

ErrorName returns error name.

func (AuthorizationRequestValidationError) Field Uses

func (e AuthorizationRequestValidationError) Field() string

Field function returns field value.

func (AuthorizationRequestValidationError) Key Uses

func (e AuthorizationRequestValidationError) Key() bool

Key function returns key value.

func (AuthorizationRequestValidationError) Reason Uses

func (e AuthorizationRequestValidationError) Reason() string

Reason function returns reason value.

type AuthorizationResponse Uses

type AuthorizationResponse struct {

    // When this :ref:`list <envoy_api_msg_type.matcher.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 *matcher.ListStringMatcher `protobuf:"bytes,1,opt,name=allowed_upstream_headers,json=allowedUpstreamHeaders,proto3" json:"allowed_upstream_headers,omitempty"`
    // When this :ref:`list <envoy_api_msg_type.matcher.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 *matcher.ListStringMatcher `protobuf:"bytes,2,opt,name=allowed_client_headers,json=allowedClientHeaders,proto3" json:"allowed_client_headers,omitempty"`
    // contains filtered or unexported fields
}

func (*AuthorizationResponse) Descriptor Uses

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

Deprecated: Use AuthorizationResponse.ProtoReflect.Descriptor instead.

func (*AuthorizationResponse) GetAllowedClientHeaders Uses

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

func (*AuthorizationResponse) GetAllowedUpstreamHeaders Uses

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

func (*AuthorizationResponse) ProtoMessage Uses

func (*AuthorizationResponse) ProtoMessage()

func (*AuthorizationResponse) ProtoReflect Uses

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

func (*AuthorizationResponse) Reset Uses

func (x *AuthorizationResponse) Reset()

func (*AuthorizationResponse) String Uses

func (x *AuthorizationResponse) String() string

func (*AuthorizationResponse) Validate Uses

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

type AuthorizationResponseValidationError Uses

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 Uses

func (e AuthorizationResponseValidationError) Cause() error

Cause function returns cause value.

func (AuthorizationResponseValidationError) Error Uses

func (e AuthorizationResponseValidationError) Error() string

Error satisfies the builtin error interface

func (AuthorizationResponseValidationError) ErrorName Uses

func (e AuthorizationResponseValidationError) ErrorName() string

ErrorName returns error name.

func (AuthorizationResponseValidationError) Field Uses

func (e AuthorizationResponseValidationError) Field() string

Field function returns field value.

func (AuthorizationResponseValidationError) Key Uses

func (e AuthorizationResponseValidationError) Key() bool

Key function returns key value.

func (AuthorizationResponseValidationError) Reason Uses

func (e AuthorizationResponseValidationError) Reason() string

Reason function returns reason value.

type BufferSettings Uses

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_api_field_config.filter.http.ext_authz.v2.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"`
    // contains filtered or unexported fields
}

Configuration for buffering the request data.

func (*BufferSettings) Descriptor Uses

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

Deprecated: Use BufferSettings.ProtoReflect.Descriptor instead.

func (*BufferSettings) GetAllowPartialMessage Uses

func (x *BufferSettings) GetAllowPartialMessage() bool

func (*BufferSettings) GetMaxRequestBytes Uses

func (x *BufferSettings) GetMaxRequestBytes() uint32

func (*BufferSettings) ProtoMessage Uses

func (*BufferSettings) ProtoMessage()

func (*BufferSettings) ProtoReflect Uses

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

func (*BufferSettings) Reset Uses

func (x *BufferSettings) Reset()

func (*BufferSettings) String Uses

func (x *BufferSettings) String() string

func (*BufferSettings) Validate Uses

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

type BufferSettingsValidationError Uses

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 Uses

func (e BufferSettingsValidationError) Cause() error

Cause function returns cause value.

func (BufferSettingsValidationError) Error Uses

func (e BufferSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (BufferSettingsValidationError) ErrorName Uses

func (e BufferSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (BufferSettingsValidationError) Field Uses

func (e BufferSettingsValidationError) Field() string

Field function returns field value.

func (BufferSettingsValidationError) Key Uses

func (e BufferSettingsValidationError) Key() bool

Key function returns key value.

func (BufferSettingsValidationError) Reason Uses

func (e BufferSettingsValidationError) Reason() string

Reason function returns reason value.

type CheckSettings Uses

type CheckSettings struct {

    // Context extensions to set on the CheckRequest's
    // :ref:`AttributeContext.context_extensions<envoy_api_field_service.auth.v2.AttributeContext.context_extensions>`
    //
    // 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_api_field_config.filter.http.ext_authz.v2.ExtAuthz.grpc_service>`.
    ContextExtensions map[string]string `protobuf:"bytes,1,rep,name=context_extensions,json=contextExtensions,proto3" json:"context_extensions,omitempty" protobuf_key:"bytes,1,opt,name=key,proto3" protobuf_val:"bytes,2,opt,name=value,proto3"`
    // contains filtered or unexported fields
}

Extra settings for the check request. 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.

func (*CheckSettings) Descriptor Uses

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

Deprecated: Use CheckSettings.ProtoReflect.Descriptor instead.

func (*CheckSettings) GetContextExtensions Uses

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

func (*CheckSettings) ProtoMessage Uses

func (*CheckSettings) ProtoMessage()

func (*CheckSettings) ProtoReflect Uses

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

func (*CheckSettings) Reset Uses

func (x *CheckSettings) Reset()

func (*CheckSettings) String Uses

func (x *CheckSettings) String() string

func (*CheckSettings) Validate Uses

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

type CheckSettingsValidationError Uses

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 Uses

func (e CheckSettingsValidationError) Cause() error

Cause function returns cause value.

func (CheckSettingsValidationError) Error Uses

func (e CheckSettingsValidationError) Error() string

Error satisfies the builtin error interface

func (CheckSettingsValidationError) ErrorName Uses

func (e CheckSettingsValidationError) ErrorName() string

ErrorName returns error name.

func (CheckSettingsValidationError) Field Uses

func (e CheckSettingsValidationError) Field() string

Field function returns field value.

func (CheckSettingsValidationError) Key Uses

func (e CheckSettingsValidationError) Key() bool

Key function returns key value.

func (CheckSettingsValidationError) Reason Uses

func (e CheckSettingsValidationError) Reason() string

Reason function returns reason value.

type ExtAuthz Uses

type ExtAuthz struct {

    // External authorization service configuration.
    //
    // Types that are assignable to Services:
    //	*ExtAuthz_GrpcService
    //	*ExtAuthz_HttpService
    Services isExtAuthz_Services `protobuf_oneof:"services"`
    //  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"`
    // [#not-implemented-hide: Support for this field has been removed.]
    //
    // Deprecated: Do not use.
    UseAlpha bool `protobuf:"varint,4,opt,name=use_alpha,json=useAlpha,proto3" json:"use_alpha,omitempty"`
    // 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 there is a network error between the
    // filter and the authorization server. The default status is HTTP 403 Forbidden.
    StatusOnError *_type.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 as an opaque *protobuf::Struct*.
    //
    // For example, if the *jwt_authn* filter is used and :ref:`payload_in_metadata
    // <envoy_api_field_config.filter.http.jwt_authn.v2alpha.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 `protobuf:"bytes,8,rep,name=metadata_context_namespaces,json=metadataContextNamespaces,proto3" json:"metadata_context_namespaces,omitempty"`
    // Specifies if the 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.
    //
    // If this field is not specified, the filter will be enabled for all requests.
    FilterEnabled *core.RuntimeFractionalPercent `protobuf:"bytes,9,opt,name=filter_enabled,json=filterEnabled,proto3" json:"filter_enabled,omitempty"`
    // Specifies whether to deny the requests, when the filter is disabled.
    // If :ref:`runtime_key <envoy_api_field_core.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.
    DenyAtDisable *core.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_api_field_service.auth.v2.AttributeContext.Peer.certificate>`.
    IncludePeerCertificate bool `protobuf:"varint,10,opt,name=include_peer_certificate,json=includePeerCertificate,proto3" json:"include_peer_certificate,omitempty"`
    // contains filtered or unexported fields
}

[#next-free-field: 12]

func (*ExtAuthz) Descriptor Uses

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

Deprecated: Use ExtAuthz.ProtoReflect.Descriptor instead.

func (*ExtAuthz) GetClearRouteCache Uses

func (x *ExtAuthz) GetClearRouteCache() bool

func (*ExtAuthz) GetDenyAtDisable Uses

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

func (*ExtAuthz) GetFailureModeAllow Uses

func (x *ExtAuthz) GetFailureModeAllow() bool

func (*ExtAuthz) GetFilterEnabled Uses

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

func (*ExtAuthz) GetGrpcService Uses

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

func (*ExtAuthz) GetHttpService Uses

func (x *ExtAuthz) GetHttpService() *HttpService

func (*ExtAuthz) GetIncludePeerCertificate Uses

func (x *ExtAuthz) GetIncludePeerCertificate() bool

func (*ExtAuthz) GetMetadataContextNamespaces Uses

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

func (*ExtAuthz) GetServices Uses

func (m *ExtAuthz) GetServices() isExtAuthz_Services

func (*ExtAuthz) GetStatusOnError Uses

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

func (*ExtAuthz) GetUseAlpha Uses

func (x *ExtAuthz) GetUseAlpha() bool

Deprecated: Do not use.

func (*ExtAuthz) GetWithRequestBody Uses

func (x *ExtAuthz) GetWithRequestBody() *BufferSettings

func (*ExtAuthz) ProtoMessage Uses

func (*ExtAuthz) ProtoMessage()

func (*ExtAuthz) ProtoReflect Uses

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

func (*ExtAuthz) Reset Uses

func (x *ExtAuthz) Reset()

func (*ExtAuthz) String Uses

func (x *ExtAuthz) String() string

func (*ExtAuthz) Validate Uses

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

type ExtAuthzPerRoute Uses

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 Uses

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

Deprecated: Use ExtAuthzPerRoute.ProtoReflect.Descriptor instead.

func (*ExtAuthzPerRoute) GetCheckSettings Uses

func (x *ExtAuthzPerRoute) GetCheckSettings() *CheckSettings

func (*ExtAuthzPerRoute) GetDisabled Uses

func (x *ExtAuthzPerRoute) GetDisabled() bool

func (*ExtAuthzPerRoute) GetOverride Uses

func (m *ExtAuthzPerRoute) GetOverride() isExtAuthzPerRoute_Override

func (*ExtAuthzPerRoute) ProtoMessage Uses

func (*ExtAuthzPerRoute) ProtoMessage()

func (*ExtAuthzPerRoute) ProtoReflect Uses

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

func (*ExtAuthzPerRoute) Reset Uses

func (x *ExtAuthzPerRoute) Reset()

func (*ExtAuthzPerRoute) String Uses

func (x *ExtAuthzPerRoute) String() string

func (*ExtAuthzPerRoute) Validate Uses

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

type ExtAuthzPerRouteValidationError Uses

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 Uses

func (e ExtAuthzPerRouteValidationError) Cause() error

Cause function returns cause value.

func (ExtAuthzPerRouteValidationError) Error Uses

func (e ExtAuthzPerRouteValidationError) Error() string

Error satisfies the builtin error interface

func (ExtAuthzPerRouteValidationError) ErrorName Uses

func (e ExtAuthzPerRouteValidationError) ErrorName() string

ErrorName returns error name.

func (ExtAuthzPerRouteValidationError) Field Uses

func (e ExtAuthzPerRouteValidationError) Field() string

Field function returns field value.

func (ExtAuthzPerRouteValidationError) Key Uses

func (e ExtAuthzPerRouteValidationError) Key() bool

Key function returns key value.

func (ExtAuthzPerRouteValidationError) Reason Uses

func (e ExtAuthzPerRouteValidationError) Reason() string

Reason function returns reason value.

type ExtAuthzPerRoute_CheckSettings Uses

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 Uses

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 Uses

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 Uses

func (e ExtAuthzValidationError) Cause() error

Cause function returns cause value.

func (ExtAuthzValidationError) Error Uses

func (e ExtAuthzValidationError) Error() string

Error satisfies the builtin error interface

func (ExtAuthzValidationError) ErrorName Uses

func (e ExtAuthzValidationError) ErrorName() string

ErrorName returns error name.

func (ExtAuthzValidationError) Field Uses

func (e ExtAuthzValidationError) Field() string

Field function returns field value.

func (ExtAuthzValidationError) Key Uses

func (e ExtAuthzValidationError) Key() bool

Key function returns key value.

func (ExtAuthzValidationError) Reason Uses

func (e ExtAuthzValidationError) Reason() string

Reason function returns reason value.

type ExtAuthz_GrpcService Uses

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

type ExtAuthz_HttpService Uses

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 Uses

type HttpService struct {

    // Sets the HTTP server URI which the authorization requests must be sent to.
    ServerUri *core.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_api_field_config.filter.http.ext_authz.v2.AuthorizationRequest.allowed_headers>` for details. Additional headers metadata may be added to the authorization request. See :ref:`headers_to_add <envoy_api_field_config.filter.http.ext_authz.v2.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_api_field_config.filter.http.ext_authz.v2.AuthorizationResponse.allowed_upstream_headers>` 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_api_field_config.filter.http.ext_authz.v2.AuthorizationResponse.allowed_client_headers>` for details. [#next-free-field: 9]

func (*HttpService) Descriptor Uses

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

Deprecated: Use HttpService.ProtoReflect.Descriptor instead.

func (*HttpService) GetAuthorizationRequest Uses

func (x *HttpService) GetAuthorizationRequest() *AuthorizationRequest

func (*HttpService) GetAuthorizationResponse Uses

func (x *HttpService) GetAuthorizationResponse() *AuthorizationResponse

func (*HttpService) GetPathPrefix Uses

func (x *HttpService) GetPathPrefix() string

func (*HttpService) GetServerUri Uses

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

func (*HttpService) ProtoMessage Uses

func (*HttpService) ProtoMessage()

func (*HttpService) ProtoReflect Uses

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

func (*HttpService) Reset Uses

func (x *HttpService) Reset()

func (*HttpService) String Uses

func (x *HttpService) String() string

func (*HttpService) Validate Uses

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

type HttpServiceValidationError Uses

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 Uses

func (e HttpServiceValidationError) Cause() error

Cause function returns cause value.

func (HttpServiceValidationError) Error Uses

func (e HttpServiceValidationError) Error() string

Error satisfies the builtin error interface

func (HttpServiceValidationError) ErrorName Uses

func (e HttpServiceValidationError) ErrorName() string

ErrorName returns error name.

func (HttpServiceValidationError) Field Uses

func (e HttpServiceValidationError) Field() string

Field function returns field value.

func (HttpServiceValidationError) Key Uses

func (e HttpServiceValidationError) Key() bool

Key function returns key value.

func (HttpServiceValidationError) Reason Uses

func (e HttpServiceValidationError) Reason() string

Reason function returns reason value.

Package envoy_config_filter_http_ext_authz_v2 imports 22 packages (graph) and is imported by 7 packages. Updated 2021-01-12. Refresh now. Tools for package owners.