Dark Matter - Simple Vault CLI Utility with GPG Encryption

Dark Matter is a command-line tool for secure file management using GPG encryption. It provides a robust way to vault, manage, and track encrypted files while maintaining security through GPG key verification.

Features

• Secure file storage with GPG encryption
• File versioning and tracking
• Easy file management (add, update, remove, export)
• Secret management (add, update, remove, list, show)
• Key verification and diagnostics
• SQLite-based database for file tracking
• Command-line interface for all operations

Prerequisites

• GPG (GnuPG) installed and configured
• A valid GPG key pair
• Rust development environment (for building from source)

Installation

1. Clone the repository:

   git clone <repository-url>
   cd dark-matter

2. Install GPG dependencies:

   sudo apt-get install libgpgme-dev

3. Build the project using Cargo:

   cargo build --release

4. The binary will be available in target/release/dark-matter.

Usage

Initialize Vault

Before using Dark Matter, you need to initialize it with your GPG key hash:

1. Get a list of GPG keys:

   gpg --list-keys

2. Create a GPG key if you don't have one:

   gpg --full-generate-key

3. Validate your GPG key:

   dark-matter keys validate <key-hash>

4. Initialize the vault:

   mkdir vault
   cd vault
   dark-matter init <key-hash>

The key hash can be obtained from your GPG keyring. This creates a new vault and configures Dark Matter for use with your key.

---

File Management

Add a File

To add a new file to the vault:

dark-matter file add <filename>

The file will be encrypted using your GPG key and stored in the vault.

List Files

View all files in the vault:

dark-matter file list

Update a File

Update an existing file in the vault:

dark-matter file update <filename>

This creates a new encrypted version of the file while maintaining version history.

Remove a File

Remove a file from the vault:

dark-matter file remove <filename>

Export a File

Export a file from the vault (decrypts the file to its original path):

dark-matter file export <filename>

To export to the current directory:

dark-matter file export <filename> --relative

To skip confirmation for overwriting files:

dark-matter file export <filename> --yes

---

Secret Management

Add a Secret

To add a new secret to the vault:

dark-matter secret add <name> <value> --tags <tag1,tag2>

• <name>: The name of the secret.
• <value>: The value of the secret.
• --tags: Optional tags for categorizing the secret (comma-separated).

Example:

dark-matter secret add "api_key" "12345" --tags "production,api"

List Secrets

To list all secrets in the vault:

dark-matter secret list

To filter secrets by tags:

dark-matter secret list --tags <tag1,tag2>

Example:

dark-matter secret list --tags "production"

Update a Secret

To update an existing secret in the vault:

dark-matter secret update <name> <new_value> --tags <tag1,tag2>

• <name>: The name of the secret to update.
• <new_value>: The new value for the secret.
• --tags: Optional tags for categorizing the secret (comma-separated).

Example:

dark-matter secret update "api_key" "67890" --tags "staging"

Remove a Secret

To remove a secret from the vault:

dark-matter secret remove <name>

Example:

dark-matter secret remove "api_key"

Show a Secret

To display the value of a secret:

dark-matter secret show <name>

Example:

dark-matter secret show "api_key"

---

Key Diagnostics

Verify GPG key configuration and system status:

dark-matter keys validate <key-hash>

---

Error Handling

Dark Matter provides detailed error messages for common issues:

• Database not found or already exists
• File not found or already exists
• Secret not found or already exists
• GPG key verification failures
• Database operation errors
• I/O errors

---

Security Considerations

• All files and secrets are encrypted using GPG.
• Key verification is performed for all operations.
• The database is protected against unauthorized access.
• Original files should be securely deleted after adding them to the vault.

---

License

This software is provided under a dual license:

1. Source-Available Evaluation License (Default)

   • Allows viewing and personal, non-commercial evaluation.
   • No modification, redistribution, or commercial use permitted.

2. Commercial License (By Agreement)

   • Required for commercial use, modifications, or redistribution.
   • Contact the author for licensing terms.

See LICENSE.txt for complete terms.

---

Contact

For commercial licensing inquiries or technical support:

• Author: Alexey Nikandrov
• Email: [email protected]

---

Contributing

As this is a proprietary, source-available project, contributions are not accepted without prior agreement. Please contact the author for collaboration opportunities.