AliasVault

[

](https://github.com/lanedirt/OGameX/releases) [

](https://github.com/lanedirt/AliasVault/actions/workflows/docker-compose-build.yml) [

](https://github.com/lanedirt/AliasVault/actions/workflows/dotnet-build-run-tests.yml) [

](https://github.com/lanedirt/AliasVault/actions/workflows/dotnet-integration-tests.yml) [

](https://sonarcloud.io/summary/new_code?id=lanedirt_AliasVault) [

](https://sonarcloud.io/summary/new_code?id=lanedirt_AliasVault)

AliasVault is an open-source password and identity manager built with C# ASP.NET technology. AliasVault can be self-hosted on your own server with Docker, providing a secure and private solution for managing your online identities and passwords. ### What makes AliasVault unique: - **Zero-knowledge architecture**: All data is end-to-end encrypted on the client and stored in encrypted state on the server. Your master password never leaves your device and the server never has access to your data. - **Built-in email server**: AliasVault includes its own email server that allows you to generate virtual email addresses for each identity. Emails sent to these addresses are instantly visible in the AliasVault app. - **Virtual identities**: Generate virtual identities and assign them to a website, allowing you to use different email addresses and usernames for each website. Keeping your online identities separate and secure, making it harder for attackers to link your accounts. - **Open-source**: The source code is available on GitHub and can be self-hosted on your own server. > Note: AliasVault is currently in development and not yet ready for production use. The project is still in the early stages and many features are not yet implemented. You are welcome to contribute to the project by submitting pull requests or opening issues. ## Live demo A live demo of the app is available at [main.aliasvault.net](https://main.aliasvault.net) (nightly builds). You can create a free account to try it out yourself. Screenshot 2024-07-12 at 14 58 29

## Installation on your own machine To install AliasVault on your own machine, follow the steps below. Note: the install process is tested on MacOS and Linux. It should work on Windows too, but you might need to adjust some commands. ### Requirements: - Access to a terminal - Docker - Git ### 1. Clone this repository. ```bash # Clone this Git repository to "AliasVault" directory $ git clone https://github.com/lanedirt/AliasVault.git ``` ### 2. Run the install script. The script checks and creates a .env file with a JWT secret, generates an admin password and manages Docker image building and container initiation. It ensures necessary configurations and services are ready for the application's operation. ```bash # Go to the project directory $ cd AliasVault # Make install script executable $ chmod +x install.sh # Run the install script $ ./install.sh ``` Note: if you do not wish to run the script, you can set up the environment variables and build the Docker image and containers manually instead. See the [manual setup instructions](docs/setup/1-manually-setup-docker.md) for more information. ### 3. AliasVault is ready to use. The script will output the URL where the app is available. You can now open the app in your browser and create an account. > Note: the container binds to port 80 for client and port 8080 for admin by default. If you have another service running on these ports, you can change the AliasVault ports in the `docker-compose.yml` file. #### Note for first time build: - When running the init script for the first time, it may take a few minutes for Docker to download all dependencies. Subsequent builds will be faster. - A SQLite database file will be created in `./database/AliasServerDb.sqlite`. This file will store all (encrypted) password vaults. It should be kept secure and not shared. #### Other useful commands: - To reset the admin password, run the install.sh script with the `--reset-admin-password` flag. - To uninstall AliasVault, make the uninstall script executable with `chmod +x uninstall.sh` first, then run the script: `./uninstall.sh`. This will remove all containers, images, and volumes related to AliasVault. It will keep all files and configuration intact however, so you can easily reinstall AliasVault later. ## Tech stack / credits The following technologies, frameworks and libraries are used in this project: - [C#](https://docs.microsoft.com/en-us/dotnet/csharp/) - A simple, modern, object-oriented, and type-safe programming language. - [ASP.NET Core](https://dotnet.microsoft.com/apps/aspnet) - An open-source framework for building modern, cloud-based, internet-connected applications. - [Entity Framework Core](https://docs.microsoft.com/en-us/ef/core/) - A lightweight, extensible, open-source and cross-platform version of the popular Entity Framework data access technology. - [Blazor WASM](https://dotnet.microsoft.com/apps/aspnet/web-apps/blazor) - A framework for building interactive web UIs using C# instead of JavaScript. It's a single-page app framework that runs in the browser via WebAssembly. - [Playwright](https://playwright.dev/) - A Node.js library to automate Chromium, Firefox and WebKit with a single API. Used for end-to-end testing. - [Docker](https://www.docker.com/) - A platform for building, sharing, and running containerized applications. - [SQLite](https://www.sqlite.org/index.html) - A C-language library that implements a small, fast, self-contained, high-reliability, full-featured, SQL database engine. - [Tailwind CSS](https://tailwindcss.com/) - A utility-first CSS framework for rapidly building custom designs. - [Flowbite](https://flowbite.com/) - A free and open-source UI component library based on Tailwind CSS. - [Konscious.Security.Cryptography](https://github.com/kmaragon/Konscious.Security.Cryptography) - A .NET library that implements Argon2id, a memory-hard password hashing algorithm. - [SRP.net](https://github.com/secure-remote-password/srp.net) - SRP6a Secure Remote Password protocol for secure password authentication. - [SmtpServer](https://github.com/cosullivan/SmtpServer) - A SMTP server library for .NET that is used for the virtual email address feature. - [MimeKit](https://github.com/jstedfast/MimeKit) - A .NET MIME creation and parser library used for the virtual email address feature.