hkds_factory.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 HKDS_FACTORY_H
#define HKDS_FACTORY_H
 
#include "common.h"
#include "hkds_config.h"

 
/* convert header to serialized packet */

HKDS_EXPORT_API void hkds_factory_serialize_packet_header(uint8_t* output, const hkds_packet_header* header);

HKDS_EXPORT_API void hkds_factory_serialize_client_message(uint8_t* output, const hkds_client_message_request* header);

HKDS_EXPORT_API void hkds_factory_serialize_client_token(uint8_t* output, const hkds_client_token_request* header);

HKDS_EXPORT_API void hkds_factory_serialize_server_message(uint8_t* output, const hkds_server_message_response* header);

HKDS_EXPORT_API void hkds_factory_serialize_server_token(uint8_t* output, const hkds_server_token_response* header);

HKDS_EXPORT_API void hkds_factory_serialize_administrative_message(uint8_t* output, const hkds_administrative_message* header);

HKDS_EXPORT_API void hkds_factory_serialize_error_message(uint8_t* output, const hkds_error_message* header);
 
/* convert serialized packet to header */

HKDS_EXPORT_API hkds_packet_header hkds_factory_extract_packet_header(const uint8_t* input);

HKDS_EXPORT_API hkds_client_message_request hkds_factory_extract_client_message(const uint8_t* input);

HKDS_EXPORT_API hkds_client_token_request hkds_factory_extract_client_token(const uint8_t* input);

HKDS_EXPORT_API hkds_server_message_response hkds_factory_extract_server_message(const uint8_t* input);

HKDS_EXPORT_API hkds_server_token_response hkds_factory_extract_server_token(const uint8_t* input);

HKDS_EXPORT_API hkds_administrative_message hkds_factory_extract_administrative_message(const uint8_t* input);

HKDS_EXPORT_API hkds_error_message hkds_factory_extract_error_message(const uint8_t* input);
 
/* packet construction */

HKDS_EXPORT_API hkds_client_message_request hkds_factory_create_client_message_request(const uint8_t* message, const uint8_t* ksn, const uint8_t* tag);

HKDS_EXPORT_API hkds_client_token_request hkds_factory_create_client_token_request(const uint8_t* ksn);

HKDS_EXPORT_API hkds_server_message_response hkds_factory_create_server_message_response(const uint8_t* message);

HKDS_EXPORT_API hkds_server_token_response hkds_factory_create_server_token_reponse(const uint8_t* etok);

HKDS_EXPORT_API hkds_administrative_message hkds_factory_create_administrative_message(const uint8_t* message);

HKDS_EXPORT_API hkds_error_message hkds_factory_create_error_message(const uint8_t* message, hkds_error_type err);
 
/* raw packet value extraction  */

HKDS_EXPORT_API hkds_packet_type hkds_factory_extract_packet_type(const uint8_t* input);

HKDS_EXPORT_API hkds_protocol_id hkds_factory_extract_protocol_id(const uint8_t* input);

HKDS_EXPORT_API size_t hkds_factory_extract_packet_size(const uint8_t* input);

HKDS_EXPORT_API uint8_t hkds_factory_extract_packet_sequence(const uint8_t* input);
 
#endif