How ossincn/alienvaultossim54 works
Project type and purpose
• Os-sim is a security infrastructure monitoring and event-correlation engine written in C.
• It integrates multiple open-source security/network tools (Snort, Nessus, Nmap, Spade, Arpwatch, etc.), ingests their alerts/logs, qualifies and correlates events, stores them, and exposes them for reporting/viewing.
File structure
• Top-level C source and headers (main.c, libos-sim.h, os-sim.h) implement the core daemon.
• sim-*.c / sim-*.h modules:
• sim-config: configuration parsing
• sim-connect: network/file input connectors
• sim-database, sim-db-command, sim-db-insert: storage abstraction for MySQL/PostgreSQL
• sim-correlation: event correlation engine
• sim-alarm-stats: alarm aggregation and statistics
• sim-command: runtime command dispatch/CLI
• sim-context: runtime context management
• sim-container: module container/registry
• sim-debug: debug/tracing utilities
• plugin_sid: plugin definitions for mapping external tool signatures to internal schema.
• Build / config files (autogen.sh, configure.ac, Makefile.*) indicate a GNU autotools build.
Key insights from the README
• Core goal: ingest, qualify, correlate low-level (logs/alerts), mid-level (risk), high-level (decision support) events.
• Integrates a diverse set of external services and storage backends.
• Multi-language surrounding ecosystem (Perl, PHP, Python, Java front-ends), but core is in C.
• Relies on relational DBs (MySQL/Postgres) and rrdtool for time-series.
a. Main components:
1. External Data Sources
• Snort, Spade, Nessus, Nmap, P0f, Arpwatch, OpenNMS, MRTG, etc.
2. Os-sim Core Daemon
• Connector modules (sim-connect)
• Configuration manager (sim-config)
• Plugin registry (sim-container, plugin_sid)
• Correlation engine (sim-correlation)
• Alarm statistics (sim-alarm-stats)
• Command/CLI interface (sim-command)
• Debug/logging (sim-debug)
3. Storage Layer
• Relational DB (MySQL, PostgreSQL via sim-database)
• Time-series RRD (rrdtool)
4. Visualization/Reporting
• Acid (PHP log viewer)
• OpenNMS UI
• MRTG graphs
• Custom dashboards (Perl/Python/Java)
b. Relationships and data flows:
1. External tools feed event logs/alerts → sim-connect
2. sim-config loads rules/schema → passed to plugin modules
3. sim-connect normalizes inputs → hands off to sim-context
4. sim-correlation matches events against correlation rules → generates alarms
5. sim-db-insert persists raw events and correlated alerts → DB backends
6. sim-alarm-stats aggregates alarms → RRD time-series
7. Visualization tools query DB / RRD → present to users
8. sim-command provides runtime inspection/control (e.g., via CLI or IPC)
c. Architectural patterns and principles:
• Modular, plugin-based architecture (sim-container, plugin_sid) for extensibility.
• Separation of concerns: connectors, config, correlation, storage, reporting.
• Multithreaded or event‐loop design in core C daemon (implied by sim-context, sim-container).
d. Key technologies/frameworks:
• C language, GNU autotools (autogen.sh, configure.ac, Makefiles)
• MySQL/PostgreSQL (via libmysqlclient/libpq)
• rrdtool library
• External security tools (Snort, Nessus, Nmap, Spade, etc.)