PQS: Post Quantum Shell 1.0.0.0a (A1)
A quantum safe shell application
server.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_SERVER_H
41#define PQS_SERVER_H
42
43#include "pqs.h"
44#include "../../QSC/QSC/rcs.h"
45#include "../../QSC/QSC/socketserver.h"
46
61
69#define PQS_SERVER_PAUSE_INTERVAL 100
70
78PQS_EXPORT_API void pqs_server_pause(void);
79
89PQS_EXPORT_API void pqs_server_quit(qsc_socket* source);
90
98PQS_EXPORT_API void pqs_server_resume(void);
99
115PQS_EXPORT_API pqs_errors pqs_server_start_ipv4(qsc_socket* source,
116 const pqs_server_signature_key* kset,
117 void (*receive_callback)(pqs_connection_state*, const uint8_t*, size_t),
118 void (*disconnect_callback)(pqs_connection_state*));
119
135PQS_EXPORT_API pqs_errors pqs_server_start_ipv6(qsc_socket* source,
136 const pqs_server_signature_key* kset,
137 void (*receive_callback)(pqs_connection_state*, const uint8_t*, size_t),
138 void (*disconnect_callback)(pqs_connection_state*));
139
140#endif
PQS support header.
pqs_errors
Enumeration of error codes returned by PQS functions.
Definition pqs.h:586
PQS_EXPORT_API pqs_errors pqs_server_start_ipv4(qsc_socket *source, const pqs_server_signature_key *kset, void(*receive_callback)(pqs_connection_state *, const uint8_t *, size_t), void(*disconnect_callback)(pqs_connection_state *))
Start the IPv4 multi-threaded server.
Definition server.c:350
PQS_EXPORT_API void pqs_server_resume(void)
Resume the server listener function from a paused state.
Definition server.c:345
PQS_EXPORT_API pqs_errors pqs_server_start_ipv6(qsc_socket *source, const pqs_server_signature_key *kset, void(*receive_callback)(pqs_connection_state *, const uint8_t *, size_t), void(*disconnect_callback)(pqs_connection_state *))
Start the IPv6 multi-threaded server.
Definition server.c:399
PQS_EXPORT_API void pqs_server_pause(void)
Pause the server, suspending new joins.
Definition server.c:328
PQS_EXPORT_API void pqs_server_quit(qsc_socket *source)
Quit the server, closing all connections.
Definition server.c:333
Maintains the state for a PQS socket connection.
Definition pqs.h:790
Structure holding a PQS server secret signature key.
Definition pqs.h:757