kyber-rs 0.1.0-alpha.9

A toolbox of advanced cryptographic primitives for Rust
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

use criterion::{measurement::Measurement, BatchSize, BenchmarkGroup};

use crate::{
    encoding::{BinaryMarshaler, BinaryUnmarshaler},
    util::random::RandStream,
    Group, Point, Scalar,
};

/// [`GroupBench`] is a generic benchmark suite for [`groups`](Group).
pub struct GroupBench<GROUP: Group> {
    _g: GROUP,

    // Random secrets and points for testing
    x: <GROUP::POINT as Point>::SCALAR,
    y: <GROUP::POINT as Point>::SCALAR,
    x_p: GROUP::POINT,
    y_p: GROUP::POINT,
    /// encoded [`Scalar`]
    xe: Vec<u8>,
    /// encoded [`Point`]    
    xe_p: Vec<u8>,
}

/// [`new_group_bench`] returns a new [`GroupBench`].
pub fn new_group_bench<GROUP: Group>(g: GROUP) -> GroupBench<GROUP> {
    let rng = &mut RandStream::default();
    let x = g.scalar().pick(rng);
    let y = g.scalar().pick(rng);
    let xe = x.marshal_binary().unwrap();
    let x_p = g.point().pick(rng);
    let y_p = g.point().pick(rng);
    let xe_p = x_p.marshal_binary().unwrap();
    GroupBench {
        _g: g,
        x,
        y,
        x_p,
        y_p,
        xe,
        xe_p,
    }
}

impl<GROUP: Group> GroupBench<GROUP> {
    /// [`scalar_add()`] benchmarks the `addition` operation for [`scalars`](Scalar)
    pub fn scalar_add<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_add", |b| {
            b.iter_batched(
                || (self.x.clone(), self.y.clone()),
                |s| s.0 + s.1,
                BatchSize::SmallInput,
            )
        });
    }

    /// [`scalar_sub()`] benchmarks the `substraction` operation for [`scalars`](Scalar)
    pub fn scalar_sub<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_sub", |b| {
            b.iter_batched(
                || self.x.clone(),
                |s| s.sub(&self.x, &self.y),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`scalar_neg()`] benchmarks the `negation` operation for [`scalars`](Scalar)
    pub fn scalar_neg<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_neg", |b| {
            b.iter_batched(|| self.x.clone(), |s| s.neg(&self.x), BatchSize::SmallInput)
        });
    }

    /// [`scalar_mul()`] benchmarks the `multiplication` operation for [`scalars`](Scalar)
    pub fn scalar_mul<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_mul", |b| {
            b.iter_batched(
                || (self.x.clone(), self.y.clone()),
                |s| s.0 * s.1,
                BatchSize::SmallInput,
            )
        });
    }

    /// [`scalar_div()`] benchmarks the `division` operation for [`scalars`](Scalar)
    pub fn scalar_div<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_div", |b| {
            b.iter_batched(
                || self.x.clone(),
                |s| s.div(&self.x, &self.y),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`scalar_inv()`] benchmarks the `inverse` operation for [`scalars`](Scalar)
    pub fn scalar_inv<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_inv", |b| {
            b.iter_batched(|| self.x.clone(), |s| s.inv(&self.x), BatchSize::SmallInput)
        });
    }

    /// [`scalar_pick()`] benchmarks the `pick-ing` operation for [`scalars`](Scalar)
    pub fn scalar_pick<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        let rng = &mut RandStream::default();
        c.bench_function("scalar_pick", |b| {
            b.iter_batched(|| self.x.clone(), |s| s.pick(rng), BatchSize::SmallInput)
        });
    }

    /// [`scalar_encode()`] benchmarks the `marshalling` operation for [`scalars`](Scalar)
    pub fn scalar_encode<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_encode", |b| {
            b.iter(|| self.x.marshal_binary().unwrap())
        });
    }

    /// [`scalar_decode()`] benchmarks the `unmarshalling` operation for [`scalars`](Scalar)
    pub fn scalar_decode<M: Measurement>(&mut self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("scalar_decode", |b| {
            b.iter(|| self.x.unmarshal_binary(&self.xe).unwrap())
        });
    }

    /// [`point_add()`] benchmarks the `addition` operation for [`points`](Point)
    pub fn point_add<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_add", |b| {
            b.iter_batched(
                || self.x_p.clone(),
                |s| s.add(&self.x_p, &self.y_p),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`point_sub()`] benchmarks the `substraction` operation for [`points`](Point)
    pub fn point_sub<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_sub", |b| {
            b.iter_batched(
                || self.x_p.clone(),
                |s| s.sub(&self.x_p, &self.y_p),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`point_neg()`] benchmarks the `negation` operation for [`points`](Point)
    pub fn point_neg<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_neg", |b| {
            b.iter_batched(
                || self.x_p.clone(),
                |mut s| s.neg(&self.x_p),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`point_mul()`] benchmarks the `multiplication` operation for [`points`](Point)
    pub fn point_mul<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_mul", |b| {
            b.iter_batched(
                || self.x_p.clone(),
                |s| s.mul(&self.y, Some(&self.x_p)),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`point_base_mul()`] benchmarks the `base multiplication` operation for [`points`](Point)
    pub fn point_base_mul<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_base_mul", |b| {
            b.iter_batched(
                || self.x_p.clone(),
                |s| s.mul(&self.y, None),
                BatchSize::SmallInput,
            )
        });
    }

    /// [`point_pick()`` benchmarks the `pick-ing` operation for [`points()`](Point)
    pub fn point_pick<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        let rng = &mut RandStream::default();
        c.bench_function("point_pick", |b| {
            b.iter_batched(|| self.x_p.clone(), |s| s.pick(rng), BatchSize::SmallInput)
        });
    }

    /// [`point_encode()`] benchmarks the encoding operation for [`points`](Point)
    pub fn point_encode<M: Measurement>(&self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_encode", |b| {
            b.iter(|| self.x_p.marshal_binary().unwrap())
        });
    }

    /// [`point_decode()`] benchmarks the decoding operation for [`points`](Point)
    pub fn point_decode<M: Measurement>(&mut self, c: &mut BenchmarkGroup<M>) {
        c.bench_function("point_decode", |b| {
            b.iter(|| self.x_p.unmarshal_binary(&self.xe_p).unwrap())
        });
    }
}