basic_authv3

package
v0.0.0-...-cae1a60 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: May 13, 2024 License: Apache-2.0 Imports: 19 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var File_envoy_extensions_filters_http_basic_auth_v3_basic_auth_proto protoreflect.FileDescriptor

Functions

This section is empty.

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 deprecated 

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

func (*BasicAuth) Validate 

func (m *BasicAuth) Validate() error

Validate checks the field values on BasicAuth with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*BasicAuth) ValidateAll 

func (m *BasicAuth) ValidateAll() error

ValidateAll checks the field values on BasicAuth with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in BasicAuthMultiError, or nil if none found.

type BasicAuthMultiError 

type BasicAuthMultiError []error

BasicAuthMultiError is an error wrapping multiple validation errors returned by BasicAuth.ValidateAll() if the designated constraints aren't met.

func (BasicAuthMultiError) AllErrors 

func (m BasicAuthMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BasicAuthMultiError) Error 

func (m BasicAuthMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

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 deprecated 

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

func (*BasicAuthPerRoute) Validate 

func (m *BasicAuthPerRoute) Validate() error

Validate checks the field values on BasicAuthPerRoute with the rules defined in the proto definition for this message. If any rules are violated, the first error encountered is returned, or nil if there are no violations.

func (*BasicAuthPerRoute) ValidateAll 

func (m *BasicAuthPerRoute) ValidateAll() error

ValidateAll checks the field values on BasicAuthPerRoute with the rules defined in the proto definition for this message. If any rules are violated, the result is a list of violation errors wrapped in BasicAuthPerRouteMultiError, or nil if none found.

type BasicAuthPerRouteMultiError 

type BasicAuthPerRouteMultiError []error

BasicAuthPerRouteMultiError is an error wrapping multiple validation errors returned by BasicAuthPerRoute.ValidateAll() if the designated constraints aren't met.

func (BasicAuthPerRouteMultiError) AllErrors 

func (m BasicAuthPerRouteMultiError) AllErrors() []error

AllErrors returns a list of validation violation errors.

func (BasicAuthPerRouteMultiError) Error 

func (m BasicAuthPerRouteMultiError) Error() string

Error returns a concatenation of all the error messages it wraps.

type BasicAuthPerRouteValidationError 

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

BasicAuthPerRouteValidationError is the validation error returned by BasicAuthPerRoute.Validate if the designated constraints aren't met.

func (BasicAuthPerRouteValidationError) Cause 

func (e BasicAuthPerRouteValidationError) Cause() error

Cause function returns cause value.

func (BasicAuthPerRouteValidationError) Error 

func (e BasicAuthPerRouteValidationError) Error() string

Error satisfies the builtin error interface

func (BasicAuthPerRouteValidationError) ErrorName 

func (e BasicAuthPerRouteValidationError) ErrorName() string

ErrorName returns error name.

func (BasicAuthPerRouteValidationError) Field 

func (e BasicAuthPerRouteValidationError) Field() string

Field function returns field value.

func (BasicAuthPerRouteValidationError) Key 

func (e BasicAuthPerRouteValidationError) Key() bool

Key function returns key value.

func (BasicAuthPerRouteValidationError) Reason 

func (e BasicAuthPerRouteValidationError) Reason() string

Reason function returns reason value.

type BasicAuthValidationError 

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

BasicAuthValidationError is the validation error returned by BasicAuth.Validate if the designated constraints aren't met.

func (BasicAuthValidationError) Cause 

func (e BasicAuthValidationError) Cause() error

Cause function returns cause value.

func (BasicAuthValidationError) Error 

func (e BasicAuthValidationError) Error() string

Error satisfies the builtin error interface

func (BasicAuthValidationError) ErrorName 

func (e BasicAuthValidationError) ErrorName() string

ErrorName returns error name.

func (BasicAuthValidationError) Field 

func (e BasicAuthValidationError) Field() string

Field function returns field value.

func (BasicAuthValidationError) Key 

func (e BasicAuthValidationError) Key() bool

Key function returns key value.

func (BasicAuthValidationError) Reason 

func (e BasicAuthValidationError) Reason() string

Reason function returns reason value.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.