oqs-sys 0.11.0+liboqs-0.13.0

Bindings to liboqs
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

// SPDX-License-Identifier: (Apache-2.0 OR MIT) AND CC0-1.0
#ifndef XMSS_H
#define XMSS_H

#include <stdint.h>
#include "namespace.h"

/**
 * Generates a XMSS key pair for a given parameter set.
 * Format sk: [OID || (32bit) idx || SK_SEED || SK_PRF || PUB_SEED || root]
 * Format pk: [OID || root || PUB_SEED]
 */
#define xmss_keypair XMSS_NAMESPACE(xmss_keypair)
int xmss_keypair(unsigned char *pk, unsigned char *sk, const uint32_t oid);

/**
 * Signs a message using an XMSS secret key.
 * Returns
 * 1. an array containing the signature followed by the message AND
 * 2. an updated secret key!
 */
#define xmss_sign XMSS_NAMESPACE(xmss_sign)
int xmss_sign(unsigned char *sk,
              unsigned char *sm, unsigned long long *smlen,
              const unsigned char *m, unsigned long long mlen);

/**
 * Verifies a given message signature pair using a given public key.
 *
 * Note: m and mlen are pure outputs which carry the message in case
 * verification succeeds. The (input) message is assumed to be contained in sm
 * which has the form [signature || message].
 */
#define xmss_sign_open XMSS_NAMESPACE(xmss_sign_open)
int xmss_sign_open(const unsigned char *m, unsigned long long mlen,
                   const unsigned char *sm, unsigned long long smlen,
                   const unsigned char *pk);

/* 
 * Write number of remaining signature to `remain` variable given `sk`
 */
#define xmss_remaining_signatures XMSS_NAMESPACE(xmss_remaining_signatures)
int xmss_remaining_signatures(unsigned long long *remain, const unsigned  char *sk);

/*
 * Write number of maximum signature to `max` variable given `sk`
 */
#define xmss_total_signatures XMSS_NAMESPACE(xmss_total_signatures)
int xmss_total_signatures(unsigned long long *max, const unsigned  char *sk);

/*
 * Generates a XMSSMT key pair for a given parameter set.
 * Format sk: [OID || (ceil(h/8) bit) idx || SK_SEED || SK_PRF || PUB_SEED || root]
 * Format pk: [OID || root || PUB_SEED]
 */
#define xmssmt_keypair XMSS_NAMESPACE(xmssmt_keypair)
int xmssmt_keypair(unsigned char *pk, unsigned char *sk, const uint32_t oid);

/**
 * Signs a message using an XMSSMT secret key.
 * Returns
 * 1. an array containing the signature followed by the message AND
 * 2. an updated secret key!
 */
#define xmssmt_sign XMSS_NAMESPACE(xmssmt_sign)
int xmssmt_sign(unsigned char *sk,
                unsigned char *sm, unsigned long long *smlen,
                const unsigned char *m, unsigned long long mlen);

/**
 * Verifies a given message signature pair using a given public key.
 *
 * Note: m and mlen are pure outputs which carry the message in case
 * verification succeeds. The (input) message is assumed to be contained in sm
 * which has the form [signature || message].
 */
#define xmssmt_sign_open XMSS_NAMESPACE(xmssmt_sign_open)
int xmssmt_sign_open(const unsigned char *m, unsigned long long mlen,
                     const unsigned char *sm, unsigned long long smlen,
                     const unsigned char *pk);

/* 
 * Write number of remaining signature to `remain` variable given `sk`
 */
#define xmssmt_remaining_signatures XMSS_NAMESPACE(xmssmt_remaining_signatures)
int xmssmt_remaining_signatures(unsigned long long *remain, const unsigned  char *sk);

/*
 * Write number of maximum signature to `max` variable given `sk`
 */
#define xmssmt_total_signatures XMSS_NAMESPACE(xmssmt_total_signatures)
int xmssmt_total_signatures(unsigned long long *max, const unsigned  char *sk);

#endif