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
|
// MIT License
// Copyright (c) 2018-2023 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;
use subtle::ConstantTimeEq;
/// xor_slices!(src, destination): XOR $src into $destination slice.
/// Uses iter() and .zip(), so it short-circuits on the slice that has
/// the smallest length.
macro_rules! xor_slices {
($src:expr, $destination:expr) => {
for (inplace, _src_elem) in $destination.iter_mut().zip($src.iter()) {
*inplace ^= _src_elem;
}
};
}
pub(crate) mod endianness;
pub(crate) mod u32x4;
pub(crate) mod u64x4;
#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."]
#[cfg(feature = "safe_api")]
/// Generate random bytes using a CSPRNG. Not available in `no_std` context.
///
/// # About:
/// This function can be used to generate cryptographic keys, salts or other
/// values that rely on strong randomness. Please note that most keys and other
/// types used throughout Orion, implement their own `generate()` function and
/// it is strongly preferred to use those, compared to [`secure_rand_bytes()`].
///
/// This uses [`getrandom`].
///
/// # Parameters:
/// - `dst`: Destination buffer for the randomly generated bytes. The amount of
/// bytes to be generated is
/// implied by the length of `dst`.
///
/// # Errors:
/// An error will be returned if:
/// - `dst` is empty.
///
/// # Panics:
/// A panic will occur if:
/// - Failure to generate random bytes securely.
/// - The platform is not supported by [`getrandom`].
///
/// # Example:
/// ```rust
/// use orion::util;
///
/// let mut salt = [0u8; 64];
/// util::secure_rand_bytes(&mut salt)?;
/// # Ok::<(), orion::errors::UnknownCryptoError>(())
/// ```
/// [`getrandom`]: https://github.com/rust-random/getrandom
pub fn secure_rand_bytes(dst: &mut [u8]) -> Result<(), errors::UnknownCryptoError> {
if dst.is_empty() {
return Err(errors::UnknownCryptoError);
}
getrandom::getrandom(dst).unwrap();
Ok(())
}
#[must_use = "SECURITY WARNING: Ignoring a Result can have real security implications."]
/// Compare two equal length slices in constant time.
///
/// # About:
/// Compare two equal length slices, in constant time, using the
/// [subtle](https://github.com/dalek-cryptography/subtle) crate.
///
/// # Parameters:
/// - `a`: The first slice used in the comparison.
/// - `b`: The second slice used in the comparison.
///
/// # Errors:
/// An error will be returned if:
/// - `a` and `b` do not have the same length.
/// - `a` is not equal to `b`.
///
/// # Example:
/// ```rust
/// # #[cfg(feature = "safe_api")] {
/// use orion::util;
///
/// let mut rnd_bytes = [0u8; 64];
/// assert!(util::secure_cmp(&rnd_bytes, &[0u8; 64]).is_ok());
///
/// util::secure_rand_bytes(&mut rnd_bytes)?;
/// assert!(util::secure_cmp(&rnd_bytes, &[0u8; 64]).is_err());
/// # }
/// # Ok::<(), orion::errors::UnknownCryptoError>(())
/// ```
pub fn secure_cmp(a: &[u8], b: &[u8]) -> Result<(), errors::UnknownCryptoError> {
if a.ct_eq(b).into() {
Ok(())
} else {
Err(errors::UnknownCryptoError)
}
}
#[cfg(test)]
mod tests {
use super::*;
#[cfg(feature = "safe_api")]
#[test]
fn rand_key_len_ok() {
let mut dst = [0u8; 64];
secure_rand_bytes(&mut dst).unwrap();
}
#[cfg(feature = "safe_api")]
#[test]
fn rand_key_len_error() {
let mut dst = [0u8; 0];
assert!(secure_rand_bytes(&mut dst).is_err());
let err = secure_rand_bytes(&mut dst).unwrap_err();
assert_eq!(err, errors::UnknownCryptoError);
}
#[test]
fn test_ct_eq_ok() {
let buf_1 = [0x06; 10];
let buf_2 = [0x06; 10];
assert!(secure_cmp(&buf_1, &buf_2).is_ok());
assert!(secure_cmp(&buf_2, &buf_1).is_ok());
}
#[test]
fn test_ct_eq_diff_len() {
let buf_1 = [0x06; 10];
let buf_2 = [0x06; 5];
assert!(secure_cmp(&buf_1, &buf_2).is_err());
assert!(secure_cmp(&buf_2, &buf_1).is_err());
}
#[test]
fn test_ct_ne() {
let buf_1 = [0x06; 10];
let buf_2 = [0x76; 10];
assert!(secure_cmp(&buf_1, &buf_2).is_err());
assert!(secure_cmp(&buf_2, &buf_1).is_err());
}
#[test]
fn test_ct_ne_reg() {
assert!(secure_cmp(&[0], &[0, 1]).is_err());
assert!(secure_cmp(&[0, 1], &[0]).is_err());
}
#[quickcheck]
#[cfg(feature = "safe_api")]
fn prop_secure_cmp(a: Vec<u8>, b: Vec<u8>) -> bool {
if a == b {
secure_cmp(&a, &b).is_ok()
} else {
secure_cmp(&a, &b).is_err()
}
}
}
|
