Documentation
¶
Index ¶
- Variables
- type RBAC
- func (*RBAC) Descriptor() ([]byte, []int)deprecated
- func (x *RBAC) GetMatcher() *v31.Matcher
- func (x *RBAC) GetRules() *v3.RBAC
- func (x *RBAC) GetShadowMatcher() *v31.Matcher
- func (x *RBAC) GetShadowRules() *v3.RBAC
- func (x *RBAC) GetShadowRulesStatPrefix() string
- func (*RBAC) ProtoMessage()
- func (x *RBAC) ProtoReflect() protoreflect.Message
- func (x *RBAC) Reset()
- func (x *RBAC) String() string
- func (m *RBAC) Validate() error
- func (m *RBAC) ValidateAll() error
- type RBACMultiError
- type RBACPerRoute
- func (*RBACPerRoute) Descriptor() ([]byte, []int)deprecated
- func (x *RBACPerRoute) GetRbac() *RBAC
- func (*RBACPerRoute) ProtoMessage()
- func (x *RBACPerRoute) ProtoReflect() protoreflect.Message
- func (x *RBACPerRoute) Reset()
- func (x *RBACPerRoute) String() string
- func (m *RBACPerRoute) Validate() error
- func (m *RBACPerRoute) ValidateAll() error
- type RBACPerRouteMultiError
- type RBACPerRouteValidationError
- func (e RBACPerRouteValidationError) Cause() error
- func (e RBACPerRouteValidationError) Error() string
- func (e RBACPerRouteValidationError) ErrorName() string
- func (e RBACPerRouteValidationError) Field() string
- func (e RBACPerRouteValidationError) Key() bool
- func (e RBACPerRouteValidationError) Reason() string
- type RBACValidationError
Constants ¶
This section is empty.
Variables ¶
var File_envoy_extensions_filters_http_rbac_v3_rbac_proto protoreflect.FileDescriptor
Functions ¶
This section is empty.
Types ¶
type RBAC ¶
type RBAC struct { // Specify the RBAC rules to be applied globally. // If absent, no enforcing RBAC policy will be applied. // If present and empty, DENY. // If both rules and matcher are configured, rules will be ignored. Rules *v3.RBAC `protobuf:"bytes,1,opt,name=rules,proto3" json:"rules,omitempty"` // The match tree to use when resolving RBAC action for incoming requests. Requests do not // match any matcher will be denied. // If absent, no enforcing RBAC matcher will be applied. // If present and empty, deny all requests. Matcher *v31.Matcher `protobuf:"bytes,4,opt,name=matcher,proto3" json:"matcher,omitempty"` // Shadow rules are not enforced by the filter (i.e., returning a 403) // but will emit stats and logs and can be used for rule testing. // If absent, no shadow RBAC policy will be applied. // If both shadow rules and shadow matcher are configured, shadow rules will be ignored. ShadowRules *v3.RBAC `protobuf:"bytes,2,opt,name=shadow_rules,json=shadowRules,proto3" json:"shadow_rules,omitempty"` // The match tree to use for emitting stats and logs which can be used for rule testing for // incoming requests. // If absent, no shadow matcher will be applied. ShadowMatcher *v31.Matcher `protobuf:"bytes,5,opt,name=shadow_matcher,json=shadowMatcher,proto3" json:"shadow_matcher,omitempty"` // If specified, shadow rules will emit stats with the given prefix. // This is useful to distinguish the stat when there are more than 1 RBAC filter configured with // shadow rules. ShadowRulesStatPrefix string `` /* 128-byte string literal not displayed */ // contains filtered or unexported fields }
RBAC filter config. [#next-free-field: 6]
func (*RBAC) Descriptor
deprecated
func (*RBAC) GetMatcher ¶ added in v0.10.2
func (*RBAC) GetShadowMatcher ¶ added in v0.10.2
func (*RBAC) GetShadowRules ¶
func (*RBAC) GetShadowRulesStatPrefix ¶ added in v0.9.9
func (*RBAC) ProtoMessage ¶
func (*RBAC) ProtoMessage()
func (*RBAC) ProtoReflect ¶ added in v0.9.6
func (x *RBAC) ProtoReflect() protoreflect.Message
func (*RBAC) Validate ¶
Validate checks the field values on RBAC 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 (*RBAC) ValidateAll ¶ added in v0.10.0
ValidateAll checks the field values on RBAC 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 RBACMultiError, or nil if none found.
type RBACMultiError ¶ added in v0.10.0
type RBACMultiError []error
RBACMultiError is an error wrapping multiple validation errors returned by RBAC.ValidateAll() if the designated constraints aren't met.
func (RBACMultiError) AllErrors ¶ added in v0.10.0
func (m RBACMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RBACMultiError) Error ¶ added in v0.10.0
func (m RBACMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RBACPerRoute ¶
type RBACPerRoute struct { // Override the global configuration of the filter with this new config. // If absent, the global RBAC policy will be disabled for this route. Rbac *RBAC `protobuf:"bytes,2,opt,name=rbac,proto3" json:"rbac,omitempty"` // contains filtered or unexported fields }
func (*RBACPerRoute) Descriptor
deprecated
func (*RBACPerRoute) Descriptor() ([]byte, []int)
Deprecated: Use RBACPerRoute.ProtoReflect.Descriptor instead.
func (*RBACPerRoute) GetRbac ¶
func (x *RBACPerRoute) GetRbac() *RBAC
func (*RBACPerRoute) ProtoMessage ¶
func (*RBACPerRoute) ProtoMessage()
func (*RBACPerRoute) ProtoReflect ¶ added in v0.9.6
func (x *RBACPerRoute) ProtoReflect() protoreflect.Message
func (*RBACPerRoute) Reset ¶
func (x *RBACPerRoute) Reset()
func (*RBACPerRoute) String ¶
func (x *RBACPerRoute) String() string
func (*RBACPerRoute) Validate ¶
func (m *RBACPerRoute) Validate() error
Validate checks the field values on RBACPerRoute 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 (*RBACPerRoute) ValidateAll ¶ added in v0.10.0
func (m *RBACPerRoute) ValidateAll() error
ValidateAll checks the field values on RBACPerRoute 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 RBACPerRouteMultiError, or nil if none found.
type RBACPerRouteMultiError ¶ added in v0.10.0
type RBACPerRouteMultiError []error
RBACPerRouteMultiError is an error wrapping multiple validation errors returned by RBACPerRoute.ValidateAll() if the designated constraints aren't met.
func (RBACPerRouteMultiError) AllErrors ¶ added in v0.10.0
func (m RBACPerRouteMultiError) AllErrors() []error
AllErrors returns a list of validation violation errors.
func (RBACPerRouteMultiError) Error ¶ added in v0.10.0
func (m RBACPerRouteMultiError) Error() string
Error returns a concatenation of all the error messages it wraps.
type RBACPerRouteValidationError ¶
type RBACPerRouteValidationError struct {
// contains filtered or unexported fields
}
RBACPerRouteValidationError is the validation error returned by RBACPerRoute.Validate if the designated constraints aren't met.
func (RBACPerRouteValidationError) Cause ¶
func (e RBACPerRouteValidationError) Cause() error
Cause function returns cause value.
func (RBACPerRouteValidationError) Error ¶
func (e RBACPerRouteValidationError) Error() string
Error satisfies the builtin error interface
func (RBACPerRouteValidationError) ErrorName ¶
func (e RBACPerRouteValidationError) ErrorName() string
ErrorName returns error name.
func (RBACPerRouteValidationError) Field ¶
func (e RBACPerRouteValidationError) Field() string
Field function returns field value.
func (RBACPerRouteValidationError) Key ¶
func (e RBACPerRouteValidationError) Key() bool
Key function returns key value.
func (RBACPerRouteValidationError) Reason ¶
func (e RBACPerRouteValidationError) Reason() string
Reason function returns reason value.
type RBACValidationError ¶
type RBACValidationError struct {
// contains filtered or unexported fields
}
RBACValidationError is the validation error returned by RBAC.Validate if the designated constraints aren't met.
func (RBACValidationError) Cause ¶
func (e RBACValidationError) Cause() error
Cause function returns cause value.
func (RBACValidationError) Error ¶
func (e RBACValidationError) Error() string
Error satisfies the builtin error interface
func (RBACValidationError) ErrorName ¶
func (e RBACValidationError) ErrorName() string
ErrorName returns error name.
func (RBACValidationError) Field ¶
func (e RBACValidationError) Field() string
Field function returns field value.
func (RBACValidationError) Key ¶
func (e RBACValidationError) Key() bool
Key function returns key value.
func (RBACValidationError) Reason ¶
func (e RBACValidationError) Reason() string
Reason function returns reason value.