ouch-org/ouch
Ouch
Ouch is a command-line archive utility designed for compressing and decompressing files across multiple formats, including zip, tar, 7z, and zstd. It functions as a secure archive processor that sanitizes metadata to prevent path traversal attacks and terminal injection during extraction.
The tool features a chain compression pipeline that allows for the sequential application of multiple compression algorithms by parsing chains of file extensions in a filename. It also includes a dedicated accessibility mode that optimizes terminal output for screen readers and text-to-speech technologies by reducing verbosity and stripping non-essential details.
Broad capabilities cover archive management, including content listing, password protection, and multi-threaded compression to increase data throughput. The utility handles extraction through configurable output directories, conflict resolution renaming, and the ability to exclude hidden files or those matching gitignore patterns.
Runtime behavior and resource limits, such as decompressed output size limits, can be managed via environment variables.
Features
- File Compression - Bundles and compresses files into a wide range of industry-standard archive formats including tar, zip, and zstd.
- Multi-Format Archive Management - Provides a unified terminal interface for compressing and extracting files across various archive formats with automatic detection.
- Terminal Archive Commands - Provides a terminal interface for creating, extracting, and inspecting archives with automatic format detection.
- Multi-Format Archive Extraction Commands - Extracts contents from various compressed formats by automatically detecting the archive type.
- Secure Metadata Sanitization - Implements metadata sanitization to protect against path traversal and terminal injection attacks during archive extraction.
- Layered Compression - Applies multiple compression algorithms sequentially by chaining file extensions to achieve layered data reduction.
- Sequential Compression Pipelines - Processes data through a chain of compression algorithms by parsing multiple file extensions in the output filename.
- Secure Extraction Sanitization - Sanitizes archive metadata during extraction to prevent path traversal attacks and terminal injection.
- Archive Format Identification - Automatically selects the correct compression or decompression backend by matching file extensions.
- Format Dispatch - Matches file extensions to specific backend modules to determine the correct compression or decompression algorithm.
- Archive Input Sanitizers - Sanitizes archive filenames, comments, and symlink targets before processing to prevent injection and traversal attacks.
- Filename Sanitizers - Cleans filenames and symlink targets before processing to prevent path traversal and terminal injection attacks.
- Archive Metadata Sanitizers - Cleans filenames and symlink targets from archives to prevent path traversal and terminal injection attacks during extraction.
- Archive Format Plugins - Uses a backend-agnostic plugin architecture where each archive format is handled by a separate module.
- Sequential Compression Pipelines - Implements a chain compression pipeline that applies multiple algorithms sequentially based on filename extensions.
- Log Formatting - Formats log messages for text-to-speech compatibility and reduces verbosity during large operations.
- Archive Content Listers - Provides a way to list the internal files and directory structure of an archive without extracting them.
- Multithreaded - Uses multi-threaded processing to accelerate the compression and decompression of archives across multiple CPU cores.
- Compression Level Tuning - Allows users to adjust compression levels using speed-based flags to balance performance and file size.
- Archive Extraction Commands - Enables unpacking archives into the current directory, a new folder, or a specific custom path.
- Password-Protected Archives - Provides the ability to create and manage password-protected archives for secure file storage.
- File Exclusion Patterns - Excludes hidden files and patterns defined in .gitignore from the compression process.
- Multi-Threaded Compression Engines - Distributes compression workloads across multiple CPU cores to increase data throughput.
- Archive Encryption - Encrypts and decrypts archives using password protection to secure files for storage or transfer.
- Accessibility Modes - Provides a dedicated mode that simplifies terminal output for users relying on screen readers.
- Screen Reader Optimizations - Optimizes command results for screen readers by stripping non-essential details for improved clarity.
- Terminal Accessibility Tools - Provides simplified command output and screen reader optimizations for users relying on assistive technologies.
- System Utilities - CLI tool for painless compression.
