butcher

README

go-butcher

Butcher for progressive hashing password

Status: POC (aka Not Production Ready)

Algorithms supported :

• Argon2i
• Bcrypt+Blake2b-512
• PBKDF2+Blake2b-512 (default)
• PBKDF2+SHA512
• PBKDF2+Keccak-512
• Bcrypt+SHA512

Output samples

"argon2i$v=19$m=4096,t=3,p=1$ogzBAhKqTQzqKb0RrcH/oXpJWAAdUYkvxi56helLZZwDkPPzJzrWlkjPLDvl7KOQ4xwfJUl6lThE/mCBAvdJKg$5FG9SXMmRtr6WmucA0FvTaUrlcTytPr9YcRdzUFgS5M"
"bcrypt+blake2b-512$$c=12$/HOypkj8TUJcYSrbvFcnk26Yv9svYQOHpqnr66OrsvCjmSaKUdBX/CxMr7TKWh/LzKe07RNPow6X+Xj2b50zXw$JDJhJDEyJENZSjRWLnFXWmdQbGFIQ29DNkNhcHVpZ2tWdWhqeFVxUjhDMEo1Q2FsSVNpclBIcTc5NEh1"
"pbkdf2+blake2b-512$$i=50000,l=64$BVs5yEUcf16+aUuQ0OceX2vnGyr6gJ+V9GfBM5abreDoTNvjdbjjKvE+ITrUJW+ePER6Nd6Xx+gkK0f4eMRUtQ$tAmYg+4mHEcs1jY1x/QduqKiILbO6oT1rxpzjMCqVO1xSmrnQTc1ApzT0XrX8nBfzYwE8amKKWz6+qaRNjw70A"
"pbkdf2+sha3-512$$i=50000,l=64$ozRBsjR9SAcM1wlOUJlgXCLB8c1SK1JMo1geDhPHzQrgZ7QS4SU99IASOcqCgMZQi4WRxBIcMT0/XPNnDlh+AQ$2Rdn9csLROjPwCDdV2gKLvdSNdYu9ZuDuTKztMETPsMnblz+UEUO3Se+StxwkH604OgyOsg7AO3WOIlrP9S1NA"
"pbkdf2+sha512$$i=50000,l=64$AgwnOOpIsc+35GVqoE8i32KeAyRK1c4GMLLMbyoOc6jMPLgFL14ZWujTYG0MxxIUN9svqc67ve/+qkCIgpxBGA$99WISIpNRSABtfMolDcSe27PqSfzBSuAEyvgEzcx2iVOQFGHfNMUNMp4b6l9Bi4dBkwXSVtg02sI+gFvvOViCw"
"bcrypt+sha512$$c=12$U8hQ/zeQyz36KE2GcoyLclZz0B82blBBKBOZ6SnfQLGBetMQ+aMIoZW7A8JBz5QyWkE7E+R0in8h6+Rx204amA$JDJhJDEyJGlpTXE2WjlsOTJrS1FyTVBNOXQ1dy5uSUY2TzJkZW9tQUNxUWZWMGVqd2VDWFdzQ2wwQ0tl"

Documentation

Index

• Constants
• Variables
• func FixedNonce(salt []byte) func() []byte
• func Hash(password []byte) (string, error)
• func NeedsUpgrade(encoded []byte) bool
• func RandomNonce(length int) func() []byte
• func Verify(encoded []byte, password []byte) (bool, error)
• type Butcher
  • func New(options ...Option) (*Butcher, error)
  • func (b *Butcher) Hash(password []byte) (string, error)
• type Option
  • func WithAlgorithm(algo string) Option
  • func WithNonce(factory func() []byte) Option

Constants

const (
	// DefaultAlgorithm defines the default algorithm to use when not specified
	DefaultAlgorithm = hasher.Pbkdf2Blake2b512
)

Variables

var (
	// DefaultNonce defines the default nonce generation factory to use when not specified
	DefaultNonce = RandomNonce(64)
)

var (
	// ErrButcherStrategyNotSupported is raised when caller try to invoke not supported algorithm
	ErrButcherStrategyNotSupported = errors.New("butcher: given strategy is not supported")
)

Functions

func FixedNonce

func FixedNonce(salt []byte) func() []byte

FixedNonce returns a nonce factory that returns the given salt

func Hash

func Hash(password []byte) (string, error)

Hash password using default instance

func NeedsUpgrade

func NeedsUpgrade(encoded []byte) bool

NeedsUpgrade returns the password hash upgrade need when DefaultAlgorithm is changed

func RandomNonce

func RandomNonce(length int) func() []byte

RandomNonce returns a nonce factory that returns a random length bound salt

func Verify

func Verify(encoded []byte, password []byte) (bool, error)

Verify cleartext password with encoded one

Types

type Butcher

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

Butcher defines the hasher configuration

func New

func New(options ...Option) (*Butcher, error)

New butcher instance is buildded according options

func (*Butcher) Hash

func (b *Butcher) Hash(password []byte) (string, error)

Hash the given password with the hash strategy

type Option

type Option func(*Butcher) error

Option is the butcher option setting function signature

func WithAlgorithm

func WithAlgorithm(algo string) Option

WithAlgorithm defines the algorithm to use for hashing password

func WithNonce

func WithNonce(factory func() []byte) Option

WithNonce defines the nonce factory value for salt generation