pqs.h

/* 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 PQS_H
#define PQS_H
 
#include "pqscommon.h"
#include "qsms.h"
 
#ifndef PQS_CRYPTO_PHASH_CPU_COST
#   define PQS_CRYPTO_PHASH_CPU_COST 4U
#endif
 
#ifndef PQS_CRYPTO_PHASH_MEMORY_COST
#   define PQS_CRYPTO_PHASH_MEMORY_COST 1U
#endif
 
#ifndef PQS_USER_VERIFIER_DOMAIN
#   define PQS_USER_VERIFIER_DOMAIN "PQS-USER-SCB-VERIFIER-V2"
#endif

PQS_EXPORT_API typedef enum pqs_application_messages
{
    pqs_application_message_none = 0x00U,                       
    pqs_application_message_login_request = 0x10U,              
    pqs_application_message_login_success = 0x11U,              
    pqs_application_message_login_failure = 0x12U,              
    pqs_application_message_command_request = 0x20U,            
    pqs_application_message_response_more = 0x21U,              
    pqs_application_message_response_final = 0x22U,             
    pqs_application_message_admin_request = 0x23U,          
    pqs_application_message_admin_response_more = 0x24U,        
    pqs_application_message_admin_response_final = 0x25U,       
    pqs_application_message_file_get_request = 0x40U,           
    pqs_application_message_file_put_start = 0x41U,             
    pqs_application_message_file_put_data = 0x42U,              
    pqs_application_message_file_put_final = 0x43U,             
    pqs_application_message_file_list_request = 0x44U,          
    pqs_application_message_file_mkdir_request = 0x45U,         
    pqs_application_message_file_remove_request = 0x46U,        
    pqs_application_message_file_data = 0x47U,                  
    pqs_application_message_file_final = 0x48U,                 
    pqs_application_message_file_status = 0x49U,                
    pqs_application_message_file_get_recursive_request = 0x4AU, 
    pqs_application_message_file_directory_begin = 0x4BU,       
    pqs_application_message_file_directory_end = 0x4CU,         
    pqs_application_message_file_begin = 0x4DU,                 
    pqs_application_message_error = 0x30U,                      
    pqs_application_message_disconnect = 0x31U                  
} pqs_application_messages;

PQS_EXPORT_API typedef enum pqs_session_states
{
    pqs_session_state_none = 0x00U,                             
    pqs_session_state_connected = 0x01U,                        
    pqs_session_state_login_required = 0x02U,                   
    pqs_session_state_authenticated = 0x03U,                    
    pqs_session_state_command_active = 0x04U,                   
    pqs_session_state_closing = 0x05U                           
} pqs_session_states;

PQS_EXPORT_API typedef enum pqs_user_privileges
{
    pqs_user_privilege_none = 0x00U,                            
    pqs_user_privilege_guest = 0x01U,                           
    pqs_user_privilege_user = 0x02U,                            
    pqs_user_privilege_admin = 0x03U                            
} pqs_user_privileges;

PQS_EXPORT_API typedef enum pqs_client_commands
{
    pqs_client_command_none = 0x00U,                            
    pqs_client_command_cprint = 0x01U,                          
    pqs_client_command_knownhosts = 0x02U,                      
    pqs_client_command_knownhost_remove = 0x03U,                
    pqs_client_command_file_get = 0x04U,                        
    pqs_client_command_file_put = 0x05U,                        
    pqs_client_command_file_list = 0x06U,                       
    pqs_client_command_file_mkdir = 0x07U,                      
    pqs_client_command_file_remove = 0x08U,                     
    pqs_client_command_help = 0x09U,                            
    pqs_client_command_help_detail = 0x0AU,                     
    pqs_client_command_execute = 0x0BU,                         
    pqs_client_command_admin = 0x0CU,                           
    pqs_client_command_quit = 0x0DU,                            
} pqs_client_commands;

PQS_EXPORT_API typedef enum pqs_errors
{
    pqs_error_none = 0x00U,                                     
    pqs_error_accept_fail = 0x01U,                              
    pqs_error_authentication_failure = 0x02U,                   
    pqs_error_bad_keep_alive = 0x03U,                           
    pqs_error_channel_down = 0x04U,                             
    pqs_error_connection_failure = 0x05U,                       
    pqs_error_connect_failure = 0x06U,                          
    pqs_error_decapsulation_failure = 0x07U,                    
    pqs_error_decryption_failure = 0x08U,                       
    pqs_error_establish_failure = 0x09U,                        
    pqs_error_exchange_failure = 0x0AU,                         
    pqs_error_hash_invalid = 0x0BU,                             
    pqs_error_hosts_exceeded = 0x0CU,                           
    pqs_error_invalid_input = 0x0DU,                            
    pqs_error_invalid_request = 0x0EU,                          
    pqs_error_keepalive_expired = 0x0FU,                        
    pqs_error_keepalive_timeout = 0x10U,                        
    pqs_error_key_expired = 0x11U,                              
    pqs_error_key_unrecognized = 0x12U,                         
    pqs_error_keychain_fail = 0x13U,                            
    pqs_error_listener_fail = 0x14U,                            
    pqs_error_memory_allocation = 0x15U,                        
    pqs_error_packet_unsequenced = 0x16U,                       
    pqs_error_random_failure = 0x17U,                           
    pqs_error_receive_failure = 0x18U,                          
    pqs_error_transmit_failure = 0x19U,                         
    pqs_error_unknown_protocol = 0x1AU,                         
    pqs_error_verify_failure = 0x1BU,                           
    pqs_error_login_failure = 0x1CU,                            
    pqs_error_login_success = 0x1DU,                            
    pqs_error_message_time_invalid = 0x1EU,                     
    pqs_error_connection_refused = 0x1FU,                       
    pqs_messages_system_message = 0x20U,                        
} pqs_errors;
 
#endif