tlsengine.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_ENGINE_H
#define QSC_TLS_ENGINE_H
 
#include "qsccommon.h"
#include "tlserrors.h"
#include "tlstypes.h"
#include "tlslimits.h"
#include "tlsstate.h"
#include "tlsclient.h"
#include "tlsserver.h"
#include "tlssession.h"
 
QSC_CPLUSPLUS_ENABLED_START


    typedef enum qsc_tls_role
{
    qsc_tls_role_client = 0,    
    qsc_tls_role_server = 1     
} qsc_tls_role;

typedef struct qsc_tls_connection
{
    union
    {
        qsc_tls_client_state client;    
        qsc_tls_server_state server;    
    } state;
 
    qsc_tls_role role;                                          
    uint8_t handshakebuffer[QSC_TLS_STREAM_BUFFER_MAX_SIZE];    
    size_t handshakebufferlen;                                  
    uint8_t applicationbuffer[QSC_TLS_MAX_RECORD_SIZE];         
    size_t applicationbufferlen;                                
} qsc_tls_connection;

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_initialize_client(qsc_tls_connection* connection, const qsc_tls_client_config* config);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_initialize_server(qsc_tls_connection* connection, const qsc_tls_server_config* config);

QSC_EXPORT_API void qsc_tls_engine_dispose(qsc_tls_connection* connection);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_handshake(qsc_tls_connection* connection, const uint8_t* input, size_t inlen, size_t* consumed, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_write_application_data(qsc_tls_connection* connection, const uint8_t* input, size_t inlen, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_read_application_data(qsc_tls_connection* connection, const uint8_t* input, size_t inlen, size_t* consumed,
    uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_read_application_data_ex(qsc_tls_connection* connection, const uint8_t* input, size_t inlen, size_t* consumed,
    uint8_t* output, size_t outlen, size_t* written, uint8_t* responseoutput, size_t responseoutlen, size_t* responsewritten);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_request_key_update(qsc_tls_connection* connection, bool requestpeerupdate, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_emit_session_ticket(qsc_tls_connection* connection, uint32_t lifetime_seconds, uint8_t* output,
    size_t outlen, size_t* written, qsc_tls_session_ticket* ticketout);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_consume_session_ticket(qsc_tls_connection* connection, const uint8_t* input, size_t inlen,
    size_t* consumed, qsc_tls_session_ticket* ticketout);

QSC_EXPORT_API qsc_tls_status qsc_tls_engine_close(qsc_tls_connection* connection, uint8_t* output, size_t outlen, size_t* written);

QSC_EXPORT_API bool qsc_tls_engine_is_handshake_complete(const qsc_tls_connection* connection);
 
QSC_CPLUSPLUS_ENABLED_END
 
#endif