aes.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_AES_H
#define QSC_AES_H
 
#include "qsccommon.h"
#include "intrinsics.h"

#define QSC_HBA_KMAC_EXTENSION

#define QSC_HBA_HKDF_EXTENSION
 
#if defined(QSC_HBA_KMAC_EXTENSION)
#   include "sha3.h"
#else
#   include "sha2.h"
#endif

 
QSC_CPLUSPLUS_ENABLED_START

typedef enum
{
    qsc_aes_cipher_128 = 0x01U,   
    qsc_aes_cipher_256 = 0x02U    
} qsc_aes_cipher_type;

typedef enum
{
    qsc_aes_mode_cbc = 0x01U,   
    qsc_aes_mode_ctr = 0x02U,   
    qsc_aes_mode_ecb = 0x03U    
} qsc_aes_cipher_mode;
 
/***********************************
*     AES CONSTANTS AND SIZES      *
***********************************/

#define QSC_AES_BLOCK_SIZE 16U

#define QSC_AES_IV_SIZE 16U

#define QSC_AES128_KEY_SIZE 16U

#define QSC_AES256_KEY_SIZE 32U

#define QSC_GCM128_MAC_SIZE 16U

#define QSC_GCM256_MAC_SIZE 16U

#define QSC_GCM_MAXAAD_SIZE 65536U

#define QSC_GCM_NONCE_SIZE 12U

#define QSC_GCM_MAX_NONCE_SIZE 32U

#define QSC_HBA256_MAC_SIZE 32U

#define QSC_HBA_MAXAAD_SIZE 256U

#define QSC_HBA_MAXINFO_SIZE 256U

#if defined(QSC_HBA_KMAC_EXTENSION)
#   define QSC_HBA_KMAC_AUTH
#endif

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

QSC_EXPORT_API typedef struct
{
#if defined(QSC_SYSTEM_AESNI_ENABLED)
    __m128i roundkeys[31U];            
#   if defined(QSC_SYSTEM_HAS_AVX512)
        __m512i roundkeysw[31U];        
#   endif
#else
    uint32_t roundkeys[124U];      
#endif
    size_t roundkeylen;              
    size_t rounds;                    
    uint8_t* nonce;                    
} qsc_aes_state;
 
/* Function Declarations */

QSC_EXPORT_API void qsc_aes_dispose(qsc_aes_state* ctx);

QSC_EXPORT_API void qsc_aes_initialize(qsc_aes_state* ctx, const qsc_aes_keyparams* keyparams, bool encryption, qsc_aes_cipher_type ctype);
 
/* CBC Mode */

QSC_EXPORT_API void qsc_aes_cbc_decrypt(qsc_aes_state* ctx, uint8_t* output, size_t* outputlen, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_cbc_encrypt(qsc_aes_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_cbc_decrypt_block(qsc_aes_state* ctx, uint8_t* output, const uint8_t* input);

QSC_EXPORT_API void qsc_aes_cbc_encrypt_block(qsc_aes_state* ctx, uint8_t* output, const uint8_t* input);
 
/* PKCS#7 Padding */

QSC_EXPORT_API void qsc_pkcs7_add_padding(uint8_t* input, size_t length);

QSC_EXPORT_API size_t qsc_pkcs7_padding_length(const uint8_t* input);
 
/* CTR Mode */

QSC_EXPORT_API void qsc_aes_ctrbe_transform(qsc_aes_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_ctrle_transform(qsc_aes_state* ctx, uint8_t* output, const uint8_t* input, size_t length);
 
/* ECB Mode */

QSC_EXPORT_API void qsc_aes_ecb_decrypt_block(const qsc_aes_state* ctx, uint8_t* output, const uint8_t* input);

QSC_EXPORT_API void qsc_aes_ecb_encrypt_block(const qsc_aes_state* ctx, uint8_t* output, const uint8_t* input);
 
/* HBA-256 Authenticated Encryption */

QSC_EXPORT_API typedef struct
{
#if defined(QSC_HBA_KMAC_EXTENSION)
    qsc_keccak_state kstate;          
#else
    qsc_hmac256_state kstate;            
#endif
    qsc_aes_state cstate;                
    uint64_t counter;                    
    uint8_t mkey[QSC_HBA256_MAC_SIZE];   
    uint8_t cust[QSC_HBA_MAXINFO_SIZE]; 
    size_t custlen;                      
    bool encrypt;                        
} qsc_aes_hba256_state;

QSC_EXPORT_API void qsc_aes_hba256_dispose(qsc_aes_hba256_state* ctx);

QSC_EXPORT_API void qsc_aes_hba256_initialize(qsc_aes_hba256_state* ctx, const qsc_aes_keyparams* keyparams, bool encrypt);

QSC_EXPORT_API void qsc_aes_hba256_set_associated(qsc_aes_hba256_state* ctx, const uint8_t* data, size_t datalen);

QSC_EXPORT_API bool qsc_aes_hba256_transform(qsc_aes_hba256_state* ctx, uint8_t* output, const uint8_t* input, size_t length);
 
/* GCM-AES-128 RFC 5288/5116 */

QSC_EXPORT_API typedef struct qsc_aes_gcm128_state
{
    qsc_aes_state cstate;           
    uint8_t C[QSC_AES_BLOCK_SIZE];  
    uint8_t H[QSC_AES_BLOCK_SIZE];  
    uint8_t J0[QSC_AES_BLOCK_SIZE]; 
    uint8_t S[QSC_AES_BLOCK_SIZE];  
    uint64_t aadlen;                
    uint64_t ctlen;                 
    bool encrypt;                   
} qsc_aes_gcm128_state;

QSC_EXPORT_API bool qsc_aes_gcm128_decrypt(qsc_aes_gcm128_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_gcm128_dispose(qsc_aes_gcm128_state* ctx);

QSC_EXPORT_API void qsc_aes_gcm128_encrypt(qsc_aes_gcm128_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_gcm128_initialize(qsc_aes_gcm128_state* ctx, const qsc_aes_keyparams* keyparams, bool encryption);

QSC_EXPORT_API void qsc_aes_gcm128_set_associated(qsc_aes_gcm128_state* ctx, const uint8_t* data, size_t datalen);

QSC_EXPORT_API bool qsc_aes_gcm128_transform(qsc_aes_gcm128_state* ctx, uint8_t* output, const uint8_t* input, size_t length);
 
/* GCM-AES-256 RFC 5288/5116 */

QSC_EXPORT_API typedef struct qsc_aes_gcm256_state 
{
    qsc_aes_state cstate;            
    uint8_t C[QSC_AES_BLOCK_SIZE];   
    uint8_t H[QSC_AES_BLOCK_SIZE];  
    uint8_t J0[QSC_AES_BLOCK_SIZE]; 
    uint8_t S[QSC_AES_BLOCK_SIZE];  
    uint64_t aadlen;              
    uint64_t ctlen;                    
    bool encrypt;                    
} qsc_aes_gcm256_state;

QSC_EXPORT_API bool qsc_aes_gcm256_decrypt(qsc_aes_gcm256_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_gcm256_dispose(qsc_aes_gcm256_state* ctx);

QSC_EXPORT_API void qsc_aes_gcm256_encrypt(qsc_aes_gcm256_state* ctx, uint8_t* output, const uint8_t* input, size_t length);

QSC_EXPORT_API void qsc_aes_gcm256_initialize(qsc_aes_gcm256_state* ctx, const qsc_aes_keyparams* keyparams, bool encryption);

QSC_EXPORT_API void qsc_aes_gcm256_set_associated(qsc_aes_gcm256_state* ctx, const uint8_t* data, size_t datalen);

QSC_EXPORT_API bool qsc_aes_gcm256_transform(qsc_aes_gcm256_state* ctx, uint8_t* output, const uint8_t* input, size_t length);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif