hqcbase.h

Go to the documentation of this file.

/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
 * All Rights Reserved.
 *
 * NOTICE:
 * This software and all accompanying materials are the exclusive property of
 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
 * and technical concepts contained herein are proprietary to QRCS and are
 * protected under applicable Canadian, U.S., and international copyright,
 * patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
 * - This software includes implementations of cryptographic primitives and
 *   algorithms that are standardized or in the public domain, such as AES
 *   and SHA-3, which are not proprietary to QRCS.
 * - This software also includes cryptographic primitives, constructions, and
 *   algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
 *   related components, which are proprietary to QRCS.
 * - All source code, implementations, protocol compositions, optimizations,
 *   parameter selections, and engineering work contained in this software are
 *   original works of QRCS and are protected under this license.
 *
 * LICENSE AND USE RESTRICTIONS:
 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
 *   Public Research and Evaluation License (QRCS-PREL), 2025-2026.
 * - Permission is granted solely for non-commercial evaluation, academic research,
 *   cryptographic analysis, interoperability testing, and feasibility assessment.
 * - Commercial use, production deployment, commercial redistribution, or
 *   integration into products or services is strictly prohibited without a
 *   separate written license agreement executed with QRCS.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 *
 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
 * Portions of this software may include experimental, novel, or evolving
 * cryptographic designs. Use of this software is entirely at the user's risk.
 *
 * DISCLAIMER:
 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
 *
 * FULL LICENSE:
 * This software is subject to the Quantum Resistant Cryptographic Solutions
 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
 *
 * Written by: John G. Underhill
 * Contact: contact@qrcscorp.ca
 */

 
#ifndef QSC_HQCBASE_H
#define QSC_HQCBASE_H
 
/* \cond NO_DOCUMENT */
 
#include "qsccommon.h"

#if !defined(QSC_HQC_S1N2321) && !defined(QSC_HQC_S3N4602) && !defined(QSC_HQC_S5N7333)
#   define QSC_HQC_S3N4602
#endif

#if (defined(QSC_HQC_S1N2321) + defined(QSC_HQC_S3N4602) + defined(QSC_HQC_S5N7333)) != 1
#   error "Define exactly one HQC parameter guard: QSC_HQC_S1N2321, QSC_HQC_S3N4602, or QSC_HQC_S5N7333."
#endif
 
#if defined(QSC_HQC_S1N2321)
#   define CEIL_DIVIDE(a, b) (((a) / (b)) + (((a) % (b)) == 0 ? 0 : 1))
#   define BITMASK(a, size)  ((1UL << ((a) % (size))) - 1UL)
#   define CRYPTO_ALGNAME "HQC-1"
#   define CRYPTO_SECRETKEYBYTES 2321U
#   define CRYPTO_PUBLICKEYBYTES 2241U
#   define CRYPTO_BYTES 32U
#   define CRYPTO_CIPHERTEXTBYTES 4433U
#   define PARAM_N 17669U
#   define PARAM_N1 46U
#   define PARAM_N2 384U
#   define PARAM_N1N2 17664U
#   define PARAM_OMEGA 66U
#   define PARAM_OMEGA_E 75U
#   define PARAM_OMEGA_R 75U
#   define PARAM_SECURITY 128U
#   define PARAM_SECURITY_BYTES 16U
#   define PARAM_DFR_EXP 128U
#   define SECRET_KEY_BYTES CRYPTO_SECRETKEYBYTES
#   define PUBLIC_KEY_BYTES CRYPTO_PUBLICKEYBYTES
#   define SHARED_SECRET_BYTES CRYPTO_BYTES
#   define CIPHERTEXT_BYTES CRYPTO_CIPHERTEXTBYTES
#   define PARAM_DELTA 15U
#   define PARAM_M 8U
#   define PARAM_GF_POLY 0x11DU
#   define PARAM_GF_MUL_ORDER 255U
#   define PARAM_K 16U
#   define PARAM_G 31U
#   define PARAM_FFT 4U
#   define SEED_BYTES 32U
#   define SALT_BYTES 16U
#   define PARAM_N_MU 243079ULL
#   define UTILS_REJECTION_THRESHOLD 16767881U
#elif defined(QSC_HQC_S3N4602)
#   define CEIL_DIVIDE(a, b) (((a) / (b)) + (((a) % (b)) == 0 ? 0 : 1))
#   define BITMASK(a, size)  ((1UL << ((a) % (size))) - 1UL)
#   define CRYPTO_ALGNAME "HQC-3"
#   define CRYPTO_SECRETKEYBYTES 4602U
#   define CRYPTO_PUBLICKEYBYTES 4514U
#   define CRYPTO_BYTES 32U
#   define CRYPTO_CIPHERTEXTBYTES 8978U
#   define PARAM_N 35851U
#   define PARAM_N1 56U
#   define PARAM_N2 640U
#   define PARAM_N1N2 35840U
#   define PARAM_OMEGA 100U
#   define PARAM_OMEGA_E 114U
#   define PARAM_OMEGA_R 114U
#   define PARAM_SECURITY 192U
#   define PARAM_SECURITY_BYTES 24U
#   define PARAM_DFR_EXP 192U
#   define SECRET_KEY_BYTES CRYPTO_SECRETKEYBYTES
#   define PUBLIC_KEY_BYTES CRYPTO_PUBLICKEYBYTES
#   define SHARED_SECRET_BYTES CRYPTO_BYTES
#   define CIPHERTEXT_BYTES CRYPTO_CIPHERTEXTBYTES
#   define PARAM_DELTA 16U
#   define PARAM_M 8U
#   define PARAM_GF_POLY 0x11DU
#   define PARAM_GF_MUL_ORDER 255U
#   define PARAM_K 24U
#   define PARAM_G 33U
#   define PARAM_FFT 5U
#   define SEED_BYTES 32U
#   define SALT_BYTES 16U
#   define PARAM_N_MU 119800ULL
#   define UTILS_REJECTION_THRESHOLD 16742417U
#elif defined(QSC_HQC_S5N7333)
#   define CEIL_DIVIDE(a, b) (((a) / (b)) + (((a) % (b)) == 0 ? 0 : 1))
#   define BITMASK(a, size)  ((1ULL << ((a) % (size))) - 1ULL)
#   define CRYPTO_ALGNAME "HQC-5"
#   define CRYPTO_SECRETKEYBYTES 7333U
#   define CRYPTO_PUBLICKEYBYTES 7237U
#   define CRYPTO_BYTES 32U
#   define CRYPTO_CIPHERTEXTBYTES 14421U
#   define PARAM_N 57637U
#   define PARAM_N1 90U
#   define PARAM_N2 640U
#   define PARAM_N1N2 57600U
#   define PARAM_OMEGA 131U
#   define PARAM_OMEGA_E 149U
#   define PARAM_OMEGA_R 149U
#   define PARAM_SECURITY 256U
#   define PARAM_SECURITY_BYTES 32U
#   define PARAM_DFR_EXP 256U
#   define SECRET_KEY_BYTES CRYPTO_SECRETKEYBYTES
#   define PUBLIC_KEY_BYTES CRYPTO_PUBLICKEYBYTES
#   define SHARED_SECRET_BYTES CRYPTO_BYTES
#   define CIPHERTEXT_BYTES CRYPTO_CIPHERTEXTBYTES
#   define PARAM_DELTA 29U
#   define PARAM_M 8U
#   define PARAM_GF_POLY 0x11DU
#   define PARAM_GF_MUL_ORDER 255U
#   define PARAM_K 32U
#   define PARAM_G 59U
#   define PARAM_FFT 5U
#   define SEED_BYTES 32U
#   define SALT_BYTES 16U
#   define PARAM_N_MU 74517ULL
#   define UTILS_REJECTION_THRESHOLD 16772367U
#endif
 
#if defined(QSC_HQC_S1N2321)
#define RS_POLY_COEFS 89, 69, 153, 116, 176, 117, 111, 75, 73, 233, 242, 233, 65, 210, 21, 139, 103, 173, 67, 118, 105, 210, 174, 110, 74, 69, 228, 82, 255, 181, 1
#elif defined(QSC_HQC_S3N4602)
#define RS_POLY_COEFS 45, 216, 239, 24, 253, 104, 27, 40, 107, 50, 163, 210, 227, 134, 224, 158, 119, 13, 158, 1, 238, 164, 82, 43, 15, 232, 246, 142, 50, 189, 29, 232, 1
#elif defined(QSC_HQC_S5N7333)
#define RS_POLY_COEFS 49, 167, 49, 39, 200, 121, 124, 91, 240, 63, 148, 71, 150, 123, 87, 101, 32, 215, 159, 71, 201, 115, 97, 210, 186, 183, 141, 217, 123, 12, 31, 243, 180, 219, 152, 239, 99, 141, 4, 246, 191, 144, 8, 232, 47, 27, 141, 178, 130, 64, 124, 47, 39, 188, 216, 48, 199, 187, 1
#endif

#define VEC_N_SIZE_BYTES CEIL_DIVIDE(PARAM_N, 8U)
#define VEC_K_SIZE_BYTES PARAM_K
#define VEC_N1_SIZE_BYTES PARAM_N1
#define VEC_N1N2_SIZE_BYTES CEIL_DIVIDE(PARAM_N1N2, 8U)
#define VEC_N_SIZE_64 CEIL_DIVIDE(PARAM_N, 64U)
#define VEC_N1_SIZE_64 CEIL_DIVIDE(PARAM_N1, 8U)
#define VEC_N1N2_SIZE_64 CEIL_DIVIDE(PARAM_N1N2, 64U)
#define QSC_HQC_SEED_SIZE 32U
#define QSC_HQC_SHAREDSECRET_SIZE 32U

typedef struct
{
    uint64_t u[VEC_N_SIZE_64];
    uint64_t v[VEC_N1N2_SIZE_64];
} qsc_hqc_ciphertext_pke;

typedef struct
{
    qsc_hqc_ciphertext_pke c_pke;
    uint8_t salt[SALT_BYTES];
} qsc_hqc_ciphertext_kem;

typedef union
{
    uint8_t u8[16];
    uint16_t u16[8];
    uint32_t u32[4];
} rm_codeword_t;

bool qsc_hqc_ref_decapsulate(uint8_t* secret, const uint8_t* ciphertext, const uint8_t* privatekey);

bool qsc_hqc_ref_encapsulate(uint8_t* secret, uint8_t* ciphertext, const uint8_t* publickey, bool (*rng_generate)(uint8_t*, size_t));

void qsc_hqc_ref_seeded_encapsulate(uint8_t* secret, uint8_t* ciphertext, const uint8_t* publickey, const uint8_t seed[QSC_HQC_SEED_SIZE]);

bool qsc_hqc_ref_generate_keypair(uint8_t* publickey, uint8_t* privatekey, bool (*rng_generate)(uint8_t*, size_t));

void qsc_hqc_ref_generate_seeded_keypair(uint8_t* publickey, uint8_t* privatekey, uint8_t* seed);
 
/* \cond NO_DOCUMENT */
 
#endif