How j0rdan-m/ansible-vulnerability-scanner works
This GitHub Action scans configured Ansible YAML playbooks, extracts package names and versions from selected package-manager tasks, queries a chosen vulnerability provider, and writes a Markdown or SARIF report. The main script owns provider selection, playbook iteration, cached lookup, and report dispatch; provider modules normalize findings into a shared vulnerability model. README documents the Action inputs, three provider choices, and report formats. Provider and generator behavior is shown in sampled source; the README also documents GitHub Code Scanning as a SARIF consumer.
Main entry points: ansible-vulnerability-scan.py Scanner entry point · nist_provider.py NIST provider · osv_provider.py OSV provider · oss_index_provider.py OSS Index provider
Components 15
Playbook scanning
- Scanner entry point
ansible-vulnerability-scan.py - Playbook scanning
ansible-vulnerability-scan.py
Vulnerability providers
- Lookup cache
ansible-vulnerability-scan.py - Provider selection
ansible-vulnerability-scan.py - NIST provider
vuln_providers/nist_provider.py - OSV provider
vuln_providers/osv_provider.py - OSS Index provider
vuln_providers/oss_index_provider.py
Findings and reports
- Vulnerability model
vulnerability_model.py - Markdown generator
generators/markdown_generator.py - SARIF generator
generators/sarif_generator.py
Other components
- Workflow author
- NVD API
- OSV API
- OSS Index API
- GitHub Code Scanning
Connections 16
- Workflow author → Scanner entry point: configures and runs
README.md - Scanner entry point → Provider selection: selects provider
ansible-vulnerability-scan.py - Scanner entry point → Playbook scanning: scans playbooks
ansible-vulnerability-scan.py - Playbook scanning → Lookup cache: checks packages
ansible-vulnerability-scan.py - Lookup cache → NIST provider: queries when selected
ansible-vulnerability-scan.py - Lookup cache → OSV provider: queries when selected
ansible-vulnerability-scan.py - Lookup cache → OSS Index provider: queries when selected
ansible-vulnerability-scan.py - NIST provider → NVD API: requests CVEs
vuln_providers/nist_provider.py - OSV provider → OSV API: queries advisories
vuln_providers/osv_provider.py - OSS Index provider → OSS Index API: queries components
vuln_providers/oss_index_provider.py - NIST provider → Vulnerability model: creates finding
vuln_providers/nist_provider.py - OSV provider → Vulnerability model: creates finding
vuln_providers/osv_provider.py - OSS Index provider → Vulnerability model: creates finding
vuln_providers/oss_index_provider.py - Scanner entry point → Markdown generator: writes Markdown
ansible-vulnerability-scan.py - Scanner entry point → SARIF generator: writes SARIF
ansible-vulnerability-scan.py - Workflow author → GitHub Code Scanning: consumes SARIF
README.md