IF Commons GitHub

Pentest: the engagement

0002Active

0002-pentest-engagement · owner if · domain commons

Requirements

FR-001checkpassing

The techniques MUST be the classes passive (reads only what the estate holds and sends nothing to a target), probe (what a normal client sends), scan (many requests to find what is there) and exploit (uses a weakness), and the classes denial, social and physical, which MUST be marked never granted.

Enforced (check): .github: cd commons/pentest && bun run verify — suite/engagement.test.ts

Proved by: pentest/suite/engagement.test.ts

Written in: pentest/src/governance/techniques.ts

Tests: passed: suite/engagement.test.ts the techniques run from passive, which sends nothing, to exploit, and three are never gran

FR-002checkpassing

An engagement MUST say its id (lower case words joined by hyphens, 2 to 60 characters, starting with a letter), its name, who authorized it with a role and a day, its window, its scope (a statement of SQL that includes assets, and optionally one that leaves some out), its techniques, its testers, whom to call (each with a role and how) and how to stop the test at once; one that leaves any of it unsaid MUST be refused with every reason.

Enforced (check): .github: cd commons/pentest && bun run verify — suite/engagement.test.ts

Proved by: pentest/suite/engagement.test.ts

Written in: pentest/src/governance/engagement.ts

Tests: passed: suite/engagement.test.ts a complete engagement is accepted with passive among its techniques, and one that leaves a

FR-003checkpassing

The window MUST have a start and an end as instants, the end after the start, and at most 90 days; and an engagement MUST be refused that grants a technique that is never granted or one that is no technique; passive MUST always be among its techniques.

Enforced (check): .github: cd commons/pentest && bun run verify — suite/engagement.test.ts

Proved by: pentest/suite/engagement.test.ts

Written in: pentest/src/governance/engagement.ts

Tests: passed: suite/engagement.test.ts a complete engagement is accepted with passive among its techniques, and one that leaves a

FR-004checkpassing

An engagement that grants exploit MUST say who approved it and why, and the approver MUST be someone other than the person who authorized the test.

Enforced (check): .github: cd commons/pentest && bun run verify — suite/engagement.test.ts

Proved by: pentest/suite/engagement.test.ts

Written in: pentest/src/governance/engagement.ts

Tests: passed: suite/engagement.test.ts an exploit needs an approver and a reason, and the approver is not the person who authoriz

Acceptance scenarios

  1. Given a complete engagement, When it is defined, Then it is accepted with passive among its techniques, per FR-002 and FR-003.
  2. Given an engagement that grants denial, When it is defined, Then it is refused, per FR-003.

Out of scope

Edge cases

  • An engagement with no way to stop it is refused, per FR-002.

Assumptions

  • None.

Open questions

  • None.

Key entities

  • Engagement, Technique.

Success criteria

SC-001success criterion

The tests of the library pass.

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

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