htpasswd

Documentation

Index

• Variables
• func CompareBasicAuth(storedCredential, user, password string) error
• func ExtractBasicAuth(basicAuthCredential string) (user, password string, err error)
• func ExtractBasicAuthFromContext(ctx context.Context) (user, password string, err error)

Variables

var (
	ErrInvalidUser             = errors.New("user is invalid")
	ErrFailedToParseBasicAuth  = errors.New("the provided basic authentication credentials are invalid")
	ErrMetadataNotFound        = errors.New("metadata not found")
	ErrAuthHeaderNotFound      = errors.New("authorization header not found")
	ErrFailedToDecodeBasicAuth = errors.New("failed to decode authorization header")
	ErrAuthHeaderInvalidFormat = errors.New("invalid authorization header format")
	ErrInvalidPassword         = errors.New("password is invalid")
)

Functions

func CompareBasicAuth

func CompareBasicAuth(storedCredential, user, password string) error

CompareBasicAuth compares a stored credential (username:password_hash) with a provided username and password. It uses bcrypt to securely compare the password hash stored in the credential with the provided password.

func ExtractBasicAuth

func ExtractBasicAuth(basicAuthCredential string) (user, password string, err error)

ExtractBasicAuth extracts the user and password or password hash from the given basic auth credential. The credential should be in the form "user:password" or "user:password_hahs".

func ExtractBasicAuthFromContext

func ExtractBasicAuthFromContext(ctx context.Context) (user, password string, err error)

ExtractBasicAuthFromContext extracts the user and password from the incoming context in gRPC request.