hash

Documentation

Index

• Constants
• type Hasher
  • func NewSCrypt() Hasher
• type SCrypt
  • func (s SCrypt) CreateHash(secretKey string) (string, error)
  • func (s SCrypt) VerifyHash(hash, secretKey string) error

Constants

const Version = 1

Version is the hashing format version

Types

type Hasher

type Hasher interface {
	// CreateHash will return a hashed version of the secretKey, or an error
	CreateHash(secretKey string) (string, error)
	// VerifyHash will compare a secretKey and a hash, and return nil if they match
	VerifyHash(hash, secretKey string) error
}

Hasher is a generic interface for hashing algorithms

func NewSCrypt

func NewSCrypt() Hasher

NewSCrypt returns a scrypt hasher with recommended default values

type SCrypt

type SCrypt struct {
	N       int
	R       int
	P       int
	KeyLen  int
	SaltLen int
}

SCrypt contains all of the variables needed for scrypt hashing

func (SCrypt) CreateHash

func (s SCrypt) CreateHash(secretKey string) (string, error)

CreateHash will return a hashed version of the secretKey, or an error

func (SCrypt) VerifyHash

func (s SCrypt) VerifyHash(hash, secretKey string) error

VerifyHash will compare a secretKey and a hash, and return nil if they match