Skip to content

README.md

Latest commit

 

History

History
160 lines (103 loc) · 4.43 KB

README.md

File metadata and controls

160 lines (103 loc) · 4.43 KB

🛡️ Obscuron

An elegant, lightweight yet powerful encryption system built on simplicity, clarity, and trust.
Secure • Elegant • Adaptive

python interface


✨ Overview

Obscuron is a modern, self-contained file encryption tool designed to provide strong security through simplicity and elegance.
Obscuron supports both Graphical (PyQt5) and Command-Line Interfaces, offering usability for everyday users and power for advanced ones.
It combines cryptographic precision, modern design, and a scientific approach to digital safety.

Obscuron introduces its own custom encrypted file format : .obsx — ensuring your data remains fully hidden, even at the metadata level.

🧭 Core Features (v1.0 beta)

  • Custom Encryption Format — proprietary .obsx extension ensuring complete data and metadata concealment.
  • AES-256 Encryption — powered by cryptography for strong symmetric protection. unique salt, nonce, and password-derived AES-GCM key.
  • Dual Interfaces — intuitive PyQt5 GUI and efficient CLI mode.
  • Error-Aware Design — gracefully handles invalid passwords and corrupted data.
  • Cross-Platform — fully functional on Linux, macOS, and Windows.
  • Organic Dark UI Theme — minimalist, futuristic design inspired by organic aesthetics.
  • Modular design — ready for extensions and research
  • Forward vision — designed for AI-driven adaptive encryption

Screenshots / Previews

  • Live Demo

Obscuron (Live Demo)

  • Encryption

Encryption)

  • Decryption

Decryption)


Tech Stack

  • Python 3.9+

  • cryptography (AES-GCM, PBKDF2)

  • Core Modules : os, json, base64, uuid

  • JSON, Base64 (for internal structured encoding)

  • PyQt5 (GUI) with custom QSS theme

  • CLI : argparse


⚙️ Installation & Setup

1. Clone the repository

git clone https://github.com/m4noj/Obscuron.git
cd Obscuron

2. Create virtual environment (Optional)

python3 -m venv obscuron
source venv/bin/activate
pip install -r requirements.txt

3. Usage

GUI Mode

python3 main.py

it launches the elegant desktop app:

  • then you can

    • Select a file to encrypt or decrypt

    • Enter a strong password

    • View progress and logs in real-time

    • Save encrypted or restored files securely


Command-Line Interface (CLI)

Obscuron also provides a fast, developer-friendly CLI for advanced users.

python3 -m app.obsx_cli [command] [options]

Commands:

  • -i / --input — Path to the file to be encrypted.

  • -p / --password — Password used for AES-256 encryption

  • -o / --output — (Optional) name of the encrypted .obsx file


🔓 Encrypt a File:

python3 -m app.obsx_cli encrypt -i main.py -p "yourpassword"

  • the flag -o & custom filename secret.obsx are optional, as by default obscuron encrypts even the filename!

    Example Output:

    Encrypted: c918c7901b024460b244d3b38b464f2b.obsx

🔐 Decrypt a File:

python3 -m app.obsx_cli decrypt -i c918c7901b024460b244d3b38b464f2b.obsx -p "yourpassword"

  • If flag -o is not specified, Obscuron automatically restores the original filename.

    Example Output:

    Decrypted: main.py

The Road Ahead

Obscuron will continue evolving toward an intelligent encryption agent — combining adaptive cryptography, AI-based anomaly detection, and multi-layered key management.

The long-term goal is to design a solid encryption ecosystem that guide towards incremental correctness and built on clarity, logic, and trust.