server.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 UDIF_SERVER_H
#define UDIF_SERVER_H
 
#include "udifcommon.h"
#include "certificate.h"
#include "commands.h"
#include "logger.h"
#include "udif.h"
#include "topology.h"
#include "collection.h"

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

#define UDIF_SERVER_MINIMUM_COMMAND_LENGTH 4U

#define UDIF_SERVER_APPLICATION_STATE_SIZE (UDIF_STORAGE_DOMAINNAME_MAX + UDIF_STORAGE_HOSTNAME_MAX + \
    UDIF_STORAGE_ADDRESS_MAX + UDIF_STORAGE_PATH_MAX + UDIF_STORAGE_USERNAME_MAX + UDIF_CERTIFICATE_ISSUER_SIZE + \
    sizeof(uint16_t) + sizeof(uint8_t) + sizeof(uint8_t) + sizeof(uint16_t) + sizeof(bool) + sizeof(bool) + \
    UDIF_ASYMMETRIC_SIGNING_KEY_SIZE)
 
/*---------------------------------------------------------------------------
  ENUMERATIONS
---------------------------------------------------------------------------*/

UDIF_EXPORT_API typedef enum udif_server_server_loop_status
{
    udif_server_loop_status_stopped = 0x00U,        
    udif_server_loop_status_started = 0x01U,        
    udif_server_loop_status_paused  = 0x02U,        
} udif_server_server_loop_status;
 
/*---------------------------------------------------------------------------
  DATA STRUCTURES
---------------------------------------------------------------------------*/

UDIF_EXPORT_API typedef struct udif_server_application_state
{
    char cmdprompt[UDIF_STORAGE_PROMPT_MAX];          
    char domain[UDIF_STORAGE_DOMAINNAME_MAX];         
    char hostname[UDIF_STORAGE_HOSTNAME_MAX];         
    char issuer[UDIF_CERTIFICATE_ISSUER_SIZE];         
    char localip[UDIF_STORAGE_ADDRESS_MAX];           
    char logpath[UDIF_STORAGE_PATH_MAX];              
    char username[UDIF_STORAGE_USERNAME_MAX];         
    uint8_t* kchain;                                  
    uint8_t* sigkey;                                  
    const char* aplpath;                              
    const char* banner;                               
    const char* cfgname;                              
    const char* prikeyname;                           
    const char* promptdef;                            
    const char* pubkeyname;                           
    const char* srvname;                              
    const char* topname;                              
    const char* wtitle;                               
    udif_child_certificate ads;                       
    udif_root_certificate root;                       
    udif_topology_list_state tlist;                   
    udif_command_actions action;                      
    udif_console_modes mode;                          
    uint16_t port;                                    
    udif_network_designations srvtype;               
    uint16_t timeout;                                 
    uint8_t retries;                                  
    bool joined;                                      
    bool loghost;                                     
} udif_server_application_state;
 
/*---------------------------------------------------------------------------
  FUNCTION PROTOTYPES
---------------------------------------------------------------------------*/

UDIF_EXPORT_API void udif_server_certificate_directory(const udif_server_application_state* state, char* dpath, size_t pathlen);

UDIF_EXPORT_API void udif_server_certificate_path(const udif_server_application_state* state, char* fpath, size_t pathlen, const char* issuer);

UDIF_EXPORT_API bool udif_server_child_certificate_export(const udif_server_application_state* state, const char* dpath);

UDIF_EXPORT_API bool udif_server_child_certificate_from_issuer(udif_child_certificate* ccert, const udif_server_application_state* state, const char* issuer);

UDIF_EXPORT_API bool udif_server_child_certificate_from_serial(udif_child_certificate* ccert, const udif_server_application_state* state, const uint8_t* serial);

UDIF_EXPORT_API void udif_server_child_certificate_generate(udif_server_application_state* state, udif_child_certificate* ccert, uint64_t period, uint8_t* capability);

UDIF_EXPORT_API bool udif_server_child_certificate_import(udif_child_certificate* lcert, udif_server_application_state* state, const char* fpath);

UDIF_EXPORT_API void udif_server_child_certificate_path(const udif_server_application_state* state, char* fpath, size_t pathlen);

UDIF_EXPORT_API void udif_server_child_certificate_path_from_issuer(const udif_server_application_state* state, char* fpath, size_t pathlen, const char* issuer);

UDIF_EXPORT_API bool udif_server_child_certificate_print(const char* fpath, size_t pathlen);

UDIF_EXPORT_API void udif_server_local_certificate_store(udif_server_application_state* state, const udif_child_certificate* ccert, const char* address);

UDIF_EXPORT_API void udif_server_clear_config(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_clear_log(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_erase_all(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_log_host(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_log_print(udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_log_write_message(udif_server_application_state* state, udif_application_messages msgtype, const char* message, size_t msglen);

UDIF_EXPORT_API void udif_server_mfkcol_path(const udif_server_application_state* state, char* fpath, size_t pathlen);

UDIF_EXPORT_API bool udif_server_mfkcol_from_file(qsc_collection_state* mfkcol, const udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_mfkcol_to_file(const qsc_collection_state* mfkcol, const udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_print_banner(const udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_print_error(const udif_server_application_state* state, udif_application_messages appmsg, const char* message, udif_protocol_errors error);

UDIF_EXPORT_API void udif_server_print_configuration(const udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_root_certificate_export(const udif_server_application_state* state, const char* dpath);

UDIF_EXPORT_API bool udif_server_root_import_dialogue(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_root_certificate_generate(udif_server_application_state* state, udif_root_certificate* rcert, uint64_t period);

UDIF_EXPORT_API bool udif_server_root_certificate_load(const udif_server_application_state* state, udif_root_certificate* root, const udif_topology_list_state* tlist);

UDIF_EXPORT_API bool udif_server_root_certificate_print(const char* fpath, size_t pathlen);

UDIF_EXPORT_API void udif_server_root_certificate_store(udif_server_application_state* state, const udif_root_certificate* rcert);

UDIF_EXPORT_API void udif_server_set_command_prompt(udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_set_console_timeout(udif_server_application_state* state, const char* snum, size_t numlen);

UDIF_EXPORT_API bool udif_server_set_domain_name(udif_server_application_state* state, const char* name, size_t namelen);

UDIF_EXPORT_API bool udif_server_set_host_name(udif_server_application_state* state, const char* name, size_t namelen);

UDIF_EXPORT_API bool udif_server_set_ip_address(udif_server_application_state* state, const char* address, size_t addlen);

UDIF_EXPORT_API bool udif_server_set_password_retries(udif_server_application_state* state, const char* snum, size_t numlen);

UDIF_EXPORT_API void udif_server_erase_signature_key(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_state_backup_restore(const udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_state_backup_save(const udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_state_initialize(udif_server_application_state* state, udif_network_designations srvtype);

UDIF_EXPORT_API bool udif_server_state_store(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_state_unload(udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_topology_adc_fetch(const udif_server_application_state* state, udif_child_certificate* dcert);

UDIF_EXPORT_API bool udif_server_topology_load(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_topology_print_list(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_topology_purge_externals(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_topology_remove_certificate(udif_server_application_state* state, const char* issuer);

UDIF_EXPORT_API void udif_server_topology_remove_node(udif_server_application_state* state, const char* issuer);

UDIF_EXPORT_API void udif_server_topology_reset(udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_topology_local_fetch(const udif_server_application_state* state, udif_child_certificate* ccert);

UDIF_EXPORT_API bool udif_server_topology_root_exists(const udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_topology_root_fetch(const udif_server_application_state* state, udif_root_certificate* rcert);

UDIF_EXPORT_API void udif_server_topology_to_file(udif_server_application_state* state);

UDIF_EXPORT_API bool udif_server_user_login(udif_server_application_state* state);

UDIF_EXPORT_API void udif_server_user_logout(udif_server_application_state* state);
 
#endif