Skip to content

Commit 6650fc7

Browse files
CodilosopherCodilosopher
authored
Update README.md
1 parent 82eea60 commit 6650fc7

1 file changed

Lines changed: 13 additions & 132 deletions

File tree

‎README.md‎

Lines changed: 13 additions & 132 deletions
Original file line numberDiff line numberDiff line change
@@ -1,147 +1,28 @@
11
# FileKrypt 🛡️
22

3-
> **The Ultimate Zero-Knowledge, Browser-Based File Encryption Suite.**
4-
5-
FileKrypt is a premium, privacy-first web application designed to give users absolute control over their sensitive data. Built on the philosophy that privacy should never be a compromise, FileKrypt performs all cryptographic operations **locally within your browser**.
6-
7-
**Your files never leave your device. Your passwords never touch a server.**
8-
9-
---
10-
11-
## 🛡️ Why FileKrypt?
12-
13-
Unlike cloud-based encryption tools, FileKrypt follows a **Zero-Server Architecture**. Even if the hosting infrastructure were ever compromised, your data would remain perfectly safe — because the keys to your files exist only in your mind and your browser's temporary memory.
14-
15-
---
16-
17-
## ✨ Features
18-
19-
- **100% Local Processing** — Encryption and decryption happen entirely in-browser using the high-performance Web Crypto API.
20-
- **Zero-Knowledge Architecture** — No sign-ups, no tracking, and zero data transmission to any external server.
21-
- **Military-Grade Security** — Powered by AES-256-GCM encryption and PBKDF2 key derivation with 310,000 iterations.
22-
- **Multi-File Bundling** — Encrypt multiple files or entire folders into a single, secure `.enc` bundle.
23-
- **Session-Isolated History** — Recent activity is encrypted with a unique session key that self-destructs when the tab is closed.
24-
- **Advanced Memory Hygiene** — Sensitive cryptographic material is zeroed out from system RAM immediately after use.
25-
- **Premium Glassmorphic UI** — A responsive, state-of-the-art interface optimized for both desktop and mobile.
26-
27-
---
28-
29-
## 🛠️ Tech Stack
30-
31-
| Layer | Technology |
32-
|---|---|
33-
| Core | Vanilla JavaScript (ES6+), HTML5, CSS3 |
34-
| Cryptography | Web Crypto API (SubtleCrypto) |
35-
| Compression | [fflate](https://github.com/101arrowz/fflate) — High-speed DEFLATE/ZIP |
36-
| Design | Modern Glassmorphism with dynamic HSL-tailored color palettes |
37-
38-
---
39-
40-
## 🚀 Getting Started
41-
42-
FileKrypt requires no installation, no build tools, and no dependencies to install locally. Simply open `index.html` in any modern browser.
43-
44-
```bash
45-
git clone https://github.com/your-username/filekrypt.git
46-
cd filekrypt
47-
# Open index.html in your browser
48-
```
49-
50-
Or serve it locally:
51-
52-
```bash
53-
npx serve .
54-
# Visit http://localhost:3000
55-
```
56-
57-
> FileKrypt works best in Chromium-based browsers (Chrome, Edge, Brave) and Firefox for full Web Crypto API support.
3+
A zero-knowledge, browser-based file encryption tool. Everything runs locally in your browser — your files and passwords never leave your device.
584

595
---
606

61-
## 🔐 How It Works
62-
63-
### Encrypting Files
64-
65-
1. Drag and drop one or more files onto the upload area.
66-
2. Enter a strong password.
67-
3. Click **Encrypt** — a `.enc` bundle is downloaded to your device.
68-
69-
### Decrypting Files
70-
71-
1. Drop your `.enc` bundle onto the upload area.
72-
2. Enter the original password.
73-
3. Click **Decrypt** — your files are restored instantly.
74-
75-
### Under the Hood
76-
77-
```
78-
Password
79-
│
80-
▼
81-
PBKDF2 (310,000 iterations, SHA-256, random salt)
82-
│
83-
▼
84-
AES-256-GCM Key
85-
│
86-
▼
87-
Encrypt(fflate-compressed file bundle)
88-
│
89-
▼
90-
.enc output (salt + IV + ciphertext)
91-
```
92-
93-
---
94-
95-
## 🔒 Security Details
96-
97-
| Property | Value |
98-
|---|---|
99-
| Encryption Algorithm | AES-256-GCM |
100-
| Key Derivation | PBKDF2 |
101-
| Hash Function | SHA-256 |
102-
| KDF Iterations | 310,000 |
103-
| IV | Randomly generated per encryption |
104-
| Salt | Randomly generated per encryption |
105-
| Key storage | Never — zeroed from memory after use |
106-
107-
---
108-
109-
## 🌐 Browser Compatibility
110-
111-
| Browser | Supported |
112-
|---|---|
113-
| Chrome / Chromium | ✅ |
114-
| Firefox | ✅ |
115-
| Edge | ✅ |
116-
| Safari | ✅ (v15+) |
117-
| Opera | ✅ |
118-
119-
---
120-
121-
## ⚖️ Legal Disclaimer
122-
123-
FileKrypt is provided **"as is"** with no warranty of any kind. Since this tool is 100% client-side, **the user is solely responsible for managing their passwords and recovery keys**. Data lost due to forgotten credentials **cannot be recovered** by the developer. Use responsibly.
124-
125-
---
7+
## Encrypting Files
1268

127-
## 🤝 Contributing
9+
1. Click or drag-and-drop the file(s) you want to encrypt
10+
2. Enter a strong password
11+
3. Click **Encrypt** — a `.enc` file will be saved to your device
12812

129-
Contributions, issues, and feature requests are welcome.
13+
## Decrypting Files
13014

131-
1. Fork the repository
132-
2. Create your branch: `git checkout -b feature/your-feature`
133-
3. Commit your changes: `git commit -m 'Add your feature'`
134-
4. Push to the branch: `git push origin feature/your-feature`
135-
5. Open a Pull Request
15+
1. Drop your `.enc` file into the upload area
16+
2. Enter the same password used during encryption
17+
3. Click **Decrypt** — your original files will be restored
13618

13719
---
13820

139-
## 📄 License
21+
## Important
14022

141-
Distributed under the MIT License. See `LICENSE` for more information.
23+
- There is **no way to recover your files if you forget your password** — no resets, no backdoors
24+
- All encryption happens in your browser using AES-256-GCM. Nothing is sent to any server
14225

14326
---
14427

145-
<p align="center">
146-
Built with Privacy. Secured by Math. Powered by AI Assistance.
147-
</p>
28+
*Built with Privacy. Secured by Math.*

0 commit comments

Comments
 (0)