topology.h

Go to the documentation of this file.

/* 2025-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 UDIF_TOPOLOGY_H
#define UDIF_TOPOLOGY_H
 
#include "udif.h"
#include "certificate.h"
#include "ipinfo.h"
#include "list.h"
#include "timestamp.h"

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

#if defined(UDIF_NETWORK_PROTOCOL_IPV6)
#   define UDIF_TOPOLOGY_NODE_ENCODED_SIZE (UDIF_CHILD_CERTIFICATE_ISSUER_PREFIX_SIZE + UDIF_CERTIFICATE_ISSUER_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_ADDRESS_PREFIX_SIZE + QSC_IPINFO_IPV6_STRNLEN + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_ROOT_CERTIFICATE_HASH_PREFIX_SIZE + (UDIF_CERTIFICATE_HASH_SIZE * 2U) + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_SERIAL_PREFIX_SIZE + (UDIF_CERTIFICATE_SERIAL_SIZE * 2U) + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_DESIGNATION_PREFIX + UDIF_NETWORK_DESIGNATION_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_VALID_FROM_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_EXPIRATION_TO_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE)
#else
#   define UDIF_TOPOLOGY_NODE_ENCODED_SIZE (UDIF_CHILD_CERTIFICATE_ISSUER_PREFIX_SIZE + UDIF_CERTIFICATE_ISSUER_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_ADDRESS_PREFIX_SIZE + QSC_IPINFO_IPV4_STRNLEN + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_ROOT_CERTIFICATE_HASH_PREFIX_SIZE + (UDIF_CERTIFICATE_HASH_SIZE * 2U) + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_SERIAL_PREFIX_SIZE + (UDIF_CERTIFICATE_SERIAL_SIZE * 2U) + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_DESIGNATION_PREFIX_SIZE + UDIF_NETWORK_DESIGNATION_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_VALID_FROM_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE + \
    UDIF_CHILD_CERTIFICATE_EXPIRATION_TO_PREFIX_SIZE + QSC_TIMESTAMP_STRING_SIZE + UDIF_CERTIFICATE_SEPERATOR_SIZE)
#endif

#define UDIF_TOPOLOGY_NODE_MINIMUM_ISSUER_SIZE 3U

#define UDIF_TOPOLOGY_NODE_NOT_FOUND -1

#define UDIF_NETWORK_TOPOLOGY_MAX_SIZE 1024U

#define UDIF_NETWORK_TOPOLOGY_NODE_SIZE (UDIF_CERTIFICATE_ADDRESS_SIZE + \
    UDIF_CERTIFICATE_HASH_SIZE + \
    UDIF_CERTIFICATE_SERIAL_SIZE + \
    UDIF_CERTIFICATE_ISSUER_SIZE + \
    UDIF_CERTIFICATE_EXPIRATION_SIZE + \
    UDIF_CERTIFICATE_DESIGNATION_SIZE)
 
/*---------------------------------------------------------------------------
  STATIC CONSTANTS
---------------------------------------------------------------------------*/

static const char UDIF_TOPOLOGY_NETWORK_DELIMITER[] = "/";

static const char UDIF_TOPOLOGY_CTYPE_DELIMITER[] = ".";

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

UDIF_EXPORT_API typedef struct udif_topology_node_state
{
    char address[UDIF_CERTIFICATE_ADDRESS_SIZE];        
    uint8_t chash[UDIF_CERTIFICATE_HASH_SIZE];         
    uint8_t serial[UDIF_CERTIFICATE_SERIAL_SIZE];     
    char issuer[UDIF_CERTIFICATE_ISSUER_SIZE];            
    udif_certificate_expiration expiration;               
    udif_network_designations designation;               
} udif_topology_node_state;

UDIF_EXPORT_API typedef struct udif_topology_list_state
{
    uint8_t* topology;                                  
    uint32_t count;                                        
} udif_topology_list_state;
 
/*---------------------------------------------------------------------------
  FUNCTION PROTOTYPES
---------------------------------------------------------------------------*/

UDIF_EXPORT_API void udif_topology_address_from_issuer(char* address, const char* issuer, const udif_topology_list_state* list);

UDIF_EXPORT_API void udif_topology_node_add_alias(udif_topology_node_state* node, const char* alias);

UDIF_EXPORT_API bool udif_topology_nodes_are_equal(const udif_topology_node_state* a, const udif_topology_node_state* b);

UDIF_EXPORT_API uint8_t* udif_topology_child_add_empty_node(udif_topology_list_state* list);

UDIF_EXPORT_API void udif_topology_child_add_item(udif_topology_list_state* list, const udif_topology_node_state* node);

UDIF_EXPORT_API bool udif_topology_canonical_to_issuer_name(char* issuer, size_t isslen, const char* domain, const char* cname);

UDIF_EXPORT_API bool udif_topology_issuer_to_canonical_name(char* cname, size_t namelen, const char* issuer);

UDIF_EXPORT_API void udif_topology_child_register(udif_topology_list_state* list, const udif_child_certificate* ccert, const char* address);

UDIF_EXPORT_API void udif_topology_list_clone(const udif_topology_list_state* tlist, udif_topology_list_state* tcopy);

UDIF_EXPORT_API void udif_topology_list_deserialize(udif_topology_list_state* list, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API void udif_topology_list_dispose(udif_topology_list_state* list);

UDIF_EXPORT_API void udif_topology_list_initialize(udif_topology_list_state* list);

UDIF_EXPORT_API bool udif_topology_list_item(const udif_topology_list_state* list, udif_topology_node_state* node, size_t index);

UDIF_EXPORT_API size_t udif_topology_list_remove_duplicates(udif_topology_list_state* list);

UDIF_EXPORT_API size_t udif_topology_list_server_count(const udif_topology_list_state* list, udif_network_designations ntype);

UDIF_EXPORT_API size_t udif_topology_list_serialize(uint8_t* output, const udif_topology_list_state* list);

UDIF_EXPORT_API size_t udif_topology_list_size(const udif_topology_list_state* list);

UDIF_EXPORT_API size_t udif_topology_list_to_string(const udif_topology_list_state* list, char* output, size_t outlen);

UDIF_EXPORT_API size_t udif_topology_list_update_pack(uint8_t* output, const udif_topology_list_state* list, udif_network_designations ntype);

UDIF_EXPORT_API size_t udif_topology_list_update_unpack(udif_topology_list_state* list, const uint8_t* input, size_t inplen);

UDIF_EXPORT_API size_t udif_topology_ordered_server_list(udif_topology_list_state* olist, const udif_topology_list_state* tlist, udif_network_designations ntype);

UDIF_EXPORT_API void udif_topology_node_clear(udif_topology_node_state* node);

UDIF_EXPORT_API void udif_topology_node_copy(const udif_topology_node_state* source, udif_topology_node_state* destination);

UDIF_EXPORT_API void udif_topology_node_deserialize(udif_topology_node_state* node, const uint8_t* input);

UDIF_EXPORT_API size_t udif_topology_node_encode(const udif_topology_node_state* node, char output[UDIF_TOPOLOGY_NODE_ENCODED_SIZE]);

UDIF_EXPORT_API bool udif_topology_node_exists(const udif_topology_list_state* list, const uint8_t* serial);

UDIF_EXPORT_API int32_t udif_topology_node_get_index(const udif_topology_list_state* list, const uint8_t* serial);

UDIF_EXPORT_API bool udif_topology_node_find(const udif_topology_list_state* list, udif_topology_node_state* node, const uint8_t* serial);

UDIF_EXPORT_API bool udif_topology_node_find_address(const udif_topology_list_state* list, udif_topology_node_state* node, const char* address);

UDIF_EXPORT_API bool udif_topology_node_find_alias(const udif_topology_list_state* list, udif_topology_node_state* node, const char* alias);

UDIF_EXPORT_API bool udif_topology_node_find_ads(const udif_topology_list_state* list, udif_topology_node_state* node);

UDIF_EXPORT_API bool udif_topology_node_find_issuer(const udif_topology_list_state* list, udif_topology_node_state* node, const char* issuer);

UDIF_EXPORT_API bool udif_topology_node_find_root(const udif_topology_list_state* list, udif_topology_node_state* node);

UDIF_EXPORT_API void udif_topology_node_remove(udif_topology_list_state* list, const uint8_t* serial);

UDIF_EXPORT_API void udif_topology_node_remove_duplicate(udif_topology_list_state* list, const char* issuer);

UDIF_EXPORT_API bool udif_topology_node_verify_ads(const udif_topology_list_state* list, const udif_child_certificate* ccert);

UDIF_EXPORT_API bool udif_topology_node_verify_issuer(const udif_topology_list_state* list, const udif_child_certificate* ccert, const char* issuer);

UDIF_EXPORT_API bool udif_topology_node_verify_root(const udif_topology_list_state* list, const udif_root_certificate* rcert);

UDIF_EXPORT_API size_t udif_topology_node_serialize(uint8_t* output, const udif_topology_node_state* node);

UDIF_EXPORT_API void udif_topology_root_register(udif_topology_list_state* list, const udif_root_certificate* rcert, const char* address);

UDIF_EXPORT_API void udif_topology_from_file(const char* fpath, udif_topology_list_state* list);

UDIF_EXPORT_API void udif_topology_to_file(const udif_topology_list_state* list, const char* fpath);
 
#if defined(UDIF_DEBUG_MODE)
UDIF_EXPORT_API bool udif_topology_functions_test();
#endif
 
#endif