pqcee_safequard_api.h

Go to the documentation of this file.

/* Author: pQCee
 *
 * Description : SafeQuard
 *
 * Copyright 2026 pQCee Pte Ltd. All rights reserved. Confidential.
 *
 * "Commons Clause" License Condition v1.0
 *
 * The Software is provided to you by the Licensor under the License, as defined
 * below, subject to the following condition.
 *
 * Without limiting other conditions in the License, the grant of rights under
 * the License will not include, and the License does not grant to you, the
 * right to Sell the Software.
 *
 * For purposes of the foregoing, "Sell" means practicing any or all of the
 * rights granted to you under the License to provide to third parties, for a
 * fee or other consideration (including without limitation fees for hosting or
 * consulting/ support services related to the Software), a product or service
 * whose value derives, entirely or substantially, from the functionality of the
 * Software. Any license notice or attribution required by the License must also
 * include this Commons Clause License Condition notice.
 *
 * Do not attempt to reverse engineer, disassemble, or decompile any prototypes,
 * software, or other items of Confidential Information that are provided here. In
 * addition, you agree not to attempt to reconstruct, identify or discover any
 * source code, underlying ideas, techniques or algorithms in Confidential
 * Information by any means whatever, except as may be specifically authorized in
 * advance by pQCee in writing.
 *
 * Software : SafeQuard
 *
 * Licensor: pQCee Pte Ltd
*/

 
 
#ifndef PQCEE_SAFEQUARD_API_H
#define PQCEE_SAFEQUARD_API_H
 
/* Auto-generated by cbindgen. Do not edit manually. */
 
#include <stdint.h>
#include <stdlib.h>

#define DLMS_CHALLENGE_SIZE 64

#define AES_256_KEY_SIZE 32

#define ML_DSA_65_SEED_SIZE 32

#define ML_DSA_65_PUBLIC_KEY_SIZE 1952

#define ML_DSA_65_SIGNATURE_SIZE 3309

#define ML_KEM_768_SEED_SIZE 64

#define ML_KEM_768_ENCAP_KEY_SIZE 1184

#define ML_KEM_768_DECAP_KEY_SIZE 2400

#define ML_KEM_768_CIPHERTEXT_SIZE 1088

#define ML_KEM_SHARED_SECRET_SIZE 32

#define ML_KEM_SHARED_SECRET_IV_SIZE 16

#define ML_KEM_SHARED_SECRET_AUTH_IV_SIZE 12

#define ML_KEM_SHARED_SECRET_AUTH_TAG_SIZE 16

#define SHA_512_BLOCK_SIZE 128

#define SHA_512_DIGEST_SIZE 64

#define SAFEQUARD_SUCCESS 0

#define SAFEQUARD_ERROR_INVALID_LOG_LEVEL -1

#define SAFEQUARD_ERROR_GENERIC -1000

#define SAFEQUARD_ERROR_NOT_SUPPORTED -1001

#define SAFEQUARD_ERROR_NOT_PERMITTED -1002

#define SAFEQUARD_ERROR_BUFFER_TOO_SMALL -1003

#define SAFEQUARD_ERROR_ALREADY_EXISTS -1004

#define SAFEQUARD_ERROR_DOES_NOT_EXIST -1005

#define SAFEQUARD_ERROR_BAD_STATE -1006

#define SAFEQUARD_ERROR_INVALID_ARGUMENT -1007

#define SAFEQUARD_ERROR_INSUFFICIENT_MEMORY -1008

#define SAFEQUARD_ERROR_INSUFFICIENT_STORAGE -1009

#define SAFEQUARD_ERROR_COMMUNICATION_FAILURE -1010

#define SAFEQUARD_ERROR_STORAGE_FAILURE -1011

#define SAFEQUARD_ERROR_DATA_CORRUPT -1012

#define SAFEQUARD_ERROR_DATA_INVALID -1013

#define SAFEQUARD_ERROR_HARDWARE_FAILURE -1014

#define SAFEQUARD_ERROR_CORRUPTION_DETECTED -1015

#define SAFEQUARD_ERROR_INSUFFICIENT_ENTROPY -1016

#define SAFEQUARD_ERROR_INVALID_SIGNATURE -1017

#define SAFEQUARD_ERROR_INVALID_PADDING -1018

#define SAFEQUARD_ERROR_INSUFFICIENT_DATA -1019

#define SAFEQUARD_ERROR_INVALID_HANDLE -1020

#define SAFEQUARD_ERROR_BACKEND -1099

#define SAFEQUARD_ERROR_MALFORMED_DER -1100

#define SAFEQUARD_ERROR_TRAILING_DATA -1101

#define SAFEQUARD_ERROR_UNSUPPORTED_ALGORITHM -1102

#define SAFEQUARD_ERROR_INVALID_PUBLIC_KEY -1103

#define SAFEQUARD_ERROR_ROOT_NOT_SELF_ISSUED -1105

#define SAFEQUARD_ERROR_INVALID_ROOT_SIGNATURE -1106

#define SAFEQUARD_ERROR_INVALID_TIME -1107

#define SAFEQUARD_ERROR_TIME_SOURCE_UNAVAILABLE -1108

#define SAFEQUARD_ERROR_CERTIFICATE_NOT_YET_VALID -1109

#define SAFEQUARD_ERROR_CERTIFICATE_EXPIRED -1110

#define SAFEQUARD_ERROR_ISSUER_MISMATCH -1111

#define SAFEQUARD_ERROR_CERTIFICATE_MUST_BE_V3 -1112

#define SAFEQUARD_ERROR_DUPLICATE_EXTENSION -1113

#define SAFEQUARD_ERROR_UNKNOWN_CRITICAL_EXTENSION -1114

#define SAFEQUARD_ERROR_MISSING_BASIC_CONSTRAINTS -1115

#define SAFEQUARD_ERROR_BASIC_CONSTRAINTS_NOT_CRITICAL -1116

#define SAFEQUARD_ERROR_EXPECTED_CA -1117

#define SAFEQUARD_ERROR_LEAF_IS_CA -1118

#define SAFEQUARD_ERROR_MISSING_KEY_USAGE -1119

#define SAFEQUARD_ERROR_KEY_USAGE_NOT_CRITICAL -1120

#define SAFEQUARD_ERROR_INVALID_CA_KEY_USAGE -1121

#define SAFEQUARD_ERROR_INVALID_LEAF_KEY_USAGE -1122

#define SAFEQUARD_ERROR_MISSING_EXTENDED_KEY_USAGE -1123

#define SAFEQUARD_ERROR_EXTENDED_KEY_USAGE_NOT_CRITICAL -1124

#define SAFEQUARD_ERROR_INVALID_CODE_SIGNING_USAGE -1125

#define SAFEQUARD_ERROR_PATH_LENGTH_EXCEEDED -1126

#define SAFEQUARD_ERROR_TOO_MANY_INTERMEDIATES -1127

#define SAFEQUARD_ERROR_INVALID_PKCS8 -1128

#define SAFEQUARD_ERROR_PKCS8_DECRYPTION_FAILED -1129

#define SAFEQUARD_ERROR_INVALID_PRIVATE_KEY_ALGORITHM -1130

#define SAFEQUARD_ERROR_SEED_NOT_AVAILABLE -1131

#define SAFEQUARD_ERROR_INVALID_SEED_ENCODING -1132

#define SAFEQUARD_LOG_LEVEL_ERROR 1

#define SAFEQUARD_LOG_LEVEL_WARN 2

#define SAFEQUARD_LOG_LEVEL_INFO 3

#define SAFEQUARD_LOG_LEVEL_DEBUG 4

#define SAFEQUARD_LOG_MESSAGE_CAPACITY 64
 
#ifdef __cplusplus
extern "C" {
#endif // __cplusplus

extern void safequard_panic_wrap(void);

int safequard_init(uint32_t max_log_level);

int safequard_mldsa65_sign(const uint8_t *seed,
                           size_t seed_size,
                           const uint8_t *data,
                           size_t data_size,
                           uint8_t *signature,
                           size_t signature_size);

int safequard_mldsa65_verify(const uint8_t *public_key,
                             size_t public_key_size,
                             const uint8_t *data,
                             size_t data_size,
                             const uint8_t *signature,
                             size_t signature_size);

int safequard_fv_import_key(uint8_t *context,
                            size_t context_size,
                            const uint8_t *trusted_cert,
                            size_t trusted_cert_size,
                            const uint8_t *leaf_cert,
                            size_t leaf_cert_size,
                            size_t *out);

int safequard_fv_verify(const uint8_t *context,
                        size_t context_size,
                        const uint8_t *data,
                        size_t data_size,
                        const uint8_t *signature,
                        size_t signature_size);

int safequard_mlkem768_init(uint8_t *context,
                            size_t context_size,
                            uint8_t *encap_key,
                            size_t encap_key_size,
                            size_t *out);

int safequard_dlms_key_agreement_encap(const uint8_t *encap_key,
                                       size_t encap_key_size,
                                       const uint8_t *other_info,
                                       size_t other_info_size,
                                       uint8_t *ciphertext,
                                       size_t ciphertext_size,
                                       uint8_t *context,
                                       size_t context_size,
                                       size_t *out);

int safequard_dlms_key_agreement_decap(const uint8_t *context,
                                       size_t context_size,
                                       const uint8_t *other_info,
                                       size_t other_info_size,
                                       const uint8_t *ciphertext,
                                       size_t ciphertext_size,
                                       uint8_t *ss_context,
                                       size_t ss_context_size,
                                       size_t *out);

int safequard_mlkem768_encrypt(const uint8_t *message,
                               size_t message_size,
                               const uint8_t *encap_key,
                               size_t encap_key_size,
                               uint8_t *ciphertext,
                               size_t ciphertext_size,
                               uint8_t *encrypted_message,
                               size_t encrypted_message_size);

int safequard_mlkem768_decrypt(const uint8_t *context,
                               size_t context_size,
                               const uint8_t *encrypted_message,
                               size_t encrypted_message_size,
                               const uint8_t *ciphertext,
                               size_t ciphertext_size,
                               uint8_t *message,
                               size_t message_size);

int safequard_dlms_auth_encrypt(const uint8_t *context,
                                size_t context_size,
                                const uint8_t *aad,
                                size_t aad_size,
                                const uint8_t *message,
                                size_t message_size,
                                uint8_t *encrypted_message,
                                size_t encrypted_message_size);

int safequard_dlms_auth_decrypt(const uint8_t *context,
                                size_t context_size,
                                const uint8_t *aad,
                                size_t aad_size,
                                const uint8_t *encrypted_message,
                                size_t encrypted_message_size,
                                uint8_t *message,
                                size_t message_size);

int safequard_mlkem768_finalise(uint8_t *context, size_t context_size);

int safequard_sha512_init(uint8_t *context,
                          size_t context_size,
                          size_t *out);

int safequard_sha512_update(uint8_t *context,
                            size_t context_size,
                            const uint8_t *chunk,
                            size_t chunk_size);

int safequard_sha512_finalise(uint8_t *context,
                              size_t context_size,
                              uint8_t *hash,
                              size_t hash_size);

int safequard_sha512(const uint8_t *message,
                     size_t message_size,
                     uint8_t *hash,
                     size_t hash_size);

int safequard_dlms_generate_challenge(uint8_t *challenge, size_t challenge_size);

extern void safequard_log_message(uint32_t level, const char *message, size_t message_length);

extern int64_t get_current_time(void);
 
#ifdef __cplusplus
}  // extern "C"
#endif  // __cplusplus
 
#endif  /* PQCEE_SAFEQUARD_API_H */