topology.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_TOPOLOGY_H
#define AERN_TOPOLOGY_H
 
#include "aern.h"
#include "certificate.h"
#include "ipinfo.h"
#include "list.h"
#include "timestamp.h"

 
/*---------------------------------------------------------------------------
  MACRO DEFINITIONS
---------------------------------------------------------------------------*/

#if defined(AERN_NETWORK_PROTOCOL_IPV6)
#   define AERN_TOPOLOGY_NODE_ENCODED_SIZE (AERN_CHILD_CERTIFICATE_ISSUER_PREFIX_SIZE + AERN_CERTIFICATE_ISSUER_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_ADDRESS_PREFIX_SIZE + QSC_IPINFO_IPV6_STRNLEN + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_ROOT_CERTIFICATE_HASH_PREFIX_SIZE + (AERN_CERTIFICATE_HASH_SIZE * 2U) + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_SERIAL_PREFIX_SIZE + (AERN_CERTIFICATE_SERIAL_SIZE * 2U) + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_DESIGNATION_PREFIX_SIZE + AERN_NETWORK_DESIGNATION_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_VALID_FROM_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_EXPIRATION_TO_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE)
#else
#   define AERN_TOPOLOGY_NODE_ENCODED_SIZE (AERN_CHILD_CERTIFICATE_ISSUER_PREFIX_SIZE + AERN_CERTIFICATE_ISSUER_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_ADDRESS_PREFIX_SIZE + QSC_IPINFO_IPV4_STRNLEN + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_ROOT_CERTIFICATE_HASH_PREFIX_SIZE + (AERN_CERTIFICATE_HASH_SIZE * 2U) + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_SERIAL_PREFIX_SIZE + (AERN_CERTIFICATE_SERIAL_SIZE * 2U) + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_DESIGNATION_PREFIX_SIZE + AERN_NETWORK_DESIGNATION_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_VALID_FROM_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE + \
    AERN_CHILD_CERTIFICATE_EXPIRATION_TO_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + AERN_CERTIFICATE_SEPERATOR_SIZE)
#endif

#define AERN_TOPOLOGY_NODE_MINIMUM_ISSUER_SIZE 3U

#define AERN_TOPOLOGY_NODE_NOT_FOUND -1

#define AERN_NETWORK_TOPOLOGY_MAX_SIZE 1024U

#define AERN_NETWORK_TOPOLOGY_NODE_SIZE (AERN_CERTIFICATE_ADDRESS_SIZE + \
    AERN_CERTIFICATE_HASH_SIZE + \
    AERN_CERTIFICATE_SERIAL_SIZE + \
    AERN_CERTIFICATE_ISSUER_SIZE + \
    AERN_CERTIFICATE_EXPIRATION_SIZE + \
    AERN_CERTIFICATE_DESIGNATION_SIZE)
 
/*---------------------------------------------------------------------------
  STATIC CONSTANTS
---------------------------------------------------------------------------*/

static const char AERN_TOPOLOGY_NETWORK_DELIMITER[] = "/";

static const char AERN_TOPOLOGY_CTYPE_DELIMITER[] = ".";

static const char AERN_TOPOLOGY_ALIAS_DELIMITER[] = ":";
 
/*---------------------------------------------------------------------------
  DATA STRUCTURES
---------------------------------------------------------------------------*/

AERN_EXPORT_API typedef struct aern_topology_node_state
{
    char address[AERN_CERTIFICATE_ADDRESS_SIZE];        
    uint8_t chash[AERN_CERTIFICATE_HASH_SIZE];           
    uint8_t serial[AERN_CERTIFICATE_SERIAL_SIZE];     
    char issuer[AERN_CERTIFICATE_ISSUER_SIZE];            
    aern_certificate_expiration expiration;                
    aern_network_designations designation;              
} aern_topology_node_state;

AERN_EXPORT_API typedef struct aern_topology_list_state
{
    uint8_t* topology;                                  
    uint32_t count;                                        
} aern_topology_list_state;
 
/*---------------------------------------------------------------------------
  FUNCTION PROTOTYPES
---------------------------------------------------------------------------*/

AERN_EXPORT_API void aern_topology_address_from_issuer(char* address, const char* issuer, const aern_topology_list_state* list);

AERN_EXPORT_API void aern_topology_node_add_alias(aern_topology_node_state* node, const char* alias);

AERN_EXPORT_API bool aern_topology_nodes_are_equal(const aern_topology_node_state* a, const aern_topology_node_state* b);

AERN_EXPORT_API uint8_t* aern_topology_child_add_empty_node(aern_topology_list_state* list);

AERN_EXPORT_API void aern_topology_child_add_item(aern_topology_list_state* list, const aern_topology_node_state* node);

AERN_EXPORT_API bool aern_topology_canonical_to_issuer_name(char* issuer, size_t isslen, const char* domain, const char* cname);

AERN_EXPORT_API bool aern_topology_issuer_to_canonical_name(char* cname, size_t namelen, const char* issuer);

AERN_EXPORT_API void aern_topology_child_register(aern_topology_list_state* list, const aern_child_certificate* ccert, const char* address);

AERN_EXPORT_API void aern_topology_list_clone(const aern_topology_list_state* tlist, aern_topology_list_state* tcopy);

AERN_EXPORT_API void aern_topology_list_deserialize(aern_topology_list_state* list, const uint8_t* input, size_t inplen);

AERN_EXPORT_API void aern_topology_list_dispose(aern_topology_list_state* list);

AERN_EXPORT_API void aern_topology_list_initialize(aern_topology_list_state* list);

AERN_EXPORT_API bool aern_topology_list_item(const aern_topology_list_state* list, aern_topology_node_state* node, size_t index);

AERN_EXPORT_API size_t aern_topology_list_remove_duplicates(aern_topology_list_state* list);

AERN_EXPORT_API size_t aern_topology_list_server_count(const aern_topology_list_state* list, aern_network_designations ntype);

AERN_EXPORT_API size_t aern_topology_list_serialize(uint8_t* output, const aern_topology_list_state* list);

AERN_EXPORT_API size_t aern_topology_list_size(const aern_topology_list_state* list);

AERN_EXPORT_API size_t aern_topology_list_to_string(const aern_topology_list_state* list, char* output, size_t outlen);

AERN_EXPORT_API size_t aern_topology_list_update_pack(uint8_t* output, const aern_topology_list_state* list, aern_network_designations ntype);

AERN_EXPORT_API size_t aern_topology_list_update_unpack(aern_topology_list_state* list, const uint8_t* input, size_t inplen);

AERN_EXPORT_API size_t aern_topology_ordered_server_list(aern_topology_list_state* olist, const aern_topology_list_state* tlist, aern_network_designations ntype);

AERN_EXPORT_API void aern_topology_node_clear(aern_topology_node_state* node);

AERN_EXPORT_API void aern_topology_node_copy(const aern_topology_node_state* source, aern_topology_node_state* destination);

AERN_EXPORT_API void aern_topology_node_deserialize(aern_topology_node_state* node, const uint8_t* input);

AERN_EXPORT_API size_t aern_topology_node_encode(const aern_topology_node_state* node, char output[AERN_TOPOLOGY_NODE_ENCODED_SIZE]);

AERN_EXPORT_API bool aern_topology_node_exists(const aern_topology_list_state* list, const uint8_t* serial);

AERN_EXPORT_API int32_t aern_topology_node_get_index(const aern_topology_list_state* list, const uint8_t* serial);

AERN_EXPORT_API bool aern_topology_node_find(const aern_topology_list_state* list, aern_topology_node_state* node, const uint8_t* serial);

AERN_EXPORT_API bool aern_topology_node_find_address(const aern_topology_list_state* list, aern_topology_node_state* node, const char* address);

AERN_EXPORT_API bool aern_topology_node_find_alias(const aern_topology_list_state* list, aern_topology_node_state* node, const char* alias);

AERN_EXPORT_API bool aern_topology_node_find_ads(const aern_topology_list_state* list, aern_topology_node_state* node);

AERN_EXPORT_API bool aern_topology_node_find_issuer(const aern_topology_list_state* list, aern_topology_node_state* node, const char* issuer);

AERN_EXPORT_API bool aern_topology_node_find_root(const aern_topology_list_state* list, aern_topology_node_state* node);

AERN_EXPORT_API void aern_topology_node_remove(aern_topology_list_state* list, const uint8_t* serial);

AERN_EXPORT_API void aern_topology_node_remove_duplicate(aern_topology_list_state* list, const char* issuer);

AERN_EXPORT_API bool aern_topology_node_verify_ads(const aern_topology_list_state* list, const aern_child_certificate* ccert);

AERN_EXPORT_API bool aern_topology_node_verify_issuer(const aern_topology_list_state* list, const aern_child_certificate* ccert, const char* issuer);

AERN_EXPORT_API bool aern_topology_node_verify_root(const aern_topology_list_state* list, const aern_root_certificate* rcert);

AERN_EXPORT_API size_t aern_topology_node_serialize(uint8_t* output, const aern_topology_node_state* node);

AERN_EXPORT_API void aern_topology_root_register(aern_topology_list_state* list, const aern_root_certificate* rcert, const char* address);

AERN_EXPORT_API void aern_topology_from_file(const char* fpath, aern_topology_list_state* list);

AERN_EXPORT_API void aern_topology_to_file(const aern_topology_list_state* list, const char* fpath);
 
#if defined(AERN_DEBUG_MODE)
AERN_EXPORT_API bool aern_topology_functions_test();
#endif
 
#endif