VKRScan

VKRScan is a modular Python cybersecurity analysis framework and CLI tool for identifying hidden data, exposed secrets, common web-security weaknesses, and cryptographic/encoding artifacts with evidence-based reporting.

╔══════════════════════════════════════════════════════════════╗
║                           VKRScan                            ║
║              Cybersecurity Analysis Framework                ║
╚══════════════════════════════════════════════════════════════╝

Key Features

• Steganography & Hidden Data Analysis:

  • MIME & magic byte verification, format integrity, and extension mismatch detection.
  • Detection of trailing data appended beyond format EOF markers (PNG, JPEG, BMP, WAV).
  • Metadata extraction (EXIF, GPS identification, PNG chunks, WAV audio parameters).
  • Global and sliding-window Shannon entropy analysis for encrypted/compressed cluster detection.
  • Channel-specific Least Significant Bit (LSB) statistical distribution and anomaly scoring.
  • Printable ASCII/UTF-8 string carving with token recognition (URLs, emails, Base64, CTF flags).

• Secrets & Credential Discovery:

  • High-fidelity pattern engine for AWS, GitHub, GitLab, Google Cloud, Slack, Stripe, Private Keys, Database connection URLs, AI keys (OpenAI, Anthropic), and JWTs.
  • Shannon entropy thresholding to reduce false positives on random strings.
  • Safe-by-default redaction engine preserving prefix/suffix (AKIA************7XYZ).
  • Custom rules support via YAML.

• Authorized Web Security Assessment:

  • Safe checks strictly bounded by mandatory authorization warning banners.
  • Security headers audit (CSP, HSTS, X-Content-Type-Options, X-Frame-Options, Referrer-Policy, Permissions-Policy).
  • Cookie security audit (HttpOnly, Secure, SameSite).
  • TLS/SSL certificate validation, expiration alert, and protocol deprecation checks.
  • Information disclosure identification and conservative sensitive file exposure probes (.env, .git/config, docker-compose.yml, web.config, etc.).
  • Harmless reflected input probe for contextual Cross-Site Scripting (XSS) assessment.
  • Non-destructive SQL injection indicator and database syntax error detection.

• Cryptographic & Encoding Utilities:

  • Multi-format encoding and decoding (Base64, Base64URL, Hex, URL, Unicode, Binary).
  • Heuristic auto-detection of unknown encoded strings.
  • Cryptographic one-way hashing (MD5, SHA-1, SHA-256, SHA-512, SHA-3).
  • File hashing with multi-digest streaming.
  • Safe JSON Web Token (JWT) inspection, claims auditing, and alg: none detection.

• Unified Evidence Collection & Reporting:

  • Standardized Finding and Evidence data models across all scanners.
  • Transparent 0–100 risk scoring with contributor breakdown.
  • Rich terminal user interface with styled tables, progress gauges, and badges.
  • Machine-readable structured JSON export.
  • Standalone, responsive HTML report dashboard.

Ethical & Safe Design

VKRScan is designed for:

• Defensive security analysis
• CTF / lab training environments
• Local system testing
• Systems owned by the user or where explicit testing authorization has been granted

VKRScan does NOT implement credential theft, malware deployment, persistence, destructive exploitation, authentication bypass, or arbitrary third-party automated attacks.

Installation

pip install vkrscan

From Source

git clone https://github.com/vkrscan/vkrscan.git
cd vkrscan
pip install -e .

Quick Start CLI Examples

1. Interactive Cyberpunk Shell

Run VKRScan without arguments or with shell to launch the interactive prompt:

vkrscan
# or
vkrscan shell

Inside the interactive shell:

vkrscan> help
vkrscan> show
vkrscan> set target https://authorized.example
vkrscan> set modules web
vkrscan> run
vkrscan> steg image.png
vkrscan> secrets ./src
vkrscan> jwt <token>
vkrscan> exit

2. Unified Scanner (CLI Mode)

# Auto-detect target and run appropriate modules
vkrscan scan https://authorized.example
vkrscan scan ./my-project-repo
vkrscan scan image.png

# Target specific modules
vkrscan scan ./my-project-repo --modules secrets --format html --output report.html

2. Steganography Analysis

vkrscan steg sample.png
vkrscan steg audio.wav

3. Secrets Scanner

vkrscan secrets ./src
vkrscan secrets ./src --rules examples/custom-rules.yaml

4. Web Security Assessment

vkrscan web https://authorized.example

5. Encoding & Auto-Detection

vkrscan encode base64 "Confidential"
vkrscan decode base64 "Q29uZmlkZW50aWFs"
vkrscan analyze "aGVsbG8gd29ybGQ="

6. Cryptographic Hashing

vkrscan hash "admin"
vkrscan hash-file firmware.bin

7. JWT Inspection

vkrscan jwt eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c

Architecture

Target (URL, Directory, Media, JWT, File)
   ↓
Target Classifier (vkrscan.utils.validators)
   ↓
Scan Engine Coordinator (vkrscan.core.engine)
   ↓
Plugins (BaseScanner)
 ├── Steganography Analyzer
 ├── Secrets Scanner
 ├── Web Security Analyzer
 └── Cryptography Utilities
   ↓
Normalized Finding & Evidence Models
   ↓
Transparent Risk Scoring (0 - 100)
   ↓
Reporters (Terminal UI, JSON, HTML)

Running Tests

Run the test suite with pytest:

pytest -v

With coverage:

pytest --cov=vkrscan --cov-report=term-missing

License

This project is licensed under the MIT License. See LICENSE for details.