envoy_extensions_filters_network_client_ssl_auth_v3

Documentation

Index

• Variables
• type ClientSSLAuth
  • func (*ClientSSLAuth) Descriptor() ([]byte, []int)
  • func (x *ClientSSLAuth) GetAuthApiCluster() string
  • func (x *ClientSSLAuth) GetIpWhiteList() []*v3.CidrRange
  • func (x *ClientSSLAuth) GetRefreshDelay() *duration.Duration
  • func (x *ClientSSLAuth) GetStatPrefix() string
  • func (*ClientSSLAuth) ProtoMessage()
  • func (x *ClientSSLAuth) ProtoReflect() protoreflect.Message
  • func (x *ClientSSLAuth) Reset()
  • func (x *ClientSSLAuth) String() string
  • func (m *ClientSSLAuth) Validate() error
• type ClientSSLAuthValidationError
  • func (e ClientSSLAuthValidationError) Cause() error
  • func (e ClientSSLAuthValidationError) Error() string
  • func (e ClientSSLAuthValidationError) ErrorName() string
  • func (e ClientSSLAuthValidationError) Field() string
  • func (e ClientSSLAuthValidationError) Key() bool
  • func (e ClientSSLAuthValidationError) Reason() string

Variables

var File_envoy_extensions_filters_network_client_ssl_auth_v3_client_ssl_auth_proto protoreflect.FileDescriptor

Types

type ClientSSLAuth

type ClientSSLAuth struct {

	// The :ref:`cluster manager <arch_overview_cluster_manager>` cluster that runs
	// the authentication service. The filter will connect to the service every 60s to fetch the list
	// of principals. The service must support the expected :ref:`REST API
	// <config_network_filters_client_ssl_auth_rest_api>`.
	AuthApiCluster string `protobuf:"bytes,1,opt,name=auth_api_cluster,json=authApiCluster,proto3" json:"auth_api_cluster,omitempty"`
	// The prefix to use when emitting :ref:`statistics
	// <config_network_filters_client_ssl_auth_stats>`.
	StatPrefix string `protobuf:"bytes,2,opt,name=stat_prefix,json=statPrefix,proto3" json:"stat_prefix,omitempty"`
	// Time in milliseconds between principal refreshes from the
	// authentication service. Default is 60000 (60s). The actual fetch time
	// will be this value plus a random jittered value between
	// 0-refresh_delay_ms milliseconds.
	RefreshDelay *duration.Duration `protobuf:"bytes,3,opt,name=refresh_delay,json=refreshDelay,proto3" json:"refresh_delay,omitempty"`
	// An optional list of IP address and subnet masks that should be white
	// listed for access by the filter. If no list is provided, there is no
	// IP allowlist.
	IpWhiteList []*v3.CidrRange `protobuf:"bytes,4,rep,name=ip_white_list,json=ipWhiteList,proto3" json:"ip_white_list,omitempty"`
	// contains filtered or unexported fields
}

func (*ClientSSLAuth) Descriptor

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

Deprecated: Use ClientSSLAuth.ProtoReflect.Descriptor instead.

func (*ClientSSLAuth) GetAuthApiCluster

func (x *ClientSSLAuth) GetAuthApiCluster() string

func (*ClientSSLAuth) GetIpWhiteList

func (x *ClientSSLAuth) GetIpWhiteList() []*v3.CidrRange

func (*ClientSSLAuth) GetRefreshDelay

func (x *ClientSSLAuth) GetRefreshDelay() *duration.Duration

func (*ClientSSLAuth) GetStatPrefix

func (x *ClientSSLAuth) GetStatPrefix() string

func (*ClientSSLAuth) ProtoMessage

func (*ClientSSLAuth) ProtoMessage()

func (*ClientSSLAuth) ProtoReflect

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

func (*ClientSSLAuth) Reset

func (x *ClientSSLAuth) Reset()

func (*ClientSSLAuth) String

func (x *ClientSSLAuth) String() string

func (*ClientSSLAuth) Validate

func (m *ClientSSLAuth) Validate() error

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

type ClientSSLAuthValidationError

type ClientSSLAuthValidationError struct {
	// contains filtered or unexported fields
}

ClientSSLAuthValidationError is the validation error returned by ClientSSLAuth.Validate if the designated constraints aren't met.

func (ClientSSLAuthValidationError) Cause

func (e ClientSSLAuthValidationError) Cause() error

Cause function returns cause value.

func (ClientSSLAuthValidationError) Error

func (e ClientSSLAuthValidationError) Error() string

Error satisfies the builtin error interface

func (ClientSSLAuthValidationError) ErrorName

func (e ClientSSLAuthValidationError) ErrorName() string

ErrorName returns error name.

func (ClientSSLAuthValidationError) Field

func (e ClientSSLAuthValidationError) Field() string

Field function returns field value.

func (ClientSSLAuthValidationError) Key

func (e ClientSSLAuthValidationError) Key() bool

Key function returns key value.

func (ClientSSLAuthValidationError) Reason

func (e ClientSSLAuthValidationError) Reason() string

Reason function returns reason value.