package
0.2.25
Repository: https://github.com/go-crypt/crypt.git
Documentation: pkg.go.dev

# Functions

Decode the encoded digest into a algorithm.Digest.
DecodeVariant the encoded digest into a algorithm.Digest provided it matches the provided argon2.Variant.
New returns a new argon2.Hasher with the provided functional options applied.
NewVariant converts an identifier string to a argon2.Variant.
RegisterDecoder the decoder with the algorithm.DecoderRegister.
RegisterDecoderArgon2d registers specifically the argon2d decoder variant with the algorithm.DecoderRegister.
RegisterDecoderArgon2i registers specifically the argon2i decoder variant with the algorithm.DecoderRegister.
RegisterDecoderArgon2id registers specifically the argon2id decoder variant with the algorithm.DecoderRegister.
WithIterations is an alias for WithT.
WithK satisfies the argon2.Opt type for the argon2.Hasher and sets input 'T' known as the tag length.
WithKeyLength is an alias for WithK.
WithM satisfies the argon2.Opt type for the argon2.Hasher and sets input 'm' known as the memory size.
WithMemoryInKiB is an alias for WithM.
WithP satisfies the argon2.Opt type for the argon2.Hasher and sets input 'p' known as the degree of parallelism.
WithParallelism is an alias for WithP.
WithProfileRFC9106LowMemory is the recommended low memory RFC9106 profile.
WithProfileRFC9106Recommended is the recommended standard RFC9106 profile.
WithS satisfies the argon2.Opt type for the argon2.Hasher and sets the length of input 'S' known as the salt length.
WithSaltLength is an alias for WithS.
WithT satisfies the argon2.Opt type for the argon2.Hasher and sets input 't' known as the number of passes.
WithTagLength is an alias for WithK.
WithVariant is used to configure the argon2.Variant of the resulting argon2.Digest.
WithVariantD satisfies the argon2.Opt type and sets the variant as argon2.VariantD.
WithVariantI satisfies the argon2.Opt type and sets the variant as argon2.VariantI.
WithVariantID satisfies the argon2.Opt type and sets the variant as argon2.VariantID.
WithVariantName uses the variant name or identifier to configure the argon2.Variant of the resulting argon2.Digest.

# Constants

AlgIdentifierVariantD is the identifier used in encoded argon2d variants of this algorithm.
AlgIdentifierVariantI is the identifier used in encoded argon2i variants of this algorithm.
AlgIdentifierVariantID is the identifier used in encoded argon2id variants of this algorithm.
AlgName is the name for this algorithm.
EncodingFmt is the encoding format for this algorithm.
IterationsDefault is the default number of passes.
IterationsMax is the maximum number of passes input.
IterationsMin is the minimum number of passes input.
KeyLengthDefault is the default key length.
KeyLengthMax is the maximum tag length output.
KeyLengthMin is the minimum tag length output.
MemoryDefault represents the default memory value.
MemoryMax is the maximum input for memory.
MemoryMin is the minimum input for memory.
MemoryMinParallelismMultiplier is the parallelism multiplier which determines the minimum memory.
MemoryRoundingParallelismMultiplier is the parallelism multiplier which determines the actual memory value.
ParallelismDefault is the default parallelism factor.
ParallelismMax is the maximum parallelism factor input.
ParallelismMin is the minimum parallelism factor input.
PasswordInputSizeMax is the maximum input for the password content.
ProfileRFC9106LowMemory is the RFC9106 low memory profile.
ProfileRFC9106Recommended is the RFC9106 recommended profile.
SaltLengthMax is the maximum salt length input/output.
SaltLengthMin is the minimum salt length input/output.
VariantD is the argon2d variant of the argon2.Digest.
VariantI is the argon2i variant of the argon2.Digest.
VariantID is the argon2id variant of the argon2.Digest.
VariantNone is a variant of the argon2.Digest which is unknown.

# Structs

Digest is a digest which handles Argon2 hashes like Argon2id, Argon2i, and Argon2d.
Hasher is a crypt.Hash for Argon2 which can be initialized via argon2.New using a functional options pattern.

# Type aliases

Opt describes the functional option pattern for the argon2.Hasher.
Profile represents a hashing profile for Argon2Hash.
Variant is a variant of the argon2.Digest.