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 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625
//! A library for iterating through entries of an mtree. //! //! *mtree* is a data format used for describing a sequence of files. Their location is record, //! along with optional extra values like checksums, size, permissions etc. //! //! For details on the spec see [mtree(5)]. //! //! # Examples //! //! ``` //! use mtree::MTree; //! use std::time::{SystemTime, UNIX_EPOCH}; //! //! // We're going to load data from a string so this example with pass doctest, //! // but there's no reason you can't use a file, or any other data source. //! let raw_data = " //! /set type=file uid=0 gid=0 mode=644 //! ./.BUILDINFO time=1523250074.300237174 size=8602 md5digest=13c0a46c2fb9f18a1a237d4904b6916e \ //! sha256digest=db1941d00645bfaab04dd3898ee8b8484874f4880bf03f717adf43a9f30d9b8c //! ./.PKGINFO time=1523250074.276237110 size=682 md5digest=fdb9ac9040f2e78f3561f27e5b31c815 \ //! sha256digest=5d41b48b74d490b7912bdcef6cf7344322c52024c0a06975b64c3ca0b4c452d1 //! /set mode=755 //! ./usr time=1523250049.905171912 type=dir //! ./usr/bin time=1523250065.373213293 type=dir //! "; //! let entries = MTree::from_reader(raw_data.as_bytes()); //! for entry in entries { //! // Normally you'd want to handle any errors //! let entry = entry.unwrap(); //! // We can print out a human-readable copy of the entry //! println!("{}", entry); //! // Let's check that if there is a modification time, it's in the past //! if let Some(time) = entry.time() { //! assert!(time < SystemTime::now()); //! } //! // We might also want to take a checksum of the file, and compare it to the digests //! // supplied by mtree, but this example doesn't have access to a filesystem. //! } //! ``` //! //! [mtree(5)]: https://www.freebsd.org/cgi/man.cgi?mtree(5) #[macro_use] extern crate newtype_array; use smallvec::SmallVec; use std::env; use std::ffi::OsStr; use std::fmt; use std::io::{self, BufRead, BufReader, Read, Split}; use std::os::unix::ffi::OsStrExt; use std::path::{Path, PathBuf}; use std::time::{SystemTime, UNIX_EPOCH}; mod parser; mod util; pub use parser::{FileMode, FileType, Format, ParserError, Perms}; use parser::{Keyword, MTreeLine, SpecialKind}; use util::{Array48, Array64}; #[cfg(not(unix))] compiler_error!("This library currently only supports unix, due to windows using utf-16 for paths"); /// An mtree parser (start here). /// /// This is the main struct for the lib. Semantically, an mtree file is a sequence of filesystem /// records. These are provided as an iterator. Use the `from_reader` function to construct an /// instance. pub struct MTree<R> where R: Read, { /// The iterator over lines (lines are guaranteed to end in \n since we only support unix). inner: Split<BufReader<R>>, /// The current working directory for dir calculations. cwd: PathBuf, /// These are set with the '/set' and '/unset' special functions. default_params: Params, } impl<R> MTree<R> where R: Read, { /// The constructor function for an MTree instance. pub fn from_reader(reader: R) -> MTree<R> { MTree { inner: BufReader::new(reader).split(b'\n'), cwd: env::current_dir().unwrap_or(PathBuf::new()), default_params: Params::default(), } } /// This is a helper function to make error handling easier. fn next_entry(&mut self, line: io::Result<Vec<u8>>) -> Result<Option<Entry>, Error> { let line = line?; let line = MTreeLine::from_bytes(&line)?; Ok(match line { MTreeLine::Blank | MTreeLine::Comment(_) => None, MTreeLine::Special(SpecialKind::Set, keywords) => { self.default_params.set_list(keywords.into_iter()); None } // this won't work because keywords need to be parsed without arguments. MTreeLine::Special(SpecialKind::Unset, _keywords) => unimplemented!(), MTreeLine::Relative(path, keywords) => { let mut params = self.default_params.clone(); params.set_list(keywords.into_iter()); if self.cwd.file_name().is_none() { panic!("relative without a current working dir"); } Some(Entry { path: self.cwd.join(OsStr::from_bytes(path)), params, }) } MTreeLine::DotDot => { self.cwd.pop(); None } MTreeLine::Full(path, keywords) => { let mut params = self.default_params.clone(); params.set_list(keywords.into_iter()); Some(Entry { path: Path::new(OsStr::from_bytes(path)).to_owned(), params, }) } }) } } impl<R> Iterator for MTree<R> where R: Read, { type Item = Result<Entry, Error>; fn next(&mut self) -> Option<Result<Entry, Error>> { while let Some(line) = self.inner.next() { match self.next_entry(line) { Ok(Some(entry)) => return Some(Ok(entry)), Ok(None) => (), Err(e) => return Some(Err(e)), } } None } } /// An entry in the mtree file. /// /// Entries have a path to the entity in question, and a list of optional params. #[derive(Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] pub struct Entry { /// The path of this entry path: PathBuf, /// All parameters applicable to this entry params: Params, } impl fmt::Display for Entry { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { writeln!(f, r#"mtree entry for "{}""#, self.path.display())?; write!(f, "{}", self.params) } } impl Entry { /// The path of this entry pub fn path(&self) -> &Path { self.path.as_ref() } /// `cksum` The checksum of the file using the default algorithm specified by /// the cksum(1) utility. pub fn checksum(&self) -> Option<u64> { self.params.checksum } /// `device` The device number for *block* or *char* file types. pub fn device(&self) -> Option<&Device> { self.params.device.as_ref() } /// `contents` The full pathname of a file that holds the contents of this file. pub fn contents(&self) -> Option<&Path> { self.params.contents.as_ref().map(|v| v.as_ref()) } /// `flags` The file flags as a symbolic name. pub fn flags(&self) -> Option<&[u8]> { self.params.flags.as_ref().map(|v| v.as_ref()) } /// `gid` The file group as a numeric value. pub fn gid(&self) -> Option<u64> { self.params.gid } /// `gname` The file group as a symbolic name. /// /// The name can be up to 32 chars and must match regex `[a-z_][a-z0-9_-]*[$]?`. pub fn gname(&self) -> Option<&[u8]> { self.params.gname.as_ref().map(|v| v.as_ref()) } /// `ignore` Ignore any file hierarchy below this line. pub fn ignore(&self) -> bool { self.params.ignore } /// `inode` The inode number. pub fn inode(&self) -> Option<u64> { self.params.inode } /// `link` The target of the symbolic link when type=link. pub fn link(&self) -> Option<&Path> { self.params.link.as_ref().map(|v| v.as_ref()) } /// `md5|md5digest` The MD5 message digest of the file. pub fn md5(&self) -> Option<u128> { self.params.md5 } /// `mode` The current file's permissions as a numeric (octal) or symbolic value. pub fn mode(&self) -> Option<FileMode> { self.params.mode } /// `nlink` The number of hard links the file is expected to have. pub fn nlink(&self) -> Option<u64> { self.params.nlink } /// `nochange` Make sure this file or directory exists but otherwise ignore /// all attributes. pub fn no_change(&self) -> bool { self.params.no_change } /// `optional` The file is optional; do not complain about the file if it is /// not in the file hierarchy. pub fn optional(&self) -> bool { self.params.optional } /// `resdevice` The "resident" device number of the file, e.g. the ID of the /// device that contains the file. Its format is the same as the one for /// `device`. pub fn resident_device(&self) -> Option<&Device> { self.params.resident_device.as_ref() } /// `rmd160|rmd160digest|ripemd160digest` The RIPEMD160 message digest of /// the file. pub fn rmd160(&self) -> Option<&[u8; 20]> { self.params.rmd160.as_ref() } /// `sha1|sha1digest` The FIPS 160-1 ("SHA-1") message digest of the file. pub fn sha1(&self) -> Option<&[u8; 20]> { self.params.sha1.as_ref() } /// `sha256|sha256digest` The FIPS 180-2 ("SHA-256") message digest of the file. pub fn sha256(&self) -> Option<&[u8; 32]> { self.params.sha256.as_ref() } /// `sha384|sha384digest` The FIPS 180-2 ("SHA-384") message digest of the file. pub fn sha384(&self) -> Option<&[u8; 48]> { self.params.sha384.as_ref().map(|v| v.as_ref()) } /// `sha512|sha512digest` The FIPS 180-2 ("SHA-512") message digest of the file. pub fn sha512(&self) -> Option<&[u8; 64]> { self.params.sha512.as_ref().map(|v| v.as_ref()) } /// `size` The size, in bytes, of the file. pub fn size(&self) -> Option<u64> { self.params.size } /// `time` The last modification time of the file. pub fn time(&self) -> Option<SystemTime> { self.params.time } /// `type` The type of the file. pub fn file_type(&self) -> Option<FileType> { self.params.file_type } /// The file owner as a numeric value. pub fn uid(&self) -> Option<u64> { self.params.uid } /// The file owner as a symbolic name. /// /// The name can be up to 32 chars and must match regex `[a-z_][a-z0-9_-]*[$]?`. pub fn uname(&self) -> Option<&[u8]> { self.params.uname.as_ref().map(|v| v.as_ref()) } } /// All possible parameters to an entry. /// /// All parameters are optional. `ignore`, `nochange` and `optional` all have no value, and so /// `true` represets their presence. #[derive(Default, Debug, Clone, Eq, PartialEq, Ord, PartialOrd, Hash)] struct Params { /// `cksum` The checksum of the file using the default algorithm specified by /// the cksum(1) utility. pub checksum: Option<u64>, /// `device` The device number for *block* or *char* file types. pub device: Option<Device>, /// `contents` The full pathname of a file that holds the contents of this file. pub contents: Option<PathBuf>, /// `flags` The file flags as a symbolic name. pub flags: Option<Vec<u8>>, /// `gid` The file group as a numeric value. pub gid: Option<u64>, /// `gname` The file group as a symbolic name. /// /// The name can be up to 32 chars and must match regex `[a-z_][a-z0-9_-]*[$]?`. pub gname: Option<SmallVec<[u8; 32]>>, /// `ignore` Ignore any file hierarchy below this line. pub ignore: bool, /// `inode` The inode number. pub inode: Option<u64>, /// `link` The target of the symbolic link when type=link. pub link: Option<PathBuf>, /// `md5|md5digest` The MD5 message digest of the file. pub md5: Option<u128>, /// `mode` The current file's permissions as a numeric (octal) or symbolic value. pub mode: Option<FileMode>, /// `nlink` The number of hard links the file is expected to have. pub nlink: Option<u64>, /// `nochange` Make sure this file or directory exists but otherwise ignore /// all attributes. pub no_change: bool, /// `optional` The file is optional; do not complain about the file if it is /// not in the file hierarchy. pub optional: bool, /// `resdevice` The "resident" device number of the file, e.g. the ID of the /// device that contains the file. Its format is the same as the one for /// `device`. pub resident_device: Option<Device>, /// `rmd160|rmd160digest|ripemd160digest` The RIPEMD160 message digest of /// the file. pub rmd160: Option<[u8; 20]>, /// `sha1|sha1digest` The FIPS 160-1 ("SHA-1") message digest of the file. pub sha1: Option<[u8; 20]>, /// `sha256|sha256digest` The FIPS 180-2 ("SHA-256") message digest of the file. pub sha256: Option<[u8; 32]>, /// `sha384|sha384digest` The FIPS 180-2 ("SHA-384") message digest of the file. pub sha384: Option<Array48<u8>>, /// `sha512|sha512digest` The FIPS 180-2 ("SHA-512") message digest of the file. pub sha512: Option<Array64<u8>>, /// `size` The size, in bytes, of the file. pub size: Option<u64>, /// `time` The last modification time of the file. pub time: Option<SystemTime>, /// `type` The type of the file. pub file_type: Option<FileType>, /// The file owner as a numeric value. pub uid: Option<u64>, /// The file owner as a symbolic name. /// /// The name can be up to 32 chars and must match regex `[a-z_][a-z0-9_-]*[$]?`. pub uname: Option<SmallVec<[u8; 32]>>, } impl Params { /// Helper method to set a number of parsed keywords. fn set_list<'a>(&mut self, keywords: impl Iterator<Item = Keyword<'a>>) { for keyword in keywords { self.set(keyword); } } /// Set a parameter from a parsed keyword. fn set(&mut self, keyword: Keyword<'_>) { match keyword { Keyword::Checksum(cksum) => self.checksum = Some(cksum), Keyword::DeviceRef(device) => self.device = Some(device.to_device()), Keyword::Contents(contents) => { self.contents = Some(Path::new(OsStr::from_bytes(contents)).to_owned()) } Keyword::Flags(flags) => self.flags = Some(flags.to_owned()), Keyword::Gid(gid) => self.gid = Some(gid), Keyword::Gname(gname) => { self.gname = Some({ let mut vec = SmallVec::new(); vec.extend_from_slice(gname); vec }) } Keyword::Ignore => self.ignore = true, Keyword::Inode(inode) => self.inode = Some(inode), Keyword::Link(link) => self.link = Some(Path::new(OsStr::from_bytes(link)).to_owned()), Keyword::Md5(md5) => self.md5 = Some(md5), Keyword::Mode(mode) => self.mode = Some(mode), Keyword::NLink(nlink) => self.nlink = Some(nlink), Keyword::NoChange => self.no_change = false, Keyword::Optional => self.optional = false, Keyword::ResidentDeviceRef(device) => self.resident_device = Some(device.to_device()), Keyword::Rmd160(rmd160) => self.rmd160 = Some(rmd160), Keyword::Sha1(sha1) => self.sha1 = Some(sha1), Keyword::Sha256(sha256) => self.sha256 = Some(sha256), Keyword::Sha384(sha384) => self.sha384 = Some(sha384), Keyword::Sha512(sha512) => self.sha512 = Some(sha512), Keyword::Size(size) => self.size = Some(size), Keyword::Time(time) => self.time = Some(UNIX_EPOCH + time), Keyword::Type(ty) => self.file_type = Some(ty), Keyword::Uid(uid) => self.uid = Some(uid), Keyword::Uname(uname) => { self.uname = Some({ let mut vec = SmallVec::new(); vec.extend_from_slice(uname); vec }) } } } /* /// Empty this params list (better mem usage than creating a new one). fn clear(&mut self) { self.checksum = None; self.device = None; self.contents = None; self.flags = None; self.gid = None; self.gname = None; self.ignore = false; self.inode = None; self.link = None; self.md5 = None; self.mode = None; self.nlink = None; self.no_change = false; self.optional = false; self.resident_device = None; self.rmd160 = None; self.sha1 = None; self.sha256 = None; self.sha384 = None; self.sha512 = None; self.size = None; self.time = None; self.file_type = None; self.uid = None; self.uname = None; } */ } impl fmt::Display for Params { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { if let Some(v) = self.checksum { writeln!(f, "checksum: {}", v)?; } if let Some(ref v) = self.device { writeln!(f, "device: {:?}", v)?; } if let Some(ref v) = self.contents { writeln!(f, "contents: {}", v.display())?; } if let Some(ref v) = self.flags { writeln!(f, "flags: {:?}", v)?; } if let Some(v) = self.gid { if v != 0 { writeln!(f, "gid: {}", v)?; } } if let Some(ref v) = self.gname { writeln!(f, "gname: {}", String::from_utf8_lossy(v))?; } if self.ignore { writeln!(f, "ignore")?; } if let Some(v) = self.inode { writeln!(f, "inode: {}", v)?; } if let Some(ref v) = self.link { writeln!(f, "link: {}", v.display())?; } if let Some(ref v) = self.md5 { writeln!(f, "md5: {:x}", v)?; } if let Some(ref v) = self.mode { writeln!(f, "mode: {}", v)?; } if let Some(v) = self.nlink { writeln!(f, "nlink: {}", v)?; } if self.no_change { writeln!(f, "no change")?; } if self.optional { writeln!(f, "optional")?; } if let Some(ref v) = self.resident_device { writeln!(f, "resident device: {:?}", v)?; } if let Some(ref v) = self.rmd160 { write!(f, "rmd160: ")?; for ch in v { write!(f, "{:x}", ch)?; } writeln!(f)?; } if let Some(ref v) = self.sha1 { write!(f, "sha1: ")?; for ch in v { write!(f, "{:x}", ch)?; } writeln!(f)?; } if let Some(ref v) = self.sha256 { write!(f, "sha256: ")?; for ch in v { write!(f, "{:x}", ch)?; } writeln!(f)?; } if let Some(ref v) = self.sha384 { write!(f, "sha384: ")?; for ch in v { write!(f, "{:x}", ch)?; } writeln!(f)?; } if let Some(ref v) = self.sha512 { write!(f, "sha512: ")?; for ch in v { write!(f, "{:x}", ch)?; } writeln!(f)?; } if let Some(v) = self.size { writeln!(f, "size: {}", v)?; } if let Some(v) = self.time { writeln!(f, "modification time: {:?}", v)?; } if let Some(v) = self.file_type { writeln!(f, "file type: {}", v)?; } if let Some(v) = self.uid { if v != 0 { writeln!(f, "uid: {}", v)?; } } if let Some(ref v) = self.uname { writeln!(f, "uname: {}", String::from_utf8_lossy(v))?; } Ok(()) } } /// A unix device. /// /// The parsing for this could probably do with some work. #[derive(Debug, Clone, PartialEq, Eq, Ord, PartialOrd, Hash)] pub struct Device { /// The device format. pub format: Format, /// The device major identifier. pub major: Vec<u8>, /// The device minor identifier. pub minor: Vec<u8>, /// The device subunit identifier, if applicable. pub subunit: Option<Vec<u8>>, } /// The error type for this crate. /// /// There are 2 possible ways that this lib can fail - there can be a problem parsing a record, or /// there can be a fault in the underlying reader. #[derive(Debug)] pub enum Error { /// There was an i/o error reading data from the reader. Io(io::Error), /// There was a problem parsing the records. Parser(ParserError), } impl fmt::Display for Error { fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result { f.write_str(match self { Error::Io(..) => "an i/o error occured while reading the mtree", Error::Parser(..) => "an error occured while parsing the mtree", }) } } impl std::error::Error for Error { fn source(&self) -> Option<&(dyn std::error::Error + 'static)> { match self { Error::Io(err) => Some(err), Error::Parser(err) => Some(err), } } } impl From<io::Error> for Error { fn from(from: io::Error) -> Error { Error::Io(from) } } impl From<parser::ParserError> for Error { fn from(from: parser::ParserError) -> Error { Error::Parser(from) } }