sha2.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_SHA2_H
#define QSC_SHA2_H
 
#include "qsccommon.h"
 
QSC_CPLUSPLUS_ENABLED_START


#define QSC_HKDF_256_KEY_SIZE 32U

#define QSC_HKDF_384_KEY_SIZE 48U

#define QSC_HKDF_512_KEY_SIZE 64U

#define QSC_HMAC_256_KEY_SIZE 32U

#define QSC_HMAC_384_KEY_SIZE 48U

#define QSC_HMAC_512_KEY_SIZE 64U

#define QSC_HMAC_256_MAC_SIZE 32U

#define QSC_HMAC_384_MAC_SIZE 48U

#define QSC_HMAC_512_MAC_SIZE 64U

#define QSC_HMAC_256_RATE 64U

#define QSC_HMAC_384_RATE 96U

#define QSC_HMAC_512_RATE 128U

#define QSC_SHA2_256_HASH_SIZE 32U

#define QSC_SHA2_384_HASH_SIZE 48U

#define QSC_SHA2_512_HASH_SIZE 64U

#define QSC_SHA2_256_RATE 64U

#define QSC_SHA2_384_RATE 128U

#define QSC_SHA2_512_RATE 128U

#define QSC_SHA2_STATE_SIZE 8U
 
/* SHA2-256 */

QSC_EXPORT_API typedef struct
{
    uint32_t state[QSC_SHA2_STATE_SIZE];    
    uint8_t  buffer[QSC_SHA2_256_RATE];     
    uint64_t t;                             
    size_t   position;                      
} qsc_sha256_state;

QSC_EXPORT_API void qsc_sha256_compute(uint8_t* output, const uint8_t* message, size_t msglen);

QSC_EXPORT_API void qsc_sha256_dispose(qsc_sha256_state* ctx);

QSC_EXPORT_API void qsc_sha256_finalize(qsc_sha256_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_sha256_initialize(qsc_sha256_state* ctx);

QSC_EXPORT_API void qsc_sha256_permute(uint32_t* output, const uint8_t* input);

QSC_EXPORT_API void qsc_sha256_update(qsc_sha256_state* ctx, const uint8_t* message, size_t msglen);
 
/* SHA2-384 */

QSC_EXPORT_API typedef struct
{
    uint64_t state[QSC_SHA2_STATE_SIZE];    
    uint64_t t[2U];                         
    uint8_t  buffer[QSC_SHA2_384_RATE];     
    size_t   position;                      
} qsc_sha384_state;

QSC_EXPORT_API void qsc_sha384_compute(uint8_t* output, const uint8_t* message, size_t msglen);

QSC_EXPORT_API void qsc_sha384_dispose(qsc_sha384_state* ctx);

QSC_EXPORT_API void qsc_sha384_finalize(qsc_sha384_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_sha384_initialize(qsc_sha384_state* ctx);

QSC_EXPORT_API void qsc_sha384_update(qsc_sha384_state* ctx, const uint8_t* message, size_t msglen);
 
/* SHA2-512 */

QSC_EXPORT_API typedef struct
{
    uint64_t state[QSC_SHA2_STATE_SIZE];    
    uint64_t t[2U];                         
    uint8_t  buffer[QSC_SHA2_512_RATE];     
    size_t   position;                      
} qsc_sha512_state;

QSC_EXPORT_API void qsc_sha512_compute(uint8_t* output, const uint8_t* message, size_t msglen);

QSC_EXPORT_API void qsc_sha512_dispose(qsc_sha512_state* ctx);

QSC_EXPORT_API void qsc_sha512_finalize(qsc_sha512_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_sha512_initialize(qsc_sha512_state* ctx);

QSC_EXPORT_API void qsc_sha512_permute(uint64_t* output, const uint8_t* input);

QSC_EXPORT_API void qsc_sha512_update(qsc_sha512_state* ctx, const uint8_t* message, size_t msglen);
 
/* HMAC-256 */

QSC_EXPORT_API typedef struct
{
    qsc_sha256_state pstate;            
    uint8_t ipad[QSC_SHA2_256_RATE];    
    uint8_t opad[QSC_SHA2_256_RATE];    
} qsc_hmac256_state;

QSC_EXPORT_API void qsc_hmac256_compute(uint8_t* output, const uint8_t* message, size_t msglen, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac256_dispose(qsc_hmac256_state* ctx);

QSC_EXPORT_API void qsc_hmac256_finalize(qsc_hmac256_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_hmac256_initialize(qsc_hmac256_state* ctx, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac256_update(qsc_hmac256_state* ctx, const uint8_t* message, size_t msglen);
 
/* HMAC-384 */

QSC_EXPORT_API typedef struct
{
    qsc_sha384_state pstate;            
    uint8_t ipad[QSC_SHA2_384_RATE];    
    uint8_t opad[QSC_SHA2_384_RATE];    
} qsc_hmac384_state;

QSC_EXPORT_API void qsc_hmac384_compute(uint8_t* output, const uint8_t* message, size_t msglen, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac384_dispose(qsc_hmac384_state* ctx);

QSC_EXPORT_API void qsc_hmac384_finalize(qsc_hmac384_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_hmac384_initialize(qsc_hmac384_state* ctx, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac384_update(qsc_hmac384_state* ctx, const uint8_t* message, size_t msglen);
 
/* HMAC-512 */

QSC_EXPORT_API typedef struct
{
    qsc_sha512_state pstate;            
    uint8_t ipad[QSC_SHA2_512_RATE];    
    uint8_t opad[QSC_SHA2_512_RATE];    
} qsc_hmac512_state;

QSC_EXPORT_API void qsc_hmac512_compute(uint8_t* output, const uint8_t* message, size_t msglen, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac512_dispose(qsc_hmac512_state* ctx);

QSC_EXPORT_API void qsc_hmac512_finalize(qsc_hmac512_state* ctx, uint8_t* output);

QSC_EXPORT_API void qsc_hmac512_initialize(qsc_hmac512_state* ctx, const uint8_t* key, size_t keylen);

QSC_EXPORT_API void qsc_hmac512_update(qsc_hmac512_state* ctx, const uint8_t* message, size_t msglen);
 
/* HKDF */

QSC_EXPORT_API void qsc_hkdf256_expand(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* info, size_t infolen);

QSC_EXPORT_API void qsc_hkdf256_extract(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* salt, size_t saltlen);

QSC_EXPORT_API void qsc_hkdf384_expand(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* info, size_t infolen);

QSC_EXPORT_API void qsc_hkdf384_extract(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* salt, size_t saltlen);

QSC_EXPORT_API void qsc_hkdf512_expand(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* info, size_t infolen);

QSC_EXPORT_API void qsc_hkdf512_extract(uint8_t* output, size_t otplen, const uint8_t* key, size_t keylen, const uint8_t* salt, size_t saltlen);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif