QSMP: Quantum Secure Messaging Protocol 1.3.0.0a (A3)
A quantum secure encrypted tunneling protocol
client.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 QSMP_CLIENT_H
41#define QSMP_CLIENT_H
42
43#include "qsmp.h"
44#include "../../QSC/QSC/rcs.h"
45#include "../../QSC/QSC/socketclient.h"
46
85
93
94#if defined(QSMP_ASYMMETRIC_RATCHET)
108QSMP_EXPORT_API bool qsmp_duplex_send_asymmetric_ratchet_request(qsmp_connection_state* cns);
109#endif
110
124
144 const qsc_ipinfo_ipv4_address* address, uint16_t port,
145 void (*send_func)(qsmp_connection_state*),
146 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
147
166 const qsc_ipinfo_ipv6_address* address, uint16_t port,
167 void (*send_func)(qsmp_connection_state*),
168 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
169
188 const qsc_ipinfo_ipv4_address* address, uint16_t port,
189 void (*send_func)(qsmp_connection_state*),
190 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
191
209 const qsc_ipinfo_ipv6_address* address, uint16_t port,
210 void (*send_func)(qsmp_connection_state*),
211 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
212
229 void (*send_func)(qsmp_connection_state*),
230 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
231
247 void (*send_func)(qsmp_connection_state*),
248 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t));
249
267 void (*send_func)(qsmp_connection_state*),
268 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t),
269 bool (*key_query)(uint8_t* rvkey, const uint8_t* pkid));
270
288 void (*send_func)(qsmp_connection_state*),
289 void (*receive_callback)(qsmp_connection_state*, const uint8_t*, size_t),
290 bool (*key_query)(uint8_t* rvkey, const uint8_t* pkid));
291
292
293#endif
QSMP_EXPORT_API qsmp_errors qsmp_client_duplex_listen_ipv4(const qsmp_server_signature_key *kset, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t), bool(*key_query)(uint8_t *rvkey, const uint8_t *pkid))
Start the server in Duplex mode over IPv4 and listen for a single host-to-host connection.
Definition client.c:1287
QSMP_EXPORT_API bool qsmp_duplex_send_symmetric_ratchet_request(qsmp_connection_state *cns)
Send a symmetric key-ratchet request to the remote host.
Definition client.c:970
QSMP_EXPORT_API qsmp_errors qsmp_client_duplex_listen_ipv6(const qsmp_server_signature_key *kset, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t), bool(*key_query)(uint8_t *rvkey, const uint8_t *pkid))
Start the server in Duplex mode over IPv6 and listen for a single host-to-host connection.
Definition client.c:1358
QSMP_EXPORT_API qsmp_errors qsmp_client_simplex_listen_ipv6(const qsmp_server_signature_key *kset, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Start the server in Simplex mode over IPv6 and listen for client connections.
Definition client.c:1759
QSMP_EXPORT_API qsmp_errors qsmp_client_duplex_connect_ipv6(const qsmp_server_signature_key *kset, const qsmp_client_verification_key *rverkey, const qsc_ipinfo_ipv6_address *address, uint16_t port, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Connect to a remote host over IPv6 and perform the Duplex key exchange.
Definition client.c:1153
QSMP_EXPORT_API qsmp_errors qsmp_client_simplex_connect_ipv4(const qsmp_client_verification_key *pubk, const qsc_ipinfo_ipv4_address *address, uint16_t port, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Connect to a remote server over IPv4 and perform the Simplex key exchange.
Definition client.c:1429
QSMP_EXPORT_API qsmp_errors qsmp_client_duplex_connect_ipv4(const qsmp_server_signature_key *kset, const qsmp_client_verification_key *rverkey, const qsc_ipinfo_ipv4_address *address, uint16_t port, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Connect to a remote host over IPv4 and perform the Duplex key exchange.
Definition client.c:1022
QSMP_EXPORT_API qsmp_errors qsmp_client_simplex_listen_ipv4(const qsmp_server_signature_key *kset, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Start the server in Simplex mode over IPv4 and listen for client connections.
Definition client.c:1676
QSMP_EXPORT_API qsmp_errors qsmp_client_simplex_connect_ipv6(const qsmp_client_verification_key *pubk, const qsc_ipinfo_ipv6_address *address, uint16_t port, void(*send_func)(qsmp_connection_state *), void(*receive_callback)(qsmp_connection_state *, const uint8_t *, size_t))
Connect to a remote server over IPv6 and perform the Simplex key exchange.
Definition client.c:1553
QSMP support header Common defined parameters and functions of the qsmp client and server implementat...
qsmp_errors
The QSMP error values.
Definition qsmp.h:854
The QSMP client key structure.
Definition qsmp.h:965
The QSMP socket connection state structure.
Definition qsmp.h:1002
The QSMP server key structure.
Definition qsmp.h:977