Skip to content

Commit e6224b0

Browse files
authored
README.md
1 parent b23b5a8 commit e6224b0

File tree

1 file changed

+30
-2
lines changed

1 file changed

+30
-2
lines changed

README.md

Lines changed: 30 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,30 @@
1-
# Encryptor
2-
A secure GUI tool for file encryption/decryption using military-grade AES-GCM
1+
# 🔒 Secure File Encryptor/Decryptor 🛡️
2+
3+
| Section | Content |
4+
|---------|---------|
5+
| **🌟 Description** | A secure GUI tool for file encryption/decryption using military-grade AES-GCM encryption |
6+
| **✨ Features** | |
7+
| 🔐 Encryption | AES-GCM 256-bit encryption (NSA-approved) |
8+
| 🔓 Decryption | Authenticated decryption with tamper detection |
9+
| 📁 Large Files | Supports huge files up to 10GB (chunked processing) |
10+
| 🖥️ GUI | Beautiful PyQt5 interface with dark theme |
11+
| 🔑 Security | PBKDF2-HMAC-SHA256 with 600,000 iterations |
12+
| **📦 Requirements** | |
13+
| 🐍 Python Version | 3.6+ (Recommended: 3.8+) |
14+
| 💻 System | Windows/macOS/Linux |
15+
| 📚 Dependencies | `PyQt5`, `cryptography`, `qt_material` |
16+
| ⚙️ Install Command | `pip install PyQt5 cryptography qt_material` |
17+
| **📋 Usage Guide** | |
18+
| 🔒 Encryption | 1. Click "Select File"<br>2. Set output path (.encrypted)<br>3. Enter password + confirmation<br>4. Click "Start Encryption"<br>5. Wait for completion ✅ |
19+
| 🔓 Decryption | 1. Click "Select Encrypted File"<br>2. Set output path<br>3. Enter original password<br>4. Click "Start Decryption"<br>5. Get your original file back ✅ |
20+
| ⚠️ Important | - Never lose your password!<br>- Keep backups of important files<br>- Cancel operations using window close |
21+
| **⚙️ Technical Specs** | |
22+
| 🛠️ Algorithm | AES-GCM (Authenticated Encryption) |
23+
| 🔑 Key Size | 256-bit (Military Grade) |
24+
| 🔄 Iterations | 600,000 (NIST Recommended) |
25+
| 🧩 Chunk Size | 1MB (Optimal Performance) |
26+
| 🧂 Salt Size | 16 bytes |
27+
| 🔢 Nonce Size | 12 bytes |
28+
| **🔐 Security Notes** | - 🔄 Cryptographically secure RNG<br>- ✅ Automatic integrity verification<br>- 🧹 Cleanup on failure<br>- 🛡️ Protection against common attacks |
29+
| **📜 License** | MIT License - Free for everyone |
30+
| **📸 Preview** | ![App Screenshot]([screenshot.png](https://github.com/logand166/Encryptor/blob/b23b5a84c050397ad2834e65e4247fec48920bcc/Screenshot.jpg)) |

0 commit comments

Comments
 (0)