QSC Post Quantum Cryptographic Library 1.3.0.0 (C1)
A post quantum secure library written in Ansi C
Loading...
Searching...
No Matches
sphincsplus.h
Go to the documentation of this file.
1/* 2020-2026 Quantum Resistant Cryptographic Solutions Corporation
2 * All Rights Reserved.
3 *
4 * NOTICE:
5 * This software and all accompanying materials are the exclusive property of
6 * Quantum Resistant Cryptographic Solutions Corporation (QRCS). The intellectual
7 * and technical concepts contained herein are proprietary to QRCS and are
8 * protected under applicable Canadian, U.S., and international copyright,
9 * patent, and trade secret laws.
10 *
11 * CRYPTOGRAPHIC ALGORITHMS AND IMPLEMENTATIONS:
12 * - This software includes implementations of cryptographic primitives and
13 * algorithms that are standardized or in the public domain, such as AES
14 * and SHA-3, which are not proprietary to QRCS.
15 * - This software also includes cryptographic primitives, constructions, and
16 * algorithms designed by QRCS, including but not limited to RCS, SCB, CSX, QMAC, and
17 * related components, which are proprietary to QRCS.
18 * - All source code, implementations, protocol compositions, optimizations,
19 * parameter selections, and engineering work contained in this software are
20 * original works of QRCS and are protected under this license.
21 *
22 * LICENSE AND USE RESTRICTIONS:
23 * - This software is licensed under the Quantum Resistant Cryptographic Solutions
24 * Public Research and Evaluation License (QRCS-PREL), 2025-2026.
25 * - Permission is granted solely for non-commercial evaluation, academic research,
26 * cryptographic analysis, interoperability testing, and feasibility assessment.
27 * - Commercial use, production deployment, commercial redistribution, or
28 * integration into products or services is strictly prohibited without a
29 * separate written license agreement executed with QRCS.
30 * - Licensing and authorized distribution are solely at the discretion of QRCS.
31 *
32 * EXPERIMENTAL CRYPTOGRAPHY NOTICE:
33 * Portions of this software may include experimental, novel, or evolving
34 * cryptographic designs. Use of this software is entirely at the user's risk.
35 *
36 * DISCLAIMER:
37 * THIS SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
38 * IMPLIED, INCLUDING BUT NOT LIMITED TO WARRANTIES OF MERCHANTABILITY, FITNESS
39 * FOR A PARTICULAR PURPOSE, SECURITY, OR NON-INFRINGEMENT. QRCS DISCLAIMS ALL
40 * LIABILITY FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES
41 * ARISING FROM THE USE OR MISUSE OF THIS SOFTWARE.
42 *
43 * FULL LICENSE:
44 * This software is subject to the Quantum Resistant Cryptographic Solutions
45 * Public Research and Evaluation License (QRCS-PREL), 2025-2026. The complete license terms
46 * are provided in the accompanying LICENSE file or at https://www.qrcscorp.ca.
47 *
48 * Written by: John G. Underhill
49 * Contact: contact@qrcscorp.ca
50 */
51
52#ifndef QSC_SPHINCSPLUS_H
53#define QSC_SPHINCSPLUS_H
54
55#include "qsccommon.h"
56
57QSC_CPLUSPLUS_ENABLED_START
58
96
97#if defined(QSC_SPHINCSPLUS_S1S128SHAKERS)
102# define QSC_SPHINCSPLUS_GENERATE_SEED_SIZE 48
103
108# define QSC_SPHINCSPLUS_SIGN_SEED_SIZE 16
109
114# define QSC_SPHINCSPLUS_SIGNATURE_SIZE 7856
115
120# define QSC_SPHINCSPLUS_PRIVATEKEY_SIZE 64
121
126# define QSC_SPHINCSPLUS_PUBLICKEY_SIZE 32
127
132# define QSC_SPHINCSPLUS_ALGNAME "SPHINCSPLUS-S1S128SHAKERS"
133
134#elif defined(QSC_SPHINCSPLUS_S3S192SHAKERS)
135
140# define QSC_SPHINCSPLUS_GENERATE_SEED_SIZE 72
141
146# define QSC_SPHINCSPLUS_SIGN_SEED_SIZE 24
147
152# define QSC_SPHINCSPLUS_SIGNATURE_SIZE 16224
153
158# define QSC_SPHINCSPLUS_PRIVATEKEY_SIZE 96
159
164# define QSC_SPHINCSPLUS_PUBLICKEY_SIZE 48
165
170# define QSC_SPHINCSPLUS_ALGNAME "SPHINCSPLUS-S3S192SHAKERS"
171
172#elif defined(QSC_SPHINCSPLUS_S5S256SHAKERS)
173
178# define QSC_SPHINCSPLUS_GENERATE_SEED_SIZE 96
179
184# define QSC_SPHINCSPLUS_SIGN_SEED_SIZE 32
185
190# define QSC_SPHINCSPLUS_SIGNATURE_SIZE 29792
191
196# define QSC_SPHINCSPLUS_PRIVATEKEY_SIZE 128
197
202# define QSC_SPHINCSPLUS_PUBLICKEY_SIZE 64
203
208# define QSC_SPHINCSPLUS_ALGNAME "SPHINCSPLUS-S5S256SHAKERS"
209
210#elif defined(QSC_SPHINCSPLUS_S6S512SHAKERS)
211
216# define QSC_SPHINCSPLUS_GENERATE_SEED_SIZE 192
217
222# define QSC_SPHINCSPLUS_SIGN_SEED_SIZE 64
223
228# define QSC_SPHINCSPLUS_EXTENDED
229
234# define QSC_SPHINCSPLUS_SIGNATURE_SIZE 113344
235
240# define QSC_SPHINCSPLUS_PRIVATEKEY_SIZE 256
241
246# define QSC_SPHINCSPLUS_PUBLICKEY_SIZE 128
247
252# define QSC_SPHINCSPLUS_ALGNAME "SPHINCSPLUS-S6S512SHAKERS"
253
254#else
255# error "The SPHINCS+ parameter set is invalid!"
256#endif
257
269QSC_EXPORT_API bool qsc_sphincsplus_generate_keypair(uint8_t* publickey, uint8_t* privatekey, bool (*rng_generate)(uint8_t*, size_t));
270
282QSC_EXPORT_API bool qsc_sphincsplus_generate_seeded_keypair(uint8_t* publickey, uint8_t* privatekey, const uint8_t seed[QSC_SPHINCSPLUS_GENERATE_SEED_SIZE]);
283
298QSC_EXPORT_API bool qsc_sphincsplus_sign(uint8_t* signedmsg, size_t* smsglen, const uint8_t* message, size_t msglen, const uint8_t* privatekey, bool (*rng_generate)(uint8_t*, size_t));
299
316QSC_EXPORT_API bool qsc_sphincsplus_sign_ex(uint8_t* signedmsg, size_t* smsglen, const uint8_t* message, size_t msglen, const uint8_t* context, size_t ctxlen, const uint8_t* privatekey, bool (*rng_generate)(uint8_t*, size_t));
317
334QSC_EXPORT_API bool qsc_sphincsplus_seeded_sign_ex(uint8_t* signedmsg, size_t* smsglen, const uint8_t* message, size_t msglen, const uint8_t* context, size_t ctxlen, const uint8_t* privatekey, const uint8_t* seed);
335
347QSC_EXPORT_API bool qsc_sphincsplus_verify(uint8_t* message, size_t* msglen, const uint8_t* signedmsg, size_t smsglen, const uint8_t* publickey);
348
362QSC_EXPORT_API bool qsc_sphincsplus_verify_ex(uint8_t* message, size_t* msglen, const uint8_t* context, size_t ctxlen, const uint8_t* signedmsg, size_t smsglen, const uint8_t* publickey);
363
364QSC_CPLUSPLUS_ENABLED_END
365
366#endif
Contains common definitions for the Quantum Secure Cryptographic (QSC) library.
#define QSC_EXPORT_API
API export macro for Microsoft compilers when importing from a DLL.
Definition qsccommon.h:645
QSC_EXPORT_API bool qsc_sphincsplus_seeded_sign_ex(uint8_t *signedmsg, size_t *smsglen, const uint8_t *message, size_t msglen, const uint8_t *context, size_t ctxlen, const uint8_t *privatekey, const uint8_t *seed)
Takes the message and a seed as input and returns an array containing the signature followed by the m...
Definition sphincsplus.c:91
QSC_EXPORT_API bool qsc_sphincsplus_generate_keypair(uint8_t *publickey, uint8_t *privatekey, bool(*rng_generate)(uint8_t *, size_t))
Generates a Sphincs+ public/private key-pair.
Definition sphincsplus.c:5
QSC_EXPORT_API bool qsc_sphincsplus_sign(uint8_t *signedmsg, size_t *smsglen, const uint8_t *message, size_t msglen, const uint8_t *privatekey, bool(*rng_generate)(uint8_t *, size_t))
Takes the message as input and returns an array containing the signature followed by the message.
Definition sphincsplus.c:41
#define QSC_SPHINCSPLUS_GENERATE_SEED_SIZE
The byte size of the key generation seed.
Definition sphincsplus.h:102
QSC_EXPORT_API bool qsc_sphincsplus_verify_ex(uint8_t *message, size_t *msglen, const uint8_t *context, size_t ctxlen, const uint8_t *signedmsg, size_t smsglen, const uint8_t *publickey)
Verifies a signature-message pair and context parameter with the public key.
Definition sphincsplus.c:131
QSC_EXPORT_API bool qsc_sphincsplus_verify(uint8_t *message, size_t *msglen, const uint8_t *signedmsg, size_t smsglen, const uint8_t *publickey)
Verifies a signature-message pair with the public key.
Definition sphincsplus.c:111
QSC_EXPORT_API bool qsc_sphincsplus_generate_seeded_keypair(uint8_t *publickey, uint8_t *privatekey, const uint8_t seed[QSC_SPHINCSPLUS_GENERATE_SEED_SIZE])
Generates a Sphincs+ public/private key-pair using a seed.
Definition sphincsplus.c:23
QSC_EXPORT_API bool qsc_sphincsplus_sign_ex(uint8_t *signedmsg, size_t *smsglen, const uint8_t *message, size_t msglen, const uint8_t *context, size_t ctxlen, const uint8_t *privatekey, bool(*rng_generate)(uint8_t *, size_t))
Takes the message as input with the additional context parameter and returns an array containing the ...
Definition sphincsplus.c:66