orion 0.17.14

Usable, easy and safe pure-Rust crypto
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

// MIT License

// Copyright (c) 2019-2026 The orion Developers

// Permission is hereby granted, free of charge, to any person obtaining a copy
// of this software and associated documentation files (the "Software"), to deal
// in the Software without restriction, including without limitation the rights
// to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the Software is
// furnished to do so, subject to the following conditions:

// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.

// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
// IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
// OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
// SOFTWARE.

use crate::errors::UnknownCryptoError;
use core::marker::PhantomData;

/// Trait to define default streaming contexts that can be tested.
pub trait TestableStreamingContext<T: PartialEq> {
    /// Streaming context function to reset the internal state.
    fn reset(&mut self) -> Result<(), UnknownCryptoError>;

    /// Streaming context function to update the internal state.
    fn update(&mut self, input: &[u8]) -> Result<(), UnknownCryptoError>;

    /// Streaming context function to finalize the internal state.
    fn finalize(&mut self) -> Result<T, UnknownCryptoError>;

    /// Streaming context function to combine new(), update() and finalize() from the internal state.
    fn one_shot(input: &[u8]) -> Result<T, UnknownCryptoError>;

    /// Streaming context function to verify pre-computed results.
    fn verify_result(expected: &T, input: &[u8]) -> Result<(), UnknownCryptoError>;

    /// Testing utility-function that compares the internal state to another.
    fn compare_states(state_1: &Self, state_2: &Self);
}

#[allow(dead_code)] // Allow because blocksize field is only used with std.
/// A streaming context tester.
pub struct StreamingContextConsistencyTester<R, T> {
    _return_type: PhantomData<R>,
    // The initial context to base further calls upon.
    _initial_context: T,
    blocksize: usize,
}

impl<R, T> StreamingContextConsistencyTester<R, T>
where
    R: PartialEq + core::fmt::Debug,
    T: TestableStreamingContext<R> + Clone,
{
    /// The streaming interface tester is created utilizing an initialized
    /// streaming state.
    pub fn new(streaming_context: T, blocksize: usize) -> Self {
        Self {
            _return_type: PhantomData,
            _initial_context: streaming_context,
            blocksize,
        }
    }

    // Default input to process.
    // The number 37 has no particular meaning.
    const DEFAULT_INPUT: [u8; 37] = [255u8; 37];

    #[cfg(feature = "safe_api")]
    /// Run all consistency tests given some input data.
    /// Usually used with quickcheck.
    pub fn run_all_tests_property(&self, data: &[u8]) {
        self.consistency(data);
        self.consistency(&[0u8; 0]);
        self.produces_same_state(data);

        // Following test requires std.
        self.incremental_and_one_shot(data);

        self.double_finalize_with_reset_no_update_ok(data);
        self.double_finalize_with_reset_ok(data);
        self.double_finalize_err(data);
        self.update_after_finalize_with_reset_ok(data);
        self.update_after_finalize_err(data);
        self.double_reset_ok(data);
        self.immediate_finalize();
        Self::verify_same_input_ok(data);
        Self::verify_diff_input_err(data);
    }

    #[cfg(feature = "safe_api")]
    /// Used when quickcheck is not available to generate input.
    /// Default input data is used instead. Requires std.
    pub fn run_all_tests(&self) {
        self.consistency(&Self::DEFAULT_INPUT);
        self.consistency(&[0u8; 0]);
        self.produces_same_state(&Self::DEFAULT_INPUT);

        // Following test requires std.
        self.incremental_processing_with_leftover();

        self.incremental_and_one_shot(&Self::DEFAULT_INPUT);
        self.double_finalize_with_reset_no_update_ok(&Self::DEFAULT_INPUT);
        self.double_finalize_with_reset_ok(&Self::DEFAULT_INPUT);
        self.double_finalize_err(&Self::DEFAULT_INPUT);
        self.update_after_finalize_with_reset_ok(&Self::DEFAULT_INPUT);
        self.update_after_finalize_err(&Self::DEFAULT_INPUT);
        self.double_reset_ok(&Self::DEFAULT_INPUT);
        self.immediate_finalize();
        Self::verify_same_input_ok(&Self::DEFAULT_INPUT);
        Self::verify_diff_input_err(&Self::DEFAULT_INPUT);
    }

    #[cfg(not(feature = "safe_api"))]
    /// Used when quickcheck is not available to generate input.
    /// Default input data is used instead. Without std.
    pub fn run_all_tests(&self) {
        self.consistency(&Self::DEFAULT_INPUT);
        self.consistency(&[0u8; 0]);
        self.produces_same_state(&Self::DEFAULT_INPUT);
        self.incremental_and_one_shot(&Self::DEFAULT_INPUT);
        self.double_finalize_with_reset_no_update_ok(&Self::DEFAULT_INPUT);
        self.double_finalize_with_reset_ok(&Self::DEFAULT_INPUT);
        self.double_finalize_err(&Self::DEFAULT_INPUT);
        self.update_after_finalize_with_reset_ok(&Self::DEFAULT_INPUT);
        self.update_after_finalize_err(&Self::DEFAULT_INPUT);
        self.double_reset_ok(&Self::DEFAULT_INPUT);
        self.immediate_finalize();
        Self::verify_same_input_ok(&Self::DEFAULT_INPUT);
        Self::verify_diff_input_err(&Self::DEFAULT_INPUT);
    }

    /// Related bug: https://github.com/orion-rs/orion/issues/46
    /// Testing different usage combinations of new(), update(),
    /// finalize() and reset() produce the same output.
    ///
    /// It is important to ensure this is also called with empty
    /// `data`.
    fn consistency(&self, data: &[u8]) {
        // new(), update(), finalize()
        let mut state_1 = self._initial_context.clone();
        state_1.update(data).unwrap();
        let res_1 = state_1.finalize().unwrap();

        // new(), reset(), update(), finalize()
        let mut state_2 = self._initial_context.clone();
        state_2.reset().unwrap();
        state_2.update(data).unwrap();
        let res_2 = state_2.finalize().unwrap();

        // new(), update(), reset(), update(), finalize()
        let mut state_3 = self._initial_context.clone();
        state_3.update(data).unwrap();
        state_3.reset().unwrap();
        state_3.update(data).unwrap();
        let res_3 = state_3.finalize().unwrap();

        // new(), update(), finalize(), reset(), update(), finalize()
        let mut state_4 = self._initial_context.clone();
        state_4.update(data).unwrap();
        let _ = state_4.finalize().unwrap();
        state_4.reset().unwrap();
        state_4.update(data).unwrap();
        let res_4 = state_4.finalize().unwrap();

        assert_eq!(res_1, res_2);
        assert_eq!(res_2, res_3);
        assert_eq!(res_3, res_4);

        // Tests for the assumption that returning Ok() on empty update() calls
        // with streaming APIs, gives the correct result. This is done by testing
        // the reasoning that if update() is empty, returns Ok(), it is the same as
        // calling new() -> finalize(). i.e not calling update() at all.
        if data.is_empty() {
            // new(), finalize()
            let mut state_5 = self._initial_context.clone();
            let res_5 = state_5.finalize().unwrap();

            // new(), reset(), finalize()
            let mut state_6 = self._initial_context.clone();
            state_6.reset().unwrap();
            let res_6 = state_6.finalize().unwrap();

            // new(), update(), reset(), finalize()
            let mut state_7 = self._initial_context.clone();
            state_7.update(b"WRONG DATA").unwrap();
            state_7.reset().unwrap();
            let res_7 = state_7.finalize().unwrap();

            assert_eq!(res_4, res_5);
            assert_eq!(res_5, res_6);
            assert_eq!(res_6, res_7);
        }
    }

    /// Related bug: https://github.com/orion-rs/orion/issues/46
    /// Testing different usage combinations of new(), update(),
    /// finalize() and reset() produce the same output.
    fn produces_same_state(&self, data: &[u8]) {
        // new()
        let state_1 = self._initial_context.clone();

        // new(), reset()
        let mut state_2 = self._initial_context.clone();
        state_2.reset().unwrap();

        // new(), update(), reset()
        let mut state_3 = self._initial_context.clone();
        state_3.update(data).unwrap();
        state_3.reset().unwrap();

        // new(), update(), finalize(), reset()
        let mut state_4 = self._initial_context.clone();
        state_4.update(data).unwrap();
        let _ = state_4.finalize().unwrap();
        state_4.reset().unwrap();

        T::compare_states(&state_1, &state_2);
        T::compare_states(&state_2, &state_3);
        T::compare_states(&state_3, &state_4);
    }

    #[cfg(feature = "safe_api")]
    /// Test for issues when incrementally processing data
    /// with leftover in the internal buffer. It should produce
    /// the same results as processing the same data in a single pass.
    fn incremental_processing_with_leftover(&self) {
        for len in 0..self.blocksize * 4 {
            let data = vec![0u8; len];
            let mut state = self._initial_context.clone();
            let mut other_data: Vec<u8> = Vec::new();

            other_data.extend_from_slice(&data);
            state.update(&data).unwrap();

            if data.len() > self.blocksize {
                other_data.extend_from_slice(b"");
                state.update(b"").unwrap();
            }
            if data.len() > self.blocksize * 2 {
                other_data.extend_from_slice(b"Extra");
                state.update(b"Extra").unwrap();
            }
            if data.len() > self.blocksize * 3 {
                other_data.extend_from_slice(&[0u8; 256]);
                state.update(&[0u8; 256]).unwrap();
            }

            let streaming_result = state.finalize().unwrap();
            let one_shot_result = T::one_shot(&other_data).unwrap();

            assert_eq!(streaming_result, one_shot_result);
        }
    }

    /// new(), update(), finalize() == one_shot()
    fn incremental_and_one_shot(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let streaming_result = state.finalize().unwrap();
        let one_shot_result = T::one_shot(data).unwrap();

        assert_eq!(streaming_result, one_shot_result);
    }

    /// new(), update(), finalize(), reset(), finalize(): OK
    fn double_finalize_with_reset_no_update_ok(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        state.reset().unwrap();
        assert!(state.finalize().is_ok());
    }

    /// new(), update(), finalize(), reset(), update(), finalize(): OK
    fn double_finalize_with_reset_ok(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        state.reset().unwrap();
        state.update(data).unwrap();
        assert!(state.finalize().is_ok());
    }

    /// new(), update(), finalize(), finalize(): ERR
    fn double_finalize_err(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        assert!(state.finalize().is_err());
    }

    /// new(), update(), finalize(), reset(), update(): OK
    fn update_after_finalize_with_reset_ok(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        state.reset().unwrap();
        assert!(state.update(data).is_ok());
    }

    /// Related bug: https://github.com/orion-rs/orion/issues/28
    /// new(), update(), finalize(), update(): ERR
    fn update_after_finalize_err(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        assert!(state.update(data).is_err());
    }

    /// reset(), reset(): OK
    fn double_reset_ok(&self, data: &[u8]) {
        let mut state = self._initial_context.clone();
        state.update(data).unwrap();
        let _ = state.finalize().unwrap();
        state.reset().unwrap();
        assert!(state.reset().is_ok());
    }

    /// new(), finalize(): OK
    fn immediate_finalize(&self) {
        let mut state = self._initial_context.clone();
        assert!(state.finalize().is_ok());
    }

    /// Using the same input should always result in a successful verification.
    pub fn verify_same_input_ok(data: &[u8]) {
        let expected = T::one_shot(data).unwrap();
        assert!(T::verify_result(&expected, data).is_ok());
    }

    /// Using different input should result in a failed verification.
    pub fn verify_diff_input_err(data: &[u8]) {
        let expected = T::one_shot(data).unwrap();
        assert!(T::verify_result(&expected, b"Bad data").is_err());
    }
}