Documentation
¶
Index ¶
- Variables
- type ExtAuthz
- func (*ExtAuthz) Descriptor() ([]byte, []int)deprecated
- func (x *ExtAuthz) GetFailureModeAllow() bool
- func (x *ExtAuthz) GetGrpcService() *core.GrpcService
- func (x *ExtAuthz) GetIncludePeerCertificate() bool
- func (x *ExtAuthz) GetStatPrefix() string
- func (*ExtAuthz) ProtoMessage()
- func (x *ExtAuthz) ProtoReflect() protoreflect.Message
- func (x *ExtAuthz) Reset()
- func (x *ExtAuthz) String() string
- func (m *ExtAuthz) Validate() error
- func (m *ExtAuthz) ValidateAll() error
- type ExtAuthzMultiError
- type ExtAuthzValidationError
Constants ¶
This section is empty.
Variables ¶
var File_envoy_config_filter_network_ext_authz_v2_ext_authz_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type ExtAuthz ¶
type ExtAuthz struct {
// The prefix to use when emitting statistics.
StatPrefix string `protobuf:"bytes,1,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
// The external authorization gRPC service configuration.
// The default timeout is set to 200ms by this filter.
GrpcService *core.GrpcService `protobuf:"bytes,2,opt,name=grpc_service,json=grpcService,proto3" json:"grpc_service,omitempty"`
// 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,3,opt,name=failure_mode_allow,json=failureModeAllow,proto3" json:"failure_mode_allow,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 `` /* 130-byte string literal not displayed */
// contains filtered or unexported fields
}
External Authorization filter calls out to an external service over the gRPC Authorization API defined by :ref:`CheckRequest <envoy_api_msg_service.auth.v2.CheckRequest>`. A failed check will cause this filter to close the TCP connection.
func (*ExtAuthz) Descriptor
deprecated
func (*ExtAuthz) GetFailureModeAllow ¶
func (*ExtAuthz) GetGrpcService ¶
func (x *ExtAuthz) GetGrpcService() *core.GrpcService
func (*ExtAuthz) GetIncludePeerCertificate ¶ added in v0.9.2
func (*ExtAuthz) GetStatPrefix ¶
func (*ExtAuthz) ProtoMessage ¶
func (*ExtAuthz) ProtoMessage()
func (*ExtAuthz) ProtoReflect ¶ added in v0.9.6
func (x *ExtAuthz) ProtoReflect() protoreflect.Message
func (*ExtAuthz) Validate ¶
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 ¶ added in v0.10.0
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 ¶ added in v0.10.0
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 ¶ added in v0.10.0
func (m ExtAuthzMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (ExtAuthzMultiError) Error ¶ added in v0.10.0
func (m ExtAuthzMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
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 ¶ added in v0.7.0
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.
Source Files