mceliece.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_MCELIECE_H
#define QSC_MCELIECE_H
 
#include "qsccommon.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_MCELIECE_KEYGEN_STACK_BYTES  (4U * 1024U * 1024U)
 
/* Parameter definitions for different McEliece parameter sets */
#if defined(QSC_MCELIECE_S1N3488T64)

#   define QSC_MCELIECE_CIPHERTEXT_SIZE 128U

#   define QSC_MCELIECE_PRIVATEKEY_SIZE 6492U

#   define QSC_MCELIECE_PUBLICKEY_SIZE 261120U

#   define QSC_MCELIECE_ALGNAME "MCELIECE-P3488T64"
 
#elif defined(QSC_MCELIECE_S3N4608T96)

#   define QSC_MCELIECE_CIPHERTEXT_SIZE 188U

#   define QSC_MCELIECE_PRIVATEKEY_SIZE 13608U

#   define QSC_MCELIECE_PUBLICKEY_SIZE 524160U

#   define QSC_MCELIECE_ALGNAME "MCELIECE-P4608T96"
 
#elif defined(QSC_MCELIECE_S5N6688T128)

#   define QSC_MCELIECE_CIPHERTEXT_SIZE 240U

#   define QSC_MCELIECE_PRIVATEKEY_SIZE 13932U

#   define QSC_MCELIECE_PUBLICKEY_SIZE 1044992U

#   define QSC_MCELIECE_ALGNAME "MCELIECE-P6688T128"
 
#elif defined(QSC_MCELIECE_S6N6960T119)

#   define QSC_MCELIECE_CIPHERTEXT_SIZE 226U

#   define QSC_MCELIECE_PRIVATEKEY_SIZE 13948U

#   define QSC_MCELIECE_PUBLICKEY_SIZE 1047319U

#   define QSC_MCELIECE_ALGNAME "MCELIECE-P6960T119"
 
#elif defined(QSC_MCELIECE_S7N8192T128)

#   define QSC_MCELIECE_CIPHERTEXT_SIZE 240U

#   define QSC_MCELIECE_PRIVATEKEY_SIZE 14120U

#   define QSC_MCELIECE_PUBLICKEY_SIZE 1357824U

#   define QSC_MCELIECE_ALGNAME "MCELIECE-P8192T128"
 
#else
#   error "The McEliece parameter set is invalid!"
#endif

#define QSC_MCELIECE_SEED_SIZE 32ULL

#define QSC_MCELIECE_SHAREDSECRET_SIZE 32ULL

QSC_EXPORT_API bool qsc_mceliece_decapsulate(uint8_t* secret, const uint8_t* ciphertext, const uint8_t* privatekey);

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

QSC_EXPORT_API bool qsc_mceliece_generate_keypair(uint8_t* publickey, uint8_t* privatekey, bool (*rng_generate)(uint8_t*, size_t));
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif