Documentation ¶
Overview ¶
Package v2alpha is a generated protocol buffer package.
It is generated from these files:
envoy/config/filter/http/ext_authz/v2alpha/ext_authz.proto
It has these top-level messages:
ExtAuthz HttpService
Index ¶
- Variables
- type ExtAuthz
- func (*ExtAuthz) Descriptor() ([]byte, []int)
- func (m *ExtAuthz) GetFailureModeAllow() bool
- func (m *ExtAuthz) GetGrpcService() *envoy_api_v2_core1.GrpcService
- func (m *ExtAuthz) GetHttpService() *HttpService
- func (m *ExtAuthz) GetServices() isExtAuthz_Services
- func (m *ExtAuthz) Marshal() (dAtA []byte, err error)
- func (m *ExtAuthz) MarshalTo(dAtA []byte) (int, error)
- func (*ExtAuthz) ProtoMessage()
- func (m *ExtAuthz) Reset()
- func (m *ExtAuthz) Size() (n int)
- func (m *ExtAuthz) String() string
- func (m *ExtAuthz) Unmarshal(dAtA []byte) error
- func (m *ExtAuthz) Validate() error
- func (*ExtAuthz) XXX_OneofFuncs() (func(msg proto.Message, b *proto.Buffer) error, ...)
- type ExtAuthzValidationError
- type ExtAuthz_GrpcService
- type ExtAuthz_HttpService
- type HttpService
- func (*HttpService) Descriptor() ([]byte, []int)
- func (m *HttpService) GetPathPrefix() string
- func (m *HttpService) GetResponseHeadersToRemove() []string
- func (m *HttpService) GetServerUri() *envoy_api_v2_core2.HttpUri
- func (m *HttpService) Marshal() (dAtA []byte, err error)
- func (m *HttpService) MarshalTo(dAtA []byte) (int, error)
- func (*HttpService) ProtoMessage()
- func (m *HttpService) Reset()
- func (m *HttpService) Size() (n int)
- func (m *HttpService) String() string
- func (m *HttpService) Unmarshal(dAtA []byte) error
- func (m *HttpService) Validate() error
- type HttpServiceValidationError
Constants ¶
This section is empty.
Variables ¶
var ( ErrInvalidLengthExtAuthz = fmt.Errorf("proto: negative length found during unmarshaling") ErrIntOverflowExtAuthz = fmt.Errorf("proto: integer overflow") )
Functions ¶
This section is empty.
Types ¶
type ExtAuthz ¶
type ExtAuthz struct { // Types that are valid to be assigned to Services: // *ExtAuthz_GrpcService // *ExtAuthz_HttpService Services isExtAuthz_Services `protobuf_oneof:"services"` // The filter's behaviour in case the external authorization service does // not respond back. When it is set to true, Envoy will also allow traffic in case of // communication failure between authorization service and the proxy. // Defaults to false. FailureModeAllow bool `protobuf:"varint,2,opt,name=failure_mode_allow,json=failureModeAllow,proto3" json:"failure_mode_allow,omitempty"` }
External Authorization filter calls out to an external service over either:
- gRPC Authorization API defined by :ref:`CheckRequest <envoy_api_msg_service.auth.v2alpha.CheckRequest>`.
- Raw HTTP Authorization server by passing the request headers to the service.
A failed check will cause this filter to close the HTTP request normally with 403 (Forbidden), unless a different status code has been indicated in the authorization response.
func (*ExtAuthz) Descriptor ¶
func (*ExtAuthz) GetFailureModeAllow ¶
func (*ExtAuthz) GetGrpcService ¶
func (m *ExtAuthz) GetGrpcService() *envoy_api_v2_core1.GrpcService
func (*ExtAuthz) GetHttpService ¶
func (m *ExtAuthz) GetHttpService() *HttpService
func (*ExtAuthz) GetServices ¶
func (m *ExtAuthz) GetServices() isExtAuthz_Services
func (*ExtAuthz) ProtoMessage ¶
func (*ExtAuthz) ProtoMessage()
type ExtAuthzValidationError ¶
ExtAuthzValidationError is the validation error returned by ExtAuthz.Validate if the designated constraints aren't met.
func (ExtAuthzValidationError) Error ¶
func (e ExtAuthzValidationError) Error() string
Error satisfies the builtin error interface
type ExtAuthz_GrpcService ¶
type ExtAuthz_GrpcService struct {
GrpcService *envoy_api_v2_core1.GrpcService `protobuf:"bytes,1,opt,name=grpc_service,json=grpcService,oneof"`
}
func (*ExtAuthz_GrpcService) MarshalTo ¶
func (m *ExtAuthz_GrpcService) MarshalTo(dAtA []byte) (int, error)
func (*ExtAuthz_GrpcService) Size ¶
func (m *ExtAuthz_GrpcService) Size() (n int)
type ExtAuthz_HttpService ¶
type ExtAuthz_HttpService struct {
HttpService *HttpService `protobuf:"bytes,3,opt,name=http_service,json=httpService,oneof"`
}
func (*ExtAuthz_HttpService) MarshalTo ¶
func (m *ExtAuthz_HttpService) MarshalTo(dAtA []byte) (int, error)
func (*ExtAuthz_HttpService) Size ¶
func (m *ExtAuthz_HttpService) Size() (n int)
type HttpService ¶
type HttpService struct { // Sets the HTTP server URI which the authorization requests must be sent to. ServerUri *envoy_api_v2_core2.HttpUri `protobuf:"bytes,1,opt,name=server_uri,json=serverUri" json:"server_uri,omitempty"` // Sets an optional 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"` // Sets a list of headers that should be not be sent *from the authorization server* to the // upstream. ResponseHeadersToRemove []string `` /* 127-byte string literal not displayed */ }
External Authorization filter calls out to an upstream authorization server by passing the raw HTTP request headers to the server. This allows the authorization service to take a decision whether the request is authorized or not.
A successful check allows the authorization service adding or overriding headers from the original request before dispatching it to the upstream. This is done by including the headers in the response sent back from the authorization service to the filter. Note that `Status`, `Method`, `Path` and `Content Length` response headers are automatically removed from this response by the filter. If other headers need be deleted, they should be specified in `response_headers_to_remove` field.
A failed check will cause this filter to close the HTTP request normally with 403 (Forbidden), unless a different status code has been indicated by the authorization service via response headers. The HTTP service also allows the authorization filter to also pass data from the response body to the downstream client in case of a denied request.
func (*HttpService) Descriptor ¶
func (*HttpService) Descriptor() ([]byte, []int)
func (*HttpService) GetPathPrefix ¶
func (m *HttpService) GetPathPrefix() string
func (*HttpService) GetResponseHeadersToRemove ¶
func (m *HttpService) GetResponseHeadersToRemove() []string
func (*HttpService) GetServerUri ¶
func (m *HttpService) GetServerUri() *envoy_api_v2_core2.HttpUri
func (*HttpService) Marshal ¶
func (m *HttpService) Marshal() (dAtA []byte, err error)
func (*HttpService) ProtoMessage ¶
func (*HttpService) ProtoMessage()
func (*HttpService) Reset ¶
func (m *HttpService) Reset()
func (*HttpService) Size ¶
func (m *HttpService) Size() (n int)
func (*HttpService) String ¶
func (m *HttpService) String() string
func (*HttpService) Unmarshal ¶
func (m *HttpService) Unmarshal(dAtA []byte) error
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, an error is returned.
type HttpServiceValidationError ¶
HttpServiceValidationError is the validation error returned by HttpService.Validate if the designated constraints aren't met.
func (HttpServiceValidationError) Error ¶
func (e HttpServiceValidationError) Error() string
Error satisfies the builtin error interface