Skip to content

Latest commit

 

History

History
92 lines (53 loc) · 2.15 KB

README.md

File metadata and controls

92 lines (53 loc) · 2.15 KB

OPWM

OPWM, or Offline Password Manager is a complete Dockerized offline application made using PostgreSQL database, FastAPI server and VueJS frontend, for managing password credentials for various websites and applications.

All login passwords (called Master Password in this context) are stored after getting hashed twice (once in the server, and finally in the database).

All passwords are encrypted using logged-in user's master password hash before storage.

All database-level encryption/decryption and hashing are done using the PGCRYPTO extension from PostgreSQL.

Features

  1. Fully integrated frontend

frontend

  1. SwaggerUI documentation for the APIs.

swaggerui

  1. Can be accessed via database management tools such as pgadmin

pgadmin

Setup

After cloning the repository, generate the SECRET_KEY to be used for this application (requires openssl) and copy to clipboard.

openssl rand -hex 30 | xclip -selection clipboard

Copy the .env.example to a new .env file and paste the SECRET_KEY into its corresponding key.

cd /backend

cp .env.example .env

Optionally, you can change the port numbers for the FastAPI server, the database and the Vue application by editing the docker-compose.yml.

Default ports:

database - 5400
backend  - 8000
frontend - 3333

(Optional) To connect to the container database, use the following URL.

psql postgresql://postgres:postgres@localhost:5400/opwm

Test

docker exec -it <CONTAINER-ID> python -m pytest -v tests

Uninstall

To remove the container and all its volumes

docker-compose down --rmi all --volumes --remove-orphans

Note

  • Please note that this is by no means a safe or secure implementation of password managers. There are other well-established software like BitWarden or KeePassXC which provide a much better solution. This was created just to teach myself and showcase the basic structure of an end-to-end password storage software. Use it at your own risk.

Todo

  • Deploy on Heroku
  • Implement better testing functionality