Skip to content

README.md

Latest commit

 

History

History
128 lines (103 loc) · 3.78 KB

README.md

File metadata and controls

128 lines (103 loc) · 3.78 KB
Raw

ViperVault - Secure and Private Password Manager

app-logo

🛡️ Requirements

  • Secure random password and passphrase generator
  • Management of:
    • Passwords
    • Passkeys (WebAuthn compatible)
    • Notes
    • Credit cards
    • ID cards
    • Driver's licenses
    • Passports
    • Bank accounts
    • Wi-Fi credentials
    • SSH keys
    • Crypto wallets
  • Multi-vault support
  • Master key unlock system
  • Secure and automatic backup system (local/exportable/cloud)
  • Secure and automatic synchronization between devices
  • Multifactor authentication system (2FA, biometrics, passkey)
  • Full biometric authentication (fingerprint and facial recognition)
  • Optional dark web monitoring (e.g. HaveIBeenPwned API)

🏗️ Architecture

  • Core logic written in Rust for maximum security, performance, and auditability
  • Native apps in Kotlin (Android) and Swift (iOS)
  • Fully degoogled (no Google Play Services, Firebase, etc.) for maximum privacy
  • Modular, maintainable, and privacy-preserving design
  • Verified and tested for cryptographic correctness

🔐 Security

  • End-to-end encryption (E2EE)
  • Zero-knowledge encryption architecture
  • Master key for unlocking vaults
  • Two-factor authentication (TOTP/HOTP)
  • Biometric authentication (FaceID/TouchID/fingerprint)
  • Secure backup (encrypted export/local/cloud)
  • Secure synchronization (E2EE over TLS)
  • Key derivation via Argon2id (OWASP recommended)
  • Use of well-audited primitives (Argon2id, XChaCha20-Poly1305)

💡 UI & UX

  • Clean, intuitive and minimal user interface
  • Fast and responsive design
  • Modern aesthetics
  • Offline-first with graceful sync fallback

🧪 Development Setup

💻 Tech Stack

  • Core: Rust
  • Android app: Kotlin
  • iOS app: Swift
  • Secure storage: platform-native secure storage (Keychain / EncryptedSharedPreferences)
  • Crypto engine: bindings to core library (Rust)
  • Biometrics: Fingerprint / FaceID support
  • 2FA: Custom implementation (no Google dependencies)
  • Passkeys: WebAuthn compatible (verify platform support)
  • Backup/sync: WebDAV or end-to-end encrypted blob sync (custom API)

🧪 Testing

  • Unit testing: native frameworks + Rust tests for core
  • Integration/E2E: platform-native tools

📦 Package & Dependency Management

  • Android: Gradle
  • iOS: Swift Package Manager / CocoaPods
  • Core: Cargo (Rust)

🔧 Tooling

  • IDEs: Android Studio / Xcode / VSCode / RustRover for core
  • Emulators: Android Studio / Xcode simulators
  • Git + GitHub

🛡️ Privacy & Compliance

  • Zero-knowledge by design: no user secrets leave the device
  • No third-party trackers, analytics, or remote logging
  • Open source auditability and reproducibility
  • GDPR compliant
  • OWASP security best practices
  • NIST-recommended cryptographic algorithms
  • NIS2 compliance considerations

Note

Privacy is a core principle. No user data is collected or shared. All encryption/decryption happens locally on the device. For better understanding, refer to the Security section and to the Threat Model.

📝 To-do:

Note

The to-do list is maintained in the Backlog & Sprints file.

🧰 Tech Stack

  • Core library in Rust for performance and security
  • Android app in Kotlin
  • iOS app in Swift
  • End-to-end encryption, local-first storage, and modern UX

📄 License

This project is licensed under the AGPLv3 license.
See the LICENSE file for full license information.

👤 Authors

  • Emanuele Relmi – Development, UI/UX, Security
    GitHub: Kirito-Emo