password

Documentation

Overview

Package password provides types and functions for password generation.

Index

• type Generator
  • func NewGenerator(options ...Option) Generator
  • func (g Generator) Password() string
• type Option
  • func MinLength(length int) Option
  • func Numbers(amount int) Option
  • func SpecialChars(amount int) Option
  • func Swap(shouldSwap bool) Option

Types

type Generator

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

Generator can generate passwords with a given configuration passed via functional Options in its constructor.

func NewGenerator

func NewGenerator(options ...Option) Generator

NewGenerator will create a Generator which can generate passwords. A number of Options can be passed to configure the resulting Generator.

func (Generator) Password

func (g Generator) Password() string

Password generates a password with the generators' configuration

type Option

type Option func(*Generator)

Option is the functional option type to allow variadic and generic configration of generators.

func MinLength

func MinLength(length int) Option

MinLength configures a minimum length for generated passwords.

func Numbers

func Numbers(amount int) Option

Numbers configures the exact amount of numbers in generated passwords.

func SpecialChars

func SpecialChars(amount int) Option

SpecialChars configures the exact amount of special characters in generated passwords.

func Swap

func Swap(shouldSwap bool) Option

Swap configures if vowels should be swapped with numbers