Module commands

Module commands 

Source
Expand description

Command implementations for analyzing Vault audit logs.

Each module in this package implements a specific analysis command, providing specialized insights into different aspects of Vault usage.

§Command Categories

§Entity Analysis Commands

Track and analyze Vault identity entities across time:

  • entity_analysis - Unified entity lifecycle analysis, creation tracking, and preprocessing
    • entity-analysis churn - Compare entity activity across multiple days to detect churn
    • entity-analysis creation - Identify when entities first appear in logs
    • entity-analysis gaps - Find gaps in entity activity patterns
    • entity-analysis timeline - Visualize entity activity over time
    • entity-analysis preprocess - Extract entity data for external processing
  • entity_list - List all entities found in audit logs
  • entity_creation - ⚠️ DEPRECATED: Use entity-analysis creation instead
  • entity_churn - ⚠️ DEPRECATED: Use entity-analysis churn instead
  • entity_gaps - ⚠️ DEPRECATED: Use entity-analysis gaps instead
  • entity_timeline - ⚠️ DEPRECATED: Use entity-analysis timeline instead
  • preprocess_entities - ⚠️ DEPRECATED: Use entity-analysis preprocess instead

§Token Analysis Commands

Analyze token lifecycle and usage patterns:

§KV Secrets Analysis Commands

Understand KV secrets engine usage:

  • kv_analysis - Unified KV secrets analysis - usage, comparison, and summarization
    • kv-analysis analyze - Analyze KV secret access patterns and frequency
    • kv-analysis compare - Compare KV usage across different time periods
    • kv-analysis summary - Summarize KV usage by mount point
  • kv_analyzer - ⚠️ DEPRECATED: Use kv-analysis analyze instead
  • kv_summary - ⚠️ DEPRECATED: Use kv-analysis summary instead
  • kv_compare - ⚠️ DEPRECATED: Use kv-analysis compare instead

§Authentication Analysis Commands

Analyze authentication patterns:

  • k8s_auth - Analyze Kubernetes authentication patterns and service accounts

§System Analysis Commands

High-level system insights:

Modules§

airflow_polling
Airflow polling pattern detection.
client_activity
Client activity metrics from Vault API.
client_traffic_analysis
Client traffic analysis for understanding request patterns and client behavior.
entity_analysis
Unified entity analysis command.
entity_churn
Multi-day entity churn analysis with intelligent ephemeral pattern detection.
entity_creation
Entity creation analysis command.
entity_gaps
Entity gaps analysis command.
entity_list
Entity list export command.
entity_timeline
Entity timeline visualization command.
k8s_auth
Kubernetes authentication analysis command.
kv_analysis
Unified KV secrets analysis command.
kv_analyzer
KV secrets engine usage analyzer.
kv_compare
KV usage comparison across time periods.
kv_summary
KV usage summary from CSV exports.
path_hotspots
Path hotspot analysis command.
preprocess_entities
Entity mapping preprocessor.
system_overview
System-wide audit log overview.
token_analysis
Unified token analysis command.
token_export
Token lookup pattern exporter.
token_lookup_abuse
Token lookup abuse detection.
token_operations
Token lifecycle operations analysis.