PQS: Post Quantum Shell 1.0.0.0a (A1)
A quantum safe shell application
logger.h
Go to the documentation of this file.
1/* 2025 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE: This software and all accompanying materials are the exclusive
5 * property of Quantum Resistant Cryptographic Solutions Corporation (QRCS).
6 * The intellectual and technical concepts contained within this implementation
7 * are proprietary to QRCS and its authorized licensors and are protected under
8 * applicable U.S. and international copyright, patent, and trade secret laws.
9 *
10 * CRYPTOGRAPHIC STANDARDS:
11 * - This software includes implementations of cryptographic algorithms such as
12 * SHA3, AES, and others. These algorithms are public domain or standardized
13 * by organizations such as NIST and are NOT the property of QRCS.
14 * - However, all source code, optimizations, and implementations in this library
15 * are original works of QRCS and are protected under this license.
16 *
17 * RESTRICTIONS:
18 * - Redistribution, modification, or unauthorized distribution of this software,
19 * in whole or in part, is strictly prohibited.
20 * - This software is provided for non-commercial, educational, and research
21 * purposes only. Commercial use in any form is expressly forbidden.
22 * - Licensing and authorized distribution are solely at the discretion of QRCS.
23 * - Any use of this software implies acceptance of these restrictions.
24 *
25 * DISCLAIMER:
26 * This software is provided "as is," without warranty of any kind, express or
27 * implied, including but not limited to warranties of merchantability or fitness
28 * for a particular purpose. QRCS disclaims all liability for any direct, indirect,
29 * incidental, or consequential damages resulting from the use or misuse of this software.
30 *
31 * FULL LICENSE:
32 * This software is subject to the **Quantum Resistant Cryptographic Solutions
33 * Proprietary License (QRCS-PL)**. The complete license terms are included
34 * in the LICENSE.txt file distributed with this software.
35 *
36 * Written by: John G. Underhill
37 * Contact: john.underhill@protonmail.com
38 */
39
40#ifndef PQS_LOGGER_H
41#define PQS_LOGGER_H
42
43#include "common.h"
44
57
64#define PQS_LOGGING_MESSAGE_MAX 256
65
71static const char PQS_LOGGER_PATH[] = "PQS";
72
78static const char PQS_LOGGER_FILE[] = "pqs.log";
79
85static const char PQS_LOGGER_HEAD[] = "PQS Version 1.0";
86
95bool pqs_logger_exists(void);
96
106void pqs_logger_initialize(const char* path);
107
114void pqs_logger_print(void);
115
125void pqs_logger_read(char* output, size_t otplen);
126
133void pqs_logger_reset(void);
134
143size_t pqs_logger_size(void);
144
155bool pqs_logger_write(const char* message);
156
166bool pqs_logger_test(void);
167
168#endif
pqs_logger_initialize
void pqs_logger_initialize(const char *path)
Initialize the logger.
Definition logger.c:33
pqs_logger_write
bool pqs_logger_write(const char *message)
Write a message to the log file.
Definition logger.c:147
pqs_logger_print
void pqs_logger_print(void)
Print the log file.
Definition logger.c:75
pqs_logger_size
size_t pqs_logger_size(void)
Get the log file size.
Definition logger.c:133
pqs_logger_reset
void pqs_logger_reset(void)
Reset the logger.
Definition logger.c:112
pqs_logger_read
void pqs_logger_read(char *output, size_t otplen)
Read the contents of the log file.
Definition logger.c:100
pqs_logger_test
bool pqs_logger_test(void)
Perform a manual test of the logger functions.
Definition logger.c:173
pqs_logger_exists
bool pqs_logger_exists(void)
Test if the log file exists.
Definition logger.c:61