You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+12-12Lines changed: 12 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -7,7 +7,7 @@ ZKE method
7
7
8
8
This repository contains the client-side encryption code that powers FileShot.io's zero-knowledge encryption feature. Files are encrypted entirely in your browser before upload, ensuring that even FileShot's servers cannot decrypt your files.
9
9
10
-
## 🔒 What is Zero-Knowledge Encryption?
10
+
What is Zero-Knowledge Encryption?
11
11
12
12
Zero-knowledge encryption means that **we cannot decrypt your files**, even if we wanted to. The encryption happens entirely in your browser using the Web Crypto API, and we never receive your encryption key or password.
13
13
@@ -19,7 +19,7 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
19
19
- ✅ **No server access** - We cannot decrypt your files, even with a court order
20
20
- ✅ **Open source** - Review the code yourself
21
21
22
-
## 🚀 Quick Start
22
+
## Quick Start
23
23
24
24
### Try the Demo
25
25
@@ -52,15 +52,15 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
52
52
</script>
53
53
```
54
54
55
-
## 📖 How It Works
55
+
## How It Works
56
56
57
57
1.**Key Generation**: Your browser generates a random salt and derives an encryption key from your password using PBKDF2
58
58
2.**Encryption**: Your file is encrypted using AES-256-GCM before upload
59
59
3.**Upload**: Only the encrypted data is sent to FileShot's servers
60
60
4.**Storage**: We store encrypted blobs that we cannot decrypt
61
61
5.**Download**: Recipients decrypt files in their browser using the password you shared
62
62
63
-
## 🔐 Security Details
63
+
## Security Details
64
64
65
65
-**Algorithm**: AES-256-GCM (Galois/Counter Mode)
66
66
-**Key Derivation**: PBKDF2 with SHA-256
@@ -69,7 +69,7 @@ Zero-knowledge encryption means that **we cannot decrypt your files**, even if w
69
69
-**IV Length**: 12 bytes (96 bits) for GCM
70
70
-**Key Length**: 256 bits
71
71
72
-
## 📁 File Structure
72
+
## File Structure
73
73
74
74
```
75
75
fileshot-zke/
@@ -79,7 +79,7 @@ fileshot-zke/
79
79
└── LICENSE # MIT License
80
80
```
81
81
82
-
## 🧪 Testing
82
+
## Testing
83
83
84
84
Open `demo.html` in a modern browser to test the encryption implementation. The demo allows you to:
85
85
@@ -88,7 +88,7 @@ Open `demo.html` in a modern browser to test the encryption implementation. The
88
88
- Decrypt files with the correct password
89
89
- Verify that incorrect passwords fail
90
90
91
-
## 📝 API Reference
91
+
## API Reference
92
92
93
93
### `zeroKnowledgeEncrypt(file, password)`
94
94
@@ -123,27 +123,27 @@ Decrypts a file in the browser.
123
123
124
124
**Returns:** Promise resolving to a Blob containing the decrypted file.
125
125
126
-
## ⚠️ Important Security Notes
126
+
## Important Security Notes
127
127
128
128
1.**Password Strength**: Use a strong, unique password for each file
129
129
2.**Password Sharing**: Share passwords through a secure channel (not via FileShot)
130
130
3.**Password Loss**: If you lose your password, the file cannot be recovered
131
131
4.**Browser Security**: Ensure your browser and system are secure and up-to-date
132
132
5.**HTTPS Only**: Only use this on HTTPS connections in production
133
133
134
-
## 🔍 Verification
134
+
## Verification
135
135
136
136
This code is used by FileShot.io. You can verify:
137
137
138
138
1. The code served on FileShot.io matches this repository
139
139
2. Encryption happens client-side (check Network tab in DevTools)
140
140
3. The encryption key never leaves your browser
141
141
142
-
## 📄 License
142
+
## License
143
143
144
144
MIT License - See [LICENSE](LICENSE) file for details.
145
145
146
-
## 🤝 Contributing
146
+
## Contributing
147
147
148
148
We welcome security reviews and improvements! Please:
149
149
@@ -152,7 +152,7 @@ We welcome security reviews and improvements! Please:
152
152
3. Submit issues or pull requests
153
153
4. Report security vulnerabilities responsibly
154
154
155
-
## 🔒 Security Policy
155
+
## Security Policy
156
156
157
157
If you discover a security vulnerability, please email **fileshot.adm@gmail.como** instead of opening a public issue.
0 commit comments