ed25519-simd 0.1.0

Verification-only, AVX-512 IFMA batch Ed25519 signature verification, acceptance-compatible with solana-ed25519
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
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
use super::decode::decompress_points_wide;
use super::field::{WideFe, loadu, storeu};
use super::multiscalar::mul_s_base_minus_k_public;
use super::point::WidePoint;
use super::*;
use crate::edwards::{
    AffineCachedPoint, BASEPOINT_COMPRESSED, BasepointTable, CachedPoint, POINT_ENCODING_LEN,
    select_signed_affine_cached_ref,
};
use crate::field::LIMB_COUNT;
use crate::wide::PreparedChunk;
use serde_json::Value;

const VECTOR_JSON: &str = include_str!("../../../tests/vectors/avx512ifma.json");

fn vectors() -> Value {
    serde_json::from_str(VECTOR_JSON).expect("valid AVX-512 IFMA vectors")
}

fn vector_cases<'a>(vectors: &'a Value, name: &str) -> &'a [Value] {
    vectors[name]
        .as_array()
        .unwrap_or_else(|| panic!("{name} must be an array"))
}

fn hex_32(value: &Value) -> [u8; POINT_ENCODING_LEN] {
    let mut out = [0u8; POINT_ENCODING_LEN];
    hex::decode_to_slice(
        value.as_str().expect("hex vector must be a string"),
        &mut out,
    )
    .expect("valid 32-byte vector");
    out
}

fn limbs(value: &Value) -> [u64; LIMB_COUNT] {
    let values = value.as_array().expect("limbs must be an array");
    assert_eq!(values.len(), LIMB_COUNT);
    core::array::from_fn(|i| values[i].as_u64().expect("limb must be a u64"))
}

fn wide_from_rows(rows: [[u64; LANES]; LIMB_COUNT]) -> WideFe {
    WideFe {
        limbs: core::array::from_fn(|i| loadu(rows[i])),
    }
}

fn wide_rows(value: WideFe) -> [[u64; LANES]; LIMB_COUNT] {
    let mut rows = [[0u64; LANES]; LIMB_COUNT];
    for (limb, row) in rows.iter_mut().enumerate() {
        storeu(value.limbs[limb], row);
    }
    rows
}

fn wide_from_case_inputs(cases: &[Value], name: &str, offset: usize) -> WideFe {
    assert_eq!(cases.len(), LANES);
    let by_lane: [[u64; LIMB_COUNT]; LANES] =
        core::array::from_fn(|lane| limbs(&cases[(lane + offset) % LANES][name]));
    wide_from_rows(core::array::from_fn(|limb| {
        core::array::from_fn(|lane| by_lane[lane][limb])
    }))
}

fn assert_wide_bytes(actual: WideFe, cases: &[Value], expected_name: &str, offset: usize) {
    let actual = actual.to_bytes_lanes();
    for lane in 0..LANES {
        assert_eq!(
            actual[lane],
            hex_32(&cases[(lane + offset) % LANES][expected_name]),
            "{expected_name} lane {lane}"
        );
    }
}

fn cached_encoding(point: &CachedPoint) -> [u8; POINT_ENCODING_LEN] {
    let (y_plus_x, y_minus_x, z2, _) = point.coords();
    let y_plus_x = WideFe::from_field_refs(&[y_plus_x; LANES]);
    let y_minus_x = WideFe::from_field_refs(&[y_minus_x; LANES]);
    let point = WidePoint {
        x: y_plus_x.subtract(&y_minus_x),
        y: y_plus_x.add_loose(&y_minus_x),
        z: WideFe::from_field_refs(&[z2; LANES]),
        t: WideFe::zero(),
    };
    point.compress()[0]
}

fn affine_cached_encoding(point: &AffineCachedPoint) -> [u8; POINT_ENCODING_LEN] {
    let (y_plus_x, y_minus_x, _) = point.coords();
    let y_plus_x = WideFe::from_field_refs(&[y_plus_x; LANES]);
    let y_minus_x = WideFe::from_field_refs(&[y_minus_x; LANES]);
    let point = WidePoint {
        x: y_plus_x.subtract(&y_minus_x),
        y: y_plus_x.add_loose(&y_minus_x),
        z: WideFe::one().double(),
        t: WideFe::zero(),
    };
    point.compress()[0]
}

fn strict_square_n(x: &WideFe, n: usize) -> WideFe {
    let mut out = *x;
    for _ in 0..n {
        out = out.square();
    }
    out
}

#[test]
fn canonical_matches_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "canonical");
    assert_eq!(cases.len(), LANES);

    let by_lane: [[u64; LIMB_COUNT]; LANES] =
        core::array::from_fn(|lane| limbs(&cases[lane]["input_limbs"]));
    let wide = wide_from_rows(core::array::from_fn(|limb| {
        core::array::from_fn(|lane| by_lane[lane][limb])
    }));
    let actual = wide_rows(wide.canonical());
    let is_zero = wide.is_zero_lanes();
    let is_odd = wide.is_odd_lanes();

    for lane in 0..LANES {
        let expected = limbs(&cases[lane]["expected_limbs"]);
        let actual_lane = core::array::from_fn(|limb| actual[limb][lane]);
        assert_eq!(actual_lane, expected, "canonical lane {lane}");
        assert_eq!(
            is_zero[lane],
            expected == [0; LIMB_COUNT],
            "zero lane {lane}"
        );
        assert_eq!(is_odd[lane], expected[0] & 1 != 0, "odd lane {lane}");
    }
}

#[test]
fn wide_field_operations_match_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "field");
    let a = wide_from_case_inputs(cases, "a_limbs", 0);
    let b = wide_from_case_inputs(cases, "b_limbs", 0);
    let c = wide_from_case_inputs(cases, "c_limbs", 0);

    assert_wide_bytes(a.add(&b), cases, "add", 0);
    assert_wide_bytes(a.add_loose(&b), cases, "add", 0);
    assert_wide_bytes(a.subtract(&b), cases, "subtract", 0);
    assert_wide_bytes(a.multiply(&b), cases, "multiply", 0);
    assert_wide_bytes(a.multiply_loose(&b), cases, "multiply", 0);
    assert_wide_bytes(a.square(), cases, "square", 0);
    assert_wide_bytes(a.square_loose(), cases, "square", 0);

    let ab = a.multiply_loose(&b);
    let bc = b.multiply_loose(&c);
    let cc = c.square_loose();
    assert_wide_bytes(ab.subtract_loose(&bc), cases, "subtract_loose", 0);
    assert_wide_bytes(ab.subtract_loose_sum(&bc, &cc), cases, "subtract_sum", 0);
    assert_wide_bytes(
        ab.subtract_loose_sum_with_doubled_rhs(&bc, &cc),
        cases,
        "subtract_sum_doubled",
        0,
    );
    assert_wide_bytes(WideFe::negate_loose_sum(&bc, &cc), cases, "negate_sum", 0);
}

#[test]
fn loose_limb0_bound_matches_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "loose_bound");
    let wide = wide_from_case_inputs(cases, "input_limbs", 0);

    assert_wide_bytes(wide.subtract_loose(&wide), cases, "zero", 0);
    assert_wide_bytes(wide.subtract_loose_sum(&wide, &wide), cases, "negate", 0);
    assert_wide_bytes(
        wide.subtract_loose_sum_with_doubled_rhs(&wide, &wide),
        cases,
        "double_negate",
        0,
    );
    assert_wide_bytes(
        WideFe::negate_loose_sum(&wide, &wide),
        cases,
        "double_negate",
        0,
    );
    assert_wide_bytes(wide.square(), cases, "square", 0);
    assert_wide_bytes(wide.square_loose(), cases, "square", 0);
}

#[test]
fn square_repeat_variants_match_strict_simd_result() {
    let a = WideFe::constant(crate::field::D_LIMBS);
    let b = WideFe::constant(crate::field::SQRT_M1_LIMBS);
    macro_rules! check {
        ($n:literal) => {
            assert!(
                WideFe::square_repeat::<$n>(&a)
                    .equals_lanes(&strict_square_n(&a, $n))
                    .iter()
                    .all(|&v| v),
                "square_repeat::<{}> diverged for a",
                $n
            );
            assert!(
                WideFe::square_repeat::<$n>(&b)
                    .equals_lanes(&strict_square_n(&b, $n))
                    .iter()
                    .all(|&v| v),
                "square_repeat::<{}> diverged for b",
                $n
            );
            let (xa, xb) = WideFe::square_repeat_x2::<$n>(&a, &b);
            assert!(
                xa.equals_lanes(&strict_square_n(&a, $n)).iter().all(|&v| v),
                "square_repeat_x2::<{}> diverged for a",
                $n
            );
            assert!(
                xb.equals_lanes(&strict_square_n(&b, $n)).iter().all(|&v| v),
                "square_repeat_x2::<{}> diverged for b",
                $n
            );
        };
    }
    check!(0);
    check!(1);
    check!(2);
    check!(5);
    check!(10);
    check!(20);
    check!(50);
    check!(100);
}

#[test]
fn pow_variants_match_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "field");
    let a = wide_from_case_inputs(cases, "a_limbs", 0);
    let b = wide_from_case_inputs(cases, "a_limbs", 3);

    assert_wide_bytes(a.pow_p_minus_5_over_8(), cases, "pow_a", 0);
    assert_wide_bytes(b.pow_p_minus_5_over_8(), cases, "pow_a", 3);

    let (paired_a, paired_b) = WideFe::pow_p_minus_5_over_8_x2(&a, &b);
    assert_wide_bytes(paired_a, cases, "pow_a", 0);
    assert_wide_bytes(paired_b, cases, "pow_a", 3);
}

#[test]
fn wide_decompression_matches_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "decompression");

    for chunk in cases.chunks(LANES) {
        let encodings =
            core::array::from_fn(|lane| hex_32(&chunk.get(lane).unwrap_or(&chunk[0])["encoding"]));
        let (point, mask) = decompress_points_wide(&encodings);
        let normalized = point.compress();

        for lane in 0..chunk.len() {
            let expected_valid = chunk[lane]["valid"].as_bool().expect("valid is a bool");
            assert_eq!(
                mask & (1 << lane) != 0,
                expected_valid,
                "{} validity",
                chunk[lane]["name"].as_str().unwrap()
            );
            if expected_valid {
                assert_eq!(
                    normalized[lane],
                    hex_32(&chunk[lane]["normalized"]),
                    "{} normalization",
                    chunk[lane]["name"].as_str().unwrap()
                );
            }
        }
    }
}

#[test]
fn batched_compression_matches_independent_inversions() {
    let vectors = vectors();
    let cases: Vec<&Value> = vector_cases(&vectors, "decompression")
        .iter()
        .filter(|case| case["valid"].as_bool() == Some(true))
        .take(LANES)
        .collect();
    assert_eq!(
        cases.len(),
        LANES,
        "vectors include one valid point per lane"
    );
    let encodings = core::array::from_fn(|lane| hex_32(&cases[lane]["encoding"]));
    let (point, mask) = decompress_points_wide(&encodings);
    assert_eq!(mask, u8::MAX);

    // Repeated doubling moves every candidate off affine `Z = 1` and to
    // a distinct `Z`, so the shared inversion has to be undone
    // differently for each one.
    let mut candidates = Vec::new();
    let mut current = point;
    for _ in 0..DALEK_BATCH {
        current = current.double();
        candidates.push(DalekCandidate(current));
    }

    for depth in 1..=DALEK_BATCH {
        let expected: Vec<_> = candidates[..depth]
            .iter()
            .map(|candidate| candidate.0.compress())
            .collect();
        let expected_small_order: Vec<_> = candidates[..depth]
            .iter()
            .map(|candidate| candidate.0.is_small_order_lanes())
            .collect();
        let mut actual = vec![[[0u8; POINT_ENCODING_LEN]; LANES]; depth];
        let mut small_order = vec![[false; LANES]; depth];
        compress_dalek_candidates(&candidates[..depth], &mut actual, &mut small_order);
        assert_eq!(actual, expected, "batch of {depth} diverged");
        assert_eq!(small_order, expected_small_order);
    }
}

#[test]
fn cached_tables_match_basepoint_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "basepoint_multiples");
    let public_table = decode_public_key_table(&BASEPOINT_COMPRESSED).expect("basepoint decodes");
    let base_table = BasepointTable::new();

    for case in cases {
        let scalar = case["scalar"].as_i64().expect("scalar is an integer") as i16;
        let expected = hex_32(&case["encoding"]);
        assert_eq!(
            affine_cached_encoding(select_signed_affine_cached_ref(
                base_table.entries(),
                scalar,
            )),
            expected,
            "fixed-base table digit {scalar}"
        );
        if (-8..=8).contains(&scalar) {
            assert_eq!(
                cached_encoding(public_table.select_signed_cached_ref(scalar as i8)),
                expected,
                "public-key table digit {scalar}"
            );
        }
    }
}

#[test]
fn wide_torsion_operations_match_vectors() {
    let vectors = vectors();
    let cases = vector_cases(&vectors, "torsion_multiples");
    let encoding = |multiple: u64| {
        hex_32(
            &cases
                .iter()
                .find(|case| case["multiple"].as_u64() == Some(multiple))
                .expect("torsion multiple is present")["encoding"],
        )
    };

    let (point, mask) = decompress_points_wide(&[encoding(1); LANES]);
    assert_eq!(mask, u8::MAX);
    assert_eq!(point.compress()[0], encoding(1));

    let doubled = point.double();
    assert_eq!(doubled.compress()[0], encoding(2));
    let quadrupled = doubled.double();
    assert_eq!(quadrupled.compress()[0], encoding(4));
    let multiplied_by_eight = quadrupled.double();
    assert_eq!(multiplied_by_eight.compress()[0], encoding(8));

    let (identity, identity_mask) = decompress_points_wide(&[encoding(8); LANES]);
    assert_eq!(identity_mask, u8::MAX);
    let subtract_chain = identity.subtract(&point).double().double().double();
    assert_eq!(subtract_chain.compress()[0], encoding(8));
}

#[test]
fn wide_multiscalar_matches_nontrivial_basepoint_relation() {
    let table = decode_public_key_table(&BASEPOINT_COMPRESSED).expect("basepoint decodes");
    let base_table = BasepointTable::new();
    let mut two_bytes = [0u8; 32];
    two_bytes[0] = 2;
    let two = crate::scalar::CanonicalScalar::from_canonical_bytes(two_bytes);
    let s_digits = [two.to_radix16(); LANES];
    let mut one_bytes = [0u8; 32];
    one_bytes[0] = 1;
    let one = crate::scalar::CanonicalScalar::from_canonical_bytes(one_bytes);
    let k_digits = [one.to_radix16(); LANES];
    let prepared = PreparedChunk {
        public_key_tables: [&table; LANES],
        s_digits: &s_digits,
        k_digits: &k_digits,
    };
    let combined = mul_s_base_minus_k_public::<true>(base_table.entries(), &prepared);
    // 2B - 1B = B exercises both signed-digit inputs and both tables.
    assert_eq!(combined.compress(), [BASEPOINT_COMPRESSED; LANES]);
}