simp / simp/rubygem-simp-compliance_engine

sce-schema.json: missing properties that live SCE data uses (id, benchmark_version, notes, oval-ids)

Open Beginner friendly
#135 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Ruby
Stars
2
Forks
1
Avg merge
5d 16h
Merged PRs (30d)
2

Description

Four keys that appear throughout shipped SCE data are absent from the schema's properties lists:

location missing key seen in
profiles.* id every benchmark file in simp_enterprise_*
profiles.* benchmark_version ditto (16 occurrences in one CIS Server 2022 benchmark alone)
ce.* notes every notes-*.yaml
checks.* oval-ids pupmod-simp-compliance_markup/SIMP/compliance_profiles/checks.yaml

All four are in scelint's own allowed-key lists (lib/scelint.rb:337, 364, 367, 564), so the two validators currently disagree about what a valid document contains.

Why this is latent rather than breaking

These produce no violations today only because properties.profiles, .ce, .checks, and .controls do not set additionalProperties: false — unrecognized keys are silently permitted. See #136, which proposes tightening exactly that.

That makes this a blocker for #136 rather than an independent bug: tightening additionalProperties without first adding these four properties would make the schema reject essentially all production data.

Suggested fix

Add the four properties with appropriate types, ideally in the same change as (or immediately before) #136. Worth reconciling the full key lists against scelint's check_profiles / check_ce / check_checks while in there, so the two implementations agree on the vocabulary.

Found while evaluating whether scelint should consume ComplianceEngine.schema as a lint pass.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start in sce-schema.json and compare the profiles., ce. and checks.* property lists with the allowed-key lists in lib/scelint.rb at lines 337, 364, 367, and 564. Add the four missing properties with appropriate types and reconcile the lists so shipped SCE data remains accepted before #136 tightens additionalProperties.

Written by the indexing model from the issue text.

Assessment

Tech stack
ruby
Domain
tooling
Issue type
Bug
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
76/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.