tlskeyschedule.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_TLS_KEYSCHEDULE_H
#define QSC_TLS_KEYSCHEDULE_H
 
#include "qsccommon.h"
#include "tlserrors.h"
#include "tlstypes.h"
#include "tlsstate.h"
 
QSC_CPLUSPLUS_ENABLED_START

    typedef struct qsc_tls_key_schedule_state
{
    uint8_t binderkey[QSC_TLS_HASH_MAX_SIZE];                           
    uint8_t clientapplicationtrafficsecret[QSC_TLS_HASH_MAX_SIZE];      
    uint8_t clientearlytrafficsecret[QSC_TLS_HASH_MAX_SIZE];            
    uint8_t clienthandshaketrafficsecret[QSC_TLS_HASH_MAX_SIZE];        
    uint8_t earlyexportermastersecret[QSC_TLS_HASH_MAX_SIZE];           
    uint8_t exportermastersecret[QSC_TLS_HASH_MAX_SIZE];                
    uint8_t earlysecret[QSC_TLS_HASH_MAX_SIZE];                         
    uint8_t handshakesecret[QSC_TLS_HASH_MAX_SIZE];                     
    uint8_t mastersecret[QSC_TLS_HASH_MAX_SIZE];                        
    uint8_t resumptionmastersecret[QSC_TLS_HASH_MAX_SIZE];              
    uint8_t serverhandshaketrafficsecret[QSC_TLS_HASH_MAX_SIZE];        
    uint8_t serverapplicationtrafficsecret[QSC_TLS_HASH_MAX_SIZE];      
    size_t digestsize;                                                  
    qsc_tls_hash_algorithm hash;                                        
    bool binderderived;                                                 
    bool earlydone;                                                     
    bool earlytrafficderived;                                           
    bool handshakedone;                                                 
    bool initialized;                                                   
    bool masterdone;                                                    
} qsc_tls_key_schedule_state;

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_state_initialize(qsc_tls_key_schedule_state* state, qsc_tls_hash_algorithm hash);

QSC_EXPORT_API void qsc_tls_keyschedule_state_dispose(qsc_tls_key_schedule_state* state);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_hkdf_extract(qsc_tls_hash_algorithm hash, const uint8_t* salt, size_t saltlen, const uint8_t* ikm,
    size_t ikmlen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_hkdf_expand(qsc_tls_hash_algorithm hash, const uint8_t* prk, size_t prklen, const uint8_t* info,
    size_t infolen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_hkdf_expand_label(qsc_tls_hash_algorithm hash, const uint8_t* secret, size_t secretlen,
    const char* label, size_t labellen, const uint8_t* context, size_t contextlen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_secret_with_hash(qsc_tls_hash_algorithm hash, const uint8_t* secret, size_t secretlen,
    const char* label, size_t labellen, const uint8_t* transcripthash, size_t transcripthashlen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_secret_empty(qsc_tls_hash_algorithm hash, const uint8_t* secret, size_t secretlen,
    const char* label, size_t labellen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_extract_early_secret(qsc_tls_key_schedule_state* state, const uint8_t* psk, size_t psklen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_extract_handshake_secret(qsc_tls_key_schedule_state* state, const uint8_t* dhe, size_t dhelen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_extract_master_secret(qsc_tls_key_schedule_state* state);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_handshake_traffic_secrets(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_application_traffic_secrets(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_exporter_master_secret(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_resumption_master_secret(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_traffic_keys(qsc_tls_hash_algorithm hash,
    const uint8_t* trafficsecret, size_t trafficsecretlen, size_t keylen, size_t ivlen, uint8_t* keyoutput, uint8_t* ivoutput);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_advance_traffic_secret(qsc_tls_hash_algorithm hash, const uint8_t* currenttrafficsecret, 
    size_t trafficsecretlen, uint8_t* nexttrafficsecret);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_compute_finished(qsc_tls_hash_algorithm hash, const uint8_t* basekey, size_t basekeylen, 
    const uint8_t* transcripthash, size_t transcripthashlen, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_verify_finished(qsc_tls_hash_algorithm hash, const uint8_t* basekey, size_t basekeylen, 
    const uint8_t* transcripthash, size_t transcripthashlen, const uint8_t* candidate, size_t candidatelen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_build_certificate_verify_input(const char* contextstring, const uint8_t* transcripthash, 
    size_t transcripthashlen, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_suite_record_sizes(qsc_tls_cipher_suite suite, size_t* keylen, size_t* ivlen);

QSC_EXPORT_API qsc_tls_hash_algorithm qsc_tls_keyschedule_suite_hash(qsc_tls_cipher_suite suite);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_resumption_psk(const qsc_tls_key_schedule_state* state, const uint8_t* nonce, 
    size_t noncelen, uint8_t* output, size_t outlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_binder_key(qsc_tls_key_schedule_state* state, bool external);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_client_early_traffic_secret(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_derive_early_exporter_secret(qsc_tls_key_schedule_state* state, const uint8_t* transcripthash, size_t transcripthashlen);

QSC_EXPORT_API qsc_tls_status qsc_tls_keyschedule_compute_psk_binder(qsc_tls_hash_algorithm hash, const uint8_t* binderkey, size_t binderkeylen,
    const uint8_t* partialtranshash, size_t transcripthashlen, uint8_t* output, size_t outlen, size_t* written);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif