Cybersecurity-Projects/PROJECTS/beginner/metadata-scrubber-tool/README.md

2.9 KiB

███╗   ███╗███████╗████████╗
████╗ ████║██╔════╝╚══██╔══╝
██╔████╔██║███████╗   ██║
██║╚██╔╝██║╚════██║   ██║
██║ ╚═╝ ██║███████║   ██║
╚═╝     ╚═╝╚══════╝   ╚═╝

Cybersecurity Projects Python License: AGPLv3 PyPI

Privacy-focused CLI that strips sensitive metadata from images, PDFs, and Office documents.

This is a quick overview — security theory, architecture, and full walkthroughs are in the learn modules.

Screenshots & demo →

Developed by @Heritage-XioN

What It Does

  • Strip metadata from JPEG, PNG, PDF, Word, Excel, and PowerPoint files
  • Concurrent processing with ThreadPoolExecutor handles 1000+ files efficiently
  • Dry-run mode previews what would be removed before making changes
  • Verification reports show before/after comparison of metadata fields
  • Smart format detection uses file signatures, not extensions
  • Removes GPS coordinates, author info, timestamps, camera data, and software traces

Quick Start

uv tool install metadata-scrubber
mst scrub photo.jpg

[!TIP] This project uses just as a command runner. Type just to see all available commands.

Install: curl -sSf https://just.systems/install.sh | bash -s -- --to ~/.local/bin

Commands

Command Description
mst read <file> Inspect metadata fields present in a file
mst scrub <file> Remove all metadata from a file
mst verify <file> Confirm metadata was successfully removed

Learn

This project includes step-by-step learning materials covering security theory, architecture, and implementation.

Module Topic
00 - Overview Prerequisites and quick start
01 - Concepts Security theory and real-world breaches
02 - Architecture System design and data flow
03 - Implementation Code walkthrough
04 - Challenges Extension ideas and exercises

License

AGPL 3.0