rind 0.1.11

Pure-Rust cryptography for MoQ, forked from graviola
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
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324

// Written for Graviola by Joe Birr-Pixton, 2024.
// SPDX-License-Identifier: Apache-2.0 OR ISC OR MIT-0

#[cfg(not(target_arch = "arm"))]
#[macro_use]
mod macros;

pub(crate) mod ct;

#[cfg(doc)]
pub mod inline_assembly_safety;

mod generic {
    // armv7's RSA arithmetic, also built in tests elsewhere to check it
    // against s2n-bignum.
    #[cfg(any(target_arch = "arm", test))]
    pub(crate) mod bignum;
    pub(super) mod blockwise;
    // Where no one-pass routine runs, and in aarch64 tests to check it
    // against.
    #[cfg(any(target_arch = "arm", target_arch = "x86_64", test))]
    pub(crate) mod chacha20poly1305;
    #[cfg(not(target_arch = "arm"))]
    pub(super) mod ct_copy;
    pub(super) mod ct_equal;
    pub(super) mod ctr;
    #[cfg(all(test, not(target_arch = "arm")))]
    pub(crate) mod ghash;
    #[cfg(any(target_arch = "aarch64", target_arch = "x86_64"))]
    pub(crate) mod mlkem;
    #[cfg(target_arch = "aarch64")]
    pub(crate) mod mlkem768;
    // x86_64's ML-KEM arithmetic for CPUs without AVX2.
    #[cfg(target_arch = "x86_64")]
    pub(crate) mod mlkem_poly;
    // armv7's group orders, picked from by modulus.
    #[cfg(target_arch = "arm")]
    pub(crate) mod order;
    // armv7's P-256, P-384, and P-521, also built in tests elsewhere to
    // check them against s2n-bignum.
    #[cfg(any(target_arch = "arm", test))]
    pub(crate) mod p256;
    #[cfg(any(target_arch = "arm", test))]
    pub(crate) mod p384;
    #[cfg(any(target_arch = "arm", test))]
    pub(crate) mod p521;
    // aarch64 runs Poly1305 only in aws-lc's one-pass ChaCha20-Poly1305,
    // whose tests check it against this.
    #[cfg(any(target_arch = "x86_64", all(target_arch = "aarch64", test)))]
    pub(crate) mod poly1305;
    // armv7's SHA1 and SHA256, also built in x86_64 tests to check the vector
    // paths against.
    #[cfg(any(target_arch = "arm", all(test, target_arch = "x86_64")))]
    pub(super) mod sha1;
    #[cfg(any(target_arch = "arm", all(test, target_arch = "x86_64")))]
    pub(super) mod sha256;
    pub(super) mod zeroise;
}

pub(crate) mod cpu;
mod entry;
mod posint;

pub(crate) use entry::Entry;
pub(crate) use generic::blockwise::{Blockwise, pad_message};
#[cfg(not(target_arch = "arm"))]
pub(crate) use generic::ct_copy::{ct_copy, ct_select_i16};
pub(crate) use generic::ct_equal::ct_equal;
#[cfg(any(target_arch = "x86_64", all(target_arch = "aarch64", test)))]
pub(crate) use generic::poly1305;
pub(crate) use generic::zeroise::{Zeroable, zeroise, zeroise_value};
pub(crate) use posint::{ModExp, PosInt, SecretPosInt};

#[cfg(all(test, not(target_arch = "arm")))]
#[cfg_attr(coverage_nightly, coverage(off))]
mod tests;

cfg_if::cfg_if! {
    if #[cfg(target_arch = "x86_64")] {
        mod x86_64;

        pub(in crate::low) use x86_64::cpu::{enter_cpu_state, zero_bytes, ct_compare_bytes, leave_cpu_state, missing_cpu_feature};
        pub(crate) use x86_64::chacha20;
        pub(crate) use x86_64::chacha20poly1305;
        pub(crate) use x86_64::aes::AesKey;
        pub(crate) use x86_64::aes_ctr;
        pub(crate) use x86_64::aes_gcm;
        pub(crate) use x86_64::bignum_add::bignum_add;
        pub(crate) use x86_64::bignum_add_p256::bignum_add_p256;
        pub(crate) use x86_64::bignum_add_p384::bignum_add_p384;
        pub(crate) use x86_64::bignum_add_p521::bignum_add_p521;
        pub(crate) use x86_64::bignum_bitsize::bignum_bitsize;
        pub(crate) use x86_64::bignum_cmp_lt::bignum_cmp_lt;
        pub(crate) use x86_64::bignum_coprime::bignum_coprime;
        #[cfg(test)]
        pub(crate) use x86_64::bignum_copy_row_from_table::bignum_copy_row_from_table;
        pub(crate) use x86_64::bignum_ctz::bignum_ctz;
        pub(crate) use x86_64::bignum_demont::bignum_demont;
        pub(crate) use x86_64::bignum_point_select::{bignum_aff_point_select_p384, bignum_aff_point_select_p521};
        pub(crate) use x86_64::adx_mux::bignum_demont_p256;
        pub(crate) use x86_64::adx_mux::bignum_demont_p384;
        pub(crate) use x86_64::bignum_digitsize::bignum_digitsize;
        pub(crate) use x86_64::bignum_eq::bignum_eq;
        pub(crate) use x86_64::bignum_inv_p256::bignum_inv_p256;
        pub(crate) use x86_64::bignum_inv_p384::bignum_inv_p384;
        pub(crate) use x86_64::bignum_inv_p521::bignum_inv_p521;
        pub(crate) use x86_64::adx_mux::bignum_madd_n25519;
        pub(crate) use x86_64::bignum_mod_n25519::bignum_mod_n25519;
        pub(crate) use x86_64::bignum_mod_n256::bignum_mod_n256;
        pub(crate) use x86_64::bignum_mod_n384::bignum_mod_n384;
        pub(crate) use x86_64::adx_mux::bignum_mod_n521;
        pub(crate) use x86_64::bignum_modadd::bignum_modadd;
        pub(crate) use x86_64::bignum_modinv::bignum_modinv;
        pub(crate) use x86_64::bignum_modsub::bignum_modsub;
        pub(crate) use x86_64::bignum_montifier::bignum_montifier;
        pub(crate) use x86_64::bignum_montmul::bignum_montmul;
        pub(crate) use x86_64::adx_mux::bignum_montmul_p256;
        pub(crate) use x86_64::adx_mux::bignum_montmul_p384;
        pub(crate) use x86_64::bignum_montredc::bignum_montredc;
        pub(crate) use x86_64::adx_mux::bignum_montsqr_p256;
        pub(crate) use x86_64::adx_mux::bignum_montsqr_p384;
        pub(crate) use x86_64::bignum_mul::bignum_mul;
        pub(crate) use x86_64::adx_mux::bignum_mul_p521;
        pub(crate) use x86_64::bignum_mux::bignum_mux;
        pub(crate) use x86_64::bignum_neg_p25519::bignum_neg_p25519;
        pub(crate) use x86_64::bignum_neg_p256::bignum_neg_p256;
        pub(crate) use x86_64::bignum_neg_p384::bignum_neg_p384;
        pub(crate) use x86_64::bignum_neg_p521::bignum_neg_p521;
        pub(crate) use x86_64::bignum_negmodinv::bignum_negmodinv;
        pub(crate) use x86_64::bignum_optsub::bignum_optsub;
        pub(crate) use x86_64::adx_mux::bignum_sqr_p521;
        pub(crate) use x86_64::adx_mux::bignum_tomont_p256;
        pub(crate) use x86_64::adx_mux::bignum_tomont_p384;
        pub(crate) use x86_64::adx_mux::curve25519_x25519;
        pub(crate) use x86_64::adx_mux::curve25519_x25519base;
        pub(crate) use x86_64::adx_mux::edwards25519_decode;
        pub(crate) use x86_64::adx_mux::edwards25519_scalarmulbase;
        pub(crate) use x86_64::adx_mux::edwards25519_scalarmuldouble;
        pub(crate) use x86_64::ghash;
        pub(crate) use x86_64::mlkem::{
            mlkem_ntt,
            mlkem_intt,
            mlkem_mulcache_compute,
            mlkem_rej_uniform_vartime,
            mlkem_basemul_k3,
            mlkem_reduce,
            mlkem_compress_d4,
            mlkem_compress_d10,
            mlkem_frombytes,
            mlkem_tobytes,
            mlkem_tomont,
            mlkem_unpack,
        };
        pub(crate) use x86_64::mont::{mont_mul, mont_sqr};
        pub(crate) use x86_64::mont_exp::mont_exp;
        pub(crate) use x86_64::rsaz::Rsaz;
        pub(crate) use x86_64::rsaz_avx512::{Operands, RsazAvx512};
        pub(crate) use x86_64::mlkem768_sample_poly_ntt_8x::mlkem768_sample_poly_ntt_8x;

        pub(crate) use x86_64::adx_mux::p256_montjadd;
        pub(crate) use x86_64::adx_mux::p256_montjdouble;
        pub(crate) use x86_64::adx_mux::p256_montjmixadd;
        pub(crate) use x86_64::adx_mux::p256_montjscalarmul;
        pub(crate) use x86_64::ecp_nistz256::{P256GeneratorRow, p256_point_add_affine, p256_select_w7};
        pub(crate) use x86_64::adx_mux::p384_montjadd;
        pub(crate) use x86_64::adx_mux::p384_montjmixadd;
        pub(crate) use x86_64::adx_mux::p384_montjdouble;
        pub(crate) use x86_64::adx_mux::p384_montjscalarmul;
        pub(crate) use x86_64::adx_mux::p521_jadd;
        pub(crate) use x86_64::adx_mux::p521_jdouble;
        pub(crate) use x86_64::adx_mux::p521_jmixadd;
        pub(crate) use x86_64::adx_mux::p521_jscalarmul;
        pub(crate) use x86_64::sha1_mux::sha1_compress_blocks;
        pub(crate) use x86_64::sha256_mux::sha256_compress_blocks;
        pub(crate) use x86_64::sha512::sha512_compress_blocks;
        pub(crate) use x86_64::sha3_keccak_f1600::sha3_keccak_f1600;
        pub(crate) use x86_64::sha3_keccak4_f1600_shim::sha3_keccak4_f1600;
        pub(crate) use x86_64::sha3_keccak_nof4_f1600::sha3_keccak_nof4_f1600;

    } else if #[cfg(target_arch = "aarch64")] {
        mod aarch64;

        pub(in crate::low) use aarch64::cpu::{enter_cpu_state, zero_bytes, ct_compare_bytes, leave_cpu_state, missing_cpu_feature};
        pub(crate) use aarch64::aes::AesKey;
        pub(crate) use aarch64::aes_ctr;
        pub(crate) use aarch64::cpu::HaveCryptoExt;
        pub(crate) use aarch64::aes_gcm;
        pub(crate) use aarch64::bignum_add::bignum_add;
        pub(crate) use aarch64::bignum_add_p256::bignum_add_p256;
        pub(crate) use aarch64::bignum_add_p384::bignum_add_p384;
        pub(crate) use aarch64::bignum_add_p521::bignum_add_p521;
        pub(crate) use aarch64::bignum_bitsize::bignum_bitsize;
        pub(crate) use aarch64::bignum_cmp_lt::bignum_cmp_lt;
        pub(crate) use aarch64::bignum_coprime::bignum_coprime;
        pub(crate) use aarch64::bignum_copy_row_from_table_mux::bignum_copy_row_from_table;
        pub(crate) use aarch64::bignum_ctz::bignum_ctz;
        pub(crate) use aarch64::bignum_point_select::{bignum_aff_point_select_p384, bignum_aff_point_select_p521};
        pub(crate) use aarch64::bignum_demont::bignum_demont;
        pub(crate) use aarch64::bignum_demont_p256::bignum_demont_p256;
        pub(crate) use aarch64::bignum_demont_p384::bignum_demont_p384;
        pub(crate) use aarch64::bignum_digitsize::bignum_digitsize;
        pub(crate) use aarch64::bignum_eq::bignum_eq;
        pub(crate) use aarch64::bignum_inv_p256::bignum_inv_p256;
        pub(crate) use aarch64::bignum_inv_p384::bignum_inv_p384;
        pub(crate) use aarch64::bignum_inv_p521::bignum_inv_p521;
        pub(crate) use aarch64::bignum_madd_n25519::bignum_madd_n25519;
        pub(crate) use aarch64::bignum_mod_n25519::bignum_mod_n25519;
        pub(crate) use aarch64::bignum_mod_n256::bignum_mod_n256;
        pub(crate) use aarch64::bignum_mod_n384::bignum_mod_n384;
        pub(crate) use aarch64::bignum_mod_n521::bignum_mod_n521;
        pub(crate) use aarch64::bignum_modadd::bignum_modadd;
        pub(crate) use aarch64::bignum_modinv::bignum_modinv;
        pub(crate) use aarch64::bignum_modsub::bignum_modsub;
        pub(crate) use aarch64::bignum_montifier::bignum_montifier;
        pub(crate) use aarch64::bignum_montmul::bignum_montmul;
        pub(crate) use aarch64::bignum_montmul_p256::bignum_montmul_p256;
        pub(crate) use aarch64::bignum_montmul_p384::bignum_montmul_p384;
        pub(crate) use aarch64::bignum_montredc::bignum_montredc;
        pub(crate) use aarch64::bignum_montsqr_p256::bignum_montsqr_p256;
        pub(crate) use aarch64::bignum_montsqr_p384::bignum_montsqr_p384;
        pub(crate) use aarch64::bignum_mul::bignum_mul;
        pub(crate) use aarch64::bignum_mul_p521::bignum_mul_p521;
        pub(crate) use aarch64::bignum_mux::bignum_mux;
        pub(crate) use aarch64::bignum_neg_p25519::bignum_neg_p25519;
        pub(crate) use aarch64::bignum_neg_p256::bignum_neg_p256;
        pub(crate) use aarch64::bignum_neg_p384::bignum_neg_p384;
        pub(crate) use aarch64::bignum_neg_p521::bignum_neg_p521;
        pub(crate) use aarch64::bignum_negmodinv::bignum_negmodinv;
        pub(crate) use aarch64::bignum_optsub::bignum_optsub;
        pub(crate) use aarch64::bignum_sqr_p521::bignum_sqr_p521;
        pub(crate) use aarch64::bignum_tomont_p256::bignum_tomont_p256;
        pub(crate) use aarch64::bignum_tomont_p384::bignum_tomont_p384;
        pub(crate) use aarch64::curve25519_x25519::curve25519_x25519;
        pub(crate) use aarch64::curve25519_x25519base::curve25519_x25519base;
        pub(crate) use aarch64::edwards25519_decode::edwards25519_decode;
        pub(crate) use aarch64::edwards25519_scalarmulbase::edwards25519_scalarmulbase;
        pub(crate) use aarch64::edwards25519_scalarmuldouble::edwards25519_scalarmuldouble;
        pub(crate) use aarch64::mlkem::{
            mlkem_ntt,
            mlkem_intt,
            mlkem_mulcache_compute,
            mlkem_rej_uniform_vartime,
        };
        pub(crate) use aarch64::mlkem_basemul_k3::mlkem_basemul_k3;
        pub(crate) use aarch64::mlkem_reduce::mlkem_reduce;
        pub(crate) use aarch64::mlkem_tobytes::mlkem_tobytes;
        pub(crate) use aarch64::mlkem_tomont::mlkem_tomont;
        pub(crate) use aarch64::mont::{mont_mul, mont_sqr};
        pub(crate) use aarch64::ghash;
        pub(crate) use aarch64::p256_montjadd::p256_montjadd;
        pub(crate) use aarch64::p256_montjdouble::p256_montjdouble;
        pub(crate) use aarch64::p256_montjmixadd::p256_montjmixadd;
        pub(crate) use aarch64::p256_montjscalarmul::p256_montjscalarmul;
        pub(crate) use aarch64::p256_scalarmulbase::p256_scalarmulbase;
        pub(crate) use aarch64::p384_montjadd::p384_montjadd;
        pub(crate) use aarch64::p384_montjmixadd::p384_montjmixadd;
        pub(crate) use aarch64::p384_montjdouble::p384_montjdouble;
        pub(crate) use aarch64::p384_montjscalarmul::p384_montjscalarmul;
        pub(crate) use aarch64::p521_jadd::p521_jadd;
        pub(crate) use aarch64::p521_jdouble::p521_jdouble;
        pub(crate) use aarch64::p521_jmixadd::p521_jmixadd;
        pub(crate) use aarch64::p521_jscalarmul::p521_jscalarmul;
        pub(crate) use aarch64::sha1::sha1_compress_blocks;
        pub(crate) use aarch64::sha256::sha256_compress_blocks;
        pub(crate) use aarch64::sha3_keccak_f1600_mux::sha3_keccak_f1600;
        pub(crate) use aarch64::sha3_keccak4_f1600_mux::sha3_keccak4_f1600;
        pub(crate) use aarch64::sha3_keccak_nof4_f1600::sha3_keccak_nof4_f1600;
        pub(crate) use aarch64::sha512::sha512_compress_blocks;

        pub(crate) use aarch64::chacha20;
        pub(crate) use aarch64::chacha20poly1305;
        pub(crate) use generic::mlkem::{mlkem_compress_d4, mlkem_compress_d10, mlkem_frombytes, mlkem_unpack};
        pub(crate) use generic::mlkem768::mlkem768_sample_poly_ntt_8x;
    } else if #[cfg(target_arch = "arm")] {
        mod arm;

        pub(in crate::low) use arm::cpu::{enter_cpu_state, zero_bytes, ct_compare_bytes, leave_cpu_state, missing_cpu_feature};
        pub(crate) use arm::aes::AesKey;
        pub(crate) use arm::aes_ctr;
        pub(crate) use arm::aesv8_armx::AesHwKey;
        pub(crate) use arm::cpu::HaveCryptoExt;
        pub(crate) use arm::ghashv8_armx::GhashTable;
        pub(crate) use arm::chacha20;
        pub(crate) use generic::chacha20poly1305;
        pub(crate) use arm::poly1305;
        pub(crate) use arm::bignum_eq::bignum_eq;
        pub(crate) use arm::curve25519::{curve25519_x25519, curve25519_x25519base};
        pub(crate) use arm::mont::{mont_mul, mont_sqr};
        pub(crate) use generic::bignum::{
            bignum_add, bignum_bitsize, bignum_cmp_lt, bignum_coprime, bignum_copy_row_from_table,
            bignum_ctz, bignum_digitsize, bignum_modsub, bignum_montifier, bignum_montredc,
            bignum_mul, bignum_negmodinv, bignum_optsub,
        };
        // libcrux's P-256 runs 64-bit limbs and recomputes the nonce's point
        // to sign, it exports P-384 only as ECDH, and it has no P-521, so
        // rind composes their arithmetic itself.
        pub(crate) use generic::order::{bignum_demont, bignum_modadd, bignum_modinv, bignum_montmul};
        pub(crate) use generic::p256::{
            bignum_add_p256, bignum_demont_p256, bignum_inv_p256, bignum_mod_n256,
            bignum_montmul_p256, bignum_montsqr_p256, bignum_neg_p256, bignum_tomont_p256,
            p256_montjadd, p256_montjdouble, p256_montjmixadd, p256_montjscalarmul,
            p256_scalarmulbase,
        };
        pub(crate) use generic::p384::{
            bignum_add_p384, bignum_aff_point_select_p384, bignum_demont_p384,
            bignum_inv_p384, bignum_jac_point_select_p384, bignum_mod_n384, bignum_montmul_p384,
            bignum_montsqr_p384, bignum_mux, bignum_neg_p384, bignum_tomont_p384, p384_montjadd,
            p384_montjdouble, p384_montjmixadd,
        };
        pub(crate) use generic::p521::{
            bignum_add_p521, bignum_aff_point_select_p521, bignum_inv_p521, bignum_mod_n521,
            bignum_mul_p521, bignum_neg_p521, bignum_sqr_p521, p521_jadd, p521_jdouble,
            p521_jmixadd, p521_jscalarmul,
        };
        // SHA-1 and SHA-256 use the crypto extension where present, else rind's
        // portable SHA, since libcrux has no SHA-1 and rind's SHA-256 is faster
        // than libcrux's. SHA-512 is aws-lc's, NEON or scalar.
        pub(crate) use arm::sha_armv4::{
            sha1_compress_blocks, sha256_compress_blocks, sha512_compress_blocks,
        };
    } else {
        compile_error!("This crate only supports x86_64, aarch64, or arm");
    }
}