package hmac

Import Path
	crypto/internal/fips140/hmac (on go.dev)

Dependency Relation
	imports 7 packages, and imported by 6 packages

Involved Source Files

	    cast.go
	  d hmac.go
		Package hmac implements HMAC according to [FIPS 198-1].
		
		[FIPS 198-1]: https://doi.org/10.6028/NIST.FIPS.198-1
Package-Level Type Names (total 3, in which 1 is exported)

	/* sort exporteds by: alphabet | popularity */
	 type HMAC (struct)

		Fields (total 7, none are exported)
			/* 7 unexporteds ... *//* 7 unexporteds: */
			forHKDF bool
				forHKDF and keyLen are stored to inform the service indicator decision.

			inner hash.Hash
			ipad []byte
				opad and ipad may share underlying storage with HMAC clones.

			keyLen int
			marshaled bool
				If marshaled is true, then opad and ipad do not contain a padded
				copy of the key, but rather the marshaled state of outer/inner after
				opad/ipad has been fed into it.

			opad []byte
				opad and ipad may share underlying storage with HMAC clones.

			outer hash.Hash
		Methods (total 6, all are exported)
			(*HMAC) BlockSize() int
			(*HMAC) Clone() (hash.Cloner, error)
				Clone implements [hash.Cloner] if the underlying hash does.
				Otherwise, it returns an error wrapping [errors.ErrUnsupported].

			(*HMAC) Reset()
			(*HMAC) Size() int
			(*HMAC) Sum(in []byte) []byte
			(*HMAC) Write(p []byte) (n int, err error)
		Implements (at least 6, in which 4 are exported)
			*HMAC : hash.Cloner
			*HMAC : hash.Hash
			*HMAC : internal/bisect.Writer
			*HMAC : io.Writer
			/* 2+ unexporteds ... *//* 2+ unexporteds: */
			*HMAC : crypto/tls.transcriptHash
			*HMAC : github.com/refraction-networking/utls.transcriptHash
		As Outputs Of (at least one exported)
			func New[H](h func() H, key []byte) *HMAC
		As Inputs Of (at least 2, in which 1 is exported)
			func MarkAsUsedInKDF(h *HMAC)
			/* at least one unexported ... *//* at least one unexported: */
			func crypto/internal/fips140/ecdsa.pad000(h *HMAC, writtenSoFar int)

	/* 2 unexporteds ... *//* 2 unexporteds: */
	 type errCloneUnsupported (struct)

		Methods (total 2, both are exported)
			( errCloneUnsupported) Error() string
			( errCloneUnsupported) Unwrap() error
		Implements (at least 2, both are exported)
			 errCloneUnsupported : error
			 errCloneUnsupported : github.com/go-faster/errors.Wrapper

	 type marshalable (interface)
		marshalable is the combination of encoding.BinaryMarshaler and
		encoding.BinaryUnmarshaler. Their method definitions are repeated here to
		avoid a dependency on the encoding package.

		Methods (total 2, both are exported)
			( marshalable) MarshalBinary() ([]byte, error)
			( marshalable) UnmarshalBinary([]byte) error
		Implemented By (at least 23, in which 16 are exported)
			*crypto/internal/fips140/sha256.Digest
			*crypto/internal/fips140/sha3.Digest
			*crypto/internal/fips140/sha3.SHAKE
			*crypto/internal/fips140/sha512.Digest
			*crypto/sha3.SHA3
			*crypto/sha3.SHAKE
			*crypto/x509.OID
			*github.com/cespare/xxhash/v2.Digest
			*github.com/klauspost/compress/zstd/internal/xxhash.Digest
			*math/rand/v2.ChaCha8
			*math/rand/v2.PCG
			*net/netip.Addr
			*net/netip.AddrPort
			*net/netip.Prefix
			*net/url.URL
			*time.Time
			/* 7+ unexporteds ... *//* 7+ unexporteds: */
			*crypto/md5.digest
			*crypto/sha1.digest
			 golang.org/x/crypto/sha3.shakeWrapper
			*golang.org/x/crypto/sha3.state
			*hash/adler32.digest
			*hash/crc32.digest
			*net.addrPortUDPAddr
		Implements (at least 2, both are exported)
			 marshalable : encoding.BinaryMarshaler
			 marshalable : encoding.BinaryUnmarshaler


Package-Level Functions (total 3, in which 2 are exported)

	 func MarkAsUsedInKDF(h *HMAC)
		MarkAsUsedInKDF records that this HMAC instance is used as part of a KDF.

	 func New[H](h func() H, key []byte) *HMAC

		Type Parameters:
			H: hash.Hash

		New returns a new HMAC hash using the given [hash.Hash] type and key.

	/* one unexported ... *//* one unexported: */
	 func init()

The pages are generated with Golds v0.8.4. (GOOS=linux GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @zigo_101 (reachable from the left QR code) to get the latest news of Golds.