package mlkem
import "crypto/mlkem"
Package mlkem implements the quantum-resistant key encapsulation method ML-KEM (formerly known as Kyber), as specified in NIST FIPS 203.
Index ¶
- Constants
- type DecapsulationKey1024
- func GenerateKey1024() (*DecapsulationKey1024, error)
- func NewDecapsulationKey1024(seed []byte) (*DecapsulationKey1024, error)
- func (dk *DecapsulationKey1024) Bytes() []byte
- func (dk *DecapsulationKey1024) Decapsulate(ciphertext []byte) (sharedKey []byte, err error)
- func (dk *DecapsulationKey1024) EncapsulationKey() *EncapsulationKey1024
- type DecapsulationKey768
- func GenerateKey768() (*DecapsulationKey768, error)
- func NewDecapsulationKey768(seed []byte) (*DecapsulationKey768, error)
- func (dk *DecapsulationKey768) Bytes() []byte
- func (dk *DecapsulationKey768) Decapsulate(ciphertext []byte) (sharedKey []byte, err error)
- func (dk *DecapsulationKey768) EncapsulationKey() *EncapsulationKey768
- type EncapsulationKey1024
- func NewEncapsulationKey1024(encapsulationKey []byte) (*EncapsulationKey1024, error)
- func (ek *EncapsulationKey1024) Bytes() []byte
- func (ek *EncapsulationKey1024) Encapsulate() (sharedKey, ciphertext []byte)
- type EncapsulationKey768
Constants ¶
const ( // CiphertextSize1024 is the size of a ciphertext produced by the 1024-bit // variant of ML-KEM. CiphertextSize1024 = 1568 // EncapsulationKeySize1024 is the size of an encapsulation key for the // 1024-bit variant of ML-KEM. EncapsulationKeySize1024 = 1568 )
const ( // SharedKeySize is the size of a shared key produced by ML-KEM. = 32 // SeedSize is the size of a seed used to generate a decapsulation key. SeedSize = 64 // CiphertextSize768 is the size of a ciphertext produced by the 768-bit // variant of ML-KEM. CiphertextSize768 = 1088 // EncapsulationKeySize768 is the size of an encapsulation key for the // 768-bit variant of ML-KEM. EncapsulationKeySize768 = 1184 )
Types ¶
type DecapsulationKey1024 ¶
type DecapsulationKey1024 struct {
// contains filtered or unexported fields
}
DecapsulationKey1024 is the secret key used to decapsulate a shared key from a ciphertext. It includes various precomputed values.
func GenerateKey1024 ¶
func GenerateKey1024() (*DecapsulationKey1024, error)
GenerateKey1024 generates a new decapsulation key, drawing random bytes from crypto/rand. The decapsulation key must be kept secret.
func NewDecapsulationKey1024 ¶
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 (*DecapsulationKey1024) Bytes ¶
func (dk *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.
func (*DecapsulationKey1024) Decapsulate ¶
func (dk *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.
func (*DecapsulationKey1024) EncapsulationKey ¶
func (dk *DecapsulationKey1024) EncapsulationKey() *EncapsulationKey1024
EncapsulationKey returns the public encapsulation key necessary to produce ciphertexts.
type DecapsulationKey768 ¶
type DecapsulationKey768 struct {
// contains filtered or unexported fields
}
DecapsulationKey768 is the secret key used to decapsulate a shared key from a ciphertext. It includes various precomputed values.
func GenerateKey768 ¶
func GenerateKey768() (*DecapsulationKey768, error)
GenerateKey768 generates a new decapsulation key, drawing random bytes from crypto/rand. The decapsulation key must be kept secret.
func NewDecapsulationKey768 ¶
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 (*DecapsulationKey768) Bytes ¶
func (dk *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.
func (*DecapsulationKey768) Decapsulate ¶
func (dk *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.
func (*DecapsulationKey768) EncapsulationKey ¶
func (dk *DecapsulationKey768) EncapsulationKey() *EncapsulationKey768
EncapsulationKey returns the public encapsulation key necessary to produce ciphertexts.
type EncapsulationKey1024 ¶
type EncapsulationKey1024 struct {
// contains filtered or unexported fields
}
An EncapsulationKey1024 is the public key used to produce ciphertexts to be decapsulated by the corresponding DecapsulationKey1024.
func NewEncapsulationKey1024 ¶
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 (*EncapsulationKey1024) Bytes ¶
func (ek *EncapsulationKey1024) Bytes() []byte
Bytes returns the encapsulation key as a byte slice.
func (*EncapsulationKey1024) Encapsulate ¶
func (ek *EncapsulationKey1024) Encapsulate() (sharedKey, ciphertext []byte)
Encapsulate generates a shared key and an associated ciphertext from an encapsulation key, drawing random bytes from crypto/rand.
The shared key must be kept secret.
type EncapsulationKey768 ¶
type EncapsulationKey768 struct {
// contains filtered or unexported fields
}
An EncapsulationKey768 is the public key used to produce ciphertexts to be decapsulated by the corresponding DecapsulationKey768.
func NewEncapsulationKey768 ¶
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.
func (*EncapsulationKey768) Bytes ¶
func (ek *EncapsulationKey768) Bytes() []byte
Bytes returns the encapsulation key as a byte slice.
func (*EncapsulationKey768) Encapsulate ¶
func (ek *EncapsulationKey768) Encapsulate() (sharedKey, ciphertext []byte)
Encapsulate generates a shared key and an associated ciphertext from an encapsulation key, drawing random bytes from crypto/rand.
The shared key must be kept secret.
Source Files ¶
- Version
- v1.24.0-rc.2
- Published
- Jan 13, 2025
- Platform
- windows/amd64
- Imports
- 1 packages
- Last checked
- 2 minutes ago –
Tools for package owners.