Password Manager

Password Manager is a backend service in the Vault Web ecosystem for securely storing, managing, and retrieving passwords.
It provides APIs for creating, updating, deleting, and retrieving passwords and categories, similar to a secure digital vault.

This service is designed to integrate seamlessly with Vault Web, sharing its PostgreSQL database and pgAdmin setup.

---

Features

• 🔹 CRUD operations for passwords and categories
• 🔹 Secure storage of encrypted passwords
• 🔹 Tenant-aware storage keyed to the authenticated Vault Web user
• 🔹 Access via JWT authentication using Vault Web's master key
• 🔹 REST API for integration with web or mobile apps

---

Project Structure

• Backend implemented in Spring Boot
• Uses PostgreSQL from the Vault Web repository for persistent storage
• See DIRECTORY.md for full project structure

---

Local Development

Password Manager relies on the Vault Web Docker environment for PostgreSQL and pgAdmin.
Important: Make sure Vault Web is running before starting the Password Manager backend.

---

1. Clone the Repository

git clone https://github.com/Vault-Web/password-manager.git
cd password-manager

2. Configure Encryption Secret Key

The backend service requires an Encryption Secret Key (as the ENCRYPTION_SECRET environment variable) to securely encrypt and decrypt passwords.

A. Generate the Key

openssl rand -base64 32
# Example output: Xl+KB4QGMbXxibMipcajAP3ET8OITa7JLF3v+lSeMts=

B. Set the Key as an Environment Variable

You must set this key in your current shell session. Important: After closing the terminal or restarting your computer, the key will be gone and must be set again.

Linux / macOS:

export ENCRYPTION_SECRET="<Your-generated-Base64-key>"

Windows (CMD):

set ENCRYPTION_SECRET="<Your-generated-Base64-key>"

⚠️ Replace with the value you generated in step A.

⚠️ Make sure PostgreSQL from the Vault Web Docker setup is running before starting Cloud Page. Run docker compose up -d in the Vault Web repository if not already running. The database credentials are inherited from the Vault Web .env setup. Do not use production secrets during local development.

3. Start the backend

The backend runs on port 8091 (can be changed in application.properties). Make sure the Vault Web Docker stack is already running (PostgreSQL & pgAdmin).

./mvnw spring-boot:run

IntelliJ / IDE Note:

If you start the application directly via your IDE (e.g., IntelliJ IDEA), you must add the ENCRYPTION_SECRET key in the Run/Debug Configurations under the Environment Variables section, as the IDE does not automatically use shell variables.

Then visit:

• API Base: http://localhost:8091
• Swagger UI: http://localhost:8091/swagger-ui.html

Notes

• This service depends on Vault Web for database and authentication.
• JWT tokens must use the same master key as Vault Web.

Questions?

For any issues, feel free to open an issue in this repository. Integration or usage questions related to Vault Web should reference the main Vault Web documentation.