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
macro_rules! stream_module (($stream_name:ident,
$xor_name:ident,
$xor_ic_name:ident,
$keybytes:expr,
$noncebytes:expr) => (
use libc::c_ulonglong;
use crate::randombytes::randombytes_into;
/// Number of bytes in a `Key`.
pub const KEYBYTES: usize = $keybytes;
/// Number of bytes in a `Nonce`.
pub const NONCEBYTES: usize = $noncebytes;
new_type! {
/// `Key` for symmetric encryption
///
/// When a `Key` goes out of scope its contents
/// will be zeroed out
secret Key(KEYBYTES);
}
new_type! {
/// `Nonce` for symmetric encryption
nonce Nonce(NONCEBYTES);
}
/// `gen_key()` randomly generates a key for symmetric encryption
///
/// THREAD SAFETY: `gen_key()` is thread-safe provided that you have
/// called `rust_sodium::init()` once before using any other function
/// from `rust_sodium`.
pub fn gen_key() -> Key {
let mut key = [0; KEYBYTES];
randombytes_into(&mut key);
Key(key)
}
/// `gen_nonce()` randomly generates a nonce for symmetric encryption
///
/// THREAD SAFETY: `gen_nonce()` is thread-safe provided that you have
/// called `rust_sodium::init()` once before using any other function
/// from `rust_sodium`.
///
/// NOTE: When using primitives with short nonces (e.g. salsa20, salsa208, salsa2012)
/// do not use random nonces since the probability of nonce-collision is not negligible
pub fn gen_nonce() -> Nonce {
let mut nonce = [0; NONCEBYTES];
randombytes_into(&mut nonce);
Nonce(nonce)
}
/// `stream()` produces a `len`-byte stream `c` as a function of a
/// secret key `k` and a nonce `n`.
pub fn stream(len: usize,
&Nonce(ref n): &Nonce,
&Key(ref k): &Key) -> Vec<u8> {
unsafe {
let mut c = vec![0u8; len];
let _todo_use_result = $stream_name(c.as_mut_ptr(),
c.len() as c_ulonglong,
n.as_ptr(),
k.as_ptr());
c
}
}
/// `stream_xor()` encrypts a message `m` using a secret key `k` and a nonce `n`.
/// The `stream_xor()` function returns the ciphertext `c`.
///
/// `stream_xor()` guarantees that the ciphertext has the same length as the plaintext,
/// and is the plaintext xor the output of `stream()`.
/// Consequently `stream_xor()` can also be used to decrypt.
pub fn stream_xor(m: &[u8],
&Nonce(ref n): &Nonce,
&Key(ref k): &Key) -> Vec<u8> {
unsafe {
let mut c = vec![0u8; m.len()];
let _todo_use_result = $xor_name(c.as_mut_ptr(),
m.as_ptr(),
m.len() as c_ulonglong,
n.as_ptr(),
k.as_ptr());
c
}
}
/// `stream_xor_inplace()` encrypts a message `m` using a secret key `k` and a nonce `n`.
/// The `stream_xor_inplace()` function encrypts the message in place.
///
/// `stream_xor_inplace()` guarantees that the ciphertext has the same length as
/// the plaintext, and is the plaintext xor the output of `stream_inplace()`.
/// Consequently `stream_xor_inplace()` can also be used to decrypt.
pub fn stream_xor_inplace(m: &mut [u8],
&Nonce(ref n): &Nonce,
&Key(ref k): &Key) {
unsafe {
let _todo_use_result = $xor_name(m.as_mut_ptr(),
m.as_ptr(),
m.len() as c_ulonglong,
n.as_ptr(),
k.as_ptr());
}
}
/// `stream_xor_ic()` encrypts a message `m` using a secret key `k` and a nonce `n`,
/// it is similar to `stream_xor()` but allows the caller to set the value of the initial
/// block counter `ic`.
///
/// `stream_xor()` guarantees that the ciphertext has the same length as the plaintext,
/// and is the plaintext xor the output of `stream()`.
/// Consequently `stream_xor()` can also be used to decrypt.
pub fn stream_xor_ic(m: &[u8],
&Nonce(ref n): &Nonce,
ic: u64,
&Key(ref k): &Key) -> Vec<u8> {
unsafe {
let mut c = vec![0u8; m.len()];
let _ = $xor_ic_name(c.as_mut_ptr(),
m.as_ptr(),
m.len() as c_ulonglong,
n.as_ptr(),
ic,
k.as_ptr());
c
}
}
/// `stream_xor_ic_inplace()` encrypts a message `m` using a secret key `k` and a nonce `n`,
/// it is similar to `stream_xor_inplace()` but allows the caller to set the value of the initial
/// block counter `ic`.
/// The `stream_xor_ic_inplace()` function encrypts the message in place.
///
/// `stream_xor_ic_inplace()` guarantees that the ciphertext has the same length as
/// the plaintext, and is the plaintext xor the output of `stream_inplace()`.
/// Consequently `stream_xor_ic_inplace()` can also be used to decrypt.
pub fn stream_xor_ic_inplace(m: &mut [u8],
&Nonce(ref n): &Nonce,
ic: u64,
&Key(ref k): &Key) {
unsafe {
let _ = $xor_ic_name(m.as_mut_ptr(),
m.as_ptr(),
m.len() as c_ulonglong,
n.as_ptr(),
ic,
k.as_ptr());
}
}
#[cfg(test)]
mod test_m {
use super::*;
#[test]
fn test_encrypt_decrypt() {
use crate::randombytes::randombytes;
unwrap!(crate::init());
for i in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
let m = randombytes(i);
let c = stream_xor(&m, &n, &k);
let m2 = stream_xor(&c, &n, &k);
assert!(m == m2);
}
}
#[test]
fn test_stream_xor() {
use crate::randombytes::randombytes;
unwrap!(crate::init());
for i in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
let m = randombytes(i);
let mut c = m.clone();
let s = stream(c.len(), &n, &k);
for (e, v) in c.iter_mut().zip(s.iter()) {
*e ^= *v;
}
let c2 = stream_xor(&m, &n, &k);
assert!(c == c2);
}
}
#[test]
fn test_stream_xor_inplace() {
use crate::randombytes::randombytes;
unwrap!(crate::init());
for i in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
let mut m = randombytes(i);
let mut c = m.clone();
let s = stream(c.len(), &n, &k);
for (e, v) in c.iter_mut().zip(s.iter()) {
*e ^= *v;
}
stream_xor_inplace(&mut m, &n, &k);
assert!(c == m);
}
}
#[test]
fn test_stream_xor_ic_same() {
use crate::randombytes::randombytes;
unwrap!(crate::init());
for i in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
let m = randombytes(i);
let c = stream_xor(&m, &n, &k);
let c_ic = stream_xor_ic(&m, &n, 0, &k);
assert_eq!(c, c_ic);
}
}
#[test]
fn test_stream_xor_ic_inplace() {
use crate::randombytes::randombytes;
unwrap!(crate::init());
for i in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
for j in 0..10 {
let mut m = randombytes(i);
let c = stream_xor_ic(&m, &n, j, &k);
stream_xor_ic_inplace(&mut m, &n, j, &k);
assert_eq!(m, c);
}
}
}
#[test]
fn test_serialisation() {
use crate::test_utils::round_trip;
unwrap!(crate::init());
for _ in 0..1024usize {
let k = gen_key();
let n = gen_nonce();
round_trip(&k);
round_trip(&n);
}
}
}
#[cfg(feature = "benchmarks")]
#[cfg(test)]
mod bench_m {
extern crate test;
use super::*;
const BENCH_SIZES: [usize; 14] = [0, 1, 2, 4, 8, 16, 32, 64,
128, 256, 512, 1024, 2048, 4096];
#[bench]
fn bench_stream(b: &mut test::Bencher) {
unwrap!(crate::init());
let k = gen_key();
let n = gen_nonce();
b.iter(|| {
for size in BENCH_SIZES.iter() {
stream(*size, &n, &k);
}
});
}
}
));