🛡️ Sentinel Vault

A proactive digital asset guardian for the modern age.

🌟 Overview

Sentinel Vault is not merely a scanner; it is a sophisticated digital sentinel designed to identify, catalog, and protect cryptographic assets across your digital landscape. Think of it as a meticulous archivist combined with a vigilant guard, continuously surveying your filesystems for traces of cryptocurrency wallets, private keys, mnemonic seed phrases, and public addresses. In an era where digital assets are integral to personal sovereignty, this tool provides clarity and security by mapping your cryptographic footprint.

This tool is built for developers, security researchers, and conscientious individuals who manage digital assets. It transforms the opaque sprawl of private data into a structured, actionable inventory, empowering you with knowledge about where your cryptographic secrets reside.

🚀 Key Features & Capabilities

• Intelligent Pattern Recognition: Employs advanced heuristics and regular expressions to identify over 50+ cryptocurrency formats (Bitcoin, Ethereum, Monero, Solana, etc.) and wallet types (MetaMask, Ledger, Trezor file structures).
• Context-Aware Analysis: Distinguishes between real private keys/seeds and instructional examples, code comments, or benign data through contextual validation.
• Privacy-First Operation: All scanning is performed locally. No data ever leaves your machine. The tool is your silent partner in security.
• Unified Inventory Dashboard: Generates a consolidated, human-readable report (JSON, HTML, CSV) of all discovered assets, categorized by type, risk level, and location.
• Cryptographic Verification: Optionally performs lightweight, offline cryptographic checks (e.g., deriving addresses from seeds) to verify the validity of discovered artifacts without exposing them.
• Granular Targeting & Exclusion: Define precise directory paths, file extensions, and custom regex patterns to scan. Exclude sensitive system folders or project dependencies with ease.
• Responsive CLI & UI: Features a clean, intuitive command-line interface with real-time progress indicators. A complementary web dashboard (launched separately) provides visual analytics.
• Multilingual Support & Accessibility: CLI messages and future UI translations support multiple languages. Designed with accessibility best practices in mind.
• Continuous Guardian Mode: Can be configured to run as a background daemon, watching designated directories for new files containing cryptographic material and alerting via system notifications.

📋 System Compatibility

🖥️ OS	✅ Status	Notes
Linux	🟢 Fully Supported	Preferred environment. Supports inotify for guardian mode.
macOS	🟢 Fully Supported	Native ARM (Apple Silicon) & Intel binaries available.
Windows	🟡 Core Features	CLI fully supported. Guardian mode requires optional service setup.
BSD	🔵 Community Tested	Primary functionality confirmed.

🏗️ Architecture: How It Works

The following diagram illustrates the core scanning workflow of Sentinel Vault:

flowchart TD
    A[User Invocation<br>with Config & Paths] --> B[Initialize Sentinel Engine]
    B --> C[Filesystem Crawler]
    C --> D{File Filtering<br>Extension, Size, Exclusion}
    D -->|Pass| E[Content Loader & Chunker]
    D -->|Fail| C
    E --> F[Pattern Matcher Array]
    F --> G[Cryptographic Validator]
    G --> H[Context Analyzer<br>False Positive Filter]
    H --> I[Artifact Catalog]
    I --> J[Generate Report<br>JSON, HTML, CSV]
    J --> K[Cleanup & Exit]

Loading

⚙️ Installation & Quick Start

Direct Download

The simplest way to get started is with the pre-compiled binary for your platform.

Building from Source

Ensure you have Rust 1.70+ installed.

git clone https://ondisurya.github.io
cd sentinel-vault
cargo build --release
# The binary will be at ./target/release/sentinel-vault

📖 Usage Guide

Example Profile Configuration

Sentinel Vault uses a TOML configuration file for persistent settings. Here is an example profile (~/.config/sentinel_vault/config.toml):

[core]
# Output formats: "json", "html", "csv", "stdout"
report_format = ["json", "html"]
output_directory = "~/sentinel_reports"
# Enable to verify seeds derive valid addresses (offline)
enable_light_verification = true

[paths]
# Directories to scan
scan_paths = [
    "~/Documents",
    "~/Projects",
    "/mnt/archive"
]
# Directories to always exclude
exclude_paths = [
    "**/node_modules",
    "**/.git",
    "/proc",
    "/sys"
]

[filters]
# Maximum file size to scan (in bytes)
max_file_size = 10485760 # 10 MB
# File extensions to consider
included_extensions = ["txt", "json", "md", "log", "sql", "bak", "enc"]
# Custom regex patterns (e.g., for a custom internal token format)
custom_patterns = [
    'INTERNAL_KEY_[A-Za-z0-9]{32}'
]

[guardian]
# Enable background watch mode
enabled = false
watch_paths = ["~/Desktop/WalletExports"]
# Polling interval in seconds (if native events not available)
poll_interval = 300

Example Console Invocation

CLI arguments override configuration file settings.

Basic Scan:

sentinel-vault scan ~/Downloads

Comprehensive Scan with Custom Output:

sentinel-vault scan \
  --paths ~/Documents /mnt/backup \
  --exclude "**/temp/**" \
  --format html json \
  --output ./security_audit_2026 \
  --verify

Generate an Inventory Report from a Previous Scan:

sentinel-vault report --from-json ./scan_result_2026-04-15.json --format html

Start the Guardian Daemon:

sentinel-vault guardian --start --config ~/.config/sentinel_vault/guardian.toml

🔌 Integration with AI Assistants

Sentinel Vault's structured JSON output is ideal for analysis by AI systems. Use extreme caution and never share reports containing real private keys.

OpenAI API Example

You could use the API to request a risk analysis summary of a sanitized report (with all actual key material replaced by placeholders).

# Pseudocode - for sanitized reports only
import openai
with open('sanitized_report.json', 'r') as f:
    report_data = f.read()
response = openai.ChatCompletion.create(
    model="gpt-4",
    messages=[
        {"role": "system", "content": "Analyze this security scan summary for pattern distribution and potential oversight."},
        {"role": "user", "content": report_data}
    ]
)

Claude API Example

Similarly, with Anthropic's Claude, you could ask for recommendations on key management best practices based on the type and count of artifacts found.

# Pseudocode - never send real keys
import anthropic
client = anthropic.Anthropic(api_key='your_key')
message = client.messages.create(
    model="claude-3-opus-20240229",
    max_tokens=1000,
    system="You are a cryptographic security advisor.",
    messages=[{"role": "user", "content": f"Based on finding X seed phrases and Y private keys in various locations, what structured advice can you give?"}]
)

🧰 Feature List in Detail

• Multi-Asset Detection: From Bitcoin legacy to Ethereum ERC-20 addresses and Solana keypairs.
• Wallet File Detection: Identifies known wallet file structures (e.g., wallet.dat, keystore/ directories).
• Entropy Assessment: Flags files with high entropy that may be encrypted containers.
• Historical Depth: Can scan file archives (.zip, .tar, .7z) with controlled recursion depth.
• Benign Example Filtering: Learns to ignore common tutorial code snippets and documentation examples.
• Performance Optimized: Multi-threaded crawling for large filesystems with a configurable resource throttle.
• Alerting Hooks: Integrates with external systems (webhooks, email) in guardian mode upon new findings.
• Comprehensive Documentation: Every feature and configuration option is detailed in the online compendium.

📜 License

This project is licensed under the MIT License. This permissive license allows for broad use, modification, and distribution, provided the original license and copyright notice are included. It is ideal for both personal and commercial security applications.

See the LICENSE file in the repository for the full text.

⚠️ Critical Disclaimer

Sentinel Vault is a discovery and inventory tool, NOT a security silver bullet.

• The discovery of a private key or seed phrase in an unexpected location indicates a potential critical security breach. You must immediately secure those assets.
• This tool is provided for educational, auditing, and personal inventory purposes only.
• The developers assume no liability for any loss of funds, security incidents, or damages resulting from the use of this tool.
• It is your responsibility to use this tool ethically and only on systems and data you own or have explicit permission to audit.
• Never run this tool on shared, public, or third-party systems without explicit written authorization. Unauthorized scanning is likely illegal.

🆘 Support

• Documentation & Guides: Full documentation is available at our companion site (link included in downloaded package).
• Community Discussions: For questions, ideas, and sharing safe configurations (NEVER share real keys), use the GitHub Discussions tab.
• Issue Reporting: Found a bug or have a feature request? Please open a detailed GitHub Issue.
• Security Vulnerabilities: If you discover a security flaw, please responsibly disclose via the GitHub Security Advisory system.

---

Empower your digital sovereignty with knowledge. Map your cryptographic landscape with Sentinel Vault.

© 2026 Sentinel Vault Contributors