v2

Documentation

Overview

Package v2 is a generated protocol buffer package.

It is generated from these files:

envoy/config/filter/network/client_ssl_auth/v2/client_ssl_auth.proto

It has these top-level messages:

ClientSSLAuth

Index

• Variables
• type ClientSSLAuth
  • func (*ClientSSLAuth) Descriptor() ([]byte, []int)
  • func (m *ClientSSLAuth) GetAuthApiCluster() string
  • func (m *ClientSSLAuth) GetIpWhiteList() []*envoy_api_v2_core1.CidrRange
  • func (m *ClientSSLAuth) GetRefreshDelay() *time.Duration
  • func (m *ClientSSLAuth) GetStatPrefix() string
  • func (m *ClientSSLAuth) Marshal() (dAtA []byte, err error)
  • func (m *ClientSSLAuth) MarshalTo(dAtA []byte) (int, error)
  • func (*ClientSSLAuth) ProtoMessage()
  • func (m *ClientSSLAuth) Reset()
  • func (m *ClientSSLAuth) Size() (n int)
  • func (m *ClientSSLAuth) String() string
  • func (m *ClientSSLAuth) Unmarshal(dAtA []byte) error
  • func (m *ClientSSLAuth) Validate() error
• type ClientSSLAuthValidationError
  • func (e ClientSSLAuthValidationError) Error() string

Variables

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

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 *time.Duration `protobuf:"bytes,3,opt,name=refresh_delay,json=refreshDelay,stdduration" 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 white list.
	IpWhiteList []*envoy_api_v2_core1.CidrRange `protobuf:"bytes,4,rep,name=ip_white_list,json=ipWhiteList" json:"ip_white_list,omitempty"`
}

func (*ClientSSLAuth) Descriptor

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

func (*ClientSSLAuth) GetAuthApiCluster

func (m *ClientSSLAuth) GetAuthApiCluster() string

func (*ClientSSLAuth) GetIpWhiteList

func (m *ClientSSLAuth) GetIpWhiteList() []*envoy_api_v2_core1.CidrRange

func (*ClientSSLAuth) GetRefreshDelay

func (m *ClientSSLAuth) GetRefreshDelay() *time.Duration

func (*ClientSSLAuth) GetStatPrefix

func (m *ClientSSLAuth) GetStatPrefix() string

func (*ClientSSLAuth) Marshal

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

func (*ClientSSLAuth) MarshalTo

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

func (*ClientSSLAuth) ProtoMessage

func (*ClientSSLAuth) ProtoMessage()

func (*ClientSSLAuth) Reset

func (m *ClientSSLAuth) Reset()

func (*ClientSSLAuth) Size

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

func (*ClientSSLAuth) String

func (m *ClientSSLAuth) String() string

func (*ClientSSLAuth) Unmarshal

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

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 {
	Field  string
	Reason string
	Cause  error
	Key    bool
}

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

func (ClientSSLAuthValidationError) Error

func (e ClientSSLAuthValidationError) Error() string

Error satisfies the builtin error interface