csx.h

Go to the documentation of this file.

/* 2025 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 within this implementation 
 * are proprietary to QRCS and its authorized licensors and are protected under 
 * applicable U.S. and international copyright, patent, and trade secret laws.
 *
 * CRYPTOGRAPHIC STANDARDS:
 * - This software includes implementations of cryptographic algorithms such as 
 *   SHA3, AES, and others. These algorithms are public domain or standardized 
 *   by organizations such as NIST and are NOT the property of QRCS.
 * - However, all source code, optimizations, and implementations in this library 
 *   are original works of QRCS and are protected under this license.
 *
 * RESTRICTIONS:
 * - Redistribution, modification, or unauthorized distribution of this software, 
 *   in whole or in part, is strictly prohibited.
 * - This software is provided for non-commercial, educational, and research 
 *   purposes only. Commercial use in any form is expressly forbidden.
 * - Licensing and authorized distribution are solely at the discretion of QRCS.
 * - Any use of this software implies acceptance of these restrictions.
 *
 * DISCLAIMER:
 * This software is provided "as is," without warranty of any kind, express or 
 * implied, including but not limited to warranties of merchantability or fitness 
 * for a particular purpose. QRCS disclaims all liability for any direct, indirect, 
 * incidental, or consequential damages resulting from the use or misuse of this software.
 *
 * FULL LICENSE:
 * This software is subject to the **Quantum Resistant Cryptographic Solutions 
 * Proprietary License (QRCS-PL)**. The complete license terms are included 
 * in the LICENSE.txt file distributed with this software.
 *
 * Written by: John G. Underhill
 * Contact: john.underhill@protonmail.com
 */
 
#ifndef QSC_CSX_H
#define QSC_CSX_H
 
#include "common.h"
#include "sha3.h"
 
QSC_CPLUSPLUS_ENABLED_START


#if !defined(QSC_CSX_AUTHENTICATED)
#   define QSC_CSX_AUTHENTICATED
#endif
 
/* Enable one of the authentication options: 
   a 24 round KMAC, a reduced rounds KMAC, or the QMAC post quantum GMAC function */
#if defined(QSC_CSX_AUTHENTICATED)
//* \def QSC_CSX_AUTH_KMAC24
//* \brief Sets the authentication mode to standard KMAC-R24.
//*/
//# define QSC_CSX_AUTH_KMAC24

//\def QSC_CSX_AUTH_KMACR12
//* \brief Enables the reduced rounds KMAC-R12 implementation.
//*/
//# define QSC_CSX_AUTH_KMACR12

#   define QSC_CSX_AUTH_QMAC
#endif

#if defined(QSC_CSX_AUTHENTICATED)
#   if !defined(QSC_CSX_AUTH_KMAC24) && !defined(QSC_CSX_AUTH_KMACR12) && !defined(QSC_CSX_AUTH_QMAC)
#       define QSC_CSX_AUTH_KMAC24
#   endif
#endif
 
#if defined(QSC_CSX_AUTH_QMAC)
#   include "qmac.h"
#endif

#define QSC_CSX_BLOCK_SIZE 128ULL

#define QSC_CSX_INFO_SIZE 48ULL

#define QSC_CSX_KEY_SIZE 64ULL
 
#if defined(QSC_CSX_AUTH_QMAC)
#define QSC_CSX_MAC_SIZE 32ULL
#else
#define QSC_CSX_MAC_SIZE 64ULL
#endif

#define QSC_CSX_NONCE_SIZE 16ULL

#define QSC_CSX_STATE_SIZE 16ULL

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

QSC_EXPORT_API typedef struct
{
    uint64_t state[QSC_CSX_STATE_SIZE];  
#if defined(QSC_CSX_AUTH_QMAC)
    qsc_qmac_state kstate;              
#else
    qsc_keccak_state kstate;          
#endif
    uint64_t counter;                    
    bool encrypt;                        
} qsc_csx_state;
 
/* public functions */

QSC_EXPORT_API void qsc_csx_dispose(qsc_csx_state* ctx);

QSC_EXPORT_API void qsc_csx_initialize(qsc_csx_state* ctx, const qsc_csx_keyparams* keyparams, bool encryption);

QSC_EXPORT_API void qsc_csx_set_associated(qsc_csx_state* ctx, const uint8_t* data, size_t length);

QSC_EXPORT_API void qsc_csx_store_nonce(const qsc_csx_state* ctx, uint8_t nonce[QSC_CSX_NONCE_SIZE]);

QSC_EXPORT_API bool qsc_csx_transform(qsc_csx_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

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