memseal 0.1.6

A small password-based encrypted vault for named secrets
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

use rand_core::{OsRng, TryRngCore};

/// Generates a random `usize` within the range `[min, max]` (inclusive).
///
/// # Arguments
/// - `min`: The minimum value of the range (inclusive).
/// - `max`: The maximum value of the range (inclusive).
///
/// # Returns
/// - `Ok(usize)`: A random number within the specified range.
/// - `Err(&'static str)`: An error message if the range is invalid or random generation fails.
///
/// # Errors
/// - Returns an error if `min >= max`.
/// - Returns an error if the random number generation fails.
pub fn secure_usize_between(min: usize, max: usize) -> Result<usize, &'static str> {
    if min >= max {
        return Err("Invalid range: min must be less than max");
    }

    // Use wrapping arithmetic so the full range [0, usize::MAX] does not overflow
    let range = max.wrapping_sub(min).wrapping_add(1);

    if range == 0 {
        // Full usize range - any value is valid, no rejection needed
        let val = OsRng
            .try_next_u64()
            .map_err(|_| "Failed to generate random number")?;
        return Ok(val as usize);
    }

    // Calculate the maximum limit to avoid bias
    let limit = usize::MAX - (usize::MAX % range);

    // Rejection sampling
    let rand_val = loop {
        let val = match OsRng.try_next_u64() {
            Ok(v) => v as usize,
            Err(_) => return Err("Failed to generate random number"),
        };

        if val < limit {
            break val;
        }
    };

    Ok(min + (rand_val % range))
}

/// Generates a random `u32` within the range `[min, max]` (inclusive).
///
/// # Arguments
/// - `min`: The minimum value of the range (inclusive).
/// - `max`: The maximum value of the range (inclusive).
///
/// # Returns
/// - `Ok(u32)`: A random number within the specified range.
/// - `Err(&'static str)`: An error message if the range is invalid or random generation fails.
///
/// # Errors
/// - Returns an error if `min >= max`.
/// - Returns an error if the random number generation fails.
pub fn secure_u32_between(min: u32, max: u32) -> Result<u32, &'static str> {
    if min >= max {
        return Err("Invalid range: min must be less than max");
    }

    // Use wrapping arithmetic so the full range [0, u32::MAX] does not overflow
    let range = max.wrapping_sub(min).wrapping_add(1);

    if range == 0 {
        // Full u32 range - any value is valid, no rejection needed
        let val = OsRng
            .try_next_u32()
            .map_err(|_| "Failed to generate random number")?;
        return Ok(val);
    }

    // Calculate the maximum limit to avoid bias
    let limit = u32::MAX - (u32::MAX % range);

    // Rejection sampling
    let rand_val = loop {
        let val = match OsRng.try_next_u32() {
            Ok(v) => v,
            Err(_) => return Err("Failed to generate random number"),
        };

        if val < limit {
            break val;
        }
    };

    Ok(min + (rand_val % range))
}

/// Generates a random `u64` within the range `[min, max]` (inclusive).
///
/// # Arguments
/// - `min`: The minimum value of the range (inclusive).
/// - `max`: The maximum value of the range (inclusive).
///
/// # Returns
/// - `Ok(u64)`: A random number within the specified range.
/// - `Err(&'static str)`: An error message if the range is invalid or random generation fails.
///
/// # Errors
/// - Returns an error if `min >= max`.
/// - Returns an error if the random number generation fails.
pub fn secure_u64_between(min: u64, max: u64) -> Result<u64, &'static str> {
    if min >= max {
        return Err("Invalid range: min must be less than max");
    }

    // Use wrapping arithmetic so the full range [0, u64::MAX] does not overflow
    let range = max.wrapping_sub(min).wrapping_add(1);

    if range == 0 {
        // Full u64 range - any value is valid, no rejection needed
        let val = OsRng
            .try_next_u64()
            .map_err(|_| "Failed to generate random number")?;
        return Ok(val);
    }

    // Calculate the maximum limit to avoid bias
    let limit = u64::MAX - (u64::MAX % range);

    // Rejection sampling
    let rand_val = loop {
        let val = match OsRng.try_next_u64() {
            Ok(v) => v,
            Err(_) => return Err("Failed to generate random number"),
        };

        if val < limit {
            break val;
        }
    };

    Ok(min + (rand_val % range))
}

/// Generates a random `i32` within the range `[min, max]` (inclusive).
///
/// # Arguments
/// - `min`: The minimum value of the range (inclusive).
/// - `max`: The maximum value of the range (inclusive).
///
/// # Returns
/// - `Ok(i32)`: A random number within the specified range.
/// - `Err(&'static str)`: An error message if the range is invalid or random generation fails.
///
/// # Errors
/// - Returns an error if `min >= max`.
/// - Returns an error if the random number generation fails.
pub fn secure_i32_between(min: i32, max: i32) -> Result<i32, &'static str> {
    if min >= max {
        return Err("Invalid range: min must be less than max");
    }

    // Use u32 arithmetic to avoid signed overflow when min=i32::MIN, max=i32::MAX
    let range = (max as u32).wrapping_sub(min as u32).wrapping_add(1);

    if range == 0 {
        // Full u32 range - any value is valid, no rejection needed
        let val = OsRng
            .try_next_u32()
            .map_err(|_| "Failed to generate random number")?;
        return Ok(val as i32);
    }

    let limit = u32::MAX - (u32::MAX % range);

    let rand_val = loop {
        let val = match OsRng.try_next_u32() {
            Ok(v) => v,
            Err(_) => return Err("Failed to generate random number"),
        };

        if val < limit {
            break val;
        }
    };

    Ok((min as u32).wrapping_add(rand_val % range) as i32)
}

/// Generates a random `i64` within the range `[min, max]` (inclusive).
///
/// # Arguments
/// - `min`: The minimum value of the range (inclusive).
/// - `max`: The maximum value of the range (inclusive).
///
/// # Returns
/// - `Ok(i64)`: A random number within the specified range.
/// - `Err(&'static str)`: An error message if the range is invalid or random generation fails.
///
/// # Errors
/// - Returns an error if `min >= max`.
/// - Returns an error if the random number generation fails.
pub fn secure_i64_between(min: i64, max: i64) -> Result<i64, &'static str> {
    if min >= max {
        return Err("Invalid range: min must be less than max");
    }

    let range = (max as u64).wrapping_sub(min as u64).wrapping_add(1);

    if range == 0 {
        let val = OsRng
            .try_next_u64()
            .map_err(|_| "Failed to generate random number")?;
        return Ok(val as i64);
    }

    let limit = u64::MAX - (u64::MAX % range);

    let rand_u64 = loop {
        match OsRng.try_next_u64() {
            Ok(val) => {
                if val < limit {
                    break val;
                }
            }
            Err(_) => return Err("Failed to generate random number"),
        };
    };

    Ok((min as u64).wrapping_add(rand_u64 % range) as i64)
}

/// Fills a buffer with cryptographically secure random bytes.
///
/// # Arguments
/// - `buffer`: A mutable slice of bytes to be filled with random data.
///
/// # Returns
/// - `Ok(())`: If the buffer is successfully filled with random bytes.
/// - `Err(&'static str)`: An error message if the buffer is empty or random generation fails.
///
/// # Errors
/// - Returns an error if the buffer is empty.
/// - Returns an error if the random number generation fails.
pub fn secure_bytes_fill(buffer: &mut [u8]) -> Result<(), &'static str> {
    if buffer.is_empty() {
        return Err("Buffer is empty");
    }

    OsRng
        .try_fill_bytes(buffer)
        .map_err(|_| "Failed to fill buffer with random bytes")?;
    Ok(())
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn secure_usize_between_returns_value_within_range() {
        let result = secure_usize_between(10, 20).unwrap();
        assert!((10..=20).contains(&result));
    }

    #[test]
    fn secure_usize_between_returns_error_for_invalid_range() {
        let result = secure_usize_between(20, 10);
        assert!(result.is_err());
    }

    #[test]
    fn secure_u32_between_returns_value_within_range() {
        let result = secure_u32_between(100, 200).unwrap();
        assert!((100..=200).contains(&result));
    }

    #[test]
    fn secure_u32_between_returns_error_for_invalid_range() {
        let result = secure_u32_between(200, 100);
        assert!(result.is_err());
    }

    #[test]
    fn secure_u64_between_returns_value_within_range() {
        let result = secure_u64_between(1_000, 2_000).unwrap();
        assert!((1_000..=2_000).contains(&result));
    }

    #[test]
    fn secure_u64_between_returns_error_for_invalid_range() {
        let result = secure_u64_between(2_000, 1_000);
        assert!(result.is_err());
    }

    #[test]
    fn secure_i32_between_returns_value_within_range() {
        let result = secure_i32_between(-50, 50).unwrap();
        assert!((-50..=50).contains(&result));
    }

    #[test]
    fn secure_i32_between_returns_error_for_invalid_range() {
        let result = secure_i32_between(50, -50);
        assert!(result.is_err());
    }

    #[test]
    fn secure_i64_between_returns_value_within_range() {
        let result = secure_i64_between(-1_000, 1_000).unwrap();
        assert!((-1_000..=1_000).contains(&result));
    }

    #[test]
    fn secure_i64_between_returns_error_for_invalid_range() {
        let result = secure_i64_between(1_000, -1_000);
        assert!(result.is_err());
    }

    #[test]
    fn secure_usize_between_handles_full_range() {
        // Previously overflowed range computation and panicked on modulo zero.
        assert!(secure_usize_between(0, usize::MAX).is_ok());
    }

    #[test]
    fn secure_u32_between_handles_full_range() {
        assert!(secure_u32_between(0, u32::MAX).is_ok());
    }

    #[test]
    fn secure_u64_between_handles_full_range() {
        assert!(secure_u64_between(0, u64::MAX).is_ok());
    }

    #[test]
    fn secure_i32_between_handles_full_range() {
        assert!(secure_i32_between(i32::MIN, i32::MAX).is_ok());
    }

    #[test]
    fn secure_i64_between_handles_full_range() {
        assert!(secure_i64_between(i64::MIN, i64::MAX).is_ok());
    }

    #[test]
    fn secure_bytes_fill_fills_buffer_with_random_bytes() {
        let mut buffer = [0u8; 16];
        secure_bytes_fill(&mut buffer).unwrap();
        assert!(buffer.iter().any(|&byte| byte != 0));
    }

    #[test]
    fn secure_bytes_fill_returns_error_for_empty_buffer() {
        let mut buffer: [u8; 0] = [];
        let result = secure_bytes_fill(&mut buffer);
        assert!(result.is_err());
    }
}