network.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 STANDAARS:
 * - 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: contact@qrcscorp.ca
 */
 
#ifndef AERN_NETWORK_H
#define AERN_NETWORK_H
 
#include "aerncommon.h"
#include "topology.h"
#include "collection.h"
#include "sha3.h"
#include "socket.h"


AERN_EXPORT_API typedef struct aern_network_announce_request_state
{
    const aern_topology_list_state* list;               
    const aern_topology_node_state* rnode;             
    const uint8_t* sigkey;                                
} aern_network_announce_request_state;

AERN_EXPORT_API typedef struct aern_network_announce_response_state
{
    const aern_child_certificate* dcert;             
    aern_topology_node_state* rnode;                   
    const aern_root_certificate* root;                 
} aern_network_announce_response_state;

AERN_EXPORT_API typedef struct aern_network_converge_request_state
{
    const aern_child_certificate* rcert;             
    aern_topology_node_state* rnode;                   
    const uint8_t* sigkey;                                
} aern_network_converge_request_state;

AERN_EXPORT_API typedef struct aern_network_converge_response_state
{
    const qsc_socket* csock;                           
    const aern_child_certificate* lcert;             
    const aern_topology_node_state* lnode;             
    const aern_child_certificate* rcert;             
    const uint8_t* sigkey;                                
} aern_network_converge_response_state;

AERN_EXPORT_API typedef struct aern_network_converge_response_verify_state
{
    const qsc_socket* csock;                           
    const aern_topology_node_state* rnode;             
    const aern_child_certificate* rcert;             
} aern_network_converge_response_verify_state;

AERN_EXPORT_API typedef struct aern_network_converge_update_verify_state
{
    const qsc_socket* csock;                                   
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_converge_update_verify_state;

AERN_EXPORT_API typedef struct aern_network_fkey_request_state
{
    uint8_t* frag;                                      
    const aern_topology_node_state* lnode;             
    const uint8_t* mfk;                                  
    const aern_topology_node_state* rnode;             
    uint8_t* token;                                        
} aern_network_fkey_request_state;

AERN_EXPORT_API typedef struct aern_network_fkey_response_state
{
    qsc_socket* csock;                                 
    uint8_t* frag;                                      
    const aern_topology_node_state* lnode;             
    const uint8_t* mfk;                                  
    const aern_topology_node_state* rnode;             
} aern_network_fkey_response_state;

AERN_EXPORT_API typedef struct aern_network_incremental_update_request_state
{
    aern_child_certificate* rcert;                       
    const aern_topology_node_state* rnode;             
    const aern_root_certificate* root;                 
} aern_network_incremental_update_request_state;

AERN_EXPORT_API typedef struct aern_network_incremental_update_response_state
{
    const qsc_socket* csock;                           
    const aern_child_certificate* rcert;             
    const uint8_t* sigkey;                                
} aern_network_incremental_update_response_state;

AERN_EXPORT_API typedef struct aern_network_register_request_state
{
    const char* address;                             
    const aern_child_certificate* lcert;             
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_register_request_state;

AERN_EXPORT_API typedef struct aern_network_register_response_state
{
    const qsc_socket* csock;                           
    const aern_child_certificate* lcert;             
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_register_response_state;

AERN_EXPORT_API typedef struct aern_network_register_update_request_state
{
    const char* address;                             
    const aern_child_certificate* lcert;             
    aern_topology_list_state* list;                     
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_register_update_request_state;

AERN_EXPORT_API typedef struct aern_network_register_update_response_state
{
    const qsc_socket* csock;                           
    const aern_child_certificate* lcert;             
    const aern_topology_list_state* list;               
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_register_update_response_state;

AERN_EXPORT_API typedef struct aern_network_mfk_request_state
{
    const aern_child_certificate* lcert;             
    uint8_t* mfk;                                        
    const aern_child_certificate* rcert;             
    const aern_topology_node_state* rnode;             
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_mfk_request_state;

AERN_EXPORT_API typedef struct aern_network_mfk_response_state
{
    const qsc_socket* csock;                           
    aern_cipher_keypair ckp;                          
    const aern_child_certificate* lcert;             
    uint8_t* mfk;                                        
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_mfk_response_state;

AERN_EXPORT_API typedef struct aern_network_remote_signing_request_state
{
    const char* address;                             
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_remote_signing_request_state;

AERN_EXPORT_API typedef struct aern_network_remote_signing_response_state
{
    qsc_socket* csock;                                 
    aern_child_certificate* dcert;                       
    aern_child_certificate* rcert;                       
    const aern_root_certificate* root;                 
    const uint8_t* sigkey;                                
} aern_network_remote_signing_response_state;

AERN_EXPORT_API typedef struct aern_network_resign_request_state
{
    const char* address;                             
    const aern_topology_node_state* lnode;             
    const uint8_t* sigkey;                                
} aern_network_resign_request_state;

AERN_EXPORT_API typedef struct aern_network_resign_response_state
{
    const aern_topology_list_state* list;               
    aern_child_certificate* rcert;                       
    aern_topology_node_state* rnode;                   
    const uint8_t* sigkey;                                
} aern_network_resign_response_state;

AERN_EXPORT_API typedef struct aern_network_revoke_request_state
{
    aern_network_designations designation;              
    const aern_topology_list_state* list;               
    const aern_topology_node_state* rnode;             
    const uint8_t* sigkey;                                
} aern_network_revoke_request_state;

AERN_EXPORT_API typedef struct aern_network_revoke_response_state
{
    const aern_topology_list_state* list;               
    aern_topology_node_state* rnode;                   
    const aern_child_certificate* dcert;             
} aern_network_revoke_response_state;

AERN_EXPORT_API typedef struct aern_network_topological_query_request_state
{
    const aern_child_certificate* dcert;             
    aern_topology_node_state* dnode;                   
    const char* issuer;                                   
    aern_topology_node_state* rnode;                   
    const uint8_t* serial;                                
    const uint8_t* sigkey;                                
} aern_network_topological_query_request_state;

AERN_EXPORT_API typedef struct aern_network_topological_query_response_state
{
    const qsc_socket* csock;                           
    const aern_child_certificate* ccert;             
    const aern_topology_node_state* rnode;             
    const uint8_t* sigkey;                                
} aern_network_topological_query_response_state;

AERN_EXPORT_API typedef struct aern_network_topological_status_request_state
{
    const aern_topology_node_state* lnode;             
    const aern_child_certificate* rcert;             
    const aern_topology_node_state* rnode;             
    const uint8_t* sigkey;                                
} aern_network_topological_status_request_state;

AERN_EXPORT_API typedef struct aern_network_topological_status_response_state
{
    const qsc_socket* csock;                           
    const aern_topology_node_state* lnode;             
    const aern_child_certificate* rcert;             
    const uint8_t* sigkey;                                
} aern_network_topological_status_response_state;

AERN_EXPORT_API typedef struct aern_network_fragment_collection_request_state
{
    qsc_socket* csock;                                 
    uint8_t* hfkey;                                        
    const aern_topology_list_state* list;               
    qsc_collection_state* lmfk;                         
    const aern_topology_node_state* lnode;             
    const aern_topology_node_state* rnode;             
    uint8_t* token;                                        
} aern_network_fragment_collection_request_state;

AERN_EXPORT_API typedef struct aern_network_fragment_collection_response_state
{
    const qsc_socket* csock;                           
    uint8_t* frag;                                      
    uint8_t* hfkey;                                        
    const aern_topology_list_state* list;               
    qsc_collection_state* lmfk;                         
    const aern_topology_node_state* lnode;             
    const aern_topology_node_state* rnode;             
    uint8_t* ctok;                                      
    uint8_t* mtok;                                      
} aern_network_fragment_collection_response_state;

AERN_EXPORT_API typedef struct aern_network_fragment_query_request_state
{
    const aern_topology_list_state* list;               
    qsc_collection_state* lmfk;                         
    const aern_topology_node_state* lnode;             
    const aern_topology_node_state* rnode;             
    const uint8_t* token;                              
} aern_network_fragment_query_request_state;

AERN_EXPORT_API typedef struct aern_network_fragment_query_response_state
{
    const qsc_socket* csock;                           
    const aern_topology_node_state* lnode;             
    const aern_topology_list_state* list;               
    qsc_collection_state* lmfk;                         
    const aern_topology_node_state* rnode;             
} aern_network_fragment_query_response_state;

AERN_EXPORT_API typedef struct aern_network_key_exchange_request_state
{
    const char* address;                             
    aern_connection_state* cns;                         
    const aern_topology_list_state* list;               
    const aern_child_certificate* rcert;             
    const uint8_t* token;                              
} aern_network_key_exchange_request_state;

AERN_EXPORT_API typedef struct aern_network_key_exchange_response_state
{
    aern_connection_state* cns;                         
    const qsc_socket* csock;                           
    const aern_topology_list_state* list;               
    const aern_child_certificate* rcert;             
    const uint8_t* sigkey;                                
} aern_network_key_exchange_response_state;
 
/*---------------------------------------------------------------------------
  Public Function Prototypes
---------------------------------------------------------------------------*/

AERN_EXPORT_API aern_protocol_errors aern_network_announce_broadcast(aern_network_announce_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_announce_response(aern_network_announce_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API uint16_t aern_network_application_to_port(aern_network_designations tnode);

AERN_EXPORT_API void aern_network_broadcast_message(const aern_topology_list_state* list, const uint8_t* message, size_t msglen, aern_network_designations tnode);

AERN_EXPORT_API qsc_socket_exceptions aern_network_connect_to_device(qsc_socket* csock, const char* address, aern_network_designations designation);

AERN_EXPORT_API aern_protocol_errors aern_network_converge_request(const aern_network_converge_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_converge_response(const aern_network_converge_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API qsc_socket_exceptions aern_network_connect_to_address(qsc_socket* csock, const char* address, uint16_t port);

AERN_EXPORT_API aern_protocol_errors aern_network_fkey_request(aern_network_fkey_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_fkey_response(aern_network_fkey_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API bool aern_network_get_local_address(char address[AERN_CERTIFICATE_ADDRESS_SIZE]);

AERN_EXPORT_API aern_protocol_errors aern_network_send_error(const qsc_socket* csock, aern_protocol_errors error);

AERN_EXPORT_API void aern_network_socket_dispose(qsc_socket* csock);

AERN_EXPORT_API aern_protocol_errors aern_network_incremental_update_request(const aern_network_incremental_update_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_incremental_update_response(const aern_network_incremental_update_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_register_request(aern_network_register_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_register_update_request(aern_network_register_update_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_register_response(aern_network_register_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_register_update_response(aern_network_register_update_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_remote_signing_request(aern_network_remote_signing_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_remote_signing_response(aern_network_remote_signing_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_mfk_exchange_request(aern_network_mfk_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_mfk_exchange_response(aern_network_mfk_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_network_designations aern_network_port_to_application(uint16_t port);

AERN_EXPORT_API aern_protocol_errors aern_network_certificate_verify(const aern_child_certificate* ccert, const aern_root_certificate* root);

AERN_EXPORT_API aern_protocol_errors aern_network_resign_request(const aern_network_resign_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_resign_response(aern_network_resign_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_revoke_broadcast(aern_network_revoke_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_revoke_response(aern_network_revoke_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_topological_query_request(const aern_network_topological_query_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_topological_query_response(const aern_network_topological_query_response_state* state, const aern_network_packet* packetin);

AERN_EXPORT_API aern_protocol_errors aern_network_topological_status_request(const aern_network_topological_status_request_state* state);

AERN_EXPORT_API aern_protocol_errors aern_network_topological_status_response(const aern_network_topological_status_response_state* state, const aern_network_packet* packetin);
 
#if defined(AERN_DEBUG_MODE)
AERN_EXPORT_API bool aern_network_protocols_test(void);
#endif
 
#endif