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 AERN_SERVER_H
#define AERN_SERVER_H
 
#include "aerncommon.h"
#include "certificate.h"
#include "commands.h"
#include "logger.h"
#include "aern.h"
#include "topology.h"
#include "collection.h"

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

#define AERN_SERVER_MINIMUM_COMMAND_LENGTH 4U

#define AERN_SERVER_APPLICATION_STATE_SIZE (AERN_STORAGE_DOMAINNAME_MAX + AERN_STORAGE_HOSTNAME_MAX + \
    AERN_STORAGE_ADDRESS_MAX + AERN_STORAGE_PATH_MAX + AERN_STORAGE_USERNAME_MAX + AERN_CERTIFICATE_ISSUER_SIZE + \
    sizeof(uint16_t) + sizeof(uint8_t) + sizeof(uint8_t) + sizeof(uint16_t) + sizeof(bool) + sizeof(bool) + \
    AERN_ASYMMETRIC_SIGNING_KEY_SIZE)
 
/*---------------------------------------------------------------------------
  ENUMERATIONS
---------------------------------------------------------------------------*/

AERN_EXPORT_API typedef enum aern_server_server_loop_status
{
    aern_server_loop_status_stopped = 0x00U,        
    aern_server_loop_status_started = 0x01U,        
    aern_server_loop_status_paused  = 0x02U,        
} aern_server_server_loop_status;
 
/*---------------------------------------------------------------------------
  DATA STRUCTURES
---------------------------------------------------------------------------*/

AERN_EXPORT_API typedef struct aern_server_application_state
{
    char cmdprompt[AERN_STORAGE_PROMPT_MAX];          
    char domain[AERN_STORAGE_DOMAINNAME_MAX];         
    char hostname[AERN_STORAGE_HOSTNAME_MAX];         
    char issuer[AERN_CERTIFICATE_ISSUER_SIZE];         
    char localip[AERN_STORAGE_ADDRESS_MAX];           
    char logpath[AERN_STORAGE_PATH_MAX];              
    char username[AERN_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;                               
    aern_child_certificate ads;                       
    aern_root_certificate root;                       
    aern_topology_list_state tlist;                   
    aern_command_actions action;                      
    aern_console_modes mode;                          
    uint16_t port;                                    
    aern_network_designations srvtype;               
    uint16_t timeout;                                 
    uint8_t retries;                                  
    bool joined;                                      
    bool loghost;                                     
} aern_server_application_state;
 
/*---------------------------------------------------------------------------
  FUNCTION PROTOTYPES
---------------------------------------------------------------------------*/

AERN_EXPORT_API void aern_server_certificate_directory(const aern_server_application_state* state, char* dpath, size_t pathlen);

AERN_EXPORT_API void aern_server_certificate_path(const aern_server_application_state* state, char* fpath, size_t pathlen, const char* issuer);

AERN_EXPORT_API bool aern_server_child_certificate_export(const aern_server_application_state* state, const char* dpath);

AERN_EXPORT_API bool aern_server_child_certificate_from_issuer(aern_child_certificate* ccert, const aern_server_application_state* state, const char* issuer);

AERN_EXPORT_API bool aern_server_child_certificate_from_serial(aern_child_certificate* ccert, const aern_server_application_state* state, const uint8_t* serial);

AERN_EXPORT_API void aern_server_child_certificate_generate(aern_server_application_state* state, aern_child_certificate* ccert, uint64_t period);

AERN_EXPORT_API bool aern_server_child_certificate_import(aern_child_certificate* lcert, aern_server_application_state* state, const char* fpath);

AERN_EXPORT_API void aern_server_child_certificate_path(const aern_server_application_state* state, char* fpath, size_t pathlen);

AERN_EXPORT_API void aern_server_child_certificate_path_from_issuer(const aern_server_application_state* state, char* fpath, size_t pathlen, const char* issuer);

AERN_EXPORT_API bool aern_server_child_certificate_print(const char* fpath, size_t pathlen);

AERN_EXPORT_API void aern_server_local_certificate_store(aern_server_application_state* state, const aern_child_certificate* ccert, const char* address);

AERN_EXPORT_API void aern_server_clear_config(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_clear_log(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_erase_all(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_log_host(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_log_print(aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_log_write_message(aern_server_application_state* state, aern_application_messages msgtype, const char* message, size_t msglen);

AERN_EXPORT_API void aern_server_mfkcol_path(const aern_server_application_state* state, char* fpath, size_t pathlen);

AERN_EXPORT_API bool aern_server_mfkcol_from_file(qsc_collection_state* mfkcol, const aern_server_application_state* state);

AERN_EXPORT_API void aern_server_mfkcol_to_file(const qsc_collection_state* mfkcol, const aern_server_application_state* state);

AERN_EXPORT_API void aern_server_print_banner(const aern_server_application_state* state);

AERN_EXPORT_API void aern_server_print_error(const aern_server_application_state* state, aern_application_messages appmsg, const char* message, aern_protocol_errors error);

AERN_EXPORT_API void aern_server_print_configuration(const aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_root_certificate_export(const aern_server_application_state* state, const char* dpath);

AERN_EXPORT_API bool aern_server_root_import_dialogue(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_root_certificate_generate(aern_server_application_state* state, aern_root_certificate* rcert, uint64_t period);

AERN_EXPORT_API bool aern_server_root_certificate_load(const aern_server_application_state* state, aern_root_certificate* root, const aern_topology_list_state* tlist);

AERN_EXPORT_API bool aern_server_root_certificate_print(const char* fpath, size_t pathlen);

AERN_EXPORT_API void aern_server_root_certificate_store(aern_server_application_state* state, const aern_root_certificate* rcert);

AERN_EXPORT_API void aern_server_set_command_prompt(aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_set_console_timeout(aern_server_application_state* state, const char* snum, size_t numlen);

AERN_EXPORT_API bool aern_server_set_domain_name(aern_server_application_state* state, const char* name, size_t namelen);

AERN_EXPORT_API bool aern_server_set_host_name(aern_server_application_state* state, const char* name, size_t namelen);

AERN_EXPORT_API bool aern_server_set_ip_address(aern_server_application_state* state, const char* address, size_t addlen);

AERN_EXPORT_API bool aern_server_set_password_retries(aern_server_application_state* state, const char* snum, size_t numlen);

AERN_EXPORT_API void aern_server_erase_signature_key(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_state_backup_restore(const aern_server_application_state* state);

AERN_EXPORT_API void aern_server_state_backup_save(const aern_server_application_state* state);

AERN_EXPORT_API void aern_server_state_initialize(aern_server_application_state* state, aern_network_designations srvtype);

AERN_EXPORT_API bool aern_server_state_store(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_state_unload(aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_topology_adc_fetch(const aern_server_application_state* state, aern_child_certificate* dcert);

AERN_EXPORT_API bool aern_server_topology_load(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_topology_print_list(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_topology_purge_externals(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_topology_remove_certificate(aern_server_application_state* state, const char* issuer);

AERN_EXPORT_API void aern_server_topology_remove_node(aern_server_application_state* state, const char* issuer);

AERN_EXPORT_API void aern_server_topology_reset(aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_topology_local_fetch(const aern_server_application_state* state, aern_child_certificate* ccert);

AERN_EXPORT_API bool aern_server_topology_root_exists(const aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_topology_root_fetch(const aern_server_application_state* state, aern_root_certificate* rcert);

AERN_EXPORT_API void aern_server_topology_to_file(aern_server_application_state* state);

AERN_EXPORT_API bool aern_server_user_login(aern_server_application_state* state);

AERN_EXPORT_API void aern_server_user_logout(aern_server_application_state* state);
 
#endif