rbacv2

Documentation

Index

• Variables
• type RBAC
  • func (x *RBAC) ClearRules()
  • func (x *RBAC) ClearShadowRules()
  • func (x *RBAC) GetEnforcementType() RBAC_EnforcementType
  • func (x *RBAC) GetRules() *v2.RBAC
  • func (x *RBAC) GetShadowRules() *v2.RBAC
  • func (x *RBAC) GetStatPrefix() string
  • func (x *RBAC) HasRules() bool
  • func (x *RBAC) HasShadowRules() bool
  • func (*RBAC) ProtoMessage()
  • func (x *RBAC) ProtoReflect() protoreflect.Message
  • func (x *RBAC) Reset()
  • func (x *RBAC) SetEnforcementType(v RBAC_EnforcementType)
  • func (x *RBAC) SetRules(v *v2.RBAC)
  • func (x *RBAC) SetShadowRules(v *v2.RBAC)
  • func (x *RBAC) SetStatPrefix(v string)
  • func (x *RBAC) String() string
• type RBAC_EnforcementType
  • func (RBAC_EnforcementType) Descriptor() protoreflect.EnumDescriptor
  • func (x RBAC_EnforcementType) Enum() *RBAC_EnforcementType
  • func (x RBAC_EnforcementType) Number() protoreflect.EnumNumber
  • func (x RBAC_EnforcementType) String() string
  • func (RBAC_EnforcementType) Type() protoreflect.EnumType
• type RBAC_builder
  • func (b0 RBAC_builder) Build() *RBAC

Variables

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

Enum value maps for RBAC_EnforcementType.

var File_envoy_config_filter_network_rbac_v2_rbac_proto protoreflect.FileDescriptor

Types

type RBAC

type RBAC struct {

	// Specify the RBAC rules to be applied globally.
	// If absent, no enforcing RBAC policy will be applied.
	Rules *v2.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 *v2.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 */
	// contains filtered or unexported fields
}

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) ClearRules

func (x *RBAC) ClearRules()

func (*RBAC) ClearShadowRules

func (x *RBAC) ClearShadowRules()

func (*RBAC) GetEnforcementType

func (x *RBAC) GetEnforcementType() RBAC_EnforcementType

func (*RBAC) GetRules

func (x *RBAC) GetRules() *v2.RBAC

func (*RBAC) GetShadowRules

func (x *RBAC) GetShadowRules() *v2.RBAC

func (*RBAC) GetStatPrefix

func (x *RBAC) GetStatPrefix() string

func (*RBAC) HasRules

func (x *RBAC) HasRules() bool

func (*RBAC) HasShadowRules

func (x *RBAC) HasShadowRules() bool

func (*RBAC) ProtoMessage

func (*RBAC) ProtoMessage()

func (*RBAC) ProtoReflect

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

func (*RBAC) Reset

func (x *RBAC) Reset()

func (*RBAC) SetEnforcementType

func (x *RBAC) SetEnforcementType(v RBAC_EnforcementType)

func (*RBAC) SetRules

func (x *RBAC) SetRules(v *v2.RBAC)

func (*RBAC) SetShadowRules

func (x *RBAC) SetShadowRules(v *v2.RBAC)

func (*RBAC) SetStatPrefix

func (x *RBAC) SetStatPrefix(v string)

func (*RBAC) String

func (x *RBAC) String() string

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) Descriptor

func (RBAC_EnforcementType) Descriptor() protoreflect.EnumDescriptor

func (RBAC_EnforcementType) Enum

func (x RBAC_EnforcementType) Enum() *RBAC_EnforcementType

func (RBAC_EnforcementType) Number

func (x RBAC_EnforcementType) Number() protoreflect.EnumNumber

func (RBAC_EnforcementType) String

func (x RBAC_EnforcementType) String() string

func (RBAC_EnforcementType) Type

func (RBAC_EnforcementType) Type() protoreflect.EnumType

type RBAC_builder

type RBAC_builder struct {

	// Specify the RBAC rules to be applied globally.
	// If absent, no enforcing RBAC policy will be applied.
	Rules *v2.RBAC
	// 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 *v2.RBAC
	// The prefix to use when emitting statistics.
	StatPrefix string
	// 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
	// contains filtered or unexported fields
}

func (RBAC_builder) Build

func (b0 RBAC_builder) Build() *RBAC