pqslogger.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_LOGGER_H
#define PQS_LOGGER_H
 
#include "pqscommon.h"


#define PQS_LOGGER_LINE_MAX 1536U

#define PQS_LOGGER_USER_MAX 64U

#define PQS_LOGGER_DETAIL_MAX 384U

PQS_EXPORT_API typedef enum pqs_log_level
{
    pqs_log_level_none = 0x00U,                           
    pqs_log_level_error = 0x01U,                     
    pqs_log_level_warning = 0x02U,                     
    pqs_log_level_info = 0x03U,                           
    pqs_log_level_audit = 0x04U,                     
    pqs_log_level_debug = 0x05U                          
} pqs_log_level;

PQS_EXPORT_API typedef enum pqs_log_event
{
    pqs_log_event_none = 0x0000U,                     
    pqs_log_event_application_start = 0x1000U,           
    pqs_log_event_application_stop = 0x1001U,         
    pqs_log_event_key_loaded = 0x1100U,                 
    pqs_log_event_key_generated = 0x1101U,               
    pqs_log_event_connection_open = 0x1200U,           
    pqs_log_event_connection_close = 0x1201U,         
    pqs_log_event_connection_refused = 0x1202U,         
    pqs_log_event_command_received = 0x1300U,         
    pqs_log_event_command_complete = 0x1301U,         
    pqs_log_event_command_failed = 0x1302U,             
    pqs_log_event_auth_success = 0x1400U,             
    pqs_log_event_auth_failure = 0x1401U,             
    pqs_log_event_auth_lockout = 0x1402U,             
    pqs_log_event_user_database_loaded = 0x1410U,     
    pqs_log_event_user_database_created = 0x1411U,       
    pqs_log_event_user_added = 0x1412U,                 
    pqs_log_event_user_removed = 0x1413U,             
    pqs_log_event_user_updated = 0x1414U,             
    pqs_log_event_shell_database_loaded = 0x1420U,       
    pqs_log_event_shell_database_created = 0x1421U,     
    pqs_log_event_shell_added = 0x1422U,               
    pqs_log_event_shell_removed = 0x1423U,               
    pqs_log_event_shell_updated = 0x1424U,               
    pqs_log_event_policy_database_loaded = 0x1430U,     
    pqs_log_event_policy_database_created = 0x1431U,   
    pqs_log_event_policy_added = 0x1432U,             
    pqs_log_event_policy_removed = 0x1433U,             
    pqs_log_event_policy_updated = 0x1434U,             
    pqs_log_event_policy_allowed = 0x1435U,             
    pqs_log_event_policy_denied = 0x1436U,               
    pqs_log_event_hostkey_loaded = 0x1440U,             
    pqs_log_event_hostkey_pinned = 0x1441U,             
    pqs_log_event_hostkey_verified = 0x1442U,         
    pqs_log_event_hostkey_changed = 0x1443U,           
    pqs_log_event_sandbox_enabled = 0x1450U,           
    pqs_log_event_sandbox_violation = 0x1451U,           
    pqs_log_event_command_timeout = 0x1452U,           
    pqs_log_event_command_output_limit = 0x1453U,     
    pqs_log_event_file_transfer_start = 0x1460U,       
    pqs_log_event_file_transfer_complete = 0x1461U,     
    pqs_log_event_file_transfer_failed = 0x1462U,     
    pqs_log_event_protocol_error = 0x1500U,             
    pqs_log_event_admin_request = 0x1550U,           
    pqs_log_event_admin_allowed = 0x1551U,           
    pqs_log_event_admin_denied = 0x1552U,         
    pqs_log_event_admin_complete = 0x1553U,         
    pqs_log_event_admin_failed = 0x1554U,         
    pqs_log_event_audit_chain_start = 0x1600U        
} pqs_log_event;

PQS_EXPORT_API void pqs_logger_dispose(void);

PQS_EXPORT_API bool pqs_logger_initialize(const char* path, pqs_log_level level);

PQS_EXPORT_API bool pqs_logger_is_initialized(void);

PQS_EXPORT_API bool pqs_logger_failure_occurred(void);

PQS_EXPORT_API bool pqs_logger_verify_chain(const char* path, uint64_t* records);

PQS_EXPORT_API bool pqs_logger_write(pqs_log_level level, pqs_log_event event, const char* user, const char* peer, const char* detail);
 
#endif