Rusty Vault

Table of Contents

1. Introduction
2. Features
3. Dependencies
4. Usage
   • Menu Options
5. Code Overview
   • Main Loop
   • Add Entry
   • List Entries
   • Search
6. File Structure
7. How to Build and Run
8. Contributing
9. License

---

1. Introduction

Rusty Vault is a command-line password management tool written in Rust. It allows users to securely store and manage their passwords for various services. The manager uses JSON files to store password entries.

2. Features

• Add new password entries with service name, username, and password.
• List all stored entries.
• Search for entries based on service name.
• Securely stores passwords in a JSON file.

3. Dependencies

The project relies on Rust and Cargo for dependency management. Make sure you have Rust and Cargo installed on your system.

4. Usage

To run the program, execute the compiled binary. It will display a menu with options to perform various tasks.

Menu Options

1. Add Entry: Allows the user to add a new password entry by providing the service name, username, and password.
2. List Entries: Displays a list of all stored password entries.
3. Search: Allows the user to search for entries based on the service name.
4. Quit: Exits the program.

5. Code Overview

Main Loop

The main loop presents the menu to the user and handles their input. It dispatches the user's choice to the corresponding functionality.

Add Entry

When the user selects to add a new entry, they are prompted for the service name, username, and password. The entry is then stored in the JSON file.

List Entries

This option reads all entries from the JSON file and displays them in a formatted manner, including the service name, username, and password.

Search

The search option allows the user to input a service name to search for. It then checks all stored entries and displays any that match the search term.

6. File Structure

• main.rs: Contains the main program logic and the main loop.
• pentry.rs: Defines the ServiceInfo struct and its methods for handling password entries.

7. How to Build and Run

To build and run the project, follow these steps:

1. Clone the project from https://github.com/lordofwizard/rusty_vault.git.
2. Navigate to the project directory in the terminal.
3. Run cargo build --release to compile the project.
4. Run ./target/release/rusty_vault to execute the compiled binary.

8. Contributing

If you would like to contribute to this project, feel free to submit pull requests or open issues on the project's repository.

9. License

This project is licensed under the MIT License.