lcx_mlkem.h

Go to the documentation of this file.

/*****************************************************************************
 *   (c) 2026 Ledger SAS.
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *****************************************************************************/
#ifndef MLKEM_H
#define MLKEM_H
 
#include <stddef.h>
#include <stdint.h>
#include "cx_errors.h"
 
#define MLKEM_N         256U 
#define MLKEM_Q         3329 
#define MLKEM_Q_HALF    1665 
#define MLKEM_SYMBYTES  32U  
#define MLKEM_SSBYTES   32U  
#define MLKEM_POLYBYTES 384U 
#define MLKEM_POLYCOMPRESSEDBYTES_D10 320U 
#define MLKEM_POLYCOMPRESSEDBYTES_D11 352U 
#define MLKEM_NUM_PARAM_SETS 3U 
#define MLKEM512_K    2U  
#define MLKEM512_ETA1 3U  
#define MLKEM512_ETA2 2U  
#define MLKEM512_DU   10U 
#define MLKEM512_DV   4U  
#define MLKEM512_POLYVECBYTES \
    (MLKEM512_K * MLKEM_POLYBYTES)           
#define MLKEM512_POLYCOMPRESSEDBYTES_DV 128U 
#define MLKEM512_POLYCOMPRESSEDBYTES_DU 320U 
#define MLKEM512_POLYVECCOMPRESSEDBYTES \
    (MLKEM512_K * MLKEM512_POLYCOMPRESSEDBYTES_DU) 
#define MLKEM512_INDCPA_PUBLICKEYBYTES \
    (MLKEM512_POLYVECBYTES + MLKEM_SYMBYTES) 
#define MLKEM512_INDCPA_SECRETKEYBYTES                        \
    MLKEM512_POLYVECBYTES 
#define MLKEM512_INDCPA_BYTES        \
    (MLKEM512_POLYVECCOMPRESSEDBYTES \
     + MLKEM512_POLYCOMPRESSEDBYTES_DV) 
#define MLKEM512_PUBLICKEYBYTES \
    MLKEM512_INDCPA_PUBLICKEYBYTES 
#define MLKEM512_SECRETKEYBYTES                                      \
    (MLKEM512_INDCPA_SECRETKEYBYTES + MLKEM512_INDCPA_PUBLICKEYBYTES \
     + (2U * MLKEM_SYMBYTES))                          
#define MLKEM512_CIPHERTEXTBYTES MLKEM512_INDCPA_BYTES 
#define MLKEM768_K    3U  
#define MLKEM768_ETA1 2U  
#define MLKEM768_ETA2 2U  
#define MLKEM768_DU   10U 
#define MLKEM768_DV   4U  
#define MLKEM768_POLYVECBYTES \
    (MLKEM768_K * MLKEM_POLYBYTES)           
#define MLKEM768_POLYCOMPRESSEDBYTES_DV 128U 
#define MLKEM768_POLYCOMPRESSEDBYTES_DU 320U 
#define MLKEM768_POLYVECCOMPRESSEDBYTES \
    (MLKEM768_K * MLKEM768_POLYCOMPRESSEDBYTES_DU) 
#define MLKEM768_INDCPA_PUBLICKEYBYTES \
    (MLKEM768_POLYVECBYTES + MLKEM_SYMBYTES) 
#define MLKEM768_INDCPA_SECRETKEYBYTES                         \
    MLKEM768_POLYVECBYTES 
#define MLKEM768_INDCPA_BYTES        \
    (MLKEM768_POLYVECCOMPRESSEDBYTES \
     + MLKEM768_POLYCOMPRESSEDBYTES_DV) 
#define MLKEM768_PUBLICKEYBYTES \
    MLKEM768_INDCPA_PUBLICKEYBYTES 
#define MLKEM768_SECRETKEYBYTES                                      \
    (MLKEM768_INDCPA_SECRETKEYBYTES + MLKEM768_INDCPA_PUBLICKEYBYTES \
     + (2U * MLKEM_SYMBYTES))                          
#define MLKEM768_CIPHERTEXTBYTES MLKEM768_INDCPA_BYTES 
#define MLKEM1024_K    4U  
#define MLKEM1024_ETA1 2U  
#define MLKEM1024_ETA2 2U  
#define MLKEM1024_DU   11U 
#define MLKEM1024_DV   5U  
#define MLKEM1024_POLYVECBYTES \
    (MLKEM1024_K * MLKEM_POLYBYTES)           
#define MLKEM1024_POLYCOMPRESSEDBYTES_DV 160U 
#define MLKEM1024_POLYCOMPRESSEDBYTES_DU 352U 
#define MLKEM1024_POLYVECCOMPRESSEDBYTES \
    (MLKEM1024_K * MLKEM1024_POLYCOMPRESSEDBYTES_DU) 
#define MLKEM1024_INDCPA_PUBLICKEYBYTES \
    (MLKEM1024_POLYVECBYTES + MLKEM_SYMBYTES) 
#define MLKEM1024_INDCPA_SECRETKEYBYTES \
    MLKEM1024_POLYVECBYTES 
#define MLKEM1024_INDCPA_BYTES        \
    (MLKEM1024_POLYVECCOMPRESSEDBYTES \
     + MLKEM1024_POLYCOMPRESSEDBYTES_DV) 
#define MLKEM1024_PUBLICKEYBYTES \
    MLKEM1024_INDCPA_PUBLICKEYBYTES 
#define MLKEM1024_SECRETKEYBYTES                                       \
    (MLKEM1024_INDCPA_SECRETKEYBYTES + MLKEM1024_INDCPA_PUBLICKEYBYTES \
     + (2U * MLKEM_SYMBYTES)) 
#define MLKEM1024_CIPHERTEXTBYTES \
    MLKEM1024_INDCPA_BYTES 
#define MLKEM_MAX_K MLKEM1024_K 
typedef enum MLKEM_param_e {
    MLKEM_512 = 0, 
    MLKEM_768,     
    MLKEM_1024,    
} MLKEM_param_t;
 
typedef struct MLKEM_param_info_s {
    uint8_t  k;                        
    uint8_t  eta1;                     
    uint8_t  eta2;                     
    uint8_t  du;                       
    uint8_t  dv;                       
    uint16_t polyvec_bytes;            
    uint16_t polyvec_compressed_bytes; 
    uint16_t poly_compressed_dv_bytes; 
    uint16_t indcpa_pk_bytes;          
    uint16_t indcpa_sk_bytes;          
    uint16_t indcpa_ct_bytes;          
    uint16_t pk_bytes;                 
    uint16_t sk_bytes;                 
    uint16_t ct_bytes;                 
} MLKEM_param_info_t;
 
extern const MLKEM_param_info_t MLKEM_PARAM[MLKEM_NUM_PARAM_SETS];
 
cx_err_t MLKEM_crypto_kem_keypair(uint8_t      *pk,
                                  size_t        pk_len,
                                  uint8_t      *sk,
                                  size_t        sk_len,
                                  MLKEM_param_t param);
 
cx_err_t MLKEM_crypto_kem_enc(uint8_t       *ct,
                              size_t         ct_len,
                              uint8_t       *ss,
                              size_t         ss_len,
                              const uint8_t *pk,
                              size_t         pk_len,
                              MLKEM_param_t  param);
 
cx_err_t MLKEM_crypto_kem_dec(uint8_t       *ss,
                              size_t         ss_len,
                              const uint8_t *ct,
                              size_t         ct_len,
                              const uint8_t *sk,
                              size_t         sk_len,
                              MLKEM_param_t  param);
 
#endif  // MLKEM_H