package mlkem

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

Dependency Relation
	imports 8 packages, and imported by 2 packages

Involved Source Files

	    cast.go
	    field.go
	    mlkem1024.go
	  d mlkem768.go
		Package mlkem implements the quantum-resistant key encapsulation method
		ML-KEM (formerly known as Kyber), as specified in [NIST FIPS 203].
Package-Level Type Names (total 4)

	/* sort by: alphabet | popularity */
	 type DecapsulationKey1024 (struct)
		A DecapsulationKey1024 is the secret key used to decapsulate a shared key from a
		ciphertext. It includes various precomputed values.

		Methods (total 3)
			(*DecapsulationKey1024) Bytes() []byte
				Bytes returns the decapsulation key as a 64-byte seed in the "d || z" form.
				
				The decapsulation key must be kept secret.

			(*DecapsulationKey1024) Decapsulate(ciphertext []byte) (sharedKey []byte, err error)
				Decapsulate generates a shared key from a ciphertext and a decapsulation key.
				If the ciphertext is not valid, Decapsulate returns an error.
				
				The shared key must be kept secret.

			(*DecapsulationKey1024) EncapsulationKey() *EncapsulationKey1024
				EncapsulationKey returns the public encapsulation key necessary to produce
				ciphertexts.

		As Outputs Of (at least 3)
			func GenerateKey1024() (*DecapsulationKey1024, error)
			func GenerateKeyInternal1024(d, z *[32]byte) *DecapsulationKey1024
			func NewDecapsulationKey1024(seed []byte) (*DecapsulationKey1024, error)

	 type DecapsulationKey768 (struct)
		A DecapsulationKey768 is the secret key used to decapsulate a shared key from a
		ciphertext. It includes various precomputed values.

		Methods (total 3)
			(*DecapsulationKey768) Bytes() []byte
				Bytes returns the decapsulation key as a 64-byte seed in the "d || z" form.
				
				The decapsulation key must be kept secret.

			(*DecapsulationKey768) Decapsulate(ciphertext []byte) (sharedKey []byte, err error)
				Decapsulate generates a shared key from a ciphertext and a decapsulation key.
				If the ciphertext is not valid, Decapsulate returns an error.
				
				The shared key must be kept secret.

			(*DecapsulationKey768) EncapsulationKey() *EncapsulationKey768
				EncapsulationKey returns the public encapsulation key necessary to produce
				ciphertexts.

		As Outputs Of (at least 3)
			func GenerateKey768() (*DecapsulationKey768, error)
			func GenerateKeyInternal768(d, z *[32]byte) *DecapsulationKey768
			func NewDecapsulationKey768(seed []byte) (*DecapsulationKey768, error)

	 type EncapsulationKey1024 (struct)
		An EncapsulationKey1024 is the public key used to produce ciphertexts to be
		decapsulated by the corresponding [DecapsulationKey1024].

		Methods (total 3)
			(*EncapsulationKey1024) Bytes() []byte
				Bytes returns the encapsulation key as a byte slice.

			(*EncapsulationKey1024) Encapsulate() (ciphertext, sharedKey []byte)
				Encapsulate generates a shared key and an associated ciphertext from an
				encapsulation key, drawing random bytes from a DRBG.
				
				The shared key must be kept secret.

			(*EncapsulationKey1024) EncapsulateInternal(m *[32]byte) (ciphertext, sharedKey []byte)
				EncapsulateInternal is a derandomized version of Encapsulate, exclusively for
				use in tests.

		As Outputs Of (at least 2)
			func NewEncapsulationKey1024(encapsulationKey []byte) (*EncapsulationKey1024, error)
			func (*DecapsulationKey1024).EncapsulationKey() *EncapsulationKey1024

	 type EncapsulationKey768 (struct)
		An EncapsulationKey768 is the public key used to produce ciphertexts to be
		decapsulated by the corresponding [DecapsulationKey768].

		Methods (total 3)
			(*EncapsulationKey768) Bytes() []byte
				Bytes returns the encapsulation key as a byte slice.

			(*EncapsulationKey768) Encapsulate() (ciphertext, sharedKey []byte)
				Encapsulate generates a shared key and an associated ciphertext from an
				encapsulation key, drawing random bytes from a DRBG.
				
				The shared key must be kept secret.

			(*EncapsulationKey768) EncapsulateInternal(m *[32]byte) (ciphertext, sharedKey []byte)
				EncapsulateInternal is a derandomized version of Encapsulate, exclusively for
				use in tests.

		As Outputs Of (at least 2)
			func NewEncapsulationKey768(encapsulationKey []byte) (*EncapsulationKey768, error)
			func (*DecapsulationKey768).EncapsulationKey() *EncapsulationKey768


Package-Level Functions (total 8)

	 func GenerateKey1024() (*DecapsulationKey1024, error)
		GenerateKey1024 generates a new decapsulation key, drawing random bytes from
		a DRBG. The decapsulation key must be kept secret.

	 func GenerateKey768() (*DecapsulationKey768, error)
		GenerateKey768 generates a new decapsulation key, drawing random bytes from
		a DRBG. The decapsulation key must be kept secret.

	 func GenerateKeyInternal1024(d, z *[32]byte) *DecapsulationKey1024
		GenerateKeyInternal1024 is a derandomized version of GenerateKey1024,
		exclusively for use in tests.

	 func GenerateKeyInternal768(d, z *[32]byte) *DecapsulationKey768
		GenerateKeyInternal768 is a derandomized version of GenerateKey768,
		exclusively for use in tests.

	 func NewDecapsulationKey1024(seed []byte) (*DecapsulationKey1024, error)
		NewDecapsulationKey1024 parses a decapsulation key from a 64-byte
		seed in the "d || z" form. The seed must be uniformly random.

	 func NewDecapsulationKey768(seed []byte) (*DecapsulationKey768, error)
		NewDecapsulationKey768 parses a decapsulation key from a 64-byte
		seed in the "d || z" form. The seed must be uniformly random.

	 func NewEncapsulationKey1024(encapsulationKey []byte) (*EncapsulationKey1024, error)
		NewEncapsulationKey1024 parses an encapsulation key from its encoded form.
		If the encapsulation key is not valid, NewEncapsulationKey1024 returns an error.

	 func NewEncapsulationKey768(encapsulationKey []byte) (*EncapsulationKey768, error)
		NewEncapsulationKey768 parses an encapsulation key from its encoded form.
		If the encapsulation key is not valid, NewEncapsulationKey768 returns an error.


Package-Level Constants (total 6)

	const CiphertextSize1024 = 1568
		ML-KEM-1024 parameters.

	const CiphertextSize768 = 1088
		ML-KEM-768 parameters.

	const EncapsulationKeySize1024 = 1568
		ML-KEM-1024 parameters.

	const EncapsulationKeySize768 = 1184
		ML-KEM-768 parameters.

	const SeedSize = 64
	const SharedKeySize = 32

The pages are generated with Golds v0.7.3-preview. (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.