commands.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_COMMANDS_H
#define UDIF_COMMANDS_H
 
#include "udif.h"


typedef enum udif_console_commands
{
    udif_commands_none = 0x00U,                                   
    udif_commands_certificate_create = 0x01U,                   
    udif_commands_certificate_change = 0x02U,                   
    udif_commands_certificate_sign = 0x03U,                       
    udif_commands_certificate_revoke = 0x04U,                   
    udif_commands_certificate_format = 0x05U,                   
    udif_commands_device_add = 0x06U,                           
    udif_commands_network_converge = 0x07U,                       
    udif_commands_adc_election = 0x08U,                           
} udif_console_commands;

typedef enum udif_application_messages
{
    udif_application_not_recognized = 0x00U,                 
    udif_application_erase_erase_all = 0x01U,                   
    udif_application_erase_config = 0x02U,                     
    udif_application_erase_log = 0x03U,                           
    udif_application_authorization_failure = 0x04U,               
    udif_application_retries_exceeded = 0x05U,                 
    udif_application_application_quit = 0x06U,                 
    udif_application_logging_disabled = 0x07U,                 
    udif_application_logging_enabled = 0x08U,                   
    udif_application_authentication_failure = 0x09U,         
    udif_application_operation_aborted = 0x0AU,                   
    udif_application_system_erased = 0x0BU,                       
    udif_application_configuration_erased = 0x0CU,             
    udif_application_log_erased = 0x0DU,                     
    udif_application_retry_invalid = 0x0EU,                       
    udif_application_timeout_invalid = 0x0FU,                   
    udif_application_domain_invalid = 0x10U,                 
    udif_application_hostname_invalid = 0x11U,                 
    udif_application_configuration = 0x12U,                       
    udif_application_connection = 0x13U,                     
    udif_application_connection_details = 0x14U,             
    udif_application_log_empty = 0x15U,                           
    udif_application_first_login = 0x16U,                       
    udif_application_choose_name = 0x17U,                       
    udif_application_choose_password = 0x18U,                   
    udif_application_password_set = 0x19U,                     
    udif_application_challenge_user = 0x1AU,                 
    udif_application_challenge_user_failure = 0x1BU,         
    udif_application_challenge_password = 0x1CU,             
    udif_application_challenge_password_failure = 0x1DU,     
    udif_application_challenge_device_name = 0x1EU,               
    udif_application_challenge_device_name_success = 0x1FU,       
    udif_application_challenge_device_name_failure = 0x20U,       
    udif_application_remote_connect = 0x21U,                 
    udif_application_remote_connect_key = 0x22U,             
    udif_application_remote_connect_success = 0x23U,         
    udif_application_remote_connect_failure = 0x24U,         
    udif_application_socket_listen = 0x25U,                       
    udif_application_socket_listen_failure = 0x26U,               
    udif_application_socket_listen_success = 0x27U,               
    udif_application_generate_key = 0x28U,                     
    udif_application_generate_key_failure = 0x29U,             
    udif_application_generate_key_success = 0x2AU,             
    udif_application_generate_key_overwrite = 0x2BU,         
    udif_application_operation_cancelled = 0x2CU,               
    udif_application_client_enter_pubkey_path = 0x2DU,         
    udif_application_client_pubkey_path_invalid = 0x2EU,     
    udif_application_client_connection_success = 0x2FU,           
    udif_application_client_connection_failure = 0x30U,           
    udif_application_address_invalid_format = 0x31U,         
    udif_application_certificate_exists = 0x32U,             
    udif_application_certificate_not_revoked = 0x33U,           
    udif_application_console_timeout_expired = 0x34U,           
    udif_application_challenge_root_path = 0x35U,               
    udif_application_challenge_root_path_success = 0x36U,       
    udif_application_challenge_root_path_failure = 0x37U,       
    udif_application_root_copy_success = 0x38U,                   
    udif_application_root_copy_failure = 0x39U,                   
    udif_application_root_sign_failure = 0x3AU,                   
    udif_application_root_sign_success = 0x3BU,                   
    udif_application_invalid_input = 0x3CU,                       
    udif_application_register_failure = 0x3DU,                 
    udif_application_register_success = 0x3EU,                 
    udif_application_register_existing = 0x3FU,                   
    udif_application_announce_failure = 0x40U,                 
    udif_application_announce_success = 0x41U,                 
    udif_application_converge_failure = 0x42U,                 
    udif_application_converge_success = 0x43U,                 
    udif_application_message_time_invalid = 0x44U,             
    udif_application_certificate_not_found = 0x45U,               
    udif_application_signature_failure = 0x46U,                   
    udif_application_network_resign_failure = 0x47U,         
    udif_application_network_resign_success = 0x48U,         
    udif_application_certificate_revoke_failure = 0x49U,     
    udif_application_certificate_revoke_success = 0x4AU,     
    udif_application_address_change_failure = 0x4BU,         
    udif_application_address_change_success = 0x4CU,         
    udif_application_address_change_challenge = 0x4DU,         
    udif_application_address_change_current = 0x4EU,         
    udif_application_address_change_message = 0x4FU,         
    udif_application_server_service_start_failure = 0x50U,     
    udif_application_server_service_start_success = 0x51U,     
    udif_application_server_service_stopped = 0x52U,         
    udif_application_server_service_paused = 0x53U,               
    udif_application_server_service_resume_failure = 0x54U,       
    udif_application_server_service_resume_success = 0x55U,       
    udif_application_import_certificate_exists = 0x56U,           
    udif_application_import_certificate_changed = 0x57U,     
    udif_application_import_certificate_failure = 0x58U,     
    udif_application_import_certificate_success = 0x59U,     
    udif_application_export_certificate_failure = 0x5AU,     
    udif_application_export_certificate_success = 0x5BU,     
    udif_application_server_domain_change_challenge = 0x5CU, 
    udif_application_server_domain_change_current = 0x5DU,     
    udif_application_server_domain_change_failure = 0x5EU,     
    udif_application_server_domain_change_success = 0x5FU,     
    udif_application_certificate_period_update = 0x60U,           
    udif_application_certificate_root_validate = 0x61U,           
    udif_application_command_not_supported = 0x62U,               
    udif_application_network_ip_address_not_set = 0x63U,     
    udif_application_network_local_error = 0x64U,               
    udif_application_network_remote_error = 0x65U,             
    udif_application_topological_query_unknown = 0x66U,           
    udif_application_topological_query_failure = 0x67U,           
    udif_application_topological_query_success = 0x68U,           
    udif_application_adc_certificate_path_failure = 0x69U,     
    udif_application_adc_certificate_path_success = 0x6AU,     
    udif_application_adc_certificate_address_challenge = 0x6BU,   
    udif_application_adc_certificate_address_failure = 0x6CU,   
    udif_application_server_backup_restore_challenge = 0x6DU,   
    udif_application_server_backup_save_confirmation = 0x6EU,   
    udif_application_certificate_remote_sign_failure = 0x6FU,   
    udif_application_certificate_remote_sign_success = 0x70U,   
    udif_application_log_address_change = 0x71U,             
    udif_application_log_domain_change = 0x72U,                   
    udif_application_log_hostname_change = 0x73U,               
    udif_application_log_user_logged_in = 0x74U,             
    udif_application_log_log_created = 0x75U,                   
    udif_application_log_log_disabled = 0x76U,                 
    udif_application_log_log_enabled = 0x77U,                   
    udif_application_log_log_header = 0x78U,                 
    udif_application_log_retries_change = 0x79U,             
    udif_application_log_timeout_change = 0x7AU,             
    udif_application_log_user_added = 0x7BU,                 
    udif_application_log_state_restore = 0x7CU,                   
    udif_application_log_state_backup = 0x7DU,                 
    udif_application_log_service_paused = 0x7EU,             
    udif_application_log_service_resumed = 0x7FU,               
    udif_application_log_service_started = 0x80U,               
    udif_application_log_service_stopped = 0x81U,               
    udif_application_log_mfk_exchange_failure = 0x82U,         
    udif_application_log_mfk_exchange_success = 0x83U,         
    udif_application_log_generate_delete = 0x84U,               
    udif_application_log_generate_failure = 0x85U,             
    udif_application_log_generate_success = 0x86U,             
    udif_application_log_revocation_failure = 0x87U,         
    udif_application_log_revocation_success = 0x88U,         
    udif_application_log_convergence_failure = 0x89U,           
    udif_application_log_convergence_success = 0x8AU,           
    udif_application_log_incremental_failure = 0x8BU,           
    udif_application_log_incremental_success = 0x8CU,           
    udif_application_log_allocation_failure = 0x8DU,         
    udif_application_log_connection_terminated = 0x8EU,           
    udif_application_log_configuration_erased = 0x8FU,         
    udif_application_log_receive_failure = 0x90U,               
    udif_application_log_register_failure = 0x91U,             
    udif_application_log_register_success = 0x92U,             
    udif_application_log_fragment_exchange_failure = 0x93U,       
    udif_application_log_fragment_exchange_success = 0x94U,       
    udif_application_log_local_resign_failure = 0x95U,         
    udif_application_log_local_resign_success = 0x96U,         
    udif_application_log_remote_invalid_request = 0x97U,     
    udif_application_log_remote_reported_error = 0x98U,           
    udif_application_log_connect_failure = 0x99U,               
    udif_application_log_connect_success = 0x9AU,               
    udif_application_log_topology_node_query_failure = 0x9BU,   
    udif_application_log_topology_node_query_success = 0x9CU,   
    udif_application_log_announce_failure = 0x9DU,             
    udif_application_log_announce_success = 0x9EU,             
    udif_application_log_remote_signing_failure = 0x9FU,     
    udif_application_log_remote_signing_success = 0xA0U,     
    udif_application_log_remote_resign_failure = 0xA1U,           
    udif_application_log_remote_resign_success = 0xA2U,           
    udif_application_log_converge_node_remove_challenge = 0xA3U,
    udif_application_ars_certificate_address_challenge = 0xA4U,   
    udif_application_ars_certificate_address_failure = 0xA5U,   
    udif_application_server_service_not_started = 0xA6U,     
} udif_application_messages;

typedef enum udif_command_actions
{
    udif_command_action_none = 0x00U,                           
      
    /* configuration commands */
    udif_command_action_config_address = 0x01U,                   
    udif_command_action_config_certificate = 0x02U,               
    udif_command_action_config_clear_all = 0x03U,               
    udif_command_action_config_clear_config = 0x04U,         
    udif_command_action_config_clear_log = 0x05U,               
    udif_command_action_config_exit = 0x06U,                 
    udif_command_action_config_help = 0x07U,                 
    udif_command_action_config_log_host = 0x08U,             
    udif_command_action_config_name_domain = 0x09U,               
    udif_command_action_config_name_host = 0x0AU,               
    udif_command_action_config_retries = 0x0BU,                   
    udif_command_action_config_server = 0x0CU,                 
    udif_command_action_config_timeout = 0x0DU,                   
 
    /* enable commands */
    udif_command_action_enable_clear_screen = 0x0EU,         
    udif_command_action_enable_config = 0x0FU,                 
    udif_command_action_enable_exit = 0x10U,                 
    udif_command_action_enable_help = 0x11U,                 
    udif_command_action_enable_quit = 0x12U,                 
    udif_command_action_enable_show_config = 0x13U,               
    udif_command_action_enable_show_log = 0x14U,             
 
    /* user commands */
    udif_command_action_user_enable = 0x15U,                 
    udif_command_action_user_help = 0x16U,                     
    udif_command_action_user_quit = 0x17U,                     
 
    /* config-certificate commands */
    udif_command_action_certificate_exit = 0x18U,               
    udif_command_action_certificate_export = 0x19U,               
    udif_command_action_certificate_generate = 0x1AU,           
    udif_command_action_certificate_help = 0x1BU,               
    udif_command_action_certificate_import = 0x1CU,               
    udif_command_action_certificate_print = 0x1DU,             
 
    /* config-server commands */
    udif_command_action_server_backup = 0x1EU,                 
    udif_command_action_server_connect = 0x1FU,                   
    udif_command_action_server_exit = 0x20U,                 
    udif_command_action_server_help = 0x21U,                 
    udif_command_action_server_list = 0x22U,                 
    udif_command_action_server_register = 0x23U,             
    udif_command_action_server_resign = 0x24U,                 
    udif_command_action_server_restore = 0x25U,                   
    udif_command_action_server_service = 0x26U,                   
 
    /* client config-connect commands */
    udif_command_action_server_query = 0x27U,                   
    udif_command_action_client_connect_help = 0x28U,         
    udif_command_action_client_connect_quit = 0x29U,         
 
    /* ads config-certificate commands */
    udif_command_action_adc_certificate_revoke = 0x2AU,           
 
    /* ads config-server commands */
    udif_command_action_adc_server_announce = 0x2BU,         
    udif_command_action_adc_server_converge = 0x2CU,         
    udif_command_action_adc_server_revoke = 0x2DU,             
    udif_command_action_adc_server_sproxy = 0x2EU,             
 
    /* rds config-certificate commands */
    udif_command_action_certificate_sign = 0x2FU,               
 
    /* config sub commands */
    udif_command_action_config_clear = 0x30U,                   
    udif_command_action_config_log = 0x31U,                       
    udif_command_action_config_name = 0x32U,                 
    udif_command_action_help_enable_all = 0x33U,             
    udif_command_action_help_enable_show = 0x34U,               
    udif_command_action_help_enable_user = 0x35U,               
    udif_command_action_command_unrecognized = 0x36U,           
} udif_command_actions;

typedef enum udif_console_modes
{
    udif_console_mode_name = 0x00U,                               
    udif_console_mode_user = 0x01U,                               
    udif_console_mode_enable = 0x02U,                           
    udif_console_mode_config = 0x03U,                           
    udif_console_mode_certificate = 0x04U,                     
    udif_console_mode_server = 0x05U,                           
    udif_console_mode_login_message = 0x06U,                 
    udif_console_mode_login_password = 0x07U,                   
    udif_console_mode_login_user = 0x08U,                       
    udif_console_mode_login_hostname = 0x09U,                   
    udif_console_mode_login_address = 0x0AU,                 
    udif_console_mode_login_domain = 0x0BU,                       
    udif_console_mode_login_rootpath = 0x0CU,                   
    udif_console_mode_client_connected = 0x0DU,                   
} udif_console_modes;
 
#endif