Getting started¶
Install¶
Requires Python 3.10+. z3-solver is installed automatically as a
dependency.
# from PyPI (distribution name is invariant-sast; the CLI and import stay `invariant`)
pip install invariant-sast
# or straight from source
git clone https://github.com/heimdallsystems/invariant.git
cd invariant
pip install .
Quickstart¶
From the root of your AWS LZA config repo (wherever your
service-control-policies/ and rcp-policies/ directories live):
invariant scan
[PASS] INV_AWS_001 service-control-policies/lza-core-guardrails-1.json No regression found.
[PASS] INV_AWS_001 service-control-policies/lza-quarantine.json No regression found.
[FAIL (critical)] INV_AWS_001 service-control-policies/lza-quarantine.json Candidate no longer denies a request the reference denied: {'action': '""', 'resource': '""', 'principal': '""'}
A FAIL line means Z3 found a concrete (action, resource, principal)
tuple that the bundled baseline guardrail denies but your policy no longer
does. Exit code is 1 whenever any check fails, so it's CI-friendly out of
the box.
Only files with a same-named counterpart in the bundled baseline catalog are
checked. A custom SCP with no LZA-default analog has nothing to prove a
baseline property against yet — invariant scan reports it (to stderr) as
skipped rather than silently ignoring it. Pair it against something of your
own choosing with invariant regression instead.
Next steps¶
- CLI reference for every flag both subcommands accept.
- Checks for what
INV_AWS_001actually proves. - Suppressions if you need to intentionally accept a finding.
- CI integration to wire this into GitHub Actions or GitLab CI.