bitcoinpqc 0.2.0

Post-Quantum Cryptographic signature algorithms for Bitcoin (BIP-360)
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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207

// This file exists to solve the problem with OUT_DIR not being
// available in the IDE but required for builds.
// The build script always generates bindings.rs in the OUT_DIR.

// When compiling for real, include the real bindings
#[cfg(all(not(feature = "ide"), not(doc)))]
include!(concat!(env!("OUT_DIR"), "/bindings.rs"));

// For documentation, we need stubs to make doctests work
#[cfg(doc)]
pub mod doc_bindings {
    // Define the essential types needed for documentation
    #[repr(C)]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    pub struct bitcoin_pqc_algorithm_t(pub u32);

    impl bitcoin_pqc_algorithm_t {
        pub const BITCOIN_PQC_SECP256K1_SCHNORR: bitcoin_pqc_algorithm_t =
            bitcoin_pqc_algorithm_t(0);
        pub const BITCOIN_PQC_ML_DSA_44: bitcoin_pqc_algorithm_t = bitcoin_pqc_algorithm_t(1);
        pub const BITCOIN_PQC_SLH_DSA_SHAKE_128S: bitcoin_pqc_algorithm_t =
            bitcoin_pqc_algorithm_t(2);
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    pub struct bitcoin_pqc_error_t(pub i32);

    impl bitcoin_pqc_error_t {
        pub const BITCOIN_PQC_OK: bitcoin_pqc_error_t = bitcoin_pqc_error_t(0);
        pub const BITCOIN_PQC_ERROR_BAD_ARG: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-1);
        pub const BITCOIN_PQC_ERROR_BAD_KEY: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-2);
        pub const BITCOIN_PQC_ERROR_BAD_SIGNATURE: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-3);
        pub const BITCOIN_PQC_ERROR_NOT_IMPLEMENTED: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-4);
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone)]
    pub struct bitcoin_pqc_keypair_t {
        pub algorithm: bitcoin_pqc_algorithm_t,
        pub public_key: *mut ::std::os::raw::c_uchar,
        pub secret_key: *mut ::std::os::raw::c_uchar,
        pub public_key_size: usize,
        pub secret_key_size: usize,
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone)]
    pub struct bitcoin_pqc_signature_t {
        pub algorithm: bitcoin_pqc_algorithm_t,
        pub signature: *mut ::std::os::raw::c_uchar,
        pub signature_size: usize,
    }

    // Dummy function declarations
    pub unsafe fn bitcoin_pqc_keygen(
        _algorithm: bitcoin_pqc_algorithm_t,
        _keypair: *mut bitcoin_pqc_keypair_t,
        _random_data: *const ::std::os::raw::c_uchar,
        _random_data_len: usize,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is a doc stub")
    }

    pub unsafe fn bitcoin_pqc_keypair_free(_keypair: *mut bitcoin_pqc_keypair_t) {}

    #[allow(clippy::too_many_arguments)]
    pub unsafe fn bitcoin_pqc_sign(
        _algorithm: bitcoin_pqc_algorithm_t,
        _secret_key: *const ::std::os::raw::c_uchar,
        _secret_key_len: usize,
        _message: *const ::std::os::raw::c_uchar,
        _message_len: usize,
        _signature: *mut bitcoin_pqc_signature_t,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is a doc stub")
    }

    pub unsafe fn bitcoin_pqc_verify(
        _algorithm: bitcoin_pqc_algorithm_t,
        _public_key: *const ::std::os::raw::c_uchar,
        _public_key_len: usize,
        _message: *const ::std::os::raw::c_uchar,
        _message_len: usize,
        _signature: *const ::std::os::raw::c_uchar,
        _signature_len: usize,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is a doc stub")
    }

    pub unsafe fn bitcoin_pqc_signature_free(_signature: *mut bitcoin_pqc_signature_t) {}

    pub unsafe fn bitcoin_pqc_public_key_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }

    pub unsafe fn bitcoin_pqc_secret_key_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }

    pub unsafe fn bitcoin_pqc_signature_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }
}

// For IDE support - similar stubs but are never compiled for release
#[cfg(feature = "ide")]
pub mod ide_bindings {
    #[repr(C)]
    #[derive(Debug, Copy, Clone)]
    pub struct bitcoin_pqc_keypair_t {
        pub algorithm: bitcoin_pqc_algorithm_t,
        pub public_key: *mut ::std::os::raw::c_uchar,
        pub secret_key: *mut ::std::os::raw::c_uchar,
        pub public_key_size: usize,
        pub secret_key_size: usize,
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone)]
    pub struct bitcoin_pqc_signature_t {
        pub algorithm: bitcoin_pqc_algorithm_t,
        pub signature: *mut ::std::os::raw::c_uchar,
        pub signature_size: usize,
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    pub struct bitcoin_pqc_algorithm_t(pub u32);

    impl bitcoin_pqc_algorithm_t {
        pub const BITCOIN_PQC_SECP256K1_SCHNORR: bitcoin_pqc_algorithm_t =
            bitcoin_pqc_algorithm_t(0);
        pub const BITCOIN_PQC_ML_DSA_44: bitcoin_pqc_algorithm_t = bitcoin_pqc_algorithm_t(1);
        pub const BITCOIN_PQC_SLH_DSA_SHAKE_128S: bitcoin_pqc_algorithm_t =
            bitcoin_pqc_algorithm_t(2);
    }

    #[repr(C)]
    #[derive(Debug, Copy, Clone, PartialEq, Eq)]
    pub struct bitcoin_pqc_error_t(pub i32);

    impl bitcoin_pqc_error_t {
        pub const BITCOIN_PQC_OK: bitcoin_pqc_error_t = bitcoin_pqc_error_t(0);
        pub const BITCOIN_PQC_ERROR_BAD_ARG: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-1);
        pub const BITCOIN_PQC_ERROR_BAD_KEY: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-2);
        pub const BITCOIN_PQC_ERROR_BAD_SIGNATURE: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-3);
        pub const BITCOIN_PQC_ERROR_NOT_IMPLEMENTED: bitcoin_pqc_error_t = bitcoin_pqc_error_t(-4);
    }

    // Function declarations for IDE support
    pub unsafe fn bitcoin_pqc_keygen(
        _algorithm: bitcoin_pqc_algorithm_t,
        _keypair: *mut bitcoin_pqc_keypair_t,
        _random_data: *const ::std::os::raw::c_uchar,
        _random_data_len: usize,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is an IDE stub")
    }

    pub unsafe fn bitcoin_pqc_keypair_free(_keypair: *mut bitcoin_pqc_keypair_t) {}

    #[allow(clippy::too_many_arguments)]
    pub unsafe fn bitcoin_pqc_sign(
        _algorithm: bitcoin_pqc_algorithm_t,
        _secret_key: *const ::std::os::raw::c_uchar,
        _secret_key_len: usize,
        _message: *const ::std::os::raw::c_uchar,
        _message_len: usize,
        _signature: *mut bitcoin_pqc_signature_t,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is an IDE stub")
    }

    pub unsafe fn bitcoin_pqc_verify(
        _algorithm: bitcoin_pqc_algorithm_t,
        _public_key: *const ::std::os::raw::c_uchar,
        _public_key_len: usize,
        _message: *const ::std::os::raw::c_uchar,
        _message_len: usize,
        _signature: *const ::std::os::raw::c_uchar,
        _signature_len: usize,
    ) -> bitcoin_pqc_error_t {
        unimplemented!("This is an IDE stub")
    }

    pub unsafe fn bitcoin_pqc_signature_free(_signature: *mut bitcoin_pqc_signature_t) {}

    pub unsafe fn bitcoin_pqc_public_key_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }

    pub unsafe fn bitcoin_pqc_secret_key_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }

    pub unsafe fn bitcoin_pqc_signature_size(_algorithm: bitcoin_pqc_algorithm_t) -> usize {
        0
    }
}

// Re-export the right set of bindings based on configuration
#[cfg(doc)]
pub use doc_bindings::*;

#[cfg(feature = "ide")]
pub use ide_bindings::*;