argon2

package

v1.2.2 Latest Latest Go to latest Published: Feb 3, 2023 License: Apache-2.0 Imports: 6 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/go-encoder/encoder

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
func WithIterations(iterations uint32) types.Option
func WithKeyLen(len uint32) types.Option
func WithMemory(memory uint32) types.Option
func WithSalt(salt []byte) types.Option
func WithSaltLen(len uint32) types.Option
func WithThreads(threads uint8) types.Option
type Encoder

Constants ¶

View Source

const (
	DefaultMemory     uint32 = 64 * 1024
	DefaultIterations uint32 = 1
	DefaultThreads    uint8  = 4
)

Variables ¶

This section is empty.

Functions ¶

func WithIterations ¶ added in v1.2.0

func WithIterations(iterations uint32) types.Option

WithIterations configure the iterations for Encoder, default value is 1

func WithKeyLen ¶

func WithKeyLen(len uint32) types.Option

WithKeyLen configure the key length for Encoder, default value is 32

func WithMemory ¶

func WithMemory(memory uint32) types.Option

WithMemory configure the memory for Encoder, default value is 64 * 1024

func WithSalt ¶

func WithSalt(salt []byte) types.Option

WithSalt configure the salt value for Encoder, default automatically generate random strings

func WithSaltLen ¶

func WithSaltLen(len uint32) types.Option

WithSaltLen configure the salt length for Encoder, default value is 16

func WithThreads ¶

func WithThreads(threads uint8) types.Option

WithThreads configure the Threads for Encoder, default value is 4

Types ¶

type Encoder ¶

type Encoder struct {
	// The amount of memory used by the algorithm (in kibibytes).
	Memory uint32
	// The number of iterations over the memory.
	Iterations uint32
	// The number of threads (or lanes) used by the algorithm.
	// Recommended value is between 1 and runtime.NumCPU().
	Threads uint8
	// Length of the random salt. 16 bytes is recommended for password hashing.
	SaltLen uint32
	// Length of the generated key. 16 bytes or more is recommended.
	KeyLen uint32
	// contains filtered or unexported fields
}

func (*Encoder) Encode ¶

func (e *Encoder) Encode(src string) (string, error)

Encode returns the hash value of the given data

func (*Encoder) GetSalt ¶

func (e *Encoder) GetSalt() ([]byte, error)

GetSalt Returns the salt if present, otherwise nil

func (*Encoder) Hash ¶ added in v1.2.2

func (e *Encoder) Hash(src string) ([]byte, error)

Hash Generate and return a hash value in []byte format

func (*Encoder) Verify ¶

func (e *Encoder) Verify(hash, rawData string) (bool, error)

Verify compares a encoded data with its possible plaintext equivalent

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL