package hash

Import Path
	hash (on go.dev)

Dependency Relation
	imports one package, and imported by 20 packages


Involved Source Files

	
		Package hash provides interfaces for hash functions.


Code Examples

	
		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 3)


	/* sort by:  |  */
	
		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] and
		[encoding.BinaryUnmarshaler] 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

		
			
				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.

			
				Reset resets the Hash to its initial state.

			
				Size returns the number of bytes Sum will return.

			
				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)
		
			 Hash32 (interface)
			 Hash64 (interface)
			*hash/maphash.Hash
			 vendor/golang.org/x/crypto/sha3.ShakeHash (interface)
		
			 Hash : internal/bisect.Writer
			 Hash : io.Writer
		
			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/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 vendor/golang.org/x/crypto/sha3.New224() Hash
			func vendor/golang.org/x/crypto/sha3.New256() Hash
			func vendor/golang.org/x/crypto/sha3.New384() Hash
			func vendor/golang.org/x/crypto/sha3.New512() Hash
			func vendor/golang.org/x/crypto/sha3.NewLegacyKeccak256() Hash
			func vendor/golang.org/x/crypto/sha3.NewLegacyKeccak512() Hash
		
			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/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)


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

		
			
				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.

			
				Reset resets the Hash to its initial state.

			
				Size returns the number of bytes Sum will return.

			
				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)
		
			 Hash32 : Hash
			 Hash32 : internal/bisect.Writer
			 Hash32 : io.Writer
		
			func hash/adler32.New() Hash32
			func hash/crc32.New(tab *crc32.Table) Hash32
			func hash/crc32.NewIEEE() Hash32
			func hash/fnv.New32() Hash32
			func hash/fnv.New32a() Hash32


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

		
			
				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.

			
				Reset resets the Hash to its initial state.

			
				Size returns the number of bytes Sum will return.

			
				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)
		
			*hash/maphash.Hash
		
			 Hash64 : Hash
			 Hash64 : internal/bisect.Writer
			 Hash64 : io.Writer
		
			func hash/crc64.New(tab *crc64.Table) Hash64
			func hash/fnv.New64() Hash64
			func hash/fnv.New64a() Hash64