Skip to main content

exarch_core/
lib.rs

1//! Memory-safe archive extraction library with security validation.
2//!
3//! `exarch-core` provides a safe API for extracting archive files (tar, zip)
4//! with built-in protection against common security vulnerabilities like
5//! path traversal, zip bombs, symlink attacks, and hardlink attacks.
6//!
7//! # Examples
8//!
9//! ```no_run
10//! use exarch_core::SecurityConfig;
11//! use exarch_core::extract_archive;
12//!
13//! # fn main() -> Result<(), Box<dyn std::error::Error>> {
14//! let config = SecurityConfig::default();
15//! let report = extract_archive("archive.tar.gz", "/output/dir", &config)?;
16//! println!("Extracted {} files", report.files_extracted);
17//! # Ok(())
18//! # }
19//! ```
20
21#![deny(unsafe_code)]
22#![warn(missing_docs)]
23
24pub mod api;
25pub mod archive;
26pub mod config;
27pub mod copy;
28pub mod creation;
29pub mod error;
30pub mod formats;
31pub mod inspection;
32pub mod io;
33pub mod report;
34pub mod security;
35pub mod test_utils;
36pub mod types;
37
38// Re-export main API types
39pub use api::create_archive;
40pub use api::create_archive_with_progress;
41pub use api::extract_archive;
42pub use api::extract_archive_full;
43pub use api::extract_archive_with_options;
44pub use api::extract_archive_with_progress;
45pub use api::list_archive;
46pub use api::verify_archive;
47pub use archive::Archive;
48pub use archive::ArchiveBuilder;
49pub use config::ExtractionOptions;
50pub use config::SecurityConfig;
51pub use error::ExtractionError;
52pub use error::FfiErrorMessage;
53pub use error::QuotaResource;
54pub use error::Result;
55pub use report::ExtractionReport;
56pub use report::NoopProgress;
57pub use report::ProgressCallback;
58
59// Re-export creation types
60pub use creation::ArchiveCreator;
61pub use creation::CreationConfig;
62pub use creation::CreationReport;
63
64// Re-export inspection types
65pub use inspection::ArchiveEntry;
66pub use inspection::ArchiveManifest;
67pub use inspection::CheckStatus;
68pub use inspection::IssueCategory;
69pub use inspection::IssueSeverity;
70pub use inspection::ManifestEntryType;
71pub use inspection::VerificationIssue;
72pub use inspection::VerificationReport;
73pub use inspection::VerificationStatus;
74
75// Re-export types module for easier access
76pub use types::DestDir;
77pub use types::EntryType;
78pub use types::SafePath;
79pub use types::SafeSymlink;