SATP: Symmetric Authenticated Tunneling Protocol 1.0.0.0a (A1)
A quantum secure symmetric pre-shared key 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: contact@qrcscorp.ca
38 */
39
40#ifndef SATP_CLIENT_H
41#define SATP_CLIENT_H
42
43#include "satpcommon.h"
44#include "satp.h"
45#include "socketclient.h"
46
63
74SATP_EXPORT_API void satp_client_send_error(const qsc_socket* sock, satp_errors error);
75
94 const qsc_ipinfo_ipv4_address* address, uint16_t port,
95 void (*send_func)(satp_connection_state*),
96 void (*receive_callback)(satp_connection_state*, const uint8_t*, size_t));
97
116 const qsc_ipinfo_ipv6_address* address, uint16_t port,
117 void (*send_func)(satp_connection_state*),
118 void (*receive_callback)(satp_connection_state*, const uint8_t*, size_t));
119
130SATP_EXPORT_API void satp_client_connection_close(satp_connection_state* cns, satp_errors error);
131
132#endif
SATP_EXPORT_API satp_errors satp_client_connect_ipv6(satp_device_key *ckey, const qsc_ipinfo_ipv6_address *address, uint16_t port, void(*send_func)(satp_connection_state *), void(*receive_callback)(satp_connection_state *, const uint8_t *, size_t))
Establish an IPv6 connection and perform the SATP key exchange.
Definition client.c:394
SATP_EXPORT_API satp_errors satp_client_connect_ipv4(satp_device_key *ckey, const qsc_ipinfo_ipv4_address *address, uint16_t port, void(*send_func)(satp_connection_state *), void(*receive_callback)(satp_connection_state *, const uint8_t *, size_t))
Establish an IPv4 connection and perform the SATP key exchange.
Definition client.c:282
SATP_EXPORT_API void satp_client_connection_close(satp_connection_state *cns, satp_errors error)
Close the remote session and dispose of client resources.
Definition client.c:496
SATP_EXPORT_API void satp_client_send_error(const qsc_socket *sock, satp_errors error)
Send an error code to the remote host.
Definition client.c:261
SATP support header Common defined parameters and functions of the SATP client and server implementat...
satp_errors
The SATP error values. This enumeration defines the error codes returned by SATP functions.
Definition satp.h:452
The SATP socket connection state structure.
Definition satp.h:511
The SATP device key structure. This structure represents the SATP device key, which is derived from t...
Definition satp.h:529