Standards as realms

For standards bodies and institutions weighing whether to publish a standard in SteerSpec form: what the core rules specify, what licence and attribution they require, and what the released CLI does with them and what is not built yet.

Read the Standard Realm rules →

TL;DR

  • Status: the Standard Realm rules (STDRLM) are Draft, in the core rule set from 1.21.0. strspc builds on a manager that lints Standard Realms and measures coverage against one, and the CLI can gate CI on coverage; the crosswalk between editions is not built yet.
  • A mapping to a standard is a reference a project declares. It is not a compliance, certification or equivalence statement, and SteerSpec does not claim endorsement by any standards body.
  • A Standard Realm must declare an SPDX license and an attribution with text and a URL.
  • It transcribes one edition of a standard as one or more rules per clause. Its rules are never Implemented and never evaluated against code.
  • Projects that link to it get a clause list to map against. SteerSpec has not published a Standard Realm yet, and it holds no clause lists itself. SteerSpec Hub is where Standard Realms are planned to be published, starting with OWASP ASVS 5.0.0; it has not launched.

// 1. Status and limits

The STDRLM rules were added as Draft in core rule set 1.21.0, with STDRLM-018 and revisions to STDREF-022 and STDREF-024 in 1.22.0. Draft text may still change. strspc-manager lints Standard Realm manifests and rules from 1.45.0 and measures coverage against a linked Standard Realm from 1.46.0. The released CLI builds on strspc-manager (go.mod), so it reports coverage against the clause list of a linked Standard Realm and checks the link against that realm (CLI docs). Not built yet: the crosswalk between editions, so a new edition's mappings do not carry forward automatically. Since 1.40.0 the CLI can also fail a build when coverage weakens, for example on a lapsed or only mapped clause, a missing required standard or a regression against an earlier report (CLI docs). How standards get published as realms is still a design under discussion.

SteerSpec records what a project declares and reports which of its rules map which clause. It does not assess a project against a standard, and a project's covered status or coverage figure says only that its own mapped rules are Implemented. SteerSpec issues no certification.

// 2. Licence and attribution

The text of many standards is licensed, so SteerSpec itself holds no clause lists (rationale note of STDREF-012; CLI docs). A Standard Realm carries its terms in its manifest:

  • license, an SPDX licence identifier, is required (STDRLM-003); its value must be an SPDX identifier (RLMMNFST-010).
  • attribution, with a non-empty text and an http or https url, is required (STDRLM-015); RLMMNFST-011 gives its form.

The current proposal in strspc-rules#144 has the publisher of a standard, or anyone its licence allows, publish the realm, and has any transcription SteerSpec publishes use SteerSpec's own namespace, not the standard owner's. That is a proposal, not a rule.

// 3. What a Standard Realm is

A Standard Realm is a realm whose manifest declares the kind standard (STDRLM-001). It transcribes one edition of an external standard as one or more rules per clause.

  • Edition. The manifest names it in edition (STDRLM-002). A project that links to the realm must cite the same edition (STDREF-018).
  • Clauses. Every live rule has a clause (STDRLM-005). The clause list is the distinct clauses of the live rules (STDRLM-006). The text of a clause is the bodies of the live rules carrying it, in rule id order (STDRLM-007), so a long clause can span several rules.
  • Profiles. The manifest may declare profiles, such as levels (STDRLM-004). Rules then declare the profiles they belong to, and all rules of one clause declare the same ones (STDRLM-008, STDRLM-009, STDRLM-018).
  • Not enforced. A rule of a Standard Realm never enters Implemented and is never evaluated against code (STDRLM-010, STDRLM-011). The realm is a reference text; the project's own rules are what get checked.
  • Wording. The body of a rule is the standard's own wording for its clause, divided only at sentence ends (STDRLM-019, RUL-004). It may hold no key word (STDRLM-020), and examples may stay in the body (STDRLM-021, an exception to NTE-020).
  • Corrections. A new rule supersedes the old one with the same clause, and the old one is Terminated when the new one is Published (STDRLM-012, STDRLM-013). At most one rule that is not Abandoned may supersede a given rule (STDRLM-016).

// 4. What a project does with it

Once a Standard Realm exists, a project declares it as a dependency and links a Standard Reference to it with realm, optionally claiming one of its profiles with profile (STDREF-017, STDREF-019, STDREF-027). It then maps its own rules to clauses with standard notes, as described in the practitioner how-to. The Draft rules (core rule file) then specify:

  • A note naming a clause that is not in the realm's clause list is invalid (STDREF-021).
  • A project may mark a clause not applicable with an exclusion note, whose content is the justification (NTE-033, NTE-034).
  • A clause nothing maps is reported as unmapped (STDREF-023).
  • The coverage figure is the clauses covered and not excluded, divided by the clause list less the exclusions (STDREF-024), counted within the claimed profile (STDREF-020). It is undefined when the divisor is zero (STDREF-028).

The figure counts a project's own declarations and rule states. strspc reports this figure (CLI docs); it is not a measure of conformity with the standard.

Where next: map rules to a standard, concepts and the rule text in the core rule file.