package crypt

Import Path
	go.pact.im/x/crypt (on go.dev)

Dependency Relation
	imports 11 packages, and imported by 0 packages

Involved Source Files

	      argon2.go
	      builtin.go
	   #d crypt.go
		Package crypt provides a UNIX crypt-style API for password hashing using
		structured hashes in PHC format.

		# Built-in functions

		This package provides the built-in implementations for widely used password
		hashing algorithms with reasonable default parameter values.

		## Argon2

		Argon2 implementation supports Argon2i and Argon2id variants, and requires
		explicit memory, iterations and parallelism parameters.

		 $argon2<variant>[$v=<version>]$m=<memory>,t=<iterations>,p=<parallelism>[$<salt>[$<hash>]]
Package-Level Type Names (total 4, in which 1 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Crypter (interface)
		Crypter is a UNIX crypt-like API that can be used both for password
		registration, and for password verification.

		Methods (only one, which is exported)
			( Crypter) Crypt(k, h string) (string, error)
				Crypt computes the hash of password string k using the given hash
				parameters. Applying Crypt to the returned hash is deterministic,
				that is, it always returns the same result that is equal to the
				returned hash.

				If h contains a salt string without output, then Crypt computes a
				hash output whose length is the default output length for the
				specified hash algorithm. The resulting hash contains a strict,
				deterministic encoding of the used parameters, salt and output.

				If h does not contain salt (and therefore output), then it generates
				a new new appropriate salt value as mandated by the specified hash
				algorithm using the defined default salt length, and then proceeds
				as in the previous case.

				If h contains hash function output, then it computes an output with
				exactly the same length as the one provided in the input. It returns
				the exact parameters and salt as they were received, and the newly
				computed output. Basically, it recomputes hash output for password
				verification.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			 crypter
		As Outputs Of (at least 2, both are exported)
			func Argon2() Crypter
			func Default() Crypter

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type crypter (map)
		crypter is the default Crypter implementation that delegates to
		algorithm-specific parsedCrypter based on the hash ID.

		Methods (only one, which is exported)
			( crypter) Crypt(k, h string) (string, error)
				Crypt implements the Crypter interface.

		Implements (at least one exported)
			 crypter : Crypter
		As Types Of (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			  var defaultArgon2Crypter
			  var defaultCrypter

	 type crypterArgon2 (struct)
		crypterArgon2 is the parsedCrypter implementation for Argon2 functions.

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			rand io.Reader
		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			(*crypterArgon2) parsedCrypt(k string, h phcformat.Hash) (string, error)
				Crypt implements the parsedCrypter interface.

		Implements (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*crypterArgon2 : parsedCrypter
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultArgon2

	 type parsedCrypter (interface)
		parsedCrypter is a Crypter variant used by crypter that accepts a parsed hash
		instead of an opaque string.

		Methods (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			( parsedCrypter) parsedCrypt(k string, h phcformat.Hash) (string, error)
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*crypterArgon2


Package-Level Functions (total 2, both are exported)

	 func Argon2() Crypter
		Argon2 returns the default Crypter implementation for Argon2i and Argon2id
		functions.

	 func Default() Crypter
		Default returns the default Crypter implementation.


Package-Level Variables (total 4, none are exported)

	/* 4 unexporteds ... *//* 4 unexporteds: */
	  var b64 *base64.Encoding
		b64 is a strict unpadded base64 encoding.

	  var defaultArgon2 crypterArgon2
	  var defaultArgon2Crypter crypter
	  var defaultCrypter crypter
Package-Level Constants (total 2, neither is exported)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	const schemeArgon2i = "argon2i"
	const schemeArgon2id = "argon2id"

The pages are generated with Golds v0.4.9. (GOOS=linux GOARCH=amd64)