girt 0.7.0

An incremental, idiomatic Rust implementation of Git
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

#![warn(
    clippy::unwrap_used,
    clippy::expect_used,
    clippy::panic,
    clippy::unreachable,
    clippy::indexing_slicing,
    reason = "parses untrusted repository or network input (#103)"
)]
use crate::ObjectReadError as Error;

/// Advances a borrowed byte cursor; all pack/delta integers use checked arithmetic.
pub(crate) fn byte(input: &mut &[u8]) -> Result<u8, Error> {
    // Hot in delta decoding: build the error only on failure.
    let Some((&value, tail)) = input.split_first() else {
        return Err(Error::Corrupt("truncated delta or entry"));
    };
    *input = tail;
    Ok(value)
}

pub(crate) fn size(
    input: &mut &[u8],
    mut value: usize,
    mut shift: u32,
    mut more: bool,
) -> Result<usize, Error> {
    while more {
        let next = byte(input)?;
        let part = (next & 0x7f) as usize;
        if shift >= usize::BITS || part > (usize::MAX >> shift) {
            return Err(Error::Corrupt("size overflow"));
        }
        value |= part << shift;
        shift += 7;
        more = next & 0x80 != 0;
    }
    Ok(value)
}

pub(crate) fn apply(
    base: &[u8],
    mut program: &[u8],
    max_size: usize,
    remaining: &mut usize,
) -> Result<Vec<u8>, Error> {
    let base_size = size(&mut program, 0, 0, true)?;
    if base_size != base.len() {
        return Err(Error::Corrupt("delta base size"));
    }
    let result_size = size(&mut program, 0, 0, true)?;
    if result_size > max_size {
        return Err(Error::Limit("object bytes"));
    }
    charge(remaining, result_size)?;
    // The declared size is unproven until the program produces it; reserve at most 1 MiB up
    // front and let larger results grow with the bytes actually copied.
    let mut result = Vec::with_capacity(result_size.min(INITIAL_RESERVATION));
    while !program.is_empty() {
        let instruction = byte(&mut program)?;
        let source = if instruction & 0x80 == 0 {
            if instruction == 0 {
                return Err(Error::Corrupt("reserved delta instruction"));
            }
            let length = instruction as usize;
            let Some((data, rest)) = program.split_at_checked(length) else {
                return Err(Error::Corrupt("truncated delta insertion"));
            };
            program = rest;
            data
        } else {
            let mut offset = 0usize;
            let mut length = 0usize;
            for bit in 0..4 {
                if instruction & (1 << bit) != 0 {
                    offset |= (byte(&mut program)? as usize) << (bit * 8);
                }
            }
            for bit in 0..3 {
                if instruction & (0x10 << bit) != 0 {
                    length |= (byte(&mut program)? as usize) << (bit * 8);
                }
            }
            if length == 0 {
                length = 65536;
            }
            let Some(end) = offset.checked_add(length) else {
                return Err(Error::Corrupt("delta copy overflow"));
            };
            let Some(copied) = base.get(offset..end) else {
                return Err(Error::Corrupt("delta copy outside base"));
            };
            copied
        };
        if source.len() > result_size.saturating_sub(result.len()) {
            return Err(Error::Corrupt("delta exceeds result size"));
        }
        result.extend_from_slice(source);
    }
    if result.len() != result_size {
        return Err(Error::Corrupt("delta result size"));
    }
    Ok(result)
}

/// Largest buffer reserved from a declared, not yet produced, size.
pub(crate) const INITIAL_RESERVATION: usize = 1024 * 1024;

pub(crate) fn charge(remaining: &mut usize, size: usize) -> Result<(), Error> {
    *remaining = remaining
        .checked_sub(size)
        .ok_or(Error::Limit("cumulative decode bytes"))?;
    Ok(())
}