Dosu LogoDosu Logo
Ask
Join our Discord
Organization avatar
libMagic-rsPublic
EvilBit Labs LLC
DocumentslibMagic-rs
chapter_1
chapter_1
Type
External
Status
Published
Created
Feb 28, 2026
Updated
Feb 28, 2026
Source
docs/src/chapter_1.md

Introduction#

DBSurveyor is a security-focused, offline-first database analysis and documentation toolchain designed for security professionals, database administrators, and DevOps teams.

Core Purpose#

Generate comprehensive, secure database schema documentation for PostgreSQL, MySQL, SQLite, and MongoDB databases without compromising security or requiring persistent network connectivity.

Key Features#

  • Dual-Binary Architecture: Separate collector (dbsurveyor-collect) and postprocessor (dbsurveyor) for flexible workflows
  • Multi-Database Support: PostgreSQL, MySQL, SQLite, SQL Server, MongoDB with unified interface
  • Security-First Design: AES-GCM encryption, credential protection, zero telemetry
  • Offline Operation: Complete functionality in air-gapped environments
  • Comprehensive Documentation: HTML, Markdown, JSON outputs with ERD generation

Security Guarantees#

  • NO NETWORK CALLS: Operates completely offline after initial installation, beyond the collector connection to the target database
  • NO TELEMETRY: Zero data collection, usage tracking, or external reporting
  • NO CREDENTIALS IN OUTPUTS: Database credentials never stored in output files
  • AES-GCM ENCRYPTION: Industry-standard authenticated encryption for sensitive outputs
  • AIRGAP COMPATIBLE: Full functionality in air-gapped environments

Target Users#

  • Red Team Operators: Post-compromise database enumeration in contested environments
  • Blue Team Analysts: Auditing unknown systems and inherited databases
  • Database Administrators: Comprehensive documentation and compliance reporting
  • Security Analysts: Database security assessment and risk identification
  • System Administrators: Exploring inherited or legacy databases with minimal documentation
Documents
Architecture
ARCHITECTURE
architecture
CLI Reference
CLI_REFERENCE
compatibility
Compatibility
compatibility
Contributing
ARCHITECTURE
code-style
CONTRIBUTING
development
testing-guidelines
Getting Started
getting-started
GETTING_STARTED
migration
Library API
api-reference
API_REFERENCE
ast-structures
configuration
evaluator
migration
parser
Magic File Format
architecture
magic-examples
MAGIC_FORMAT
migration
Performance
io-performance
Release & CI-CD
release-process
release-verification
testing-guidelines
Troubleshooting
troubleshooting
SUMMARY
architecture
chapter_1
cli-reference
cli-reference
cli-usage
collection
configuration
contributing
database-support
documentation
error-handling
installation
introduction
introduction
json-schema-specification
library-api
magic-format
output
output-formats
performance
quick-start
security
security-assurance
testing
testing
troubleshooting