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)
• 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
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 Storage

Get list of gpg keys

gpg --list-keys

Create your GPG key

gpg --full-generate-key

Validate your GPG key

dark-matter validate <key-hash>

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

# create dir
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.

Adding Files

To add a new file to vault:

dark-matter add <filename>

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

Listing Files

View all files in vault:

dark-matter list

Updating Files

Update an existing file in vault:

dark-matter update <filename>

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

Removing Files

Remove a file from vault:

dark-matter remove <filename>

Exporting Files

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

dark-matter export <filename>

Diagnostic Tools

Verify GPG key configuration and system status:

dark-matter 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
• GPG key verification failures
• Database operation errors
• I/O errors

Security Considerations

• All files are encrypted using GPG
• Key verification is performed for all operations
• Database is protected against unauthorized access
• Original files should be securely deleted after adding to Dark Matter

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.