SSF Tools Entropy Command - CLI Usage Examples and Unified Configuration¶

Command Line Interface Examples with Dependency Injection¶

The entropy command uses the dependency-injector framework for service management as documented in dependency-injection.md. All commands automatically receive properly configured services through container injection.

Basic Usage Examples¶

# Basic entropy analysis with container-managed services
ssf_tools entropy analyze sample.bin

# Initialize unified configuration file first (recommended)
ssf_tools config init
ssf_tools entropy analyze sample.bin

# Analyze with verbose output (overrides config file setting)
ssf_tools entropy analyze sample.bin --verbose

# Analyze multiple files with JSON output
ssf_tools entropy analyze file1.bin file2.exe file3.dll --results-format json

# Analyze directory recursively with specific config
ssf_tools entropy analyze /path/to/directory --config ./my-ssf-tools-config.yaml

# High-sensitivity scan for compliance auditing
ssf_tools entropy analyze . --output compliance-report.json

# Generate PCI SSF 2.3 compliance report
ssf_tools entropy analyze /workspace --compliance-report --results-format json --output pci-ssf-compliance.json

# Generate compliance report with evidence trail
ssf_tools entropy analyze . --compliance-report --evidence-trail --output compliance-audit.json

Advanced Usage Examples¶

# Create project-specific PCI SSF 2.3 compliant configuration
ssf_tools config init --output ./ssf-tools-config.yaml

# Run PCI SSF 2.3 compliance scan with dedicated compliance reporting
ssf_tools entropy analyze firmware.bin --config ./ssf-tools-config.yaml --compliance-report

# Use default configuration for PCI SSF 2.3 compliance with evidence trail
ssf_tools entropy analyze /workspace --config ~/.config/ssf_tools/ssf-tools-config.yaml --compliance-report --evidence-trail

# Generate executive compliance summary for audit purposes
ssf_tools entropy analyze /production/code --compliance-report --executive-summary --results-format xml --output audit-report.xml

# Memory-constrained analysis (set in config file)
ssf_tools entropy analyze large_dump.bin --config ./ssf-tools-config.yaml

# Offline analysis without network dependencies
ssf_tools entropy analyze suspicious.bin --offline

# Validate configuration before running analysis
ssf_tools config validate ./ssf-tools-config.yaml
ssf_tools entropy analyze /path/to/analyze --config ./project-config.yaml

Content-Aware Analysis Examples¶

# Override file type detection
ssf_tools entropy analyze app.exe --force-file-type windows_pe

# Use project-specific configuration
ssf_tools entropy analyze /var/log --config ./project-config.yaml

# Directory scan with configuration file
ssf_tools entropy analyze /codebase --config ./project-config.yaml

Managing Entropy Information¶

Examine Internal Data Types¶

# List detectable file types
ssf_tools entropy list filetypes

# List content-aware thresholds
ssf_tools entropy list thresholds

# List known crypto-structures
ssf_tools entropy list cryptostructures

# List available wordlists (from Cache)
ssf_tools entropy list wordlists

Update Word Lists¶

# Update cached wordlists
ssf_tools entropy list wordlists