package hash

Import Path
	hash (on go.dev)

Dependency Relation
	imports one package, and imported by 27 packages

Involved Source Files

	  d hash.go
		Package hash provides interfaces for hash functions.
Code Examples

	_binaryMarshaler
		package main
		
		import (
			"bytes"
			"crypto/sha256"
			"encoding"
			"fmt"
			"log"
		)
		
		func main() {
			const (
				input1 = "The tunneling gopher digs downwards, "
				input2 = "unaware of what he will find."
			)
		
			first := sha256.New()
			first.Write([]byte(input1))
		
			marshaler, ok := first.(encoding.BinaryMarshaler)
			if !ok {
				log.Fatal("first does not implement encoding.BinaryMarshaler")
			}
			state, err := marshaler.MarshalBinary()
			if err != nil {
				log.Fatal("unable to marshal hash:", err)
			}
		
			second := sha256.New()
		
			unmarshaler, ok := second.(encoding.BinaryUnmarshaler)
			if !ok {
				log.Fatal("second does not implement encoding.BinaryUnmarshaler")
			}
			if err := unmarshaler.UnmarshalBinary(state); err != nil {
				log.Fatal("unable to unmarshal hash:", err)
			}
		
			first.Write([]byte(input2))
			second.Write([]byte(input2))
		
			fmt.Printf("%x\n", first.Sum(nil))
			fmt.Println(bytes.Equal(first.Sum(nil), second.Sum(nil)))
		}


Package-Level Type Names (total 5, all are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Cloner (interface)
		A Cloner is a hash function whose state can be cloned, returning a value with
		equivalent and independent state.
		
		All [Hash] implementations in the standard library implement this interface,
		unless GOFIPS140=v1.0.0 is set.
		
		If a hash can only determine at runtime if it can be cloned (e.g. if it wraps
		another hash), Clone may return an error wrapping [errors.ErrUnsupported].
		Otherwise, Clone must always return a nil error.

		Methods (total 6, all are exported)
			( Cloner) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( Cloner) Clone() (Cloner, error)
			( Cloner) Reset()
				Reset resets the Hash to its initial state.

			( Cloner) Size() int
				Size returns the number of bytes Sum will return.

			( Cloner) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( Cloner) Write([]byte) (int, error)
		Implemented By (at least 14, in which 5 are exported)
			*hash/maphash.Hash
			*crypto/internal/fips140/hmac.HMAC
			*crypto/internal/fips140/sha256.Digest
			*crypto/internal/fips140/sha512.Digest
			*crypto/sha3.SHA3
			/* 9+ unexporteds ... *//* 9+ unexporteds: */
			*hash/crc32.digest
			*hash/fnv.sum128
			*hash/fnv.sum128a
			*hash/fnv.sum32
			*hash/fnv.sum32a
			*hash/fnv.sum64
			*hash/fnv.sum64a
			*crypto/md5.digest
			*crypto/sha1.digest
		Implements (at least 4, in which 3 are exported)
			 Cloner : Hash
			 Cloner : internal/bisect.Writer
			 Cloner : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			 Cloner : crypto/tls.transcriptHash
		As Outputs Of (at least 6, all are exported)
			func Cloner.Clone() (Cloner, error)
			func hash/maphash.(*Hash).Clone() (Cloner, error)
			func crypto/internal/fips140/hmac.(*HMAC).Clone() (Cloner, error)
			func crypto/internal/fips140/sha256.(*Digest).Clone() (Cloner, error)
			func crypto/internal/fips140/sha512.(*Digest).Clone() (Cloner, error)
			func crypto/sha3.(*SHA3).Clone() (Cloner, error)

	 type Hash (interface)
		Hash is the common interface implemented by all hash functions.
		
		Hash implementations in the standard library (e.g. [hash/crc32] and
		[crypto/sha256]) implement the [encoding.BinaryMarshaler], [encoding.BinaryAppender],
		[encoding.BinaryUnmarshaler] and [Cloner] interfaces. Marshaling a hash implementation
		allows its internal state to be saved and used for additional processing
		later, without having to re-write the data previously written to the hash.
		The hash state may contain portions of the input in its original form,
		which users are expected to handle for any possible security implications.
		
		Compatibility: Any future changes to hash or crypto packages will endeavor
		to maintain compatibility with state encoded using previous versions.
		That is, any released versions of the packages should be able to
		decode data written with any previously released version,
		subject to issues such as security fixes.
		See the Go compatibility document for background: https://golang.org/doc/go1compat

		Methods (total 5, all are exported)
			( Hash) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( Hash) Reset()
				Reset resets the Hash to its initial state.

			( Hash) Size() int
				Size returns the number of bytes Sum will return.

			( Hash) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( Hash) Write([]byte) (int, error)
		Implemented By (at least 22, in which 10 are exported)
			 Cloner (interface)
			 Hash32 (interface)
			 Hash64 (interface)
			*hash/maphash.Hash
			*crypto/internal/fips140/hmac.HMAC
			*crypto/internal/fips140/sha256.Digest
			*crypto/internal/fips140/sha3.Digest
			*crypto/internal/fips140/sha3.SHAKE
			*crypto/internal/fips140/sha512.Digest
			*crypto/sha3.SHA3
			/* 12+ unexporteds ... *//* 12+ unexporteds: */
			*hash/crc32.digest
			*hash/fnv.sum128
			*hash/fnv.sum128a
			*hash/fnv.sum32
			*hash/fnv.sum32a
			*hash/fnv.sum64
			*hash/fnv.sum64a
			*crypto/md5.digest
			*crypto/sha1.digest
			 crypto/tls.constantTimeHash (interface)
			*crypto/tls.cthWrapper
			*golang.org/x/crypto/blake2b.digest
		Implements (at least 3, in which 2 are exported)
			 Hash : internal/bisect.Writer
			 Hash : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			 Hash : crypto/tls.transcriptHash
		As Outputs Of (at least 27, in which 24 are exported)
			func hash/fnv.New128() Hash
			func hash/fnv.New128a() Hash
			func crypto.Hash.New() Hash
			func crypto/hmac.New(h func() Hash, key []byte) Hash
			func crypto/internal/boring.NewHMAC(h func() Hash, key []byte) Hash
			func crypto/internal/boring.NewSHA1() Hash
			func crypto/internal/boring.NewSHA224() Hash
			func crypto/internal/boring.NewSHA256() Hash
			func crypto/internal/boring.NewSHA384() Hash
			func crypto/internal/boring.NewSHA512() Hash
			func crypto/internal/fips140hash.Unwrap(h Hash) Hash
			func crypto/md5.New() Hash
			func crypto/sha1.New() Hash
			func crypto/sha256.New() Hash
			func crypto/sha256.New224() Hash
			func crypto/sha512.New() Hash
			func crypto/sha512.New384() Hash
			func crypto/sha512.New512_224() Hash
			func crypto/sha512.New512_256() Hash
			func go.pact.im/x/extraio.(*HashReader).Hash() Hash
			func golang.org/x/crypto/blake2b.New(size int, key []byte) (Hash, error)
			func golang.org/x/crypto/blake2b.New256(key []byte) (Hash, error)
			func golang.org/x/crypto/blake2b.New384(key []byte) (Hash, error)
			func golang.org/x/crypto/blake2b.New512(key []byte) (Hash, error)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			func crypto/tls.cloneHash(in Hash, h crypto.Hash) Hash
			func crypto/tls.macSHA1(key []byte) Hash
			func crypto/tls.macSHA256(key []byte) Hash
		As Inputs Of (at least 33, in which 22 are exported)
			func crypto/internal/boring.DecryptRSAOAEP(h, mgfHash Hash, priv *boring.PrivateKeyRSA, ciphertext, label []byte) ([]byte, error)
			func crypto/internal/boring.EncryptRSAOAEP(h, mgfHash Hash, pub *boring.PublicKeyRSA, msg, label []byte) ([]byte, error)
			func crypto/internal/fips140/rsa.DecryptOAEP(hash, mgfHash Hash, priv *rsa.PrivateKey, ciphertext []byte, label []byte) ([]byte, error)
			func crypto/internal/fips140/rsa.EncryptOAEP(hash, mgfHash Hash, random io.Reader, pub *rsa.PublicKey, msg []byte, label []byte) ([]byte, error)
			func crypto/internal/fips140/rsa.PSSMaxSaltLength(pub *rsa.PublicKey, hash Hash) (int, error)
			func crypto/internal/fips140/rsa.SignPSS(rand io.Reader, priv *rsa.PrivateKey, hash Hash, hashed []byte, saltLength int) ([]byte, error)
			func crypto/internal/fips140/rsa.VerifyPSS(pub *rsa.PublicKey, hash Hash, digest []byte, sig []byte) error
			func crypto/internal/fips140/rsa.VerifyPSSWithSaltLength(pub *rsa.PublicKey, hash Hash, digest []byte, sig []byte, saltLength int) error
			func crypto/internal/fips140/tls13.(*EarlySecret).ClientEarlyTrafficSecret(transcript Hash) []byte
			func crypto/internal/fips140/tls13.(*EarlySecret).EarlyExporterMasterSecret(transcript Hash) *tls13.ExporterMasterSecret
			func crypto/internal/fips140/tls13.(*HandshakeSecret).ClientHandshakeTrafficSecret(transcript Hash) []byte
			func crypto/internal/fips140/tls13.(*HandshakeSecret).ServerHandshakeTrafficSecret(transcript Hash) []byte
			func crypto/internal/fips140/tls13.(*MasterSecret).ClientApplicationTrafficSecret(transcript Hash) []byte
			func crypto/internal/fips140/tls13.(*MasterSecret).ExporterMasterSecret(transcript Hash) *tls13.ExporterMasterSecret
			func crypto/internal/fips140/tls13.(*MasterSecret).ResumptionMasterSecret(transcript Hash) []byte
			func crypto/internal/fips140/tls13.(*MasterSecret).ServerApplicationTrafficSecret(transcript Hash) []byte
			func crypto/internal/fips140hash.Unwrap(h Hash) Hash
			func crypto/internal/fips140only.ApprovedHash(h Hash) bool
			func crypto/rsa.DecryptOAEP(hash Hash, random io.Reader, priv *rsa.PrivateKey, ciphertext []byte, label []byte) ([]byte, error)
			func crypto/rsa.EncryptOAEP(hash Hash, random io.Reader, pub *rsa.PublicKey, msg []byte, label []byte) ([]byte, error)
			func go.pact.im/x/extraio.NewHashReader(h Hash) *extraio.HashReader
			func go.pact.im/x/extraio.NewStrippedHashReader(h Hash, n int64) io.Reader
			/* 11+ unexporteds ... *//* 11+ unexporteds: */
			func crypto/internal/fips140/rsa.checkApprovedHash(hash Hash)
			func crypto/internal/fips140/rsa.emsaPSSEncode(mHash []byte, emBits int, salt []byte, hash Hash) ([]byte, error)
			func crypto/internal/fips140/rsa.emsaPSSVerify(mHash, em []byte, emBits, sLen int, hash Hash) error
			func crypto/internal/fips140/rsa.mgf1XOR(out []byte, hash Hash, seed []byte)
			func crypto/internal/fips140/rsa.verifyPSS(pub *rsa.PublicKey, hash Hash, digest []byte, sig []byte, saltLength int) error
			func crypto/internal/fips140/tls13.deriveSecret[H](hash func() H, secret []byte, label string, transcript Hash) []byte
			func crypto/rsa.decryptOAEP(hash, mgfHash Hash, priv *rsa.PrivateKey, ciphertext []byte, label []byte) ([]byte, error)
			func crypto/tls.cloneHash(in Hash, h crypto.Hash) Hash
			func crypto/tls.computeAndUpdatePSK(m *tls.clientHelloMsg, binderKey []byte, transcript Hash, finishedHash func([]byte, Hash) []byte) error
			func crypto/tls.signedMessage(sigHash crypto.Hash, context string, transcript Hash) []byte
			func crypto/tls.tls10MAC(h Hash, out, seq, header, data, extra []byte) []byte

	 type Hash32 (interface)
		Hash32 is the common interface implemented by all 32-bit hash functions.

		Methods (total 6, all are exported)
			( Hash32) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( Hash32) Reset()
				Reset resets the Hash to its initial state.

			( Hash32) Size() int
				Size returns the number of bytes Sum will return.

			( Hash32) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( Hash32) Sum32() uint32
			( Hash32) Write([]byte) (int, error)
		Implemented By (at least 3, none are exported)
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*hash/crc32.digest
			*hash/fnv.sum32
			*hash/fnv.sum32a
		Implements (at least 4, in which 3 are exported)
			 Hash32 : Hash
			 Hash32 : internal/bisect.Writer
			 Hash32 : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			 Hash32 : crypto/tls.transcriptHash
		As Outputs Of (at least 4, all are exported)
			func hash/crc32.New(tab *crc32.Table) Hash32
			func hash/crc32.NewIEEE() Hash32
			func hash/fnv.New32() Hash32
			func hash/fnv.New32a() Hash32

	 type Hash64 (interface)
		Hash64 is the common interface implemented by all 64-bit hash functions.

		Methods (total 6, all are exported)
			( Hash64) BlockSize() int
				BlockSize returns the hash's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( Hash64) Reset()
				Reset resets the Hash to its initial state.

			( Hash64) Size() int
				Size returns the number of bytes Sum will return.

			( Hash64) Sum(b []byte) []byte
				Sum appends the current hash to b and returns the resulting slice.
				It does not change the underlying hash state.

			( Hash64) Sum64() uint64
			( Hash64) Write([]byte) (int, error)
		Implemented By (at least 3, in which 1 is exported)
			*hash/maphash.Hash
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*hash/fnv.sum64
			*hash/fnv.sum64a
		Implements (at least 4, in which 3 are exported)
			 Hash64 : Hash
			 Hash64 : internal/bisect.Writer
			 Hash64 : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			 Hash64 : crypto/tls.transcriptHash
		As Outputs Of (at least 2, both are exported)
			func hash/fnv.New64() Hash64
			func hash/fnv.New64a() Hash64

	 type XOF (interface)
		XOF (extendable output function) is a hash function with arbitrary or unlimited output length.

		Methods (total 4, all are exported)
			( XOF) BlockSize() int
				BlockSize returns the XOF's underlying block size.
				The Write method must be able to accept any amount
				of data, but it may operate more efficiently if all writes
				are a multiple of the block size.

			( XOF) Read(p []byte) (n int, err error)
			( XOF) Reset()
				Reset resets the XOF to its initial state.

			( XOF) Write([]byte) (int, error)
		Implemented By (at least 3, in which 2 are exported)
			*crypto/internal/fips140/sha3.SHAKE
			*crypto/sha3.SHAKE
			/* at least one unexported ... *//* at least one unexported: */
			*golang.org/x/crypto/blake2b.xof
		Implements (at least 5, in which 4 are exported)
			 XOF : internal/bisect.Writer
			 XOF : io.Reader
			 XOF : io.ReadWriter
			 XOF : io.Writer
			/* at least one unexported ... *//* at least one unexported: */
			 XOF : crypto/tls.transcriptHash

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