basic_authv3

Documentation

Index

• Variables
• type BasicAuth
  • func (*BasicAuth) Descriptor() ([]byte, []int)
  • func (x *BasicAuth) GetForwardUsernameHeader() string
  • func (x *BasicAuth) GetUsers() *v3.DataSource
  • func (*BasicAuth) ProtoMessage()
  • func (x *BasicAuth) ProtoReflect() protoreflect.Message
  • func (x *BasicAuth) Reset()
  • func (x *BasicAuth) String() string
• type BasicAuthPerRoute
  • func (*BasicAuthPerRoute) Descriptor() ([]byte, []int)
  • func (x *BasicAuthPerRoute) GetUsers() *v3.DataSource
  • func (*BasicAuthPerRoute) ProtoMessage()
  • func (x *BasicAuthPerRoute) ProtoReflect() protoreflect.Message
  • func (x *BasicAuthPerRoute) Reset()
  • func (x *BasicAuthPerRoute) String() string

Variables

var File_envoy_extensions_filters_http_basic_auth_v3_basic_auth_proto protoreflect.FileDescriptor

Types

type BasicAuth

type BasicAuth struct {

	// Username-password pairs used to verify user credentials in the "Authorization" header.
	// The value needs to be the htpasswd format.
	// Reference to https://httpd.apache.org/docs/2.4/programs/htpasswd.html
	Users *v3.DataSource `protobuf:"bytes,1,opt,name=users,proto3" json:"users,omitempty"`
	// This field specifies the header name to forward a successfully authenticated user to
	// the backend. The header will be added to the request with the username as the value.
	//
	// If it is not specified, the username will not be forwarded.
	ForwardUsernameHeader string `` /* 126-byte string literal not displayed */
	// contains filtered or unexported fields
}

Basic HTTP authentication.

Example:

.. code-block:: yaml

users:
  inline_string: |-
    user1:{SHA}hashed_user1_password
    user2:{SHA}hashed_user2_password

func (*BasicAuth) Descriptor

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

Deprecated: Use BasicAuth.ProtoReflect.Descriptor instead.

func (*BasicAuth) GetForwardUsernameHeader

func (x *BasicAuth) GetForwardUsernameHeader() string

func (*BasicAuth) GetUsers

func (x *BasicAuth) GetUsers() *v3.DataSource

func (*BasicAuth) ProtoMessage

func (*BasicAuth) ProtoMessage()

func (*BasicAuth) ProtoReflect

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

func (*BasicAuth) Reset

func (x *BasicAuth) Reset()

func (*BasicAuth) String

func (x *BasicAuth) String() string

type BasicAuthPerRoute

type BasicAuthPerRoute struct {

	// Username-password pairs for this route.
	Users *v3.DataSource `protobuf:"bytes,1,opt,name=users,proto3" json:"users,omitempty"`
	// contains filtered or unexported fields
}

Extra settings that may be added to per-route configuration for a virtual host or a cluster.

func (*BasicAuthPerRoute) Descriptor

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

Deprecated: Use BasicAuthPerRoute.ProtoReflect.Descriptor instead.

func (*BasicAuthPerRoute) GetUsers

func (x *BasicAuthPerRoute) GetUsers() *v3.DataSource

func (*BasicAuthPerRoute) ProtoMessage

func (*BasicAuthPerRoute) ProtoMessage()

func (*BasicAuthPerRoute) ProtoReflect

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

func (*BasicAuthPerRoute) Reset

func (x *BasicAuthPerRoute) Reset()

func (*BasicAuthPerRoute) String

func (x *BasicAuthPerRoute) String() string