Skip to content

Commit bd45374

Browse files
committed
Update README.md, add security assets, ignore private archive folder
1 parent 3ca81b1 commit bd45374

4 files changed

Lines changed: 111 additions & 3 deletions

File tree

.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,9 @@
1111
SECURITY_INTERNAL.md
1212
docs/security/SECURITY_AUDIT_INTERNAL.md
1313

14+
# Private assets
15+
assets/archive(private)/
16+
1417
# Temporary files
1518
*.tmp
1619
*.bak

README.md

Lines changed: 108 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,12 @@
88
[![PlatformIO](https://img.shields.io/badge/PlatformIO-Compatible-orange.svg)](https://platformio.org/)
99
[![ESP32](https://img.shields.io/badge/ESP32-Powered-blue.svg)](https://www.espressif.com/)
1010

11-
[Features](#-key-features)[Installation](#-quick-start)[Documentation](#-documentation)[Security](#-security)[Support](#-support)
11+
[![YouTube](https://img.shields.io/badge/YouTube-Demo-red?logo=youtube)](https://www.youtube.com/watch?v=YTVQBwgok_E)
12+
[![Hackster](https://img.shields.io/badge/Hackster.io-Featured-00979D?logo=hackster)](https://www.hackster.io/makepkg/securegen-open-source-totp-authenticator-password-manager-c350d6)
13+
[![Dev.to](https://img.shields.io/badge/Dev.to-Blog-0A0A0A?logo=dev.to)](https://dev.to/makepkg)
14+
[![Product Hunt](https://img.shields.io/badge/Product_Hunt-Launched-DA552F?logo=producthunt&logoColor=white)]([https://www.producthunt.com/posts/](https://www.producthunt.com/products/securegen-2)[)
15+
16+
[Video Demo](#-video-demo)[Features](#-key-features)[Installation](#-quick-start)[Documentation](#-documentation)[Security](#-security)[Support](#-support)
1217

1318
</div>
1419

@@ -94,6 +99,83 @@
9499

95100
---
96101

102+
## 🎥 Video Demo
103+
104+
<div align="center">
105+
106+
[![SecureGen Demo Video](https://img.youtube.com/vi/YTVQBwgok_E/maxresdefault.jpg)](https://www.youtube.com/watch?v=YTVQBwgok_E)
107+
108+
**Watch the full demonstration** showing TOTP generation, password management, BLE keyboard typing, and web interface in action.
109+
110+
[▶️ Watch on YouTube](https://www.youtube.com/watch?v=YTVQBwgok_E) | Duration: 2 minutes
111+
112+
</div>
113+
114+
---
115+
116+
## 🔒 Security in Action
117+
118+
### Network Traffic Protection Visualization
119+
120+
SecureGen implements multiple security layers to protect web communications. Here's what that looks like in practice:
121+
122+
<table>
123+
<tr>
124+
<td align="center" width="50%">
125+
<img src="assets/security/before-protection.png" alt="Before Security Layers" width="100%"/>
126+
<br/><b>Before: Readable HTTP Traffic</b>
127+
<br/>All request details visible in plaintext
128+
</td>
129+
<td align="center" width="50%">
130+
<img src="assets/security/after-protection.png" alt="After Security Layers" width="100%"/>
131+
<br/><b>After: Protected Traffic</b>
132+
<br/>Encrypted and obfuscated communications
133+
</td>
134+
</tr>
135+
</table>
136+
137+
**What Changes:**
138+
- **Before:** API endpoints, session cookies, and request structure are fully visible to network monitoring tools
139+
- **After:** Multi-layer protection encrypts payload, obfuscates URLs, masks metadata, and prevents traffic analysis
140+
141+
This demonstrates the **7-layer security architecture** protecting your sensitive data from passive monitoring, MITM attacks, and traffic pattern analysis.
142+
143+
<details>
144+
<summary><b>🔍 Technical Details (Click to Expand)</b></summary>
145+
146+
**Protection Layers:**
147+
148+
1. **Key Exchange (ECDH)** - Establishes secure session keys using elliptic curve cryptography
149+
2. **Session Encryption** - Unique encryption for each communication session
150+
3. **URL Obfuscation** - Dynamic API endpoints generated using cryptographic hashing
151+
4. **Header Obfuscation** - HTTP headers dynamically mapped to hide metadata
152+
5. **Decoy Injection** - Fake headers added to confuse traffic analysis
153+
6. **Method Tunneling** - HTTP methods hidden to prevent fingerprinting
154+
7. **Timing Protection** - Random delays prevent timing-based side-channel attacks
155+
156+
**Security Benefits:**
157+
- Protects against passive network monitoring (Wireshark, packet sniffing)
158+
- Prevents traffic pattern analysis and metadata leakage
159+
- Resists MITM attacks through session-based encryption
160+
- Anti-fingerprinting measures prevent device identification
161+
162+
**Performance Impact:**
163+
- ~50ms overhead per request
164+
- Minimal impact on user experience
165+
- Worth the trade-off for security-critical applications
166+
167+
**Implementation:**
168+
- Built with mbedTLS for cryptographic primitives
169+
- Custom session management layer
170+
- Hardware-accelerated encryption on ESP32
171+
- All code available in the repository for audit
172+
173+
</details>
174+
175+
**Read more:** [Security Architecture Documentation](docs/security/SECURITY_OVERVIEW.md)
176+
177+
---
178+
97179
## ✨ Key Features
98180

99181
### 🔐 Security First
@@ -136,7 +218,7 @@
136218

137219
1. **Clone the repository**
138220
```bash
139-
git clone https://github.com/makepkg/SecureGen.git
221+
git clone https://github.com/Unix-like-SoN/SecureGen.git
140222
cd SecureGen
141223
```
142224

@@ -371,6 +453,29 @@ This device implements **7+ layers of security** for protecting your sensitive d
371453

372454
---
373455

456+
## 🌐 Community & Resources
457+
458+
### Stay Connected
459+
460+
- **📺 YouTube**: [Demo Videos & Tutorials](https://www.youtube.com/watch?v=YTVQBwgok_E)
461+
- **📝 Dev.to**: [Technical Articles](https://dev.to/makepkg)
462+
- **🐦 Twitter/X**: [@makepkg](https://x.com/makepkg_)
463+
464+
### Featured On
465+
466+
- 🏆 Product Hunt - [Launch Page](https://www.producthunt.com/products/securegen-2)
467+
- 📰 Hackster.io - [Featured Project](https://www.hackster.io/makepkg/securegen-open-source-totp-authenticator-password-manager-c350d6)
468+
- ✍️ Dev.to - [Technical Series](https://dev.to/makepkg)
469+
470+
### Share Your Build
471+
472+
Built your own SecureGen? We'd love to see it!
473+
- Tag us on social media
474+
- Submit to [Discussions](https://github.com/makepkg/SecureGen/discussions)
475+
- Share photos in the community
476+
477+
---
478+
374479
## 🤝 Support
375480

376481
### Get Help
@@ -387,7 +492,7 @@ If you like this project and want to support its development, you can do so in t
387492

388493
**GitHub Sponsors:**
389494

390-
[![Sponsor](https://img.shields.io/badge/Sponsor-❤-red.svg)](https://github.com/sponsors/Unix-like-SoN)
495+
[![Sponsor](https://img.shields.io/badge/Sponsor-❤-red.svg)](https://github.com/sponsors/makepkg)
391496

392497
**Cryptocurrency Donations:**
393498

514 KB
Loading
212 KB
Loading

0 commit comments

Comments
 (0)