Skip to content

    Type a page, a command such as keryn scan, or a rule id.

    keryn aspm gate

    Describes Keryn 0.5.2 and keryn-rules 0.8.0. Changelog

    View as Markdown

    Application posture from ledgers and scanner reports: recorded snapshots, what changed without calling absence a repair, a pipeline gate that is blocked when a stage did not run, an ordered work list with its basis.

    keryn aspm gate --estate <file> --app <id> --store <store> | --estate <file> --before <snapshot.json> --after <snapshot.json> [--policy <file>] [--interventions <file>] [--decisions <file>] [--epss <file>] [--kev <file>] [--at <time>] [--json]
    Usage: keryn aspm <snapshot | compare | gate | priority | report> [options]
    Application posture: what is known about each application, what changed between two looks, and what to do first.
    An application is declared in an estate file (keryn.dev/estate/v1): its components, owners, criticality and exposure.
    keryn aspm snapshot --estate <file> --app <id> --store <store> [--at <time>]
    [--ledger [<component>=]<ledger.json>]... [--report <stage>=<file>[:<parser>]]... [--run <dir>]...
    [--revision <revision> | --revision <component>=<revision>]... [--build <id>] [--paths <file>]
    Record what is known about one application now: findings ledgers (keryn ledger build) and outside scanner reports
    (the formats keryn import reads). With several repositories, name the component each ledger is a scan of and the
    revision of each. A CI evidence.json beside ledger.json is digested when it matches. A snapshot is never rewritten.
    keryn aspm compare --app <id> --store <store> | --before <snapshot.json> --after <snapshot.json>
    [--interventions <file>] [--decisions <file>] [--json]
    Say what happened to each earlier entry. An entry that stops appearing is a verified repair only when the same stages
    ran again on the same inputs and scope and a validation receipt names it; otherwise it is not observed or
    indeterminate, with the reason. Exit 1 when the later snapshot has new entries.
    keryn aspm gate --estate <file> --app <id> --store <store> | --estate <file> --before <snapshot.json> --after <snapshot.json>
    [--policy <file>] [--interventions <file>] [--decisions <file>] [--epss <file>] [--kev <file>]
    [--at <time>] [--json]
    A check a pipeline can stop on, over the same comparison. Exit 1 (fail) on a new act-tier entry or a decision that
    says fixed without a verified repair. Exit 3 (blocked) when nothing was shown broken and a stage did not run, did
    not finish or had its reach cut: a scan that failed finds nothing new, and that is not a pass. Exit 0 otherwise.
    A policy file (keryn.dev/aspm-gate/v1) can loosen some checks; none of its settings passes a stage that did not run.
    keryn aspm priority --estate <file> --app <id> --store <store> [--at <time>] [--epss <file>] [--kev <file>]
    [--decisions <file>] [--json]
    The ordered work list of the latest snapshot, with the basis of every position (exploitation, exposure, impact,
    decision). It is an order, not a score: the Risk Index stays the only published number. What is not known is shown
    as unknown and never read as the safe case. Exit 1 when an entry is in the act tier.
    keryn aspm report --estate <file> --store <store> [--at <time>] [--epss <file>] [--kev <file>]
    [--checkout <provider>:<owner>/<repo>=<dir>]... [--json]
    One row per application of the estate, with what is not known beside every count. Exit 1 when any application has
    an act-tier entry.
    A store is a directory of snapshot files, or sqlite:<file> for one SQLite file. Both only ever gain snapshots.
    Nothing here assigns work, tracks tickets or accepts a risk: decisions are read from keryn decide's file, and a person signs them.
    A gate that passes is not a release decision; a person makes that.
    Terminal window
    # The last two snapshots of the shop. Fails on a new act-tier entry or a decision that says fixed without a verified repair; blocked when a stage did not run again, did not finish or had its reach cut. Here the source stage of the recorded run did not finish, so the answer is blocked, exit 3.
    keryn aspm gate --estate estate.yml --app shop --store aspm-store
    Code Meaning
    0 pass: nothing shown broken, and every stage ran to its end on both sides
    1 fail: a new act-tier entry, or a decision that says fixed without a verified repair
    2 usage error, unreadable input, an unknown policy key, or fewer than two snapshots
    3 blocked: nothing was shown broken, and the looking was not whole