lamlvm 0.1.1

read-only no_std LVM2 reader for UEFI bootloaders; maintained fork of rust-lvm2
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

use alloc::borrow::ToOwned;
use alloc::string::String;
use alloc::vec::Vec;
use nom::IResult;
use nom::bytes::complete::take;
use nom::bytes::streaming::tag;
use nom::error::ParseError;
use nom::multi::many_till;
use nom::number::complete::le_u32;
use nom::number::streaming::le_u64;

// Fields mirror the on-disk LVM2 PV label for fidelity and fuzz coverage; the
// linear-LV reader consumes `data_offset` and leaves the rest unread.
#[allow(
    dead_code,
    reason = "on-disk format fields retained for fidelity/fuzzing"
)]
#[derive(Debug)]
pub struct PhysicalVolumeLabelHeader {
    pub sector_number: u64,
    pub checksum: u32,
    pub data_offset: u32,
}

impl PhysicalVolumeLabelHeader {
    pub fn parse(input: &[u8]) -> IResult<&[u8], Self> {
        let (input, _) = tag(b"LABELONE")(input)?;
        let (input, sector_number) = le_u64(input)?;
        let (input, checksum) = le_u32(input)?;
        let (input, data_offset) = le_u32(input)?;
        let (input, _) = tag(b"LVM2 001")(input)?;
        Ok((
            input,
            Self {
                sector_number,
                checksum,
                data_offset,
            },
        ))
    }
}

// `pv_size` is parsed for format fidelity but not needed to map LV→PV offsets.
#[allow(
    dead_code,
    reason = "on-disk format fields retained for fidelity/fuzzing"
)]
#[derive(Debug)]
pub struct PhysicalVolumeHeader {
    pub pv_ident: String,
    pub pv_size: u64,
    pub data_descriptors: Vec<DataDescriptor>,
    pub metadata_descriptors: Vec<DataDescriptor>,
}

impl PhysicalVolumeHeader {
    pub fn parse(input: &[u8]) -> IResult<&[u8], Self> {
        let (input, pv_ident_raw) = take(32usize)(input)?;
        let pv_ident = alloc::str::from_utf8(pv_ident_raw)
            .map_err(|_| {
                nom::Err::Failure(nom::error::Error::from_error_kind(
                    pv_ident_raw,
                    nom::error::ErrorKind::Char,
                ))
            })?
            .to_owned();
        let (input, pv_size) = le_u64(input)?;
        let (input, (data_descriptors, _)) =
            many_till(DataDescriptor::parse, tag(&[0u8; 16]))(input)?;
        let (input, (metadata_descriptors, _)) =
            many_till(DataDescriptor::parse, tag(&[0u8; 16]))(input)?;
        Ok((
            input,
            Self {
                pv_ident,
                pv_size,
                data_descriptors,
                metadata_descriptors,
            },
        ))
    }
}

#[derive(Debug)]
pub struct DataDescriptor {
    pub offset: u64,
    pub size: u64,
}

impl DataDescriptor {
    pub fn parse(input: &[u8]) -> IResult<&[u8], Self> {
        let (input, offset) = le_u64(input)?;
        let (input, size) = le_u64(input)?;
        Ok((input, Self { offset, size }))
    }
}

// checksum/version/offset/size are parsed for fidelity; the reader navigates via
// `location_descriptors` and does not currently verify the metadata-area checksum.
#[allow(
    dead_code,
    reason = "on-disk format fields retained for fidelity/fuzzing"
)]
#[derive(Debug)]
pub struct MetadataAreaHeader {
    pub checksum: u32,
    pub version: u32,
    pub metadata_area_offset: u64,
    pub metadata_area_size: u64,
    pub location_descriptors: Vec<LocationDescriptor>,
}

impl MetadataAreaHeader {
    pub fn parse(input: &[u8]) -> IResult<&[u8], Self> {
        let (input, checksum) = le_u32(input)?;
        let (input, _) = tag(b" LVM2 x[5A%r0N*>")(input)?; // lol
        let (input, version) = le_u32(input)?;
        let (input, metadata_area_offset) = le_u64(input)?;
        let (input, metadata_area_size) = le_u64(input)?;
        let (input, (location_descriptors, _)) =
            many_till(LocationDescriptor::parse, tag(&[0u8; 24]))(input)?;
        Ok((
            input,
            Self {
                checksum,
                version,
                metadata_area_offset,
                metadata_area_size,
                location_descriptors,
            },
        ))
    }
}

// `checksum` and `flags` are parsed for fidelity but unused by the reader.
#[allow(
    dead_code,
    reason = "on-disk format fields retained for fidelity/fuzzing"
)]
#[derive(Debug)]
pub struct LocationDescriptor {
    pub data_area_offset: u64,
    pub data_area_size: u64,
    pub checksum: u32,
    pub flags: u32,
}

impl LocationDescriptor {
    pub fn parse(input: &[u8]) -> IResult<&[u8], Self> {
        let (input, data_area_offset) = le_u64(input)?;
        let (input, data_area_size) = le_u64(input)?;
        let (input, checksum) = le_u32(input)?;
        let (input, flags) = le_u32(input)?;
        Ok((
            input,
            Self {
                data_area_offset,
                data_area_size,
                checksum,
                flags,
            },
        ))
    }
}