Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/gabfl/vault

Python password manager
https://github.com/gabfl/vault

password-manager python3 secrets-management sqlite3

Last synced: 8 days ago
JSON representation

Python password manager

Host: GitHub
URL: https://github.com/gabfl/vault
Owner: gabfl
License: mit
Created: 2017-06-23T23:47:27.000Z (over 7 years ago)
Default Branch: main
Last Pushed: 2024-01-15T03:37:47.000Z (10 months ago)
Last Synced: 2024-04-16T02:12:31.373Z (7 months ago)
Topics: password-manager, python3, secrets-management, sqlite3
Language: Python
Size: 1.62 MB
Stars: 180
Watchers: 13
Forks: 47
Open Issues: 1
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

        # Vault

[![Pypi](https://img.shields.io/pypi/v/pyvault.svg)](https://pypi.org/project/pyvault)

[![Build Status](https://github.com/gabfl/vault/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/gabfl/vault/actions)

[![codecov](https://codecov.io/gh/gabfl/vault/branch/main/graph/badge.svg)](https://codecov.io/gh/gabfl/vault)

[![MIT licensed](https://img.shields.io/badge/license-MIT-green.svg)](https://raw.githubusercontent.com/gabfl/vault/main/LICENSE)

Vault is a simple Python password manager. It allows you to securely save secrets with a simple CLI interface.

## Features

 - Secrets are stored in an encrypted SQLite database with [SQLCipher](https://www.zetetic.net/sqlcipher/)

 - Within the database, each password and notes are encrypted with a unique salt using AES-256 encryption with [pycryptodome](http://legrandin.github.io/pycryptodome/)

 - Master key is hashed with a unique salt

 - Possibility to create an unlimited number of vaults

 - Clipboard cleared automatically

 - Automatic vault locking after inactivity

 - Password suggestions with [password-generator-py](https://github.com/gabfl/password-generator-py)

 - Import / Export in Json

## Basic usage

![Demo](https://github.com/gabfl/vault/blob/main/img/demo.gif?raw=true)

## Installation and setup

Vault 2.x requires `sqlcipher` to be installed on your machine.

### MacOS

On MacOS, you can install `sqlcipher` with [brew](https://brew.sh/):

```bash

brew install sqlcipher

# Install sqlcipher3

SQLCIPHER_VERSION="0.5.3"

pip3 install sqlcipher3==$SQLCIPHER_VERSION

# If you are getting an error "Failed to build sqlcipher3", you would need to fix the build flags:

SQLCIPHER_PATH="$(brew --cellar sqlcipher)/$(brew list --versions sqlcipher | tr ' ' '\n' | tail -1)"

C_INCLUDE_PATH=$SQLCIPHER_PATH/include LIBRARY_PATH=$SQLCIPHER_PATH/lib pip3 install sqlcipher3==$SQLCIPHER_VERSION

```

Then install the vault:

```bash

pip3 install pyvault

# Run setup

vault

```

### Ubuntu / Debian

On Ubuntu/Debian, you can install `sqlcipher` with apt:

```bash

sudo apt update

sudo apt install -y gcc python3-dev libsqlcipher-dev xclip

```

Then install the vault:

```bash

pip3 install pyvault

# Run setup

vault

```

### Using Docker

```bash

# Pull the image

docker pull gabfl/vault

# Create local directory

mkdir ~/.vault

# Launch image

docker run -v ~/.vault:/root/.vault -ti gabfl/vault

```

### Cloning the project

```bash

# Clone project

git clone https://github.com/gabfl/vault && cd vault

# Installation

pip3 install .

# Run setup

vault

```

## Advanced settings:

```

usage: vault [-h] [-t [CLIPBOARD_TTL]] [-p [HIDE_SECRET_TTL]]

             [-a [AUTO_LOCK_TTL]] [-v VAULT_LOCATION] [-c CONFIG_LOCATION]

             [-k] [-i IMPORT_ITEMS] [-x EXPORT] [-f [{json}]] [-e]

optional arguments:

  -h, --help            show this help message and exit

  -t [CLIPBOARD_TTL], --clipboard_TTL [CLIPBOARD_TTL]

                        Set clipboard TTL (in seconds, default: 15)

  -p [HIDE_SECRET_TTL], --hide_secret_TTL [HIDE_SECRET_TTL]

                        Set delay before hiding a printed password (in

                        seconds, default: 15)

  -a [AUTO_LOCK_TTL], --auto_lock_TTL [AUTO_LOCK_TTL]

                        Set auto lock TTL (in seconds, default: 900)

  -v VAULT_LOCATION, --vault_location VAULT_LOCATION

                        Set vault path

  -c CONFIG_LOCATION, --config_location CONFIG_LOCATION

                        Set config path

  -k, --change_key      Change master key

  -i IMPORT_ITEMS, --import_items IMPORT_ITEMS

                        File to import credentials from

  -x EXPORT, --export EXPORT

                        File to export credentials to

  -f [{json}], --file_format [{json}]

                        Import/export file format (default: 'json')

  -e, --erase_vault     Erase the vault and config file

```