This commit is contained in:
lockbitchat
2025-08-20 23:04:43 -04:00

217
README.md
View File

@@ -15,12 +15,38 @@
--- ---
## ✨ What's New in v4.01.222
### 📱 Progressive Web App (PWA)
* **Install directly** on mobile and desktop devices
* **Offline mode support** with session persistence
* **Improved performance** through smart caching and service workers
* **Native app experience** without app store requirements
### 📂 Secure File Transfer
* **End-to-end encrypted** file transfers over pure P2P WebRTC channels
* **File chunking** with individual encryption per block
* **Hash validation** for every chunk to prevent tampering or MITM attacks
* **Automatic recovery** for lost packets and interrupted transfers
* **AES-GCM 256-bit + ECDH P-384** encryption for files
* **SHA-384 checksums** for integrity enforcement
### 🔍 Enhanced Security Testing
* **Comprehensive data leakage testing** of chat sessions
* **Verified MITM and replay attack resistance**
* **Enhanced memory cleanup algorithms** for session termination
* **Isolated file streams** separated from chat channels
---
## 🚀 Try It Now ## 🚀 Try It Now
### 🌐 [Live Demo — SecureBit.chat](https://securebitchat.github.io/securebit-chat/) ### 🌐 [Live Demo — SecureBit.chat](https://securebitchat.github.io/securebit-chat/)
*No installation required — works directly in your browser with military-grade encryption.* *No installation required — works directly in your browser with military-grade encryption.*
**New:** Install as PWA for native app experience on mobile and desktop!
--- ---
## ✨ What Makes SecureBit.chat Unique ## ✨ What Makes SecureBit.chat Unique
@@ -31,6 +57,7 @@
* **First messenger** with Lightning Network integration * **First messenger** with Lightning Network integration
* **Military-grade cryptography** exceeding government standards * **Military-grade cryptography** exceeding government standards
* **Zero servers** — truly decentralized P2P architecture * **Zero servers** — truly decentralized P2P architecture
* **PWA technology** — install like native apps without app stores
### ⚡ Lightning Network Pioneer ### ⚡ Lightning Network Pioneer
@@ -61,6 +88,7 @@
* **Traffic analysis resistance** — fake traffic generation * **Traffic analysis resistance** — fake traffic generation
* **Censorship resistance** — no servers to block * **Censorship resistance** — no servers to block
* **Instant anonymous channels** — connect in seconds * **Instant anonymous channels** — connect in seconds
* **Secure file transfers** — encrypted P2P file sharing
--- ---
@@ -70,6 +98,8 @@
| --------------------------- | ----------------------------- | ---------------------------- | --------------------- | ---------------------- | | --------------------------- | ----------------------------- | ---------------------------- | --------------------- | ---------------------- |
| **Architecture** | 🏆 Pure P2P WebRTC | ❌ Centralized servers | ❌ Centralized servers | ⚠️ Onion network | | **Architecture** | 🏆 Pure P2P WebRTC | ❌ Centralized servers | ❌ Centralized servers | ⚠️ Onion network |
| **Payment Integration** | 🏆 Lightning Network | ❌ None | ❌ None | ❌ None | | **Payment Integration** | 🏆 Lightning Network | ❌ None | ❌ None | ❌ None |
| **File Transfer** | 🏆 P2P encrypted + chunked | ✅ Encrypted via servers | ✅ Encrypted via servers | ✅ Encrypted via servers |
| **PWA Support** | 🏆 Full PWA installation | ❌ None | ❌ None | ❌ None |
| **Registration** | 🏆 Anonymous | ❌ Phone required | ✅ ID generated | ✅ Random ID | | **Registration** | 🏆 Anonymous | ❌ Phone required | ✅ ID generated | ✅ Random ID |
| **Traffic Obfuscation** | 🏆 Advanced fake traffic | ❌ None | ❌ None | ✅ Onion routing | | **Traffic Obfuscation** | 🏆 Advanced fake traffic | ❌ None | ❌ None | ✅ Onion routing |
| **Censorship Resistance** | 🏆 Hard to block | ⚠️ Blocked in some countries | ⚠️ May be blocked | ✅ Onion routing | | **Censorship Resistance** | 🏆 Hard to block | ⚠️ Blocked in some countries | ⚠️ May be blocked | ✅ Onion routing |
@@ -89,10 +119,11 @@
### Option 1: Use Online (Recommended) ### Option 1: Use Online (Recommended)
1. **Visit:** [https://securebitchat.github.io/securebit-chat/](https://securebitchat.github.io/securebit-chat/) 1. **Visit:** [https://securebitchat.github.io/securebit-chat/](https://securebitchat.github.io/securebit-chat/)
2. **Choose:** *Create Channel* or *Join Channel* 2. **Install PWA:** Click "Install" button for native app experience
3. **Complete:** Secure key exchange with verification 3. **Choose:** *Create Channel* or *Join Channel*
4. **Select:** Session type (Demo / Basic / Premium) 4. **Complete:** Secure key exchange with verification
5. **Communicate:** With militarygrade encryption 5. **Select:** Session type (Demo / Basic / Premium)
6. **Communicate:** With militarygrade encryption + secure file transfers
### Option 2: SelfHost ### Option 2: SelfHost
@@ -112,6 +143,34 @@ open http://localhost:8000
--- ---
## 📂 Secure File Transfer
### Features
* **P2P Direct Transfer** — No servers involved, direct WebRTC channels
* **Military-Grade Encryption** — AES-GCM 256-bit + ECDH P-384
* **Chunk-Level Security** — Each file chunk individually encrypted
* **Hash Validation** — SHA-384 checksums prevent tampering
* **Automatic Recovery** — Retry mechanisms for interrupted transfers
* **Stream Isolation** — Separate channels from chat messages
### Supported File Types
* **Documents:** PDF, DOC, TXT, MD
* **Images:** JPG, PNG, GIF, WEBP
* **Archives:** ZIP, RAR, 7Z
* **Media:** MP3, MP4, AVI (size limits apply)
* **General:** Any file type up to size limits
### Security Guarantees
* End-to-end encryption with perfect forward secrecy
* MITM attack prevention through hash validation
* Zero server storage — files transfer directly P2P
* Complete cleanup after transfer completion
---
## ⚡ Lightning Network Integration ## ⚡ Lightning Network Integration
### Session Types ### Session Types
@@ -140,11 +199,13 @@ open http://localhost:8000
### Cryptographic Stack ### Cryptographic Stack
``` ```
📂 File Transfer Layer: AES-GCM 256-bit + SHA-384 + Chunking
🔐 Application Layer: AES-GCM 256-bit + ECDSA P-384 🔐 Application Layer: AES-GCM 256-bit + ECDSA P-384
🔑 Key Exchange: ECDH P-384 (Perfect Forward Secrecy) 🔑 Key Exchange: ECDH P-384 (Perfect Forward Secrecy)
🛡️ Transport Layer: WebRTC DTLS 1.2 🛡️ Transport Layer: WebRTC DTLS 1.2
🌐 Network Layer: P2P WebRTC Data Channels 🌐 Network Layer: P2P WebRTC Data Channels
⚡ Payment Layer: Lightning Network + WebLN ⚡ Payment Layer: Lightning Network + WebLN
📱 PWA Layer: Service Workers + Cache API
``` ```
### Security Standards ### Security Standards
@@ -153,33 +214,36 @@ open http://localhost:8000
* NIST SP 800186 — Elliptic Curve Cryptography * NIST SP 800186 — Elliptic Curve Cryptography
* RFC 6090 — Fundamental ECC Algorithms * RFC 6090 — Fundamental ECC Algorithms
* RFC 8446 — TLS 1.3 for WebRTC * RFC 8446 — TLS 1.3 for WebRTC
* RFC 3874 — SHA-384 Hash Algorithm
### Browser Requirements ### Browser Requirements
* Modern browser with WebRTC support (Chrome 60+, Firefox 60+, Safari 12+) * Modern browser with WebRTC support (Chrome 60+, Firefox 60+, Safari 12+)
* HTTPS connection (required for WebRTC) * HTTPS connection (required for WebRTC and PWA)
* JavaScript enabled * JavaScript enabled
* Lightning wallet with WebLN (for payments) * Lightning wallet with WebLN (for payments)
* Service Worker support for PWA features
--- ---
## 🗺️ Development Roadmap ## 🗺️ Development Roadmap
**Current:** v4.0 — Enhanced Security Edition ✅ **Current:** v4.01.222 — PWA & File Transfer Edition ✅
* 12layer militarygrade security * Progressive Web App installation
* Lightning Network payments * Secure P2P file transfer system
* Pure P2P WebRTC architecture * Enhanced security testing and MITM protection
* Advanced traffic obfuscation * Improved memory cleanup algorithms
**Next Releases** **Next Releases**
### v4.5 (Q2 2025) — Mobile & Desktop Apps ### v4.5 (Q2 2025) — Mobile & Desktop Apps
* PWA with offline support * Native mobile applications (iOS/Android)
* Electron desktop application * Electron desktop application
* Push notifications * Push notifications
* Crossdevice synchronization * Crossdevice synchronization
* Enhanced PWA features
### v5.0 (Q4 2025) — QuantumResistant Edition ### v5.0 (Q4 2025) — QuantumResistant Edition
@@ -194,6 +258,7 @@ open http://localhost:8000
* Mesh networking topology * Mesh networking topology
* Group Lightning payments * Group Lightning payments
* Anonymous group administration * Anonymous group administration
* Group file sharing
### v6.0 (2027) — Decentralized Network ### v6.0 (2027) — Decentralized Network
@@ -211,12 +276,26 @@ open http://localhost:8000
``` ```
securebit-chat/ securebit-chat/
├── index.html # Main application ├── index.html # Main application
├── manifest.json # PWA manifest
├── sw.js # Service worker
├── browserconfig.xml # Browser configuration for PWA
├── src/ ├── src/
│ ├── components/ui/ # React UI components │ ├── components/ui/ # React UI components
│ │ ├── DownloadApps.js # PWA download/install component
│ │ ├── FileTransfer.js # File transfer UI component
│ │ └── ... # Other UI components
│ ├── crypto/ # Cryptographic utilities │ ├── crypto/ # Cryptographic utilities
│ ├── network/ # WebRTC P2P manager │ ├── network/ # WebRTC P2P manager
│ ├── session/ # Payment session manager │ ├── session/ # Payment session manager
│ ├── transfer/ # File transfer system
│ │ └── EnhancedSecureFileTransfer.js # Secure P2P file transfer
│ ├── pwa/ # PWA management
│ │ ├── install-prompt.js # PWA installation prompts
│ │ ├── offline-manager.js # Offline mode management
│ │ └── pwa-manager.js # PWA lifecycle management
│ └── styles/ # CSS styling │ └── styles/ # CSS styling
│ ├── pwa.css # PWA-specific styles
│ └── ... # Other stylesheets
├── logo/ # Wallet logos and icons ├── logo/ # Wallet logos and icons
├── docs/ # Documentation ├── docs/ # Documentation
└── README.md # This file └── README.md # This file
@@ -225,10 +304,13 @@ securebit-chat/
### Technology Stack ### Technology Stack
* **Frontend:** Pure JavaScript + React (via CDN) * **Frontend:** Pure JavaScript + React (via CDN)
* **PWA:** Service Workers + Cache API + Web App Manifest + Install Prompts
* **Cryptography:** Web Crypto API + custom ECDH/ECDSA * **Cryptography:** Web Crypto API + custom ECDH/ECDSA
* **Network:** WebRTC P2P Data Channels * **Network:** WebRTC P2P Data Channels
* **File Transfer:** Enhanced secure P2P streaming with chunked encryption
* **Payments:** Lightning Network via WebLN * **Payments:** Lightning Network via WebLN
* **Styling:** TailwindCSS + custom CSS * **Offline Support:** Smart caching with offline-manager
* **Styling:** TailwindCSS + custom CSS + PWA-specific styles
### Development Setup ### Development Setup
@@ -255,6 +337,8 @@ python -m http.server 8000
* ✅ Internal cryptographic review completed * ✅ Internal cryptographic review completed
* ✅ P2P protocol security analysis completed * ✅ P2P protocol security analysis completed
* ✅ File transfer security validation completed
* ✅ MITM and replay attack resistance verified
* 🔄 Professional security audit planned Q3 2025 * 🔄 Professional security audit planned Q3 2025
* 🔄 Postquantum cryptography review for v5.0 * 🔄 Postquantum cryptography review for v5.0
@@ -265,11 +349,13 @@ Contact: **[SecureBitChat@proton.me](mailto:SecureBitChat@proton.me)**
### Security Features ### Security Features
* Perfect Forward Secrecy — Past messages secure even if keys compromised * Perfect Forward Secrecy — Past messages and files secure even if keys compromised
* Outofband verification — Prevents maninthemiddle attacks * Outofband verification — Prevents maninthemiddle attacks
* Traffic obfuscation — Defeats network analysis * Traffic obfuscation — Defeats network analysis
* Memory protection — No persistent storage of sensitive data * Memory protection — No persistent storage of sensitive data
* Session isolation — Complete cleanup between sessions * Session isolation — Complete cleanup between sessions
* File integrity — SHA-384 hash validation prevents tampering
* Chunked encryption — Individual encryption per file block
--- ---
@@ -279,15 +365,18 @@ Contact: **[SecureBitChat@proton.me](mailto:SecureBitChat@proton.me)**
* Connection setup: < 3 seconds * Connection setup: < 3 seconds
* Message latency: < 100 ms (P2P direct) * Message latency: < 100 ms (P2P direct)
* File transfer speed: Up to 5 MB/s per connection
* Throughput: Up to 1 MB/s per connection * Throughput: Up to 1 MB/s per connection
* Memory usage: < 50 MB for active session * Memory usage: < 50 MB for active session
* Battery impact: Minimal (optimized WebRTC) * Battery impact: Minimal (optimized WebRTC)
* PWA install size: < 2 MB
### Scalability ### Scalability
* Concurrent connections: Limited by device capabilities * Concurrent connections: Limited by device capabilities
* Message size: Up to 2000 characters * Message size: Up to 2000 characters
* File transfer: Planned for v4.5 * File size: Up to 100 MB per file
* File types: All formats supported
* Group size: Up to 8 participants (v5.5) * Group size: Up to 8 participants (v5.5)
--- ---
@@ -322,8 +411,9 @@ We welcome contributions from the community!
* 🔐 Cryptography — Security improvements and audits * 🔐 Cryptography — Security improvements and audits
* 🌐 Network — P2P optimization and reliability * 🌐 Network — P2P optimization and reliability
* ⚡ Lightning — Payment integration enhancements * ⚡ Lightning — Payment integration enhancements
* 🎨 UI/UX — Interface improvements and accessibility * 📂 File Transfer — EnhancedSecureFileTransfer improvements
* 📱 Mobile — PWA and mobile optimizations * 📱 PWA — Install prompts, offline management, and PWA lifecycle
* 🎨 UI/UX — Interface improvements, FileTransfer and DownloadApps components
* 📚 Documentation — Guides, tutorials, translations * 📚 Documentation — Guides, tutorials, translations
### Development Guidelines ### Development Guidelines
@@ -332,6 +422,7 @@ We welcome contributions from the community!
* Add tests for new features * Add tests for new features
* Update documentation * Update documentation
* Respect securityfirst principles * Respect securityfirst principles
* Test PWA functionality across devices
--- ---
@@ -351,60 +442,78 @@ We welcome contributions from the community!
--- ---
⚠️ Important Disclaimers ## ⚠️ Important Disclaimers
Security Notice
### Security Notice
While SecureBit.chat implements military-grade cryptography and follows security best practices, no communication system is 100% secure. Users should: While SecureBit.chat implements military-grade cryptography and follows security best practices, no communication system is 100% secure. Users should:
Always verify security codes out-of-band * Always verify security codes out-of-band
Keep devices and browsers updated * Keep devices and browsers updated
Be aware of endpoint security risks * Be aware of endpoint security risks
Use reputable Lightning wallets * Use reputable Lightning wallets
* **File transfers are protected with the same military-grade cryptography as chat messages**
Legal Notice ### Legal Notice
This software is provided "as is" for educational and research purposes. Users are responsible for compliance with local laws and regulations regarding: This software is provided "as is" for educational and research purposes. Users are responsible for compliance with local laws and regulations regarding:
Cryptographic software usage * Cryptographic software usage
Private communications * Private communications
Bitcoin/Lightning Network transactions * Bitcoin/Lightning Network transactions
* File sharing and transfer
Privacy Statement ### Privacy Statement
SecureBit.chat: SecureBit.chat:
Collects zero data - no analytics, tracking, or telemetry * Collects zero data - no analytics, tracking, or telemetry
Stores nothing - all data exists only in browser memory * Stores nothing - all data exists only in browser memory
Requires no registration - completely anonymous usage * Requires no registration - completely anonymous usage
Uses no servers - direct P2P connections only * Uses no servers - direct P2P connections only
* **Files are transferred directly P2P with zero server storage**
---
🎯 Why Choose SecureBit.chat? ## 🎯 Why Choose SecureBit.chat?
For Privacy Advocates
True zero-knowledge architecture ### For Privacy Advocates
Military-grade encryption standards
Complete anonymity and untraceability
Resistance to censorship and surveillance
For Bitcoin/Lightning Users * True zero-knowledge architecture
* Military-grade encryption standards
* Complete anonymity and untraceability
* Resistance to censorship and surveillance
* **Secure P2P file sharing without servers**
Native Lightning Network integration ### For Bitcoin/Lightning Users
Sustainable pay-per-session model
Support for all major Lightning wallets
No KYC or account requirements
For Developers * Native Lightning Network integration
* Sustainable pay-per-session model
* Support for all major Lightning wallets
* No KYC or account requirements
100% open source transparency ### For Mobile Users
Modern cryptographic standards
Clean, auditable codebase
Extensible modular architecture
For Everyone * **Progressive Web App installation**
* **Offline mode support**
* **Native app experience without app stores**
* **Works on all modern mobile devices**
No installation required ### For Developers
Works on all modern devices
Intuitive user interface
Professional security standards
* 100% open source transparency
* Modern cryptographic standards
* Clean, auditable codebase
* Extensible modular architecture
* **PWA best practices implementation**
### For Everyone
* **Install like native apps**
* **Works offline with session persistence**
* Works on all modern devices
* Intuitive user interface
* Professional security standards
* **Secure file transfers included**
---
<div align="center"> <div align="center">
@@ -414,4 +523,8 @@ Professional security standards
**Report vulnerabilities:** SecureBitChat@proton.me **Report vulnerabilities:** SecureBitChat@proton.me
---
**Latest Release: v4.01.222** — PWA & Secure File Transfer
</div> </div>