nodedb-types 0.6.0

Portable type definitions shared between NodeDB Origin and NodeDB-Lite
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

// SPDX-License-Identifier: Apache-2.0

//! Dependency-neutral allocation bounds for untrusted binary decoders.

/// Validate a decoded element count before reserving its output container.
///
/// The encoded frame must contain at least `min_encoded_bytes_per_item` bytes
/// for every declared item. Both that proof and the output allocation use
/// checked multiplication so 32-bit targets cannot wrap either calculation.
/// Returns the approved element capacity on success.
pub fn checked_decode_capacity(
    count: usize,
    element_size: usize,
    remaining_encoded_bytes: usize,
    min_encoded_bytes_per_item: usize,
    max_count: usize,
    max_allocation_bytes: usize,
) -> Option<usize> {
    if count > max_count {
        return None;
    }
    let allocation_bytes = count.checked_mul(element_size)?;
    if allocation_bytes > max_allocation_bytes {
        return None;
    }
    let minimum_encoded_bytes = count.checked_mul(min_encoded_bytes_per_item)?;
    if minimum_encoded_bytes > remaining_encoded_bytes {
        return None;
    }
    Some(count)
}

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

    #[test]
    fn accepts_count_within_all_bounds() {
        assert_eq!(checked_decode_capacity(2, 8, 12, 4, 3, 24), Some(2));
    }

    #[test]
    fn accepts_zero_count_without_encoded_bytes() {
        assert_eq!(
            checked_decode_capacity(0, usize::MAX, 0, usize::MAX, 0, 0),
            Some(0)
        );
    }

    #[test]
    fn accepts_exact_allocation_and_encoded_limits() {
        assert_eq!(checked_decode_capacity(3, 8, 12, 4, 3, 24), Some(3));
    }

    #[test]
    fn rejects_count_limit() {
        assert_eq!(checked_decode_capacity(4, 8, 16, 4, 3, 32), None);
    }

    #[test]
    fn rejects_allocation_limit() {
        assert_eq!(checked_decode_capacity(3, 8, 12, 4, 3, 23), None);
    }

    #[test]
    fn rejects_insufficient_encoded_bytes() {
        assert_eq!(checked_decode_capacity(3, 8, 11, 4, 3, 24), None);
    }

    #[test]
    fn rejects_output_multiplication_overflow() {
        assert_eq!(
            checked_decode_capacity(usize::MAX, 2, usize::MAX, 0, usize::MAX, usize::MAX),
            None
        );
    }

    #[test]
    fn rejects_input_multiplication_overflow() {
        assert_eq!(
            checked_decode_capacity(usize::MAX, 0, usize::MAX, 2, usize::MAX, usize::MAX),
            None
        );
    }
}