Privacy-first password manager with built-in email aliasing. Fully encrypted and self-hostable.
Update zero-knowledge architecture docs
Leendert de Borst94bad914110b
diff --git a/ARCHITECTURE.md b/ARCHITECTURE.mdindex 6d48f0d6f..5f1228e53 100644--- a/ARCHITECTURE.md+++ b/ARCHITECTURE.md@@ -2,12 +2,17 @@This document provides a high-level overview of the AliasVault architecture, focusing on the encryption algorithms used to ensure the security of user data.## Overview-AliasVault features a [zero-knowledge architecture](https://en.wikipedia.org/wiki/Zero-knowledge_service) and uses a combination of encryption algorithms to protect the data of its users.+AliasVault implements zero-knowledge encryption using a combination of encryption algorithms to protect the privacy of its users.-The basic premise is that the master password chosen by the user upon registration forms the basis for all encryption-and decryption operations. This master password is never transmitted over the network and only resides on the client.-All data is encrypted at rest and in transit. This ensures that even if the AliasVault servers are compromised,-the user's data remains secure.+The basic premise is that the master password chosen by the user upon registration forms the basis for all encryption and decryption operations. This master password is never transmitted over the network and only resides on the client.++### What is Zero-Knowledge Encrypted+- **Vault Data**: Your entire vault (passwords, usernames, notes, passkeys, email addresses, etc.) is fully encrypted client-side before being sent to the server. The server cannot decrypt any vault contents.+- **Email Contents**: When emails are received by the server, their contents are immediately encrypted with your public key (from your vault) before being saved. Only you can decrypt and read these emails with your private key.++*Note: email aliases are stored on the server as "claims" which are linked to internal user IDs for routing purposes.*++This ensures that even if the AliasVault servers are compromised, vault contents and email messages remain secure and unreadable.## Encryption algorithmsThe following encryption algorithms and standards are used by AliasVault:diff --git a/docs/architecture/index.md b/docs/architecture/index.mdindex 3c7d986c8..a5d802e31 100644--- a/docs/architecture/index.md+++ b/docs/architecture/index.md@@ -7,7 +7,13 @@ nav_order: 5# Architecture-AliasVault implements a zero-knowledge architecture where sensitive user data and passwords never leave the client device in unencrypted form. Below is a detailed explanation of how the system secures user data and communications.+AliasVault implements zero-knowledge encryption where sensitive user data never leaves the client device in unencrypted form. Below is a detailed explanation of how the system secures user data and communications.++**What is Zero-Knowledge in AliasVault**:+- **Vault Data** (usernames, passwords, notes, passkeys etc.) is fully encrypted client-side before being sent to the server. The server cannot decrypt any vault contents.+- **Email Contents**: When emails are received by the server, their contents are immediately encrypted with your public key before being saved. Only you can decrypt and read them with your private key.++*Note: email aliases are stored on the server as "claims" which are linked to internal user IDs for routing purposes.*## DiagramThe security architecture diagram below illustrates all encryption and authentication processes used in AliasVault to secure user data and communications.@@ -55,7 +61,7 @@ You can also view the diagram in a browser-friendly HTML format: [AliasVault Sec#### Email Reception Process1. When an email is received, the server:- - Verifies if the recipient has a valid email claim+ - Verifies if the recipient (email address) matches a valid email claim- If no valid claim exists, the email is rejected- If valid, generates a random 256-bit symmetric key- Encrypts the email content using this symmetric key@@ -129,15 +135,17 @@ AliasVault includes a virtual passkey authenticator that implements the WebAuthn- Android support is pending due to limited Android API support## Security Benefits-- Zero-knowledge architecture ensures user data privacy+- Zero-knowledge encryption: entire vault is encrypted client-side before transmission+- Email contents are encrypted with your public key immediately upon receipt by the server- Master password never leaves the client device- All sensitive operations (key derivation, encryption/decryption) happen locally-- Server stores only encrypted data-- Multi-layer encryption for emails provides secure communication+- Server stores only encrypted vault data and encrypted email contents+- Multi-layer hybrid encryption for emails provides secure communication- Optional 2FA adds an additional security layer- Use of established cryptographic standards (Argon2id, AES-256-GCM, RSA/OAEP)- Passkey private keys remain encrypted in vault at all times- Cross-platform passkey sync without compromising security- WebAuthn compliance eliminates phishing risks through domain binding+- No personally identifiable information required for registration-This security architecture ensures that even if the server is compromised, user data remains secure as all sensitive operations and keys remain strictly on the client side.+This security architecture ensures that even if the server is compromised, vault contents and email messages remain secure and unreadable as all sensitive operations and keys remain strictly on the client side. Email aliases (stored on the server as "claims" for routing) are linked to internal user IDs, not real-world identities.diff --git a/docs/index.md b/docs/index.mdindex 9fb7b6ccf..c66ff76ca 100644--- a/docs/index.md+++ b/docs/index.md@@ -30,8 +30,8 @@ AliasVault is a self-hosted password and (email) alias manager that helps you:## Key Features-### Zero-Knowledge Architecture-All data is end-to-end encrypted on the client. Your master password never leaves your device, and the server never has access to your data.+### Zero-Knowledge Encryption+Your entire vault (usernames, passwords, notes, passkeys etc.) is fully encrypted client-side before being sent to the server. Your master password never leaves your device, and the server cannot decrypt any vault contents. When emails are received by the server, they are immediately encrypted with your public key before being saved, ensuring only you can read them. Email aliases themselves are registered on the server as "claims" linked to your account for routing purposes, but no personally identifiable information is required.### Built-in Email ServerGenerate virtual email addresses for each identity. Emails sent to these addresses are instantly visible in the AliasVault app.