Documentation
¶
Index ¶
- Variables
- type BasicAuth
- func (*BasicAuth) Descriptor() ([]byte, []int)deprecated
- func (x *BasicAuth) GetUsers() *v3.DataSource
- func (*BasicAuth) ProtoMessage()
- func (x *BasicAuth) ProtoReflect() protoreflect.Message
- func (x *BasicAuth) Reset()
- func (x *BasicAuth) String() string
- func (m *BasicAuth) Validate() error
- func (m *BasicAuth) ValidateAll() error
- type BasicAuthMultiError
- type BasicAuthValidationError
Constants ¶
This section is empty.
Variables ¶
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"`
// 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) GetUsers ¶
func (x *BasicAuth) GetUsers() *v3.DataSource
func (*BasicAuth) ProtoMessage ¶
func (*BasicAuth) ProtoMessage()
func (*BasicAuth) ProtoReflect ¶
func (x *BasicAuth) ProtoReflect() protoreflect.Message
func (*BasicAuth) Validate ¶
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 ¶
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 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