v2

Documentation

Index

• Variables
• type RBAC
  • func (*RBAC) Descriptor() ([]byte, []int)
  • func (m *RBAC) GetEnforcementType() RBAC_EnforcementType
  • func (m *RBAC) GetRules() *v2alpha.RBAC
  • func (m *RBAC) GetShadowRules() *v2alpha.RBAC
  • func (m *RBAC) GetStatPrefix() string
  • func (m *RBAC) Marshal() (dAtA []byte, err error)
  • func (m *RBAC) MarshalTo(dAtA []byte) (int, error)
  • func (*RBAC) ProtoMessage()
  • func (m *RBAC) Reset()
  • func (m *RBAC) Size() (n int)
  • func (m *RBAC) String() string
  • func (m *RBAC) Unmarshal(dAtA []byte) error
  • func (m *RBAC) Validate() error
  • func (m *RBAC) XXX_DiscardUnknown()
  • func (m *RBAC) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)
  • func (m *RBAC) XXX_Merge(src proto.Message)
  • func (m *RBAC) XXX_Size() int
  • func (m *RBAC) XXX_Unmarshal(b []byte) error
• type RBACValidationError
  • func (e RBACValidationError) Cause() error
  • func (e RBACValidationError) Error() string
  • func (e RBACValidationError) ErrorName() string
  • func (e RBACValidationError) Field() string
  • func (e RBACValidationError) Key() bool
  • func (e RBACValidationError) Reason() string
• type RBAC_EnforcementType
  • func (RBAC_EnforcementType) EnumDescriptor() ([]byte, []int)
  • func (x RBAC_EnforcementType) String() string

Variables

var (
	ErrInvalidLengthRbac = fmt.Errorf("proto: negative length found during unmarshaling")
	ErrIntOverflowRbac   = fmt.Errorf("proto: integer overflow")
)

var RBAC_EnforcementType_name = map[int32]string{
	0: "ONE_TIME_ON_FIRST_BYTE",
	1: "CONTINUOUS",
}

var RBAC_EnforcementType_value = map[string]int32{
	"ONE_TIME_ON_FIRST_BYTE": 0,
	"CONTINUOUS":             1,
}

Types

type RBAC

type RBAC struct {
	// Specify the RBAC rules to be applied globally.
	// If absent, no enforcing RBAC policy will be applied.
	Rules *v2alpha.RBAC `protobuf:"bytes,1,opt,name=rules,proto3" json:"rules,omitempty"`
	// Shadow rules are not enforced by the filter but will emit stats and logs
	// and can be used for rule testing.
	// If absent, no shadow RBAC policy will be applied.
	ShadowRules *v2alpha.RBAC `protobuf:"bytes,2,opt,name=shadow_rules,json=shadowRules,proto3" json:"shadow_rules,omitempty"`
	// The prefix to use when emitting statistics.
	StatPrefix string `protobuf:"bytes,3,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// RBAC enforcement strategy. By default RBAC will be enforced only once
	// when the first byte of data arrives from the downstream. When used in
	// conjunction with filters that emit dynamic metadata after decoding
	// every payload (e.g., Mongo, MySQL, Kafka) set the enforcement type to
	// CONTINUOUS to enforce RBAC policies on every message boundary.
	EnforcementType      RBAC_EnforcementType `` /* 169-byte string literal not displayed */
	XXX_NoUnkeyedLiteral struct{}             `json:"-"`
	XXX_unrecognized     []byte               `json:"-"`
	XXX_sizecache        int32                `json:"-"`
}

RBAC network filter config.

Header should not be used in rules/shadow_rules in RBAC network filter as this information is only available in :ref:`RBAC http filter <config_http_filters_rbac>`.

func (*RBAC) Descriptor

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

func (*RBAC) GetEnforcementType

func (m *RBAC) GetEnforcementType() RBAC_EnforcementType

func (*RBAC) GetRules

func (m *RBAC) GetRules() *v2alpha.RBAC

func (*RBAC) GetShadowRules

func (m *RBAC) GetShadowRules() *v2alpha.RBAC

func (*RBAC) GetStatPrefix

func (m *RBAC) GetStatPrefix() string

func (*RBAC) Marshal

func (m *RBAC) Marshal() (dAtA []byte, err error)

func (*RBAC) MarshalTo

func (m *RBAC) MarshalTo(dAtA []byte) (int, error)

func (*RBAC) ProtoMessage

func (*RBAC) ProtoMessage()

func (*RBAC) Reset

func (m *RBAC) Reset()

func (*RBAC) Size

func (m *RBAC) Size() (n int)

func (*RBAC) String

func (m *RBAC) String() string

func (*RBAC) Unmarshal

func (m *RBAC) Unmarshal(dAtA []byte) error

func (*RBAC) Validate

func (m *RBAC) Validate() error

Validate checks the field values on RBAC with the rules defined in the proto definition for this message. If any rules are violated, an error is returned.

func (*RBAC) XXX_DiscardUnknown

func (m *RBAC) XXX_DiscardUnknown()

func (*RBAC) XXX_Marshal

func (m *RBAC) XXX_Marshal(b []byte, deterministic bool) ([]byte, error)

func (*RBAC) XXX_Merge

func (m *RBAC) XXX_Merge(src proto.Message)

func (*RBAC) XXX_Size

func (m *RBAC) XXX_Size() int

func (*RBAC) XXX_Unmarshal

func (m *RBAC) XXX_Unmarshal(b []byte) error

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.

type RBAC_EnforcementType

type RBAC_EnforcementType int32

const (
	// Apply RBAC policies when the first byte of data arrives on the connection.
	RBAC_ONE_TIME_ON_FIRST_BYTE RBAC_EnforcementType = 0
	// Continuously apply RBAC policies as data arrives. Use this mode when
	// using RBAC with message oriented protocols such as Mongo, MySQL, Kafka,
	// etc. when the protocol decoders emit dynamic metadata such as the
	// resources being accessed and the operations on the resources.
	RBAC_CONTINUOUS RBAC_EnforcementType = 1
)

func (RBAC_EnforcementType) EnumDescriptor

func (RBAC_EnforcementType) EnumDescriptor() ([]byte, []int)

func (RBAC_EnforcementType) String

func (x RBAC_EnforcementType) String() string