vault

README

Vault

Vault is a self-hosted project that allows you to store sensitive text in a secure way. It uses Argon2 for password hashing and key derivation and encrypts the data symmetrically with AES-256, the user's password is not saved at all, only the encrypted data with the generated salt. I wouldn't recommend using it in a real production environment but it's useful for keeping your secrets (or diary) safe from the general public.

Getting Started

Manually

• Get Go
• (Optional) Get Taskfile
• Open a terminal and run:

git clone https://github.com/DarkCeptor44/vault.git
cd vault


# without Taskfile
go build .
./vault # if on Windows, use .\vault.exe

# with Taskfile
task

Docker

You can find a Docker image here:

docker run -d --name vault -p 8080:8080 -v ./data:/app/documents -v /etc/localtime:/etc/localtime:ro --restart unless-stopped darkceptor44/vault

Or build it yourself:

docker build -t vault . --no-cache
docker run -d --name vault -p 8080:8080 -v ./data:/app/documents -v /etc/localtime:/etc/localtime:ro --restart unless-stopped vault

Docker Compose

You can find a compose.yml file here:

services:
  vault:
    image: darkceptor44/vault:latest
    container_name: vault
    ports:
      - 8080:8080
    environment:
      - HOST=0.0.0.0  # optional
      - PORT=8080  # optional unless using a different port
      - DOCKER=yes  # optional
      - DEBUG=yes  # if debug needed
    volumes:
      - ./data:/app/documents # where data will be stored
      - /etc/localtime:/etc/localtime:ro # for correct timezone when logging
    restart: unless-stopped

Environment Variables

If needed you can make a .env file in the root of the repo and put some env variables in there, the following are supported:

Variable	Description	Default
HOST	Host the server binds to	0.0.0.0
PORT	Port the server listens on	8080
DOCKER	Tells the server it's running in a Docker container	yes if built the image with provided Dockerfile
DEBUG	Tells the server to print debug messages, requests and to enable pprof	no

Disclaimer

• This project was made for personal use and learning purposes, there could be vulnerabilities.
• Since the user's password is not saved it is up to the user to choose a secure password and if anything happens (say it refuses to decrypt) the data is lost.
• This project was made mostly in a private self-hosted Git instance and that's why there are only a few commits.

License

This project is licensed under the GNU General Public License v3.0 (GPLv3), you can check the license here: LICENSE.

Documentation

Overview

*

• Vault: Vault for encrypted text storage
• Copyright (C) 2024 DarkCeptor44 *
• This program is free software: you can redistribute it and/or modify
• it under the terms of the GNU General Public License as published by
• the Free Software Foundation, either version 3 of the License, or
• (at your option) any later version. *
• This program is distributed in the hope that it will be useful,
• but WITHOUT ANY WARRANTY; without even the implied warranty of
• MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
• GNU General Public License for more details. *
• You should have received a copy of the GNU General Public License
• along with this program. If not, see <https://www.gnu.org/licenses/>.