Skip to content

srkyn/stigpilot

Repository files navigation

STIGPilot banner

STIGPilot

STIGPilot is a local Python CLI that compares DISA STIG XCCDF releases and turns the changes into impact summaries, remediation backlogs, evidence checklists, manager summaries, and ticket-ready exports.

Tests Python License

Why this exists

Official tools are authoritative for viewing, scanning, checklist work, and formal compliance. STIGPilot focuses on the workflow gap after a new STIG release drops:

  • What changed?
  • What matters?
  • What got more severe?
  • What likely needs implementation work?
  • What evidence needs to be refreshed?
  • What tickets should be created?
  • What should a manager know?

I built this after learning about STIGs and asking a practical question: if someone is responsible for applying these controls or comparing releases, what would make their day easier? The answer was not another viewer or scanner. It was a fast local helper that turns a dense XML release into a short brief, a backlog, and evidence requests people can actually act on.

30-second demo

git clone https://github.com/srkyn/stigpilot.git
cd stigpilot
python -m pip install -e ".[dev]"
stigpilot demo

Generated files:

output/demo/change-brief.md
output/demo/change-brief.html
output/demo/changes.json
output/demo/manager-summary.md
output/demo/remediation-backlog.csv
output/demo/evidence-checklist.md
output/demo/jira-import.csv
output/demo/servicenow-import.csv
output/demo/github-issues.md

Example terminal output:

Demo Reports Generated
Change brief          output/demo/change-brief.md
Manager summary       output/demo/manager-summary.md
Remediation backlog   output/demo/remediation-backlog.csv

STIGPilot Diff Summary
Total changes                     4
Added                             1
Removed                           1
Modified                          2
High-priority review              2
Evidence update likely            1

Change brief excerpt:

4 control change(s) were detected. 3 change(s) are likely to require priority review,
implementation work, or evidence refresh. Prioritize high-severity additions or
severity increases, then review remediation text changes before reusing old tickets.

Real-world Chrome demo

Google Chrome for Windows is the best first real-world scenario because it is familiar, endpoint-security relevant, and smaller than a full operating system STIG.

Run the built-in sanitized Chrome workflow:

stigpilot chrome-demo

Generate a Chrome packet for only one team or impact category:

stigpilot chrome-demo --impact evidence_update_likely --owner "Endpoint/Windows Admin"

Generated files:

output/chrome/change-brief.md
output/chrome/change-brief.html
output/chrome/changes.json
output/chrome/manager-summary.md
output/chrome/remediation-backlog.csv
output/chrome/evidence-checklist.md
output/chrome/jira-import.csv
output/chrome/servicenow-import.csv
output/chrome/github-issues.md

To run against official DoD Cyber Exchange Google Chrome Current Windows STIG V2R10 and V2R11 files, download the public ZIPs, extract the XCCDF XML files, and place them here:

examples/chrome_windows_input/old.xml
examples/chrome_windows_input/new.xml

Then rerun:

stigpilot chrome-demo

What STIGPilot is good at

  • Release-to-release STIG change triage
  • Folder-to-folder portfolio comparisons for multiple STIG updates
  • Identifying severity increases and implementation-impacting changes
  • Generating remediation backlog CSVs
  • Preparing owner-focused evidence requests
  • Creating manager summaries
  • Exporting ticket-ready CSVs and GitHub issue drafts

What STIGPilot is not

  • Not official DISA tooling
  • Not compliance validation
  • Not a scanner
  • Not auto-remediation
  • Not a replacement for SCC, STIG Viewer, PowerSTIG, OpenRMF, or organizational compliance review

When to use it

  • A new Windows 11 STIG release drops and you need to know what changed.
  • A vulnerability management analyst needs a backlog CSV.
  • A GRC analyst needs an evidence checklist.
  • A sysadmin team needs owner-focused remediation work.
  • A manager needs a short update without reading hundreds of controls.

Install

From a clone:

git clone https://github.com/srkyn/stigpilot.git
cd stigpilot
python -m pip install -e .

Development dependencies:

python -m pip install -e ".[dev]"

With pipx from a local clone:

pipx install .

Fallback without the console script:

python -m stigpilot.cli --help
python -m stigpilot.cli demo

Windows note: if stigpilot is not recognized after install, your Python Scripts directory may not be on PATH. The python -m stigpilot.cli ... fallback works without changing PATH.

CLI usage

Health check:

stigpilot doctor

Parse a STIG:

stigpilot parse examples/sample_input/new.xml --csv output/controls.csv --json output/controls.json

Generate a brief:

stigpilot brief examples/sample_input/new.xml --out output/brief.md --severity high

Compare two STIG versions:

stigpilot diff examples/sample_input/old.xml examples/sample_input/new.xml --out output/change-brief.md --csv output/remediation-backlog.csv

Generate a complete local workflow packet from two STIG files:

stigpilot packet examples/sample_input/old.xml examples/sample_input/new.xml --out output/packet

Generate workflow exports:

stigpilot diff examples/sample_input/old.xml examples/sample_input/new.xml --out output/change-brief.md --csv output/remediation-backlog.csv --jira-csv output/jira-import.csv --servicenow-csv output/servicenow-import.csv --github-md output/github-issues.md --json output/changes.json

Compare folders of old/new STIG XML files:

stigpilot batch examples/portfolio_input/old examples/portfolio_input/new --out output/portfolio

Generate a focused packet for one impact category or owner group:

stigpilot diff examples/sample_input/old.xml examples/sample_input/new.xml --out output/windows-high-priority.md --csv output/windows-high-priority.csv --impact high_priority_review --owner "Endpoint/Windows Admin"

Generate a manager-facing summary:

stigpilot manager examples/sample_input/old.xml examples/sample_input/new.xml --out output/manager-summary.md

Generate a self-contained HTML change brief:

stigpilot html examples/sample_input/old.xml examples/sample_input/new.xml --out output/change-brief.html

Generate ticket-ready export from one STIG:

stigpilot tickets examples/sample_input/new.xml --out output/tickets.csv --severity high

Generate an evidence checklist:

stigpilot evidence examples/sample_input/new.xml --out output/evidence-checklist.md

Show a terminal summary:

stigpilot summary examples/sample_input/new.xml

Write a configurable owner/tag mapping example:

stigpilot config-example --out stigpilot.toml

Use a local owner/tag mapping config:

stigpilot diff examples/sample_input/old.xml examples/sample_input/new.xml --out output/change-brief.md --csv output/remediation-backlog.csv --config stigpilot.toml

Example outputs

Synthetic fixtures are included in examples/sample_input/. They are fake and sanitized.

Committed sample outputs in examples/sample_output/:

  • change-brief.md
  • change-brief.html
  • changes.json
  • manager-summary.md
  • remediation-backlog.csv
  • evidence-checklist.md
  • jira-import.csv
  • servicenow-import.csv
  • github-issues.md

One-command packet outputs are committed in examples/packet_output/.

Folder comparison sample outputs are committed in examples/portfolio_output/.

HTML report output is committed in examples/html_output/.

Additional parsed-control and ticket-export examples:

  • controls.csv
  • controls.json
  • tickets.csv

Chrome for Windows official inputs

Official Google Chrome Current Windows STIG XML files are not vendored in this repository. The Chrome demo uses sanitized sample files unless you provide official XMLs under examples/chrome_windows_input/.

Suggested source ZIPs:

  • https://dl.dod.cyber.mil/wp-content/uploads/stigs/zip/U_Google_Chrome_V2R10_STIG.zip
  • https://dl.dod.cyber.mil/wp-content/uploads/stigs/zip/U_Google_Chrome_V2R11_STIG.zip

This keeps the project useful immediately while avoiding unclear redistribution of official STIG XML files.

Impact rules

The classifier is intentionally transparent. There is no opaque AI dependency.

  • New high severity control: high_priority_review
  • Severity increased to high: high_priority_review
  • Severity increased below high: review_recommended
  • Meaningful fix text change: implementation_change_likely
  • Meaningful check text change: evidence_update_likely
  • Removed control: review_recommended
  • Only title/metadata wording changed: no_action_likely
  • CCI/reference changes: review_recommended

Text changes use a transparent similarity threshold of 0.86 plus configuration-language keywords. The goal is to separate wording-only churn from changes likely to affect implementation steps or evidence requests.

Tags and ownership

Tags and suggested owners are keyword-based and explainable.

  • Windows, GPO, Registry, Defender/AV: Endpoint/Windows Admin
  • Linux, sshd, sudo, auditd, PAM: Linux Admin
  • IAM, privileged access, authentication, lockout: IAM/Security Admin
  • SQL, Oracle, PostgreSQL, MongoDB: Database Admin
  • Firewall, router, switch, Cisco, Palo Alto: Network/Security Engineering
  • Cloud, Azure, AWS, GCP, Entra: Cloud/IAM Admin
  • Container, Kubernetes, Docker: Platform/Container Admin

Everything else defaults to Security/GRC Analyst.

Teams can extend mappings with a local TOML file:

[[owner_rules]]
owner = "Identity/IAM Team"
keywords = ["authentication", "privileged account"]

[tag_rules]
"Privileged Access" = ["privileged account", "sudoers"]

See docs/configuration.md for owner routing examples, tag rules, and config validation notes.

Limitations

  • STIGPilot does not validate host compliance.
  • STIGPilot does not replace formal review.
  • STIGPilot does not download or scrape DISA content.
  • STIGPilot does not auto-remediate.
  • XML variants are handled best-effort; unusual vendor packaging may require parser improvements.
  • Keyword tags and owner mapping are transparent but imperfect.

Safe usage

Use STIGPilot only with files you are authorized to process. Do not publish sensitive evidence, system names, internal host data, credentials, classified information, or restricted organizational material. The included fixtures are synthetic.

Roadmap

  • PyPI packaging and publish workflow
  • Better HTML packet/portfolio report coverage
  • More parser fixtures from official-but-user-supplied STIG variants
  • Optional screenshot assets for README examples
  • Optional Streamlit dashboard after the CLI remains strong

Portfolio value

  • Built from a practical security-automation question: how can STIG comparison and follow-up work be made less painful for the people doing it?
  • Defensive security product judgment
  • XCCDF/XML parsing with namespace resilience
  • STIG release change analysis
  • Rule-based impact classification
  • Ticket and evidence workflow design
  • Testable Python CLI engineering

Development

Run tests:

python -m pytest

Regenerate sample outputs:

python -m stigpilot.cli diff examples/sample_input/old.xml examples/sample_input/new.xml --out examples/sample_output/change-brief.md --csv examples/sample_output/remediation-backlog.csv --jira-csv examples/sample_output/jira-import.csv --servicenow-csv examples/sample_output/servicenow-import.csv --github-md examples/sample_output/github-issues.md
python -m stigpilot.cli manager examples/sample_input/old.xml examples/sample_input/new.xml --out examples/sample_output/manager-summary.md
python -m stigpilot.cli parse examples/sample_input/new.xml --csv examples/sample_output/controls.csv --json examples/sample_output/controls.json
python -m stigpilot.cli tickets examples/sample_input/new.xml --out examples/sample_output/tickets.csv
python -m stigpilot.cli evidence examples/sample_input/new.xml --out examples/sample_output/evidence-checklist.md
python -m stigpilot.cli chrome-demo --out examples/chrome_windows_output --input-dir examples/chrome_windows_input

About

Local Python CLI that compares DISA STIG XCCDF releases and generates impact summaries, remediation backlogs, evidence checklists, and ticket-ready exports.

Topics

Resources

License

Contributing

Security policy

Stars

Watchers

Forks

Packages

 
 
 

Contributors

Languages