credential

Documentation

Overview

Package credential provides different types of credentials for authentication.

Index

• Variables
• type BasicAuth
  • func NewBasicAuth(username, password string) (*BasicAuth, error)
  • func NewBasicAuthFromText(credential string) (*BasicAuth, error)
  • func (bC *BasicAuth) ToBase64() string

Variables

var (
	ErrMissingCredential        = customerror.NewMissingError("credential", "", nil)
	ErrUsernamePasswordRequired = customerror.NewRequiredError("username, and password are", "", nil)
)

Types

type BasicAuth

type BasicAuth struct {
	Username string `json:"username" validate:"required,gte=3"`
	Password string `json:"password" validate:"required,gte=3"`
}

BasicAuth is the basic authentication credential definition.

See: https://developer.mozilla.org/en-US/docs/Web/HTTP/Authentication#basic_authentication_scheme

func NewBasicAuth

func NewBasicAuth(username, password string) (*BasicAuth, error)

NewBasicAuth is the BasicAuth factory.

func NewBasicAuthFromText

func NewBasicAuthFromText(credential string) (*BasicAuth, error)

NewBasicAuthFromText is a BasicAuth factory that automatically parses `credential` from text.

func (*BasicAuth) ToBase64

func (bC *BasicAuth) ToBase64() string

ToBase64 converts a basic auth credential to the base64 format.