pqsconfig.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 PQS_CONFIG_H
#define PQS_CONFIG_H
 
#include "pqscommon.h"
#include "pqslogger.h"
#include "qsms.h"


#define PQS_CONFIG_LINE_MAX 1024U

#define PQS_CONFIG_KEY_MAX 64U

#define PQS_CONFIG_VALUE_MAX QSC_SYSTEM_MAX_PATH

#define PQS_SERVER_CONFIG_NAME "pqsd.conf"

#define PQS_CLIENT_CONFIG_NAME "pqs.conf"

PQS_EXPORT_API typedef struct pqs_server_config
{
    char application_path[QSC_SYSTEM_MAX_PATH];             
    char private_key_path[QSC_SYSTEM_MAX_PATH];             
    char public_key_path[QSC_SYSTEM_MAX_PATH];               
    char user_database_path[QSC_SYSTEM_MAX_PATH];         
    char shell_database_path[QSC_SYSTEM_MAX_PATH];           
    char policy_database_path[QSC_SYSTEM_MAX_PATH];         
    char log_path[QSC_SYSTEM_MAX_PATH];                     
    char listen_address[QSC_IPINFO_IPV4_STRNLEN];         
    uint16_t listen_port;                                    
    uint32_t max_sessions;                                  
    uint32_t max_login_attempts;                          
    char sandbox_working_directory[QSC_SYSTEM_MAX_PATH];   
    char sandbox_run_as_user[PQS_USERNAME_MAX];              
    char sandbox_run_as_group[PQS_USERNAME_MAX];            
    uint32_t login_timeout_seconds;                            
    uint32_t idle_timeout_seconds;                          
    uint32_t command_timeout_seconds;                        
    uint32_t command_output_max_bytes;                  
    pqs_log_level log_level;                              
    bool sandbox_enabled;                                    
    bool sandbox_clear_environment;                            
    bool sandbox_chroot_enabled;                          
    bool sandbox_allow_same_user;                            
} pqs_server_config;

PQS_EXPORT_API typedef struct pqs_client_config
{
    char application_path[QSC_SYSTEM_MAX_PATH];             
    char server_public_key_path[QSC_SYSTEM_MAX_PATH];     
    char known_hosts_path[QSC_SYSTEM_MAX_PATH];             
    char log_path[QSC_SYSTEM_MAX_PATH];                     
    char host[QSC_IPINFO_IPV4_STRNLEN];                     
    char username[PQS_USERNAME_MAX];                        
    uint16_t port;                                          
    bool strict_host_checking;                              
    pqs_log_level log_level;                              
} pqs_client_config;

PQS_EXPORT_API void pqs_config_server_defaults(pqs_server_config* cfg);

PQS_EXPORT_API void pqs_config_client_defaults(pqs_client_config* cfg);

PQS_EXPORT_API bool pqs_config_server_load(pqs_server_config* cfg, const char* fpath);

PQS_EXPORT_API bool pqs_config_client_load(pqs_client_config* cfg, const char* fpath);

PQS_EXPORT_API const char* pqs_config_log_level_to_string(pqs_log_level level);
 
#endif