raw

Documentation

Overview

Package raw provides a raw implementation of the modular-crypt-wrapped Argon2i primitive.

Index

• Constants
• Variables
• func Argon2(password string, salt []byte, time, memory uint32, threads uint8) string
• func Parse(stub string) (salt, hash []byte, version int, time, memory uint32, parallelism uint8, ...)

Constants

const RecommendedMemory uint32 = 32 * 1024

The current recommended memory for interactive logins.

const RecommendedThreads uint8 = 4

The current recommended number of threads for interactive logins.

const RecommendedTime uint32 = 4

The current recommended time value for interactive logins.

Variables

var ErrInvalidKeyValuePair = fmt.Errorf("invalid argon2 key-value pair")

Indicates that a key-value pair in the configuration part is malformed.

var ErrInvalidStub = fmt.Errorf("invalid argon2 password stub")

Indicates that a password hash or stub is invalid.

var ErrMissingMemory = fmt.Errorf("memory parameter (m) is missing")

Indicates that the memory parameter ("m") was mossing in the hash config part, even though it is required.

var ErrMissingParallelism = fmt.Errorf("parallelism parameter (p) is missing")

Indicates that the parallelism parameter ("p") was mossing in the hash config part, even though it is required.

var ErrMissingTime = fmt.Errorf("time parameter (t) is missing")

Indicates that the time parameter ("t") was mossing in the hash config part, even though it is required.

var ErrMissingVersion = fmt.Errorf("version parameter (v) is missing")

Indicates that the version parameter ("v") was missing in the version part, even though it is required.

var ErrParseConfig = fmt.Errorf("hash config section has wrong number of parameters")

Indicates that the hash config part had the wrong number of parameters.

var ErrParseVersion = fmt.Errorf("version section has wrong number of parameters")

Indicates that the version part had the wrong number of parameters.

Functions

func Argon2

func Argon2(password string, salt []byte, time, memory uint32, threads uint8) string

Wrapper for golang.org/x/crypto/argon2 implementing a sensible hashing interface.

password should be a UTF-8 plaintext password. salt should be a random salt value in binary form.

Time, memory, and threads are parameters to argon2.

Returns an argon2 encoded hash.

func Parse

func Parse(stub string) (salt, hash []byte, version int, time, memory uint32, parallelism uint8, err error)

Parses an argon2 encoded hash.

The format is as follows:

$argon2i$v=version$m=memory,t=time,p=threads$salt$hash   // hash
$argon2i$v=version$m=memory,t=time,p=threads$salt        // stub