authentication

README

What does this directory DO?

The primary authentication.go file defines structures and methods for PasswordSession, PasswordInfo, and Token. It also provides the ValidatePassword() method used to confirm user passwords, and a CompileLocksmithPassword() function to generate a hashed password.

Documentation

Index

• func GenerateRandomBytes(n int) ([]byte, error)
• func GenerateRandomString(n int) (string, error)
• func GenerateRandomStringURLSafe(n int) (string, error)
• func ValidatePassword(locksmithPassword PasswordInfo, inputPassword string) (bool, error)
• type PasswordInfo
  • func CompileLocksmithPassword(password string, saltString ...string) (PasswordInfo, error)
  • func PasswordInfoFromMap(passinfo map[string]interface{}) PasswordInfo
  • func (p PasswordInfo) ToMap() map[string]interface{}
• type PasswordSession
  • func PasswordSessionFromJson(data string) (PasswordSession, error)
  • func (p PasswordSession) FromMap(input map[string]interface{}) PasswordSession
  • func (p PasswordSession) IsExpired() bool
  • func (p PasswordSession) Marshal() ([]byte, error)
  • func (p PasswordSession) ToMap() map[string]interface{}
• type PasswordSessions
  • func (p PasswordSessions) FromMap(input []map[string]interface{}) []PasswordSession
  • func (p PasswordSessions) ToMap() []map[string]interface{}
• type Token
  • func ParseToken(cookieValue string) (Token, error)

Functions

func GenerateRandomBytes

func GenerateRandomBytes(n int) ([]byte, error)

GenerateRandomBytes returns securely generated random bytes. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func GenerateRandomString

func GenerateRandomString(n int) (string, error)

GenerateRandomString returns a securely generated random string. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func GenerateRandomStringURLSafe

func GenerateRandomStringURLSafe(n int) (string, error)

GenerateRandomStringURLSafe returns a URL-safe, base64 encoded securely generated random string. It will return an error if the system's secure random number generator fails to function correctly, in which case the caller should not continue.

func ValidatePassword

func ValidatePassword(locksmithPassword PasswordInfo, inputPassword string) (bool, error)

Types

type PasswordInfo

type PasswordInfo struct {
	Password            string                `json:"password" bson:"password"`
	Salt                string                `json:"salt" bson:"salt"`
	WebAuthnCredentials []webauthn.Credential `json:"webauthn" bson:"webauthn"`
}

func CompileLocksmithPassword

func CompileLocksmithPassword(password string, saltString ...string) (PasswordInfo, error)

func PasswordInfoFromMap

func PasswordInfoFromMap(passinfo map[string]interface{}) PasswordInfo

func (PasswordInfo) ToMap

func (p PasswordInfo) ToMap() map[string]interface{}

type PasswordSession

type PasswordSession struct {
	Token     string `json:"token" bson:"token"`
	ExpiresAt int64  `json:"expire" bson:"expire"`
}

func PasswordSessionFromJson

func PasswordSessionFromJson(data string) (PasswordSession, error)

func (PasswordSession) FromMap

func (p PasswordSession) FromMap(input map[string]interface{}) PasswordSession

func (PasswordSession) IsExpired

func (p PasswordSession) IsExpired() bool

func (PasswordSession) Marshal

func (p PasswordSession) Marshal() ([]byte, error)

func (PasswordSession) ToMap

func (p PasswordSession) ToMap() map[string]interface{}

type PasswordSessions

type PasswordSessions []PasswordSession

func (PasswordSessions) FromMap

func (p PasswordSessions) FromMap(input []map[string]interface{}) []PasswordSession

func (PasswordSessions) ToMap

func (p PasswordSessions) ToMap() []map[string]interface{}

type Token

type Token struct {
	Token    string
	Username string
}

func ParseToken

func ParseToken(cookieValue string) (Token, error)