README formatting.

This commit is contained in:
Aaron D. Lee
2025-12-29 12:28:30 -05:00
parent c9741c1da6
commit a7df211242

View File

@@ -22,24 +22,52 @@ A secure steganography system for hiding encrypted messages in images using hybr
### From PyPI (coming soon) ### From PyPI (coming soon)
# Stegasoo
A secure steganography system for hiding encrypted messages in images using hybrid authentication.
![Python](https://img.shields.io/badge/Python-3.10+-blue)
![License](https://img.shields.io/badge/License-MIT-green)
![Security](https://img.shields.io/badge/Security-AES--256--GCM-red)
## Features
- 🔐 **AES-256-GCM** authenticated encryption
- 🧠 **Argon2id** memory-hard key derivation (256MB RAM requirement)
- 🎲 **Pseudo-random pixel selection** defeats steganalysis
- 📅 **Daily key rotation** with BIP-39 passphrases
- 🔑 **Multi-factor authentication**: PIN, RSA key, or both
- 🖼️ **Reference photo** as "something you have"
- 🌐 **Multiple interfaces**: CLI, Web UI, REST API
- 📁 **File embedding** - Hide any file type (PDF, ZIP, documents)
- 📱 **QR code support** - Encode/decode RSA keys via QR codes
## Installation
### From Source
```bash ```bash
# Core library only # Clone the repository
pip install stegasoo git clone https://github.com/adlee-was-taken/stegasoo.git
cd stegasoo
# With CLI # Install core library
pip install stegasoo[cli] pip install -e .
# With Web UI # Install with CLI
pip install stegasoo[web] pip install -e ".[cli]"
# With REST API # Install with Web UI
pip install stegasoo[api] pip install -e ".[web]"
# Everything # Install with REST API
pip install stegasoo[all] pip install -e ".[api]"
# Install everything
pip install -e ".[all]"
``` ```
## CLI Usage ### CLI Usage
```bash ```bash
# Generate credentials # Generate credentials