rcs.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_RCS_H
#define QSC_RCS_H
 
#include "qsccommon.h"
#include "sha3.h"
#if defined(QSC_SYSTEM_AESNI_ENABLED)
#   include "intrinsics.h"
#   include <immintrin.h>
#endif
 
QSC_CPLUSPLUS_ENABLED_START

 
/***********************************
*    USER CONFIGURABLE SETTINGS    *
***********************************/

#if !defined(QSC_RCS_AUTHENTICATED)
#   define QSC_RCS_AUTHENTICATED
#endif

//#define QSC_RCS_REDUCED_ROUNDS
 
/***********************************
*     RCS CONSTANTS AND SIZES      *
***********************************/

#define QSC_RCS_BLOCK_SIZE 32U

#define QSC_RCS256_KEY_SIZE 32U

#define QSC_RCS256_MAC_SIZE 32U

#define QSC_RCS512_KEY_SIZE 64U

#define QSC_RCS512_MAC_SIZE 64U

#define QSC_RCS_NONCE_SIZE 32U

typedef enum
{
    RCS256 = 0x01,            
    RCS512 = 0x02,            
} rcs_cipher_type;

QSC_EXPORT_API typedef struct
{
    const uint8_t* key;      
    size_t keylen;            
    uint8_t* nonce;            
    const uint8_t* info;    
    size_t infolen;          
} qsc_rcs_keyparams;

QSC_EXPORT_API typedef struct
{
    rcs_cipher_type ctype;              
#if defined(QSC_SYSTEM_AESNI_ENABLED)
    __m128i roundkeys[62U];                
#   if defined(QSC_SYSTEM_HAS_AVX512)
        __m512i roundkeysw[31U];            
#   endif
#else
    uint32_t roundkeys[248U];          
#endif
    size_t roundkeylen;                  
    size_t rounds;                        
    qsc_keccak_state kstate;          
    uint8_t nonce[QSC_RCS_NONCE_SIZE];   
    uint64_t counter;                    
    bool encrypt;                        
} qsc_rcs_state;

QSC_EXPORT_API void qsc_rcs_dispose(qsc_rcs_state* ctx);

QSC_EXPORT_API void qsc_rcs_initialize(qsc_rcs_state* ctx, const qsc_rcs_keyparams* keyparams, bool encryption);

QSC_EXPORT_API void qsc_rcs_set_associated(qsc_rcs_state* ctx, const uint8_t* data, size_t length);

QSC_EXPORT_API void qsc_rcs_store_nonce(const qsc_rcs_state* ctx, uint8_t nonce[QSC_RCS_NONCE_SIZE]);

QSC_EXPORT_API bool qsc_rcs_transform(qsc_rcs_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API bool qsc_rcs_extended_transform(qsc_rcs_state* ctx, uint8_t* output, const uint8_t* input, size_t length, bool finalize);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif