libarchive_oxide-core 0.1.0

Frozen trait algebra and sans-IO core: Transform/Filter/Format/EntryReader/EntryWriter. no_std + alloc.
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
// SPDX-FileCopyrightText: 2026 libarchive_oxide contributors
//
// SPDX-License-Identifier: MIT OR Apache-2.0

//! Unix `ar` archive format (used by `.deb`, static libraries).
//!
//! Handles the three name conventions: plain `SysV` names (trailing `/` terminator), the GNU
//! extended-name string table (`//` member plus `/N` offset references), and BSD long names
//! (`#1/LEN` with the real name stored at the start of the member data). The special GNU symbol
//! tables (`/` and 64-bit `/SYM64/`) are skipped. Every member is a regular file (`ar` carries no
//! type info).

use alloc::borrow::Cow;
use alloc::vec::Vec;

use crate::error::{Error, Result};
use crate::format::{
    ArchiveFormat, Detection, Entry, EntryDataSink, EntryReader, EntrySink, EntryWriter, SliceData,
};
use crate::io::Sink;
use crate::meta::{EntryKind, EntryMeta, Timestamp};

const MAGIC: &[u8] = b"!<arch>\n";
const HEADER: usize = 60;
const F_NAME: (usize, usize) = (0, 16);
const F_MTIME: (usize, usize) = (16, 28);
const F_UID: (usize, usize) = (28, 34);
const F_GID: (usize, usize) = (34, 40);
const F_MODE: (usize, usize) = (40, 48);
const F_SIZE: (usize, usize) = (48, 58);
const F_MAGIC: (usize, usize) = (58, 60);

/// The `ar` format detection anchor (zero-sized type).
#[derive(Debug, Clone, Copy, Default)]
pub struct Ar;

impl ArchiveFormat for Ar {
    const NAME: &'static str = "ar";

    fn sniff(prefix: &[u8]) -> Detection {
        if prefix.len() < MAGIC.len() {
            return Detection::NeedMore;
        }
        if prefix.starts_with(MAGIC) {
            Detection::Match
        } else {
            Detection::NoMatch
        }
    }
}

/// `ar` streaming reader (over an in-memory slice).
#[derive(Debug)]
pub struct ArReader<'a> {
    data: &'a [u8],
    pos: usize,
    payload: SliceData<'a>,
    /// GNU extended-name string table (the `//` member's data), once seen.
    strtab: Option<&'a [u8]>,
    started: bool,
    ended: bool,
}

impl<'a> ArReader<'a> {
    /// Builds a reader from the entire post-filter archive byte slice.
    #[must_use]
    pub fn new(data: &'a [u8]) -> Self {
        Self {
            data,
            pos: 0,
            payload: SliceData::default(),
            strtab: None,
            started: false,
            ended: false,
        }
    }

    /// Resolves a raw 16-byte name field into the effective name and the data sub-range.
    ///
    /// Returns `(name, data_start, data_len)`, accounting for GNU `/N` table references and
    /// BSD `#1/LEN` inline names (which consume the first `LEN` bytes of the member data).
    fn resolve_name(
        &self,
        raw: &'a [u8],
        data_start: usize,
        data_len: usize,
    ) -> Result<(Cow<'a, [u8]>, usize, usize)> {
        let trimmed = rtrim(raw, b' ');

        // GNU extended name reference: "/N" where N is a decimal offset into the string table.
        if trimmed.len() >= 2 && trimmed[0] == b'/' && trimmed[1].is_ascii_digit() {
            let offset = usize_of(parse_decimal(&trimmed[1..])?)?;
            let table = self
                .strtab
                .ok_or(Error::Malformed("ar: missing // table"))?;
            let name = gnu_table_name(table, offset)?;
            return Ok((Cow::Borrowed(name), data_start, data_len));
        }

        // BSD long name: "#1/LEN", real name is the first LEN bytes of the data.
        if let Some(rest) = trimmed.strip_prefix(b"#1/") {
            let len = usize_of(parse_decimal(rest)?)?;
            let name = self
                .data
                .get(data_start..data_start + len)
                .ok_or(Error::Malformed("ar: truncated BSD name"))?;
            let data_len = data_len
                .checked_sub(len)
                .ok_or(Error::Malformed("ar: BSD name longer than data"))?;
            return Ok((Cow::Borrowed(name), data_start + len, data_len));
        }

        // Plain SysV name: strip a single trailing '/' terminator.
        let name = trimmed.strip_suffix(b"/").unwrap_or(trimmed);
        Ok((Cow::Borrowed(name), data_start, data_len))
    }
}

impl<'a> EntryReader for ArReader<'a> {
    type Data = SliceData<'a>;

    fn next_entry(&mut self) -> Result<Option<Entry<'_, SliceData<'a>>>> {
        if self.ended {
            return Ok(None);
        }
        let data = self.data;

        if !self.started {
            if !data.starts_with(MAGIC) {
                return Err(Error::Malformed("ar: bad global magic"));
            }
            self.pos = MAGIC.len();
            self.started = true;
        }

        loop {
            if self.pos + HEADER > data.len() {
                self.ended = true;
                return Ok(None);
            }
            let hdr = &data[self.pos..self.pos + HEADER];
            if field(hdr, F_MAGIC) != [0x60, 0x0a] {
                return Err(Error::Malformed("ar: bad header terminator"));
            }

            let size = usize_of(parse_decimal(rtrim(field(hdr, F_SIZE), b' '))?)?;
            let data_start = self.pos + HEADER;
            let member = data
                .get(data_start..data_start + size)
                .ok_or(Error::Malformed("ar: truncated member data"))?;
            // Members are padded to an even offset with a trailing '\n'.
            self.pos = data_start + size + (size & 1);

            let raw = field(hdr, F_NAME);
            let trimmed = rtrim(raw, b' ');

            // The GNU string table: keep it for later "/N" references, then skip.
            if trimmed == b"//" {
                self.strtab = Some(member);
                continue;
            }
            // The GNU 32-bit ("/") and 64-bit ("/SYM64/") symbol tables: skip.
            if trimmed == b"/" || trimmed == b"/SYM64/" {
                continue;
            }

            let (name, body_start, body_len) = self.resolve_name(raw, data_start, size)?;
            let meta = EntryMeta {
                kind: EntryKind::File,
                path: name,
                mode: u32::try_from(parse_octal(rtrim(field(hdr, F_MODE), b' '))? & 0o7777)
                    .unwrap_or(0),
                uid: parse_decimal(rtrim(field(hdr, F_UID), b' ')).unwrap_or(0),
                gid: parse_decimal(rtrim(field(hdr, F_GID), b' ')).unwrap_or(0),
                mtime: parse_decimal(rtrim(field(hdr, F_MTIME), b' '))
                    .ok()
                    .map(|secs| Timestamp {
                        secs: i64::try_from(secs).unwrap_or(i64::MAX),
                        nanos: 0,
                    }),
                size: body_len as u64,
                link_target: None,
                pax: crate::meta::PaxMap::new(),
            };

            self.payload = SliceData::new(data, body_start, body_len);
            return Ok(Some(Entry::new(meta, &mut self.payload)));
        }
    }
}

/// `ar` streaming writer — the dual of [`ArReader`]. Writes the global magic once, then a 60-byte
/// header per member (BSD `#1/LEN` inline names for names longer than 15 bytes) and an even-byte
/// pad. Every member is a regular file.
#[derive(Debug)]
pub struct ArWriter<W: Sink> {
    sink: W,
    remaining: u64,
    pad: bool,
    open: bool,
    started: bool,
}

impl<W: Sink> ArWriter<W> {
    /// Builds a writer over a byte sink.
    pub fn new(sink: W) -> Self {
        Self {
            sink,
            remaining: 0,
            pad: false,
            open: false,
            started: false,
        }
    }

    /// Consumes the writer and returns the underlying sink.
    pub fn into_inner(self) -> W {
        self.sink
    }

    /// Writes the global `!<arch>\n` magic if it has not been written yet.
    fn ensure_started(&mut self) -> Result<()> {
        if !self.started {
            self.sink.write_all(MAGIC)?;
            self.started = true;
        }
        Ok(())
    }

    /// Emits a 60-byte member header.
    fn emit_header(
        &mut self,
        name_field: &[u8],
        mode: u64,
        meta: &EntryMeta<'_>,
        size: u64,
    ) -> Result<()> {
        let mtime = meta
            .mtime
            .map_or(0, |t| u64::try_from(t.secs.max(0)).unwrap_or(0));
        let mut h = [b' '; HEADER];
        let mut buf = [0u8; 24];
        put_field(&mut h[F_NAME.0..F_NAME.1], name_field);
        put_field(
            &mut h[F_MTIME.0..F_MTIME.1],
            radix_bytes(mtime, 10, &mut buf),
        );
        put_field(
            &mut h[F_UID.0..F_UID.1],
            radix_bytes(meta.uid, 10, &mut buf),
        );
        put_field(
            &mut h[F_GID.0..F_GID.1],
            radix_bytes(meta.gid, 10, &mut buf),
        );
        put_field(&mut h[F_MODE.0..F_MODE.1], radix_bytes(mode, 8, &mut buf));
        put_field(&mut h[F_SIZE.0..F_SIZE.1], radix_bytes(size, 10, &mut buf));
        h[F_MAGIC.0] = b'`';
        h[F_MAGIC.0 + 1] = b'\n';
        self.sink.write_all(&h)
    }
}

impl<W: Sink> EntryWriter for ArWriter<W> {
    type Sink = Self;

    fn start_entry(&mut self, meta: &EntryMeta<'_>) -> Result<EntrySink<'_, Self>> {
        if self.open {
            return Err(Error::InvalidState("ar: previous entry not closed"));
        }
        self.ensure_started()?;

        // Names up to 15 bytes fit "name/" in the 16-byte field; longer names use BSD "#1/LEN"
        // with the name stored inline at the front of the member data.
        let name = &meta.path;
        let mut prefix: &[u8] = &[];
        let name_field: Vec<u8> = if name.len() <= 15 {
            let mut nf = Vec::with_capacity(name.len() + 1);
            nf.extend_from_slice(name);
            nf.push(b'/');
            nf
        } else {
            prefix = name;
            let mut nf = Vec::new();
            nf.extend_from_slice(b"#1/");
            let mut buf = [0u8; 24];
            nf.extend_from_slice(radix_bytes(name.len() as u64, 10, &mut buf));
            nf
        };

        let total = prefix.len() as u64 + meta.size;
        let mode = 0o100_000 | u64::from(meta.mode & 0o7777);
        self.emit_header(&name_field, mode, meta, total)?;
        if !prefix.is_empty() {
            self.sink.write_all(prefix)?;
        }

        self.remaining = meta.size;
        self.pad = total % 2 == 1;
        self.open = true;
        Ok(EntrySink::new(self))
    }

    fn finish(&mut self) -> Result<()> {
        if self.open {
            return Err(Error::InvalidState("ar: entry open at finish"));
        }
        // An empty archive is still just the magic.
        self.ensure_started()
    }
}

impl<W: Sink> EntryDataSink for ArWriter<W> {
    fn write_chunk(&mut self, data: &[u8]) -> Result<()> {
        if data.len() as u64 > self.remaining {
            return Err(Error::InvalidState("ar: payload exceeds declared size"));
        }
        self.sink.write_all(data)?;
        self.remaining -= data.len() as u64;
        Ok(())
    }

    fn close(&mut self) -> Result<()> {
        if self.remaining != 0 {
            return Err(Error::InvalidState(
                "ar: payload shorter than declared size",
            ));
        }
        if self.pad {
            self.sink.write_all(b"\n")?;
            self.pad = false;
        }
        self.open = false;
        Ok(())
    }
}

/// Left-aligns `value` into `field`, space-padding the remainder (ar's ASCII header fields).
fn put_field(field: &mut [u8], value: &[u8]) {
    field.fill(b' ');
    let n = value.len().min(field.len());
    field[..n].copy_from_slice(&value[..n]);
}

/// Formats `val` in the given radix (8 or 10) into `buf`, returning the written slice.
fn radix_bytes(val: u64, radix: u64, buf: &mut [u8; 24]) -> &[u8] {
    if val == 0 {
        buf[0] = b'0';
        return &buf[..1];
    }
    let mut i = buf.len();
    let mut v = val;
    while v > 0 {
        i -= 1;
        buf[i] = b'0' + u8::try_from(v % radix).unwrap_or(0);
        v /= radix;
    }
    &buf[i..]
}

/// Extracts a fixed header field.
fn field(hdr: &[u8], (start, end): (usize, usize)) -> &[u8] {
    &hdr[start..end]
}

/// Trims trailing occurrences of `b` from a slice.
fn rtrim(mut s: &[u8], b: u8) -> &[u8] {
    while let [rest @ .., last] = s {
        if *last == b {
            s = rest;
        } else {
            break;
        }
    }
    s
}

/// Looks up a name at `offset` in the GNU string table (names are `\n`-terminated, `/`-suffixed).
fn gnu_table_name(table: &[u8], offset: usize) -> Result<&[u8]> {
    let rest = table
        .get(offset..)
        .ok_or(Error::Malformed("ar: // offset out of range"))?;
    let end = rest.iter().position(|&c| c == b'\n').unwrap_or(rest.len());
    Ok(rest[..end].strip_suffix(b"/").unwrap_or(&rest[..end]))
}

/// Parses ASCII decimal digits into a `u64`.
fn parse_decimal(field: &[u8]) -> Result<u64> {
    if field.is_empty() {
        return Err(Error::Malformed("ar: empty numeric field"));
    }
    let mut val: u64 = 0;
    for &b in field {
        if !b.is_ascii_digit() {
            return Err(Error::Malformed("ar: invalid decimal digit"));
        }
        val = val
            .checked_mul(10)
            .and_then(|v| v.checked_add(u64::from(b - b'0')))
            .ok_or(Error::Malformed("ar: numeric overflow"))?;
    }
    Ok(val)
}

/// Parses ASCII octal digits into a `u64` (empty yields 0).
fn parse_octal(field: &[u8]) -> Result<u64> {
    let mut val: u64 = 0;
    for &b in field {
        if !(b'0'..=b'7').contains(&b) {
            return Err(Error::Malformed("ar: invalid octal digit"));
        }
        val = val
            .checked_mul(8)
            .and_then(|v| v.checked_add(u64::from(b - b'0')))
            .ok_or(Error::Malformed("ar: numeric overflow"))?;
    }
    Ok(val)
}

/// `u64` to `usize`, rejecting oversized values on 32-bit targets.
fn usize_of(v: u64) -> Result<usize> {
    usize::try_from(v).map_err(|_| Error::LimitExceeded("ar: size exceeds usize"))
}