IF Commons GitHub

GRC catalog data packages

0008Active

0008-grc-catalogs · owner if · domain grc

The package

FR-001checkpassing

A catalog package MUST hold a manifest, a document of kind grc.catalog-package (id, schema, version, title, source with the publisher's name, edition and URL, licence as an SPDX identifier or a statement, redistributable, sources, holds: the list of its documents with each one's kind, id and digest), and the documents themselves (grc.framework, grc.crosswalk, and optionally grc.policy, grc.check and grc.evidence-policy) as JSON files.

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

Proved by: grc/suite/catalog.test.ts

Written in: grc/src/physical/catalog.ts

Tests: passed: suite/catalog.test.ts a package of a manifest and its documents loads, and its controls are addressed by URN und

FR-002checkpassing

A package MUST hold no code and no executable input; the loader MUST read each file through the registry of kinds (0004), check its digest against the manifest, and refuse a package with a document of a kind or a schema this release does not know.

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

Proved by: grc/suite/catalog.test.ts

Written in: grc/src/physical/catalog.ts

Tests: passed: suite/catalog.test.ts a document of a kind or a schema this release does not know is refused; passed: suite/catalog.test.ts a manifest that lists a document whose digest differs is refused, naming the file; passed: suite/catalog.test.ts a package with code, an unlisted file or a path out of the folder is refused

FR-003checkpassing

The controls of a package MUST be addressed by the URN of 0002 under the package's framework slug and the edition's version, and a package of a newer edition MUST be a new package version, never a change of one already published.

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

Proved by: grc/suite/catalog.test.ts

Written in: grc/src/physical/catalog.ts

Tests: passed: suite/catalog.test.ts a package of a manifest and its documents loads, and its controls are addressed by URN und; passed: suite/catalog.test.ts a crosswalk to a framework the package does not hold is valid, and to a control a held fra

FR-004checkpassing

Every package MUST record its licence and source, and a package whose content may not be redistributed MUST say so in the manifest and MUST hold only identifiers and mappings.

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

Proved by: grc/suite/catalog.test.ts

Written in: grc/src/physical/catalog.ts

Tests: passed: suite/catalog.test.ts a package without a licence or a source is refused, and content that may not be redistribu

FR-005checkpassing

A package MUST record where its content came from as data: the publisher's URL or commit, the edition and the SHA-256 of each source file it was made from, so that a change of the source is found; sources the package reads are an OSCAL catalog or profile, a workbook of the Secure Controls Framework, the rules of a regulator's programme (FedRAMP's), and a schema pin of an exchange format.

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

Proved by: grc/suite/catalog.test.ts

Written in: grc/src/physical/catalog.ts

Tests: passed: suite/catalog.test.ts a package without a licence or a source is refused, and content that may not be redistribu

FR-006checkpassing

What a person writes (policies as Markdown with front matter, acknowledgments, risks, vendors, roles, engagement records) MUST be read as data and never executed: a literal file is read by its literals, so that its past versions read the same from Git.

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

Proved by: grc/suite/catalog.test.ts

Tests: passed: suite/catalog.test.ts what a package holds is read by its literals and never executed

Scenarios

  • Given a manifest that lists a framework whose digest differs, When the package is loaded, Then the loader refuses the package and names the file, per FR-002.

Out of scope

  • Building any package; the licences of any catalog (checked by the person who publishes it).

Edge cases

  • A package with a crosswalk to a framework it does not hold: valid, the other end is found when both are loaded, per FR-003.

Assumptions

  • A package is published to npm or as files in Git; the loader reads folders.

Open questions

OQ-1open question

The naming of packages (grc-catalog-<name>).

Key entities

  • Catalog package, Manifest.

Success criteria

SC-001success criterion

A catalog is added by installing data, with no change to this library.

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

governance/kinds, GRC, physical/catalog, Intellectual Frontiers Commons, The layers of GRC, NIST CSF 2.0 catalog package, GRC governance, SOC 2 Trust Services Criteria catalog package, NIST SP 800 catalog package, The probe's policies as evidence for controls

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