IF Commons GitHub

Machine probe policies

0004Active

0004-machine-probe-policies · owner if · domain commons

Requirements

FR-001checkpassing

The pack MUST hold the ten policies observed, disk-encryption, firewall, auto-updates, updates-waiting, supported-os, ssh-keys-only, antivirus, few-admins and osquery, in that order, each with a title and at least one control, so that no result is without a control (no compliance without traceability).

Enforced (check): .github: cd commons/machine-probe && bun run verify — suite/policies.test.ts

Proved by: machine-probe/suite/policies.test.ts

Written in: machine-probe/src/logical/policies.ts

Tests: passed: suite/policies.test.ts the pack holds the ten policies in order, each with a title and at least one control

FR-002checkpassing

evaluate MUST give the result of every policy that applies to the observation, in order, with its verdict, its detail, its controls and how to make it pass on the system observed, and MUST give nothing for a policy that does not apply (no antivirus fact, no ssh setting, no updates count).

Enforced (check): .github: cd commons/machine-probe && bun run verify — suite/policies.test.ts

Proved by: machine-probe/suite/policies.test.ts

Written in: machine-probe/src/logical/policies.ts

Tests: passed: suite/policies.test.ts a real Ubuntu observation fails the settings that are off, passes what holds, gives no res

FR-003checkpassing

A setting on MUST pass and off MUST fail, manual automatic updates MUST warn, a setting the probe could not tell MUST be unknown, an observation older than seven days MUST fail, more than twenty updates waiting or more than three administrators or ssh passwords or no osquery MUST warn, and a system the maker no longer supports MUST fail while one the table does not know MUST be unknown.

Enforced (check): .github: cd commons/machine-probe && bun run verify — suite/policies.test.ts

Proved by: machine-probe/suite/policies.test.ts

Written in: machine-probe/src/logical/policies.ts

Tests: passed: suite/policies.test.ts a real Ubuntu observation fails the settings that are off, passes what holds, gives no res; passed: suite/policies.test.ts on, off, manual and unknown, the thresholds, and the systems the maker supports are judged

FR-004checkpassing

The results MUST be usable by an estate as policy outcomes: each has the policy's id, its finding and its controls.

Enforced (check): .github: cd commons/machine-probe && bun run verify — suite/policies.test.ts

Proved by: machine-probe/suite/policies.test.ts

Written in: machine-probe/src/logical/policies.ts

Tests: passed: suite/policies.test.ts the results are policy outcomes an estate judges, a machine never observed is waiting, an

Acceptance scenarios

  1. Given the observation of a real Ubuntu machine with the disk, firewall and updates off, When it is evaluated, Then those policies fail and each names its controls, per FR-002 and FR-003.
  2. Given an observation with no ssh setting, When it is evaluated, Then there is no result for ssh-keys-only, per FR-002.
  3. Given the results of an estate's machine, When its invariants are checked, Then no result lacks a control, per FR-001 and FR-004.

Out of scope

  • The policies of a controller PC (its signing keys, backups and recovery key): the fleet's host program adds them.
  • Accepting a risk and showing the status: the estate library (estate 0003-estate-logical FR-005, FR-006).

Edge cases

  • A rolling distribution is supported, per FR-003.

Assumptions

  • The supported releases are a starter table kept in code, reviewed with each release.

Open questions

  • None.

Key entities

  • Policy - what an observation must show, with its controls and its fix.

Success criteria

SC-001success criterion

Every verdict an auditor reads names the controls it is evidence for.

Review & acceptance checklist

  • [x] Every requirement is testable (MUST / MUST NOT), not aspirational
  • [x] No company fact is asserted here
  • [x] Every open item is marked, not silently decided

Cited by

Machine probe observation, The probe's policies as evidence for controls

Titles, headings, exports, tables, columns and requirements. Esc closes.