core/crypto/mlkem

mlkem

Types

Decapsulation_Key :: Decapsulation_KeySource

Decapsulation_Key is a ML-KEM decapsulation (aka "private") key. This implementation opts to include the encapsulation (aka "public") key as well for cases where the decapsulation key is reused (eg: HPKE with X-Wing).

Encapsulation_Key :: Encapsulation_KeySource

Encapsulation_Key is a ML-KEM encapsulation (aka "public") key.

Parameters :: enum int {
	Invalid     = 0,
	ML_KEM_512  = 1,
	ML_KEM_768  = 2,
	ML_KEM_1024 = 3,
}

Source

Parameters are the supported ML-KEM parameter sets.

Constants

DECAPSULATION_KEY_SEED_SIZE :: 64Source

DECAPSULATION_KEY_SEED_SIZE is the size of a Decapsulation key in bytes.

SHARED_SECRET_SIZE :: 32Source

SHARED_SECRET_SIZE is the size of the final shared secret in bytes.

Variables

CIPHERTEXT_SIZES :: [4]int = [Parameters]int {
	.Invalid = 0,
	.ML_KEM_512 = _mlkem.CIPHERTEXTBYTES_512,    // 768-bytes
	.ML_KEM_768 = _mlkem.CIPHERTEXTBYTES_768,    // 1088-bytes
	.ML_KEM_1024 = _mlkem.CIPHERTEXTBYTES_1024,  // 1568-bytes
}

Source

CIPHERTEXT_SIZES are the per-parameter set sizes of the ciphertext in bytes.

DECAPSULATION_KEY_EXPANDED_SIZES :: [4]int = [Parameters]int {
	.Invalid = 0,
	.ML_KEM_512 = _mlkem.DECAPSKEYBYTES_512,   // 1632-bytes
	.ML_KEM_768 = _mlkem.DECAPSKEYBYTES_768,   // 2400-bytes
	.ML_KEM_1024 = _mlkem.DECAPSKEYBYTES_1024, // 3168-bytes
}

Source

DECAPSULATION_KEY_EXPANDED_SIZES are the per-parameter sizes of the decapsulation key in bytes.

ENCAPSULATION_KEY_SIZES :: [4]int = [Parameters]int {
	.Invalid = 0,
	.ML_KEM_512 = _mlkem.ENCAPSKEYBYTES_512,   // 800-bytes
	.ML_KEM_768 = _mlkem.ENCAPSKEYBYTES_768,   // 1184-bytes
	.ML_KEM_1024 = _mlkem.ENCAPSKEYBYTES_1024, // 1568-bytes
}

Source

ENCAPSULATION_KEY_SIZES are the per-parameter sizes of the encapsulation key in bytes.

Procedures

decaps :: proc(dk: ^Decapsulation_Key, ciphertext: []u8, shared_secret: []u8) -> (bool)Source

decaps uses the decapsulation key to generate a shared secret from a ciphertext. Due to ML-KEM's implicit rejection mechanism, this function will only return false if and only if (⟺) the lengths of the inputs are invalid or the decapsulation key is uninitialized.

This routine returning true does not guarantee that the shared secret matches that generated by the peer.

decapsulation_key_bytes :: proc(dk: ^Decapsulation_Key, dst: []u8)Source

decapsulation_key_bytes sets dst to byte-encoding of dk in the (d, z) "seed" format.

decapsulation_key_clear :: proc(dk: ^Decapsulation_Key)Source

decapsulation_key_clear clears dk to the uninitialized state.

decapsulation_key_encaps_bytes :: proc(dk: ^Decapsulation_Key, dst: []u8)Source

decapsulation_key_encaps_bytes sets dst to the byte-encoding of the encasulation key corresponding to dk.

decapsulation_key_expanded_bytes :: proc(dk: ^Decapsulation_Key, dst: []u8)Source

decapsulation_key_expanded_bytes sets dst to the byte-encoding of dk. in the expanded FIPS 203 format. This primarily exists for export purposes.

decapsulation_key_generate :: proc(dk: ^Decapsulation_Key, params: Parameters) -> (bool)Source

decapsulation_key_generate uses the system entropy source to generate a decapsulation key. This will only fail if and only if (⟺) the system entropy source is missing or broken.

decapsulation_key_set_bytes :: proc(dk: ^Decapsulation_Key, params: Parameters, seed: []u8) -> (bool)Source

decapsulation_key_set_bytes decodes a byte-encoded decapsulation key in (d, z) "seed" format, and returns true if and only if (⟺) the operation was successful.

encaps_ek :: proc(ek: ^Encapsulation_Key, shared_secret: []u8, ciphertext: []u8) -> (bool)Source

encaps_ek uses the encapsulation key to generate a shared secret and an associated ciphertext. This routine will fail if the system entropy source is unavailable.

encaps_ek_raw_bytes :: proc(params: Parameters, raw_ek: []u8, shared_secret: []u8, ciphertext: []u8) -> (bool)Source

encaps_raw_ek_bytes uses the byte encoded encapsulation key to generate a shared secret and an associated ciphertext. This routine will fail if the system entropy source is unavailable, or of the encapsulation key is invalid.

encapsulation_key_bytes :: proc(ek: ^Encapsulation_Key, dst: []u8)Source

encapsulation_key_encaps_bytes sets dst to the byte-encoding of ek.

encapsulation_key_clear :: proc(ek: ^Encapsulation_Key)Source

encapsulation_key_clear clears ek to the uninitialized state.

encapsulation_key_set_bytes :: proc(ek: ^Encapsulation_Key, params: Parameters, b: []u8) -> (bool)Source

encapsulation_key_set_bytes decodes a byte-encoded encapsulation key, and returns true if and only if (⟺) the operation was successful.

encapsulation_key_set_decaps :: proc(ek: ^Encapsulation_Key, dk: ^Decapsulation_Key)Source

encapsulation_key_set_decaps sets ek to the encapsulation key corresponding to dk.

key_size :: proc(k: ^T) -> (int)Source

key_size returns the key size of a Decapsulation_Key or Encapsulation_Key in bytes.

params :: proc(k: ^T) -> (Parameters)Source

params returns the Parameters used by a Decapsulation_Key or Encapsulation_Key instance.

Procedure Groups

encaps :: proc{encaps_ek, encaps_ek_raw_bytes}Source

mlkem

Types

Constants

Variables

Procedures

Procedure Groups

Find anything

Settings