Documentation
¶
Index ¶
- Constants
- Variables
- func Generate(length, numDigits, numSymbols int, noUpper, allowRepeat bool) (string, error)
- func HashPassword(password string) ([]byte, error)
- func MustGenerate(length, numDigits, numSymbols int, noUpper, allowRepeat bool) string
- func VerifyPassword(passwordHash, password string) error
- type Generator
- type GeneratorInput
Constants ¶
const ( // LowerLetters is the list of lowercase letters. LowerLetters = "abcdefghijklmnopqrstuvwxyz" // UpperLetters is the list of uppercase letters. UpperLetters = "ABCDEFGHIJKLMNOPQRSTUVWXYZ" // Digits is the list of permitted digits. Digits = "0123456789" // Symbols is the list of symbols. Symbols = "~!@#$%^&*()_+`-={}|[]\\:\"<>?,./" )
Variables ¶
var ( // ErrExceedsTotalLength is the error returned with the number of digits and // symbols is greater than the total length. ErrExceedsTotalLength = errors.New("number of digits and symbols must be less than total length") // ErrLettersExceedsAvailable is the error returned with the number of letters // exceeds the number of available letters and repeats are not allowed. ErrLettersExceedsAvailable = errors.New("number of letters exceeds available letters and repeats are not allowed") // ErrDigitsExceedsAvailable is the error returned with the number of digits // exceeds the number of available digits and repeats are not allowed. ErrDigitsExceedsAvailable = errors.New("number of digits exceeds available digits and repeats are not allowed") // ErrSymbolsExceedsAvailable is the error returned with the number of symbols // exceeds the number of available symbols and repeats are not allowed. ErrSymbolsExceedsAvailable = errors.New("number of symbols exceeds available symbols and repeats are not allowed") )
Functions ¶
func HashPassword ¶
HashPassword creates a bcrypt password hash
func MustGenerate ¶
MustGenerate is the package shortcut for Generator.MustGenerate.
func VerifyPassword ¶
VerifyPassword compares password and the hashed password
Types ¶
type Generator ¶
type Generator struct {
// contains filtered or unexported fields
}
Generator is the stateful generator which can be used to customize the list of letters, digits, and/or symbols.
func NewGenerator ¶
func NewGenerator(i *GeneratorInput) (*Generator, error)
NewGenerator creates a new Generator from the specified configuration. If no input is given, all the default values are used. This function is safe for concurrent use.
func (*Generator) Generate ¶
func (g *Generator) Generate(length, numDigits, numSymbols int, noUpper, allowRepeat bool) (string, error)
Generate generates a password with the given requirements. length is the total number of characters in the password. numDigits is the number of digits to include in the result. numSymbols is the number of symbols to include in the result. noUpper excludes uppercase letters from the results. allowRepeat allows characters to repeat.
The algorithm is fast, but it's not designed to be performant; it favors entropy over speed. This function is safe for concurrent use.
Source Files