threecpio 0.14.0

// Copyright (C) 2024-2026, Benjamin Drung <bdrung@posteo.de>
// SPDX-License-Identifier: ISC

use std::fs::Permissions;
use std::io::{Error, ErrorKind, Read, Result, Write};
use std::num::NonZeroU32;
use std::os::unix::fs::PermissionsExt;

use crate::extract::SeenFiles;
use crate::filetype::*;
use crate::seek_forward::SeekForward;

pub(crate) const CPIO_ALIGNMENT: u64 = 4;
pub(crate) const CPIO_HEADER_LENGTH: u32 = 110;
const CPIO_MAGIC_NUMBER: [u8; 6] = *b"070701";
const PATH_MAX: usize = 4096;
pub(crate) const TRAILER_FILENAME: &str = "TRAILER!!!";
pub(crate) const TRAILER_SIZE: u64 = calculate_size(TRAILER_FILENAME, 0);

#[derive(Debug, PartialEq)]
pub(crate) struct Header {
    pub(crate) ino: u32,
    pub(crate) mode: u32,
    pub(crate) uid: u32,
    pub(crate) gid: u32,
    pub(crate) nlink: u32,
    pub(crate) mtime: u32,
    pub(crate) filesize: u32,
    major: u32,
    minor: u32,
    pub(crate) rmajor: u32,
    pub(crate) rminor: u32,
    pub(crate) filename: String,
}

impl Header {
    #![allow(clippy::too_many_arguments)]
    pub(crate) fn new<S>(
        ino: u32,
        mode: u32,
        uid: u32,
        gid: u32,
        nlink: u32,
        mtime: u32,
        filesize: u32,
        rmajor: u32,
        rminor: u32,
        filename: S,
    ) -> Self
    where
        S: Into<String>,
    {
        Self {
            ino,
            mode,
            uid,
            gid,
            nlink,
            mtime,
            filesize,
            major: 0,
            minor: 0,
            rmajor,
            rminor,
            filename: filename.into(),
        }
    }

    pub(crate) fn trailer() -> Self {
        Self {
            ino: 0,
            mode: 0,
            uid: 0,
            gid: 0,
            nlink: 1,
            mtime: 0,
            filesize: 0,
            major: 0,
            minor: 0,
            rmajor: 0,
            rminor: 0,
            filename: TRAILER_FILENAME.into(),
        }
    }

    // Return major and minor combined as u64
    fn dev(&self) -> u64 {
        (u64::from(self.major) << 32) | u64::from(self.minor)
    }

    pub(crate) fn file_type_name(&self) -> &str {
        match self.mode & MODE_FILETYPE_MASK {
            FILETYPE_FIFO => "fifo",
            FILETYPE_CHARACTER_DEVICE => "character device",
            FILETYPE_DIRECTORY => "directory",
            FILETYPE_BLOCK_DEVICE => "block device",
            FILETYPE_REGULAR_FILE => "regular file",
            FILETYPE_SYMLINK => "symlink",
            FILETYPE_SOCKET => "socket",
            _ => "invalid/unknown file type",
        }
    }

    pub(crate) fn is_root_directory(&self) -> bool {
        self.filename == "." && self.mode & MODE_FILETYPE_MASK == FILETYPE_DIRECTORY
    }

    pub(crate) fn mode_perm(&self) -> u32 {
        self.mode & MODE_PERMISSION_MASK
    }

    // ls-style ASCII representation of the mode
    pub(crate) fn mode_string(&self) -> [u8; 10] {
        [
            match self.mode & MODE_FILETYPE_MASK {
                FILETYPE_FIFO => b'p',
                FILETYPE_CHARACTER_DEVICE => b'c',
                FILETYPE_DIRECTORY => b'd',
                FILETYPE_BLOCK_DEVICE => b'b',
                FILETYPE_REGULAR_FILE => b'-',
                FILETYPE_SYMLINK => b'l',
                FILETYPE_SOCKET => b's',
                _ => b'?',
            },
            if self.mode & 0o400 != 0 { b'r' } else { b'-' },
            if self.mode & 0o200 != 0 { b'w' } else { b'-' },
            match self.mode & 0o4100 {
                0o4100 => b's', // set-uid and executable by owner
                0o4000 => b'S', // set-uid but not executable by owner
                0o0100 => b'x',
                _ => b'-',
            },
            if self.mode & 0o040 != 0 { b'r' } else { b'-' },
            if self.mode & 0o020 != 0 { b'w' } else { b'-' },
            match self.mode & 0o2010 {
                0o2010 => b's', // set-gid and executable by group
                0o2000 => b'S', // set-gid but not executable by group
                0o0010 => b'x',
                _ => b'-',
            },
            if self.mode & 0o004 != 0 { b'r' } else { b'-' },
            if self.mode & 0o002 != 0 { b'w' } else { b'-' },
            match self.mode & 0o1001 {
                0o1001 => b't', // sticky and executable by others
                0o1000 => b'T', // sticky but not executable by others
                0o0001 => b'x',
                _ => b'-',
            },
        ]
    }

    fn padding_needed_for_file_content(&self) -> u64 {
        padding_needed_for(self.filesize.into(), CPIO_ALIGNMENT)
    }

    pub(crate) fn permission(&self) -> Permissions {
        PermissionsExt::from_mode(self.mode & MODE_PERMISSION_MASK)
    }

    fn ino_and_dev(&self) -> u128 {
        (u128::from(self.ino) << 64) | u128::from(self.dev())
    }

    pub(crate) fn mark_seen(&self, seen_files: &mut SeenFiles) {
        seen_files.insert(self.ino_and_dev(), self.filename.clone());
    }

    pub(crate) fn read<R: Read>(archive: &mut R) -> Result<Self> {
        let mut buffer = [0; CPIO_HEADER_LENGTH as usize];
        archive.read_exact(&mut buffer)?;
        check_begins_with_cpio_magic_header(&buffer)?;
        let namesize = hex_str_to_u32(&buffer[94..102])?;
        let filename = read_filename(archive, namesize.into())?;
        Ok(Self {
            ino: hex_str_to_u32(&buffer[6..14])?,
            mode: hex_str_to_u32(&buffer[14..22])?,
            uid: hex_str_to_u32(&buffer[22..30])?,
            gid: hex_str_to_u32(&buffer[30..38])?,
            nlink: hex_str_to_u32(&buffer[38..46])?,
            mtime: hex_str_to_u32(&buffer[46..54])?,
            filesize: hex_str_to_u32(&buffer[54..62])?,
            major: hex_str_to_u32(&buffer[62..70])?,
            minor: hex_str_to_u32(&buffer[70..78])?,
            rmajor: hex_str_to_u32(&buffer[78..86])?,
            rminor: hex_str_to_u32(&buffer[86..94])?,
            filename,
        })
    }

    pub(crate) fn read_symlink_target<R: Read>(&self, archive: &mut R) -> Result<String> {
        let align = usize::try_from(self.padding_needed_for_file_content()).unwrap();
        let filesize = self.filesize.try_into().unwrap();
        let mut target_bytes = vec![0u8; filesize + align];
        archive.read_exact(&mut target_bytes)?;
        target_bytes.truncate(filesize);
        // TODO: propper name reading handling
        let target = std::str::from_utf8(&target_bytes).unwrap();
        Ok(target.into())
    }

    pub(crate) fn skip_file_content<R: SeekForward>(&self, archive: &mut R) -> Result<()> {
        skip_file_content(archive, self.filesize)
    }

    pub(crate) fn skip_file_content_padding<R: SeekForward>(&self, archive: &mut R) -> Result<()> {
        let skip = self.padding_needed_for_file_content();
        if skip == 0 {
            return Ok(());
        };
        archive.seek_forward(skip)
    }

    pub(crate) fn try_get_hard_link_target<'a>(
        &self,
        seen_files: &'a SeenFiles,
    ) -> Option<&'a String> {
        if self.nlink <= 1 {
            return None;
        }
        seen_files.get(&self.ino_and_dev())
    }

    pub(crate) fn write<W: Write>(&self, file: &mut W) -> Result<u64> {
        self.write_with_alignment(file, None, 0)
    }

    pub(crate) fn write_with_alignment<W: Write>(
        &self,
        file: &mut W,
        alignment: Option<NonZeroU32>,
        written: u64,
    ) -> Result<u64> {
        // The filename needs to be terminated with \0.
        let mut filename_len = self.filename.len().checked_add(1).unwrap();
        if filename_len > PATH_MAX {
            return Err(Error::new(
                ErrorKind::InvalidData,
                format!("Path '{}' exceeds filename length limit", self.filename),
            ));
        }
        let offset = u64::from(CPIO_HEADER_LENGTH) + u64::try_from(filename_len).unwrap();
        let mut padding_len;
        if alignment.is_some_and(|alignment| self.filesize >= alignment.into()) {
            padding_len = padding_needed_for(written + offset, alignment.unwrap().get().into());
            let filename_plus_alignment = filename_len
                .checked_add(padding_len.try_into().unwrap())
                .unwrap();
            if filename_plus_alignment > PATH_MAX {
                // Required padding exceeds namesize maximum. Use normal padding.
                padding_len = padding_needed_for(offset, CPIO_ALIGNMENT);
            } else {
                filename_len = filename_plus_alignment;
            }
        } else {
            padding_len = padding_needed_for(offset, CPIO_ALIGNMENT);
        }
        let padding = vec![0u8; (padding_len + 1).try_into().unwrap()];
        let filename_len: u32 = filename_len.try_into().unwrap();
        write!(
            file,
            "{}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}{:08X}00000000{}{}",
            std::str::from_utf8(&CPIO_MAGIC_NUMBER).unwrap(), self.ino,
            self.mode, self.uid, self.gid, self.nlink, self.mtime, self.filesize,
            self.major, self.minor, self.rmajor, self.rminor,
            filename_len, self.filename,
            std::str::from_utf8(&padding).unwrap(),
        )?;
        Ok(offset + padding_len)
    }

    pub(crate) fn write_file_data_padding<W: Write>(&self, file: &mut W) -> Result<u64> {
        let padding_len = self.padding_needed_for_file_content();
        if padding_len == 0 {
            return Ok(0);
        }
        let padding = vec![0u8; padding_len.try_into().unwrap()];
        file.write_all(&padding)?;
        Ok(padding_len)
    }
}

/// Calculate the size of the header and file data plus the 4-byte padding
pub(crate) const fn calculate_size(filename: &str, filesize: u64) -> u64 {
    let filename_len = filename.len() as u64 + 1;
    let mut size = CPIO_HEADER_LENGTH as u64 + filename_len;
    size += padding_needed_for(size, CPIO_ALIGNMENT);
    size + filesize + padding_needed_for(filesize, CPIO_ALIGNMENT)
}

fn check_begins_with_cpio_magic_header(header: &[u8]) -> std::io::Result<()> {
    if header[0..6] != CPIO_MAGIC_NUMBER {
        return Err(Error::new(
            ErrorKind::InvalidData,
            format!(
                "Invalid CPIO magic number '{}'. Expected {}",
                &header[0..6].escape_ascii(),
                std::str::from_utf8(&CPIO_MAGIC_NUMBER).unwrap(),
            ),
        ));
    }
    Ok(())
}

fn hex_str_to_u32(bytes: &[u8]) -> Result<u32> {
    let s = match std::str::from_utf8(bytes) {
        Err(_) => {
            return Err(Error::new(
                ErrorKind::InvalidData,
                format!("Invalid hexadecimal value '{}'", bytes.escape_ascii()),
            ))
        }
        Ok(value) => value,
    };
    match u32::from_str_radix(s, 16) {
        Err(_) => Err(Error::new(
            ErrorKind::InvalidData,
            format!("Invalid hexadecimal value '{s}'"),
        )),
        Ok(value) => Ok(value),
    }
}

/// Returns the amount of padding needed after `offset` to ensure that the
/// following address will be aligned to `alignment`.
pub(crate) const fn padding_needed_for(offset: u64, alignment: u64) -> u64 {
    let misalignment = offset % alignment;
    if misalignment == 0 {
        return 0;
    }
    alignment - misalignment
}

fn read_filename<R: Read>(archive: &mut R, namesize: u64) -> Result<String> {
    let header_align = padding_needed_for(u64::from(CPIO_HEADER_LENGTH) + namesize, CPIO_ALIGNMENT);
    let mut filename_bytes = vec![0u8; (namesize + header_align).try_into().unwrap()];
    let filename_length: usize = (namesize - 1).try_into().unwrap();
    archive.read_exact(&mut filename_bytes)?;
    if filename_bytes[filename_length] != 0 {
        return Err(Error::new(
            ErrorKind::InvalidData,
            format!(
                "Entry name '{:?}' is not NULL-terminated",
                &filename_bytes[0..filename_length]
            ),
        ));
    }
    filename_bytes.truncate(filename_length);
    // TODO: propper name reading handling
    let filename = std::str::from_utf8(&filename_bytes).unwrap();
    Ok(filename.to_string())
}

/// Read only the file name from the next cpio object.
///
/// Read the next cpio object header, check the magic, skip the file data.
/// Return the file name.
pub(crate) fn read_file_name_and_size_from_next_cpio_object<R: Read + SeekForward>(
    archive: &mut R,
) -> Result<(String, u32)> {
    let mut header = [0; CPIO_HEADER_LENGTH as usize];
    archive.read_exact(&mut header)?;
    check_begins_with_cpio_magic_header(&header)?;
    let filesize = hex_str_to_u32(&header[54..62])?;
    let namesize = hex_str_to_u32(&header[94..102])?;
    let filename = read_filename(archive, namesize.into())?;
    skip_file_content(archive, filesize)?;
    Ok((filename, filesize))
}

fn skip_file_content<R: SeekForward>(archive: &mut R, filesize: u32) -> Result<()> {
    if filesize == 0 {
        return Ok(());
    };
    let skip = u64::from(filesize) + padding_needed_for(filesize.into(), CPIO_ALIGNMENT);
    archive.seek_forward(skip)
}

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

    #[test]
    fn test_header_read() {
        // Wrapped before mtime and filename
        let archive = b"07070100000002000081B4000003E8000007D000000001\
            661BE5C600000008000000000000000000000000000000000000000A00000000\
            path/file\0content\0";
        let header = Header::read(&mut archive.as_ref()).unwrap();
        assert_eq!(
            header,
            Header {
                ino: 2,
                mode: 0o100664,
                uid: 1000,
                gid: 2000,
                nlink: 1,
                mtime: 1713104326,
                filesize: 8,
                major: 0,
                minor: 0,
                rmajor: 0,
                rminor: 0,
                filename: "path/file".into()
            }
        );
        assert_eq!(header.file_type_name(), "regular file");

        // Test writing the header and get the original data back
        let mut output = Vec::new();
        let mut size = header.write(&mut output).unwrap();
        output.write_all(b"content\0").unwrap();
        size += 8;
        assert_eq!(
            std::str::from_utf8(&output).unwrap(),
            std::str::from_utf8(archive).unwrap(),
        );
        assert_eq!(size, archive.len() as u64);
    }

    #[test]
    fn test_header_read_invalid_file_type() {
        // Wrapped before mtime and filename
        let archive = b"070701000000010003FFA200000007000000420000000168AEBD2C\
            00000000000000000000000000000000000000000000000800000000\
            invalid\0\0\0";
        let header = Header::read(&mut archive.as_ref()).unwrap();
        assert_eq!(
            header,
            Header {
                ino: 1,
                mode: 0o777642,
                uid: 7,
                gid: 0x42,
                nlink: 1,
                mtime: 0x68AEBD2C,
                filesize: 0,
                major: 0,
                minor: 0,
                rmajor: 0,
                rminor: 0,
                filename: "invalid".into()
            }
        );
        assert_eq!(header.file_type_name(), "invalid/unknown file type");
        assert_eq!(
            std::str::from_utf8(&header.mode_string()).unwrap(),
            "?rwSr-S-wT"
        );
    }

    #[test]
    fn test_header_read_invalid_magic_number() {
        let invalid_data = b"abc\tefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ\
            abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz";
        let got = Header::read(&mut invalid_data.as_ref()).unwrap_err();
        assert_eq!(got.kind(), ErrorKind::InvalidData);
        assert_eq!(
            got.to_string(),
            "Invalid CPIO magic number 'abc\\tef'. Expected 070701"
        );
    }

    #[test]
    fn test_header_write() {
        let header = Header {
            ino: 42,
            mode: 0o43_777,
            uid: 1000,
            gid: 2001,
            nlink: 2,
            mtime: 1720081471,
            filesize: 0,
            major: 3,
            minor: 7,
            rmajor: 42,
            rminor: 153,
            filename: "./directory_with_setuid".into(),
        };
        let mut output = Vec::new();
        let size = header.write(&mut output).unwrap();
        assert_eq!(
            std::str::from_utf8(&output).unwrap(),
            "0707010000002A000047FF000003E8000007D10000000266865C3F00000000\
            00000003000000070000002A000000990000001800000000\
            ./directory_with_setuid\0\0\0",
        );
        assert_eq!(size, 136);
    }

    #[test]
    fn test_header_write_filename_too_long() {
        let filename = format!("this/path/is/way/t{}/long", "o".repeat(5000));
        let header = Header::new(
            42, 0o43_777, 1000, 2000, 1, 1720081471, 0, 37, 153, &filename,
        );
        let mut output = Vec::new();
        let got = header.write(&mut output).unwrap_err();
        assert_eq!(got.kind(), ErrorKind::InvalidData);
        assert_eq!(
            got.to_string(),
            format!("Path '{filename}' exceeds filename length limit")
        );
    }

    #[test]
    fn test_header_write_with_alignment_exceeds_path_max() {
        let path = "usr/lib/modules/6.16.0-13-generic/modules.dep";
        let header = Header::new(42, 0o100_644, 0xAA, 0xBB, 1, 0x689CD1CC, 917184, 0, 0, path);
        let mut output = Vec::new();
        let size = header
            .write_with_alignment(&mut output, NonZeroU32::new(PATH_MAX as u32), 3956)
            .unwrap();
        assert_eq!(
            std::str::from_utf8(&output).unwrap(),
            "0707010000002A000081A4000000AA000000BB00000001689CD1CC\
            000DFEC0000000000000000000000000000000000000002E00000000\
            usr/lib/modules/6.16.0-13-generic/modules.dep\0",
        );
        assert_eq!(size, 156);
    }

    #[test]
    fn test_header_write_with_alignment_near_path_max() {
        let header = Header::new(
            42, 0o100_644, 0xAA, 0xBB, 1, 0x689CD1CC, 917184, 0, 0, "data",
        );
        let mut output = Vec::new();
        let size = header
            .write_with_alignment(&mut output, NonZeroU32::new(PATH_MAX as u32), 3988)
            .unwrap();
        assert_eq!(
            std::str::from_utf8(&output).unwrap(),
            format!(
                "0707010000002A000081A4000000AA000000BB00000001689CD1CC\
                000DFEC00000000000000000000000000000000000000FFE00000000\
                data\0\0{}",
                "\0".repeat(4088)
            ),
        );
        assert_eq!(size, 4204);
    }

    #[test]
    fn test_hex_str_to_u32() {
        let value = hex_str_to_u32(b"000003E8").unwrap();
        assert_eq!(value, 1000);
    }

    #[test]
    fn test_hex_str_to_u32_invalid_hex() {
        let got = hex_str_to_u32(b"something").unwrap_err();
        assert_eq!(got.kind(), ErrorKind::InvalidData);
        assert_eq!(got.to_string(), "Invalid hexadecimal value 'something'");
    }

    #[test]
    fn test_hex_str_to_u32_invalid_utf8() {
        let got = hex_str_to_u32(b"no\xc3\x28utf8").unwrap_err();
        assert_eq!(got.kind(), ErrorKind::InvalidData);
        assert_eq!(got.to_string(), "Invalid hexadecimal value 'no\\xc3(utf8'");
    }

    #[test]
    fn test_is_root_directory() {
        let header = Header::new(0, 0o040_755, 0, 0, 1, 1744150584, 0, 0, 0, ".");
        assert!(header.is_root_directory());
        assert_eq!(header.file_type_name(), "directory");
    }

    #[test]
    fn test_is_root_directory_not_root_path() {
        let header = Header::new(0, 0o040_755, 0, 0, 1, 1744150584, 0, 0, 0, "path");
        assert!(!header.is_root_directory());
    }

    #[test]
    fn test_is_root_directory_is_file() {
        let header = Header::new(0, 0o100_644, 0, 0, 1, 1744150584, 0, 0, 0, ".");
        assert!(!header.is_root_directory());
    }

    #[test]
    fn test_padding_needed_for() {
        assert_eq!(padding_needed_for(110, 4), 2);
    }

    #[test]
    fn test_padding_needed_for_is_aligned() {
        assert_eq!(padding_needed_for(32, 4), 0);
    }
}