lib-q-random 0.0.3

Unified secure random number generation for libQ post-quantum cryptography library
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
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
#![cfg_attr(not(feature = "std"), no_std)]

#[cfg(not(feature = "std"))]
extern crate alloc;

#[cfg(feature = "custom-entropy")]
use lib_q_random::custom_entropy::{
    CustomEntropyConfig,
    CustomEntropySource,
    EntropyContext,
    EntropyQuality,
    generate_custom_entropy,
    get_entropy_source_info,
    has_custom_entropy_source,
    register_custom_entropy_source,
    unregister_custom_entropy_source,
};
#[cfg(all(not(feature = "alloc"), feature = "custom-entropy"))]
use lib_q_random::no_std_rng::NoStdRng;
#[cfg(all(not(feature = "alloc"), feature = "custom-entropy"))]
use rand_core::Rng;

// Test entropy callback that generates predictable data
#[allow(dead_code)]
unsafe extern "C" fn test_entropy_callback(dest: *mut u8, len: usize, _context: *mut u8) -> i32 {
    if dest.is_null() {
        return -1;
    }

    // Generate predictable test data (handle empty buffer case)
    for i in 0..len {
        unsafe {
            *dest.add(i) = (i as u8).wrapping_add(42);
        }
    }

    0
}

// Test entropy callback that fails
#[allow(dead_code)]
unsafe extern "C" fn failing_entropy_callback(
    _dest: *mut u8,
    _len: usize,
    _context: *mut u8,
) -> i32 {
    -1 // Always fail
}

// Test entropy callback that generates high-quality random data
#[allow(dead_code)]
unsafe extern "C" fn high_quality_entropy_callback(
    dest: *mut u8,
    len: usize,
    _context: *mut u8,
) -> i32 {
    if dest.is_null() || len == 0 {
        return -1;
    }

    // Generate high-quality test data (simulating hardware RNG)
    for i in 0..len {
        unsafe {
            *dest.add(i) = ((i * 7 + 13) % 256) as u8;
        }
    }

    0
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_registration() {
    // Initially no source registered
    assert!(!has_custom_entropy_source());
    assert!(get_entropy_source_info().is_none());

    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();
    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "test_registration",
    };

    // Register the source
    unsafe {
        register_custom_entropy_source(&source);
    }

    assert!(has_custom_entropy_source());
    let info = get_entropy_source_info().unwrap();
    assert_eq!(info.0, "test_registration");
    assert_eq!(info.1, EntropyQuality::User);

    // Unregister the source
    unregister_custom_entropy_source();
    assert!(!has_custom_entropy_source());
    assert!(get_entropy_source_info().is_none());
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_generation() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();
    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "test_generation",
    };

    // Register the source
    unsafe {
        register_custom_entropy_source(&source);
    }

    // Test entropy generation
    let mut buffer = [0u8; 16];
    generate_custom_entropy(&mut buffer).unwrap();

    // Check that the callback was called (predictable test data)
    for (i, &byte) in buffer.iter().enumerate() {
        assert_eq!(byte, (i as u8).wrapping_add(42));
    }

    // Test different buffer sizes
    let mut small_buffer = [0u8; 4];
    generate_custom_entropy(&mut small_buffer).unwrap();
    for (i, &byte) in small_buffer.iter().enumerate() {
        assert_eq!(byte, (i as u8).wrapping_add(42));
    }

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_failure() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();
    let source = CustomEntropySource {
        callback: failing_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "failing_source",
    };

    // Register the failing source
    unsafe {
        register_custom_entropy_source(&source);
    }

    // Test entropy generation failure
    let mut buffer = [0u8; 8];
    let result = generate_custom_entropy(&mut buffer);
    assert!(result.is_err());

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_no_source() {
    // Ensure no source is registered
    unregister_custom_entropy_source();

    let mut buffer = [0u8; 8];
    let result = generate_custom_entropy(&mut buffer);
    assert!(result.is_err());
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_quality_levels() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();

    // Test hardware quality
    let hardware_source = CustomEntropySource {
        callback: high_quality_entropy_callback,
        context,
        quality: EntropyQuality::Hardware,
        config: config.clone(),
        source_id: "hardware_source",
    };

    unsafe {
        register_custom_entropy_source(&hardware_source);
    }

    let info = get_entropy_source_info().unwrap();
    assert_eq!(info.1, EntropyQuality::Hardware);
    assert!(info.1.is_secure());

    // Test OS quality
    let os_source = CustomEntropySource {
        callback: high_quality_entropy_callback,
        context,
        quality: EntropyQuality::Os,
        config: config.clone(),
        source_id: "os_source",
    };

    unsafe {
        register_custom_entropy_source(&os_source);
    }

    let info = get_entropy_source_info().unwrap();
    assert_eq!(info.1, EntropyQuality::Os);
    assert!(info.1.is_secure());

    // Test user quality
    let user_source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config: config.clone(),
        source_id: "user_source",
    };

    unsafe {
        register_custom_entropy_source(&user_source);
    }

    let info = get_entropy_source_info().unwrap();
    assert_eq!(info.1, EntropyQuality::User);
    assert!(info.1.is_secure());

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_config_validation() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig {
        max_bytes_per_call: 8, // Limit to 8 bytes
        ..Default::default()
    };

    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "limited_source",
    };

    unsafe {
        register_custom_entropy_source(&source);
    }

    // Test within limit
    let mut small_buffer = [0u8; 4];
    generate_custom_entropy(&mut small_buffer).unwrap();

    // Test exceeding limit
    let mut large_buffer = [0u8; 16];
    let result = generate_custom_entropy(&mut large_buffer);
    assert!(result.is_err());

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_deterministic_validation() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig {
        validate_quality: true,
        ..Default::default()
    };

    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::Deterministic, // Low quality
        config,
        source_id: "deterministic_source",
    };

    unsafe {
        register_custom_entropy_source(&source);
    }

    let mut buffer = [0u8; 8];
    let result = generate_custom_entropy(&mut buffer);
    assert!(result.is_err());

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_context_data() {
    let test_data = [1u8, 2, 3, 4, 5];
    let context = unsafe { EntropyContext::new(test_data.as_ptr() as *mut u8, test_data.len()) };
    let config = CustomEntropyConfig::default();

    // Test callback that uses context data
    unsafe extern "C" fn context_entropy_callback(
        dest: *mut u8,
        len: usize,
        context: *mut u8,
    ) -> i32 {
        if dest.is_null() || len == 0 || context.is_null() {
            return -1;
        }

        let context_data = unsafe { core::slice::from_raw_parts(context, 5) };
        for i in 0..len {
            unsafe {
                *dest.add(i) = context_data[i % context_data.len()];
            }
        }

        0
    }

    let source = CustomEntropySource {
        callback: context_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "context_source",
    };

    unsafe {
        register_custom_entropy_source(&source);
    }

    let mut buffer = [0u8; 10];
    generate_custom_entropy(&mut buffer).unwrap();

    // Check that context data was used
    for (i, &byte) in buffer.iter().enumerate() {
        assert_eq!(byte, test_data[i % test_data.len()]);
    }

    unregister_custom_entropy_source();
}

#[test]
#[cfg(all(not(feature = "alloc"), feature = "custom-entropy"))]
fn test_custom_entropy_with_no_std_rng() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();
    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "rng_test_source",
    };

    // Register the source
    unsafe {
        register_custom_entropy_source(&source);
    }

    // Test that NoStdRng can use the custom entropy source
    let mut rng = NoStdRng::new().unwrap();
    let mut buffer = [0u8; 32];
    rng.fill_bytes(&mut buffer);

    // The buffer should be filled (though we can't predict the exact values
    // since NoStdRng might use getrandom as fallback)
    let has_non_zero = buffer.iter().any(|&b| b != 0);
    assert!(has_non_zero);

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_multiple_registrations() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();

    // Register first source
    let source1 = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config: config.clone(),
        source_id: "source1",
    };

    unsafe {
        register_custom_entropy_source(&source1);
    }

    assert_eq!(get_entropy_source_info().unwrap().0, "source1");

    // Register second source (should replace first)
    let source2 = CustomEntropySource {
        callback: high_quality_entropy_callback,
        context,
        quality: EntropyQuality::Hardware,
        config,
        source_id: "source2",
    };

    unsafe {
        register_custom_entropy_source(&source2);
    }

    assert_eq!(get_entropy_source_info().unwrap().0, "source2");
    assert_eq!(
        get_entropy_source_info().unwrap().1,
        EntropyQuality::Hardware
    );

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_edge_cases() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig::default();
    let source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::User,
        config,
        source_id: "edge_case_source",
    };

    unsafe {
        register_custom_entropy_source(&source);
    }

    // Test empty buffer
    let mut empty_buffer = [];
    let result = generate_custom_entropy(&mut empty_buffer);
    assert!(result.is_ok());

    // Test single byte
    let mut single_byte = [0u8; 1];
    generate_custom_entropy(&mut single_byte).unwrap();
    assert_eq!(single_byte[0], 42);

    unregister_custom_entropy_source();
}

#[test]
#[cfg(feature = "custom-entropy")]
fn test_custom_entropy_security_validation() {
    let context = EntropyContext::empty();
    let config = CustomEntropyConfig {
        validate_quality: true,
        ..Default::default()
    };

    // Test secure source
    let secure_source = CustomEntropySource {
        callback: high_quality_entropy_callback,
        context,
        quality: EntropyQuality::Hardware,
        config: config.clone(),
        source_id: "secure_source",
    };

    unsafe {
        register_custom_entropy_source(&secure_source);
    }

    let mut buffer = [0u8; 8];
    let result = generate_custom_entropy(&mut buffer);
    assert!(result.is_ok());

    // Test insecure source
    let insecure_source = CustomEntropySource {
        callback: test_entropy_callback,
        context,
        quality: EntropyQuality::Deterministic,
        config,
        source_id: "insecure_source",
    };

    unsafe {
        register_custom_entropy_source(&insecure_source);
    }

    let result = generate_custom_entropy(&mut buffer);
    assert!(result.is_err());

    unregister_custom_entropy_source();
}