gpswd

README

gpswd - Golang SQL Password Column

gpswd.Password implements interfaces sql.Scanner and driver.Valuer.

Documentation

Index

• Variables
• type Password
  • func NewPassword(plain string, salt []byte) *Password
  • func (p *Password) Compare(passwd string, salt []byte) error
  • func (p *Password) Encrypt() error
  • func (p *Password) Encrypted() bool
  • func (p *Password) Scan(value any) error
  • func (p *Password) Value() (driver.Value, error)

Variables

var (
	ErrEmptyPassword   = errors.New("empty passowrd")
	ErrNotYetEncrypted = errors.New("not yet encrypted")
	ErrMismatched      = errors.New("mismatched password")
)

var BeforeEncrypt = func(plain, salt []byte) ([]byte, error) {
	return append(plain, salt...), nil
}

BeforeEncrypt is called before encryption and concats plain passwords and salt

var HashCost = 12

HashCost is cost of generating password hash

Types

type Password

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

Password

func NewPassword

func NewPassword(plain string, salt []byte) *Password

NewPassword returns Password

func (*Password) Compare

func (p *Password) Compare(passwd string, salt []byte) error

Compare compares with password and returns nil if matched

func (*Password) Encrypt

func (p *Password) Encrypt() error

Encrypt encrypts plain password

func (*Password) Encrypted

func (p *Password) Encrypted() bool

Encrypted returns true if encrypted

func (*Password) Scan

func (p *Password) Scan(value any) error

Scan is an implementation interface sql.Scanner

func (*Password) Value

func (p *Password) Value() (driver.Value, error)

Value is an implementation interface driver.Valuer