@mitre/hdf-openapi 0.0.1-reserve.0 → 3.8.0-next.42533588944.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +27 -14
- package/dist/hdf-components.oas.json +669 -124
- package/dist/hdf-components.oas.yaml +504 -93
- package/dist/index.d.ts +19 -172
- package/dist/index.d.ts.map +1 -1
- package/dist/index.js +126 -1201
- package/dist/index.js.map +1 -1
- package/dist/problems.json +114 -0
- package/dist/problems.yaml +125 -0
- package/package.json +4 -13
- package/dist/hdf-api.oas.json +0 -12580
|
@@ -2,7 +2,7 @@
|
|
|
2
2
|
"openapi": "3.1.1",
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "HDF Components",
|
|
5
|
-
"version": "3.
|
|
5
|
+
"version": "3.8.0",
|
|
6
6
|
"description": "OpenAPI 3.1 components generated from the HDF JSON Schema 2020-12 bundles. Generated — do not edit by hand.",
|
|
7
7
|
"license": {
|
|
8
8
|
"name": "Apache-2.0",
|
|
@@ -40,10 +40,6 @@
|
|
|
40
40
|
"type": "string",
|
|
41
41
|
"description": "The name of the parent baseline if this is a dependency of another."
|
|
42
42
|
},
|
|
43
|
-
"description": {
|
|
44
|
-
"type": "string",
|
|
45
|
-
"description": "The description - should be more detailed than the summary."
|
|
46
|
-
},
|
|
47
43
|
"integrity": {
|
|
48
44
|
"$ref": "#/components/schemas/Integrity",
|
|
49
45
|
"description": "Cryptographic integrity information for verifying this baseline has not been tampered with."
|
|
@@ -54,7 +50,7 @@
|
|
|
54
50
|
},
|
|
55
51
|
"resultsChecksum": {
|
|
56
52
|
"$ref": "#/components/schemas/Checksum",
|
|
57
|
-
"description": "SHA-256 checksum of the raw results before any amendments (statusOverrides or POAMs). Used to detect tampering with test results.
|
|
53
|
+
"description": "SHA-256 checksum of the raw results before any amendments (statusOverrides or POAMs). Used to detect tampering with test results. Amendment integrity is checked against the document-level preAmendmentChecksum at the root, not this per-baseline value: hdf amend apply writes it as the hash of the raw document bytes immediately before the most recent amendment application, one step back only."
|
|
58
54
|
},
|
|
59
55
|
"statusMessage": {
|
|
60
56
|
"type": "string",
|
|
@@ -83,9 +79,8 @@
|
|
|
83
79
|
"description": "Typed inputs used to parameterize this baseline at execution time. See the Input primitive for the full schema."
|
|
84
80
|
},
|
|
85
81
|
"extensions": {
|
|
86
|
-
"
|
|
87
|
-
"
|
|
88
|
-
"description": "Reserved for tool-specific baseline metadata not defined in the HDF standard."
|
|
82
|
+
"$ref": "#/components/schemas/Extensions",
|
|
83
|
+
"description": "Producer data outside the HDF model that belongs to this baseline rather than to the document, and the pre-converted source artifact(s) this baseline was built from."
|
|
89
84
|
}
|
|
90
85
|
},
|
|
91
86
|
"description": "Information on a baseline that was evaluated, including any findings.",
|
|
@@ -427,7 +422,6 @@
|
|
|
427
422
|
"statusOverrides": [
|
|
428
423
|
{
|
|
429
424
|
"type": "operationalRequirement",
|
|
430
|
-
"status": "failed",
|
|
431
425
|
"reason": "Air-gapped system requires USB transfer for classified data ingestion per operational procedure OP-2026-003. Compensating controls: USB ports are physically secured, all transfers are logged and require two-person integrity.",
|
|
432
426
|
"appliedBy": {
|
|
433
427
|
"type": "email",
|
|
@@ -494,10 +488,23 @@
|
|
|
494
488
|
"description": "A requirement that has been evaluated, including any findings.",
|
|
495
489
|
"title": "Evaluated Requirement"
|
|
496
490
|
},
|
|
491
|
+
"External_Reference_Encoding": {
|
|
492
|
+
"type": "string",
|
|
493
|
+
"enum": [
|
|
494
|
+
"utf-8",
|
|
495
|
+
"base64"
|
|
496
|
+
],
|
|
497
|
+
"description": "How an embedded copy's bytes are read back: 'utf-8' for text, 'base64' for anything that is not valid UTF-8 text.",
|
|
498
|
+
"title": "External Reference Encoding",
|
|
499
|
+
"examples": [
|
|
500
|
+
"base64"
|
|
501
|
+
],
|
|
502
|
+
"$comment": "Examples, in order: 1) a binary artifact, embedded base64-encoded."
|
|
503
|
+
},
|
|
497
504
|
"External_Reference": {
|
|
498
505
|
"type": "object",
|
|
499
506
|
"title": "External Reference",
|
|
500
|
-
"description": "A generalized reference to any external artifact by identity and/or location, modeled on the STIX 2.1 `external_references` common property.\n\nPurpose-agnostic: cite a CVE, an ATT&CK technique, a STIX bundle/object, a BOM, a runbook, or any vendor artifact — including kinds with no dedicated HDF reference category.\n\n`sourceName` names the system; `externalId` cites by id within that system; `href` locates it. `sourceName` + `externalId` is equivalently a URN (`urn:<sourceName>:<externalId>`, RFC 8141), so the by-identity and by-location forms stay interconvertible.\n\nA reference is inert context: it overrides nothing, so it carries only lightweight optional `addedBy`/`addedAt` attribution, never override machinery.",
|
|
507
|
+
"description": "A generalized reference to any external artifact by identity and/or location, modeled on the STIX 2.1 `external_references` common property.\n\nPurpose-agnostic: cite a CVE, an ATT&CK technique, a STIX bundle/object, a BOM, a runbook, or any vendor artifact — including kinds with no dedicated HDF reference category.\n\n`sourceName` names the system; `externalId` cites by id within that system; `href` locates it. `sourceName` + `externalId` is equivalently a URN (`urn:<sourceName>:<externalId>`, RFC 8141), so the by-identity and by-location forms stay interconvertible.\n\nAn entry may also carry the artifact itself rather than point at it: `document` for a JSON object, `content` + `encoding` for anything else. Embedding satisfies the at-least-one rule on its own, so an artifact with no meaningful public location needs no synthetic `href`.\n\nA reference is inert context: it overrides nothing, so it carries only lightweight optional `addedBy`/`addedAt` attribution, never override machinery.",
|
|
501
508
|
"required": [
|
|
502
509
|
"sourceName"
|
|
503
510
|
],
|
|
@@ -516,6 +523,42 @@
|
|
|
516
523
|
"required": [
|
|
517
524
|
"description"
|
|
518
525
|
]
|
|
526
|
+
},
|
|
527
|
+
{
|
|
528
|
+
"required": [
|
|
529
|
+
"content"
|
|
530
|
+
]
|
|
531
|
+
},
|
|
532
|
+
{
|
|
533
|
+
"required": [
|
|
534
|
+
"document"
|
|
535
|
+
]
|
|
536
|
+
}
|
|
537
|
+
],
|
|
538
|
+
"allOf": [
|
|
539
|
+
{
|
|
540
|
+
"if": {
|
|
541
|
+
"required": [
|
|
542
|
+
"content"
|
|
543
|
+
]
|
|
544
|
+
},
|
|
545
|
+
"then": {
|
|
546
|
+
"required": [
|
|
547
|
+
"encoding"
|
|
548
|
+
]
|
|
549
|
+
}
|
|
550
|
+
},
|
|
551
|
+
{
|
|
552
|
+
"if": {
|
|
553
|
+
"required": [
|
|
554
|
+
"encoding"
|
|
555
|
+
]
|
|
556
|
+
},
|
|
557
|
+
"then": {
|
|
558
|
+
"required": [
|
|
559
|
+
"content"
|
|
560
|
+
]
|
|
561
|
+
}
|
|
519
562
|
}
|
|
520
563
|
],
|
|
521
564
|
"properties": {
|
|
@@ -531,7 +574,7 @@
|
|
|
531
574
|
"href": {
|
|
532
575
|
"type": "string",
|
|
533
576
|
"format": "uri-reference",
|
|
534
|
-
"description": "Location of the artifact. `uri-reference` (not `uri`) so a bare internal `#fragment`/`#uuid` reference is expressible alongside absolute URLs.
|
|
577
|
+
"description": "Location of the artifact. `uri-reference` (not `uri`) so a bare internal `#fragment`/`#uuid` reference is expressible alongside absolute URLs. Set it only when the location is meaningful to a reader — never a producer's local filesystem path."
|
|
535
578
|
},
|
|
536
579
|
"description": {
|
|
537
580
|
"type": "string",
|
|
@@ -543,11 +586,11 @@
|
|
|
543
586
|
},
|
|
544
587
|
"mediaType": {
|
|
545
588
|
"type": "string",
|
|
546
|
-
"description": "IANA media type of the
|
|
589
|
+
"description": "IANA media type of the artifact (RFC 6838), e.g., 'application/json', 'application/xml', 'text/csv'. Applies both to an artifact retrievable at `href` and to one embedded here in `content` or `document`."
|
|
547
590
|
},
|
|
548
591
|
"checksum": {
|
|
549
592
|
"$ref": "#/components/schemas/Checksum",
|
|
550
|
-
"description": "Integrity hash of the
|
|
593
|
+
"description": "Integrity hash of the artifact. Reuses the HDF `Checksum` primitive (not STIX `hashes`). Applies both to an artifact retrievable at `href` and to one embedded here in `content` or `document` — beside embedded bytes it is what makes the copy verifiable rather than merely present."
|
|
551
594
|
},
|
|
552
595
|
"addedBy": {
|
|
553
596
|
"$ref": "#/components/schemas/Identity",
|
|
@@ -566,11 +609,19 @@
|
|
|
566
609
|
"document": {
|
|
567
610
|
"type": "object",
|
|
568
611
|
"additionalProperties": true,
|
|
569
|
-
"description": "Optional lossless embedded copy of the referenced artifact — the raw STIX object, EPSS record, advisory, or annotation payload — preserved verbatim.\n\nComposes with `href`/`externalId` (which point at the artifact) and `checksum` (which ties the copy to the source): a single entry can both point and embed.\n\nHDF stays payload-agnostic — the content is carried untouched, never normalized into HDF fields — so this does not duplicate the source ontology (e.g. STIX rides here unchanged)."
|
|
612
|
+
"description": "Optional lossless embedded copy of the referenced artifact as a JSON object — the raw STIX object, EPSS record, advisory, or annotation payload — preserved verbatim.\n\nJSON objects only. An artifact that is not a JSON object (XML, CSV, NDJSON, plain text, a JSON array, or bytes that are not text at all) embeds through `content` + `encoding` instead.\n\nComposes with `href`/`externalId` (which point at the artifact) and `checksum` (which ties the copy to the source): a single entry can both point and embed.\n\nHDF stays payload-agnostic — the content is carried untouched, never normalized into HDF fields — so this does not duplicate the source ontology (e.g. STIX rides here unchanged)."
|
|
613
|
+
},
|
|
614
|
+
"content": {
|
|
615
|
+
"type": "string",
|
|
616
|
+
"description": "Optional lossless embedded copy of the artifact's bytes as a string, for artifacts `document` cannot hold: XML, CSV, NDJSON, plain text, a JSON array, or bytes that are not valid UTF-8 text at all.\n\n`encoding` states how to read it back and is required alongside it. Set `mediaType` so a consumer knows what the bytes are, and `checksum` so the copy can be verified against the source.\n\nCarried verbatim — never reformatted, re-indented, or re-serialized."
|
|
617
|
+
},
|
|
618
|
+
"encoding": {
|
|
619
|
+
"$ref": "#/components/schemas/External_Reference_Encoding",
|
|
620
|
+
"description": "How to read `content` back into the artifact's bytes. 'utf-8' for text (XML, CSV, NDJSON, plain text, JavaScript-wrapped JSON); 'base64' for anything that is not valid UTF-8 text.\n\nRequired whenever `content` is present, and meaningless without it — an embedded copy whose encoding a consumer has to guess is not lossless."
|
|
570
621
|
}
|
|
571
622
|
},
|
|
572
623
|
"unevaluatedProperties": false,
|
|
573
|
-
"$comment": "Examples, in order: 1) By-identity: cite a CVE by its id in the 'cve' system without a URL — equivalently urn:cve:CVE-2021-44228; 2) By-identity AND by-locator together (anyOf, not oneOf) — an ATT&CK technique cited by id with its canonical URL; 3) By-locator to a retrievable STIX bundle, with integrity hash, media type, and attribution; 4) Enrichment envelope: a STIX threat-intel object embedded losslessly in `document` and classified via `kind`, cited by id and pointed at by href — the pointer and the embedded copy compose. The payload rides verbatim; HDF does not normalize STIX fields.",
|
|
624
|
+
"$comment": "Examples, in order: 1) By-identity: cite a CVE by its id in the 'cve' system without a URL — equivalently urn:cve:CVE-2021-44228; 2) By-identity AND by-locator together (anyOf, not oneOf) — an ATT&CK technique cited by id with its canonical URL; 3) By-locator to a retrievable STIX bundle, with integrity hash, media type, and attribution; 4) Enrichment envelope: a STIX threat-intel object embedded losslessly in `document` and classified via `kind`, cited by id and pointed at by href — the pointer and the embedded copy compose. The payload rides verbatim; HDF does not normalize STIX fields; 5) Embed-only, text: an XCCDF results file carried in `content` as utf-8 with its media type and checksum, and no `href` at all — the artifact was read from a local file whose path means nothing to a reader; 6) Embed-only, non-text: a Fortify FPR (a zip) carried in `content` as base64, the case `document` and utf-8 both fail.",
|
|
574
625
|
"examples": [
|
|
575
626
|
{
|
|
576
627
|
"sourceName": "cve",
|
|
@@ -616,6 +667,28 @@
|
|
|
616
667
|
}
|
|
617
668
|
]
|
|
618
669
|
}
|
|
670
|
+
},
|
|
671
|
+
{
|
|
672
|
+
"sourceName": "openscap",
|
|
673
|
+
"rel": "raw-source",
|
|
674
|
+
"mediaType": "application/xml",
|
|
675
|
+
"encoding": "utf-8",
|
|
676
|
+
"content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Benchmark xmlns=\"http://checklists.nist.gov/xccdf/1.2\" id=\"xccdf_org.ssgproject.content_benchmark_RHEL-9\">\n <TestResult id=\"xccdf_org.open-scap_testresult_default-profile\" start-time=\"2026-09-27T12:00:00+00:00\" end-time=\"2026-09-27T12:04:11+00:00\">\n <rule-result idref=\"xccdf_org.ssgproject.content_rule_sshd_disable_root_login\" severity=\"medium\">\n <result>fail</result>\n </rule-result>\n </TestResult>\n</Benchmark>",
|
|
677
|
+
"checksum": {
|
|
678
|
+
"algorithm": "sha256",
|
|
679
|
+
"value": "713b3ee32af5c14ac93e519b5025d760983607143dba3a0438f68667923beda1"
|
|
680
|
+
}
|
|
681
|
+
},
|
|
682
|
+
{
|
|
683
|
+
"sourceName": "fortify",
|
|
684
|
+
"rel": "raw-source",
|
|
685
|
+
"mediaType": "application/zip",
|
|
686
|
+
"encoding": "base64",
|
|
687
|
+
"content": "UEsDBBQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAYXVkaXQuZnZkbLOxr8jNUShLLSrOzM+zVTLUM1Cyt7NxC3Px0bcDAFBLAQIUAxQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAAAAAAAAAAACAAQAAAABhdWRpdC5mdmRsUEsFBgAAAAABAAEAOAAAAEYAAAAAAA==",
|
|
688
|
+
"checksum": {
|
|
689
|
+
"algorithm": "sha256",
|
|
690
|
+
"value": "c7e4cefceecb83511ae6174c7d22584061671dee6dc5f27243503b47532a66b1"
|
|
691
|
+
}
|
|
619
692
|
}
|
|
620
693
|
]
|
|
621
694
|
},
|
|
@@ -627,7 +700,7 @@
|
|
|
627
700
|
"sha512",
|
|
628
701
|
"blake3"
|
|
629
702
|
],
|
|
630
|
-
"description": "
|
|
703
|
+
"description": "Cryptographic hash algorithms a checksum or integrity record may name. blake3 covers container-image and other artifact digests that use it. HDF tooling verifies every algorithm in this enum, so any of them may be recorded where the checksum needs to be verifiable. md5 and sha1 are excluded deliberately: a checksum or integrity record exists to detect tampering, and both are collision-broken, so a digest in either would look verifiable while proving nothing. A source tool digest in an excluded algorithm is not recorded as a checksum. Admitting weak hashes as an application-level accept/reject decision was considered and rejected; widening this enum is a schema decision, not an oversight.",
|
|
631
704
|
"title": "Hash Algorithm"
|
|
632
705
|
},
|
|
633
706
|
"Requirement_Group": {
|
|
@@ -785,7 +858,33 @@
|
|
|
785
858
|
}
|
|
786
859
|
],
|
|
787
860
|
"description": "A reference to an external document.",
|
|
788
|
-
"title": "Reference"
|
|
861
|
+
"title": "Reference",
|
|
862
|
+
"unevaluatedProperties": false,
|
|
863
|
+
"$comment": "Examples, in order: 1) By-locator: a plain URL, the commonest form by far in practice; 2) By-name: a human-meaningful citation with no locator, as InSpec's `ref 'title'` emits; 3) Both together, since this is an anyOf rather than a oneOf; 4) The ref-as-array form, whose items are deliberately open so a source format's own reference record can be carried verbatim — XCCDF's DPMS target identifiers reach HDF this way; 5) uri, accepted as a synonym of url for documents that spell it that way. The object itself is CLOSED: a member none of the three branches declares is rejected. The openness that matters here is one level down, on the items of the ref array, and it is declared there explicitly. This primitive predates External_Reference, which is the STIX-aligned type a new converter should reach for; refs survives because it is InSpec-inherited and HDF consumes InSpec output.",
|
|
864
|
+
"examples": [
|
|
865
|
+
{
|
|
866
|
+
"url": "https://nvd.nist.gov/vuln/detail/CVE-2021-44228"
|
|
867
|
+
},
|
|
868
|
+
{
|
|
869
|
+
"ref": "NIST SP 800-53 Rev 5, AC-6"
|
|
870
|
+
},
|
|
871
|
+
{
|
|
872
|
+
"ref": "CIS Benchmark for RHEL 9, 1.1.1",
|
|
873
|
+
"url": "https://www.cisecurity.org/benchmark/red_hat_linux"
|
|
874
|
+
},
|
|
875
|
+
{
|
|
876
|
+
"ref": [
|
|
877
|
+
{
|
|
878
|
+
"identifier": "2921",
|
|
879
|
+
"publisher": "DISA",
|
|
880
|
+
"type": "DPMS Target"
|
|
881
|
+
}
|
|
882
|
+
]
|
|
883
|
+
},
|
|
884
|
+
{
|
|
885
|
+
"uri": "https://attack.mitre.org/techniques/T1059/"
|
|
886
|
+
}
|
|
887
|
+
]
|
|
789
888
|
},
|
|
790
889
|
"Source_Location": {
|
|
791
890
|
"type": "object",
|
|
@@ -1303,6 +1402,10 @@
|
|
|
1303
1402
|
"type": "string",
|
|
1304
1403
|
"description": "The title - should be human readable."
|
|
1305
1404
|
},
|
|
1405
|
+
"description": {
|
|
1406
|
+
"type": "string",
|
|
1407
|
+
"description": "Prose description of the baseline, more detailed than summary. Carried verbatim, like every HDF prose field."
|
|
1408
|
+
},
|
|
1306
1409
|
"maintainer": {
|
|
1307
1410
|
"type": "string",
|
|
1308
1411
|
"description": "The maintainer(s)."
|
|
@@ -1381,7 +1484,7 @@
|
|
|
1381
1484
|
},
|
|
1382
1485
|
"id": {
|
|
1383
1486
|
"type": "string",
|
|
1384
|
-
"description": "The requirement identifier. Example: 'SV-238196'."
|
|
1487
|
+
"description": "The requirement identifier, naming the requirement itself rather than one finding of it. Example: 'SV-238196'. Several entries in one baseline may legitimately carry the same id (one scanner reporting one CVE against several packages, or an overlay restating what it inherits), so an id is not an instance key: index requirements as id to list, never id to one, and an amendment addressing an id applies to every entry carrying it."
|
|
1385
1488
|
},
|
|
1386
1489
|
"title": {
|
|
1387
1490
|
"type": "string",
|
|
@@ -2552,6 +2655,25 @@
|
|
|
2552
2655
|
}
|
|
2553
2656
|
]
|
|
2554
2657
|
},
|
|
2658
|
+
"Modality": {
|
|
2659
|
+
"type": [
|
|
2660
|
+
"string",
|
|
2661
|
+
"array"
|
|
2662
|
+
],
|
|
2663
|
+
"items": {
|
|
2664
|
+
"type": "string"
|
|
2665
|
+
},
|
|
2666
|
+
"description": "A content modality such as text, image, audio, tabular or timeseries: one string, or a list when the content spans several.",
|
|
2667
|
+
"title": "Modality",
|
|
2668
|
+
"examples": [
|
|
2669
|
+
"text",
|
|
2670
|
+
[
|
|
2671
|
+
"text",
|
|
2672
|
+
"image"
|
|
2673
|
+
]
|
|
2674
|
+
],
|
|
2675
|
+
"$comment": "Examples, in order: 1) a single modality; 2) multimodal content listed in full."
|
|
2676
|
+
},
|
|
2555
2677
|
"AI_Model_Extension": {
|
|
2556
2678
|
"type": "object",
|
|
2557
2679
|
"additionalProperties": true,
|
|
@@ -2653,13 +2775,7 @@
|
|
|
2653
2775
|
"description": "Input/output data types. Examples: string, byte[], float32, image."
|
|
2654
2776
|
},
|
|
2655
2777
|
"modality": {
|
|
2656
|
-
"
|
|
2657
|
-
"string",
|
|
2658
|
-
"array"
|
|
2659
|
-
],
|
|
2660
|
-
"items": {
|
|
2661
|
-
"type": "string"
|
|
2662
|
-
},
|
|
2778
|
+
"$ref": "#/components/schemas/Modality",
|
|
2663
2779
|
"description": "Input/output modalities. String or array of strings. Examples: text, image, audio. Symmetric with Dataset_Extension.modality."
|
|
2664
2780
|
},
|
|
2665
2781
|
"contextLength": {
|
|
@@ -2699,13 +2815,7 @@
|
|
|
2699
2815
|
"description": "Free-text statement of the dataset's intended use (CISA/G7 minimum element)."
|
|
2700
2816
|
},
|
|
2701
2817
|
"modality": {
|
|
2702
|
-
"
|
|
2703
|
-
"string",
|
|
2704
|
-
"array"
|
|
2705
|
-
],
|
|
2706
|
-
"items": {
|
|
2707
|
-
"type": "string"
|
|
2708
|
-
},
|
|
2818
|
+
"$ref": "#/components/schemas/Modality",
|
|
2709
2819
|
"description": "Content modality/kind of the data (CISA/G7 'Dataset content: modality'). Examples: text, image, tabular, timeseries, audio. DISTINCT from datasetFormat, which is the physical encoding (parquet/csv). Resolves SPDX 3.0 dataset_datasetType, which is content-kind, not physical format. String or array of strings."
|
|
2710
2820
|
},
|
|
2711
2821
|
"provenance": {
|
|
@@ -2956,6 +3066,177 @@
|
|
|
2956
3066
|
"description": "Statistics for the assessment run(s) such as duration and result counts.",
|
|
2957
3067
|
"title": "Statistics"
|
|
2958
3068
|
},
|
|
3069
|
+
"Raw_Source_Artifact": {
|
|
3070
|
+
"allOf": [
|
|
3071
|
+
{
|
|
3072
|
+
"$ref": "#/components/schemas/External_Reference"
|
|
3073
|
+
},
|
|
3074
|
+
{
|
|
3075
|
+
"not": {
|
|
3076
|
+
"required": [
|
|
3077
|
+
"document"
|
|
3078
|
+
]
|
|
3079
|
+
}
|
|
3080
|
+
},
|
|
3081
|
+
{
|
|
3082
|
+
"if": {
|
|
3083
|
+
"required": [
|
|
3084
|
+
"content"
|
|
3085
|
+
]
|
|
3086
|
+
},
|
|
3087
|
+
"then": {
|
|
3088
|
+
"required": [
|
|
3089
|
+
"encoding",
|
|
3090
|
+
"mediaType"
|
|
3091
|
+
]
|
|
3092
|
+
}
|
|
3093
|
+
}
|
|
3094
|
+
],
|
|
3095
|
+
"description": "One artifact exactly as a converter received it, before conversion.\n\nAn External_Reference used for a single purpose, so the same primitive both points and embeds: `sourceName` names the producing tool; `content` + `encoding` carry the bytes; `checksum` is of the exact bytes the converter read; `rel` is 'raw-source'; `href` appears only when the caller supplied a location that means something to a reader, never a producer's local filesystem path.\n\nBYTES, NOT A PARSED COPY. `document` is forbidden here, enforced by the schema rather than described: it holds a parsed JSON object, so embedding through it discards the original whitespace, key order, duplicate keys and trailing bytes — which makes the artifact unreconstructable and the checksum unverifiable against what is stored. A JSON input carries as a `content` string like every other input. This is deliberately stricter than HDF v2, whose `passthrough.raw` held a parsed structure in every converter but one, and which for XML inputs stored a reshaped object whose keys could collide.\n\n`mediaType` is REQUIRED on an entry that embeds — bytes whose type a consumer has to infer are not carriage. It is derived from the converter's declared input family (json → application/json, xml → application/xml, text → text/plain) and overridden by converters that know their bytes more precisely (CSV, NDJSON, JavaScript-wrapped JSON).\n\nAn entry that only points at a location may omit `mediaType`, `content` and `encoding`.",
|
|
3096
|
+
"$comment": "Examples, in order: 1) JSON input embedded as a utf-8 `content` string — the common case, and note it is NOT a parsed object; 2) XML input, which `document` never could have held; 3) CSV input, where `mediaType` overrides the 'text' input family's derived text/plain; 4) non-text input (a Fortify FPR zip) embedded as base64; 5) by-reference only: a scan retrievable at a meaningful URL, with no embedded copy and therefore no required mediaType, encoding or content.",
|
|
3097
|
+
"examples": [
|
|
3098
|
+
{
|
|
3099
|
+
"sourceName": "grype",
|
|
3100
|
+
"rel": "raw-source",
|
|
3101
|
+
"mediaType": "application/json",
|
|
3102
|
+
"encoding": "utf-8",
|
|
3103
|
+
"content": "{\"matches\":[{\"vulnerability\":{\"id\":\"CVE-2021-36159\",\"severity\":\"Critical\"}}]}",
|
|
3104
|
+
"checksum": {
|
|
3105
|
+
"algorithm": "sha256",
|
|
3106
|
+
"value": "4b33be77f104d6ee323ff2c945d1c3f9a151606b2d263ea7932716844c75920c"
|
|
3107
|
+
}
|
|
3108
|
+
},
|
|
3109
|
+
{
|
|
3110
|
+
"sourceName": "openscap",
|
|
3111
|
+
"rel": "raw-source",
|
|
3112
|
+
"mediaType": "application/xml",
|
|
3113
|
+
"encoding": "utf-8",
|
|
3114
|
+
"content": "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n<Benchmark xmlns=\"http://checklists.nist.gov/xccdf/1.2\" id=\"xccdf_org.ssgproject.content_benchmark_RHEL-9\">\n <TestResult id=\"xccdf_org.open-scap_testresult_default-profile\" start-time=\"2026-09-27T12:00:00+00:00\" end-time=\"2026-09-27T12:04:11+00:00\">\n <rule-result idref=\"xccdf_org.ssgproject.content_rule_sshd_disable_root_login\" severity=\"medium\">\n <result>fail</result>\n </rule-result>\n </TestResult>\n</Benchmark>",
|
|
3115
|
+
"checksum": {
|
|
3116
|
+
"algorithm": "sha256",
|
|
3117
|
+
"value": "713b3ee32af5c14ac93e519b5025d760983607143dba3a0438f68667923beda1"
|
|
3118
|
+
}
|
|
3119
|
+
},
|
|
3120
|
+
{
|
|
3121
|
+
"sourceName": "prisma",
|
|
3122
|
+
"rel": "raw-source",
|
|
3123
|
+
"mediaType": "text/csv",
|
|
3124
|
+
"encoding": "utf-8",
|
|
3125
|
+
"content": "Hostname,Distro,CVE ID,Compliance ID,Type,Severity,Packages,Source Package,Package Version\nhost-01,Ubuntu 22.04,CVE-2021-36159,,image,critical,apk-tools,apk-tools,2.12.5-r1\n",
|
|
3126
|
+
"checksum": {
|
|
3127
|
+
"algorithm": "sha256",
|
|
3128
|
+
"value": "c5a8077ee069e18fd6687c6b1c4f72fdbc95b7af77d954b6fb5e522cd783aa83"
|
|
3129
|
+
}
|
|
3130
|
+
},
|
|
3131
|
+
{
|
|
3132
|
+
"sourceName": "fortify",
|
|
3133
|
+
"rel": "raw-source",
|
|
3134
|
+
"mediaType": "application/zip",
|
|
3135
|
+
"encoding": "base64",
|
|
3136
|
+
"content": "UEsDBBQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAYXVkaXQuZnZkbLOxr8jNUShLLSrOzM+zVTLUM1Cyt7NxC3Px0bcDAFBLAQIUAxQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAAAAAAAAAAACAAQAAAABhdWRpdC5mdmRsUEsFBgAAAAABAAEAOAAAAEYAAAAAAA==",
|
|
3137
|
+
"checksum": {
|
|
3138
|
+
"algorithm": "sha256",
|
|
3139
|
+
"value": "c7e4cefceecb83511ae6174c7d22584061671dee6dc5f27243503b47532a66b1"
|
|
3140
|
+
}
|
|
3141
|
+
},
|
|
3142
|
+
{
|
|
3143
|
+
"sourceName": "nessus",
|
|
3144
|
+
"rel": "raw-source",
|
|
3145
|
+
"href": "https://scans.example.gov/exports/2026-09-27-prod-web.nessus",
|
|
3146
|
+
"mediaType": "application/xml",
|
|
3147
|
+
"checksum": {
|
|
3148
|
+
"algorithm": "sha256",
|
|
3149
|
+
"value": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2"
|
|
3150
|
+
}
|
|
3151
|
+
}
|
|
3152
|
+
]
|
|
3153
|
+
},
|
|
3154
|
+
"Extensions": {
|
|
3155
|
+
"type": "object",
|
|
3156
|
+
"additionalProperties": false,
|
|
3157
|
+
"properties": {
|
|
3158
|
+
"passthrough": {
|
|
3159
|
+
"type": "object",
|
|
3160
|
+
"additionalProperties": true,
|
|
3161
|
+
"description": "Catch-all for producer data that HDF does not model — the role heimdall2's `passthrough.auxiliary_data` played: fields a converter deliberately carried but had no home for.\n\nDeliberately permissive: unenumerated properties are accepted by design, with no shape imposed on them. HDF neither reads nor interprets what is here. It is the ONLY permissive surface in `extensions` — everything HDF does not define belongs here rather than beside it.\n\nThis is NOT where the pre-converted source artifact goes. v2 put it here only because nothing else had room; `rawSourceArtifacts` is its home now, and it gives the bytes a checksum, a media type and a reference contract that an untyped object cannot.\n\nFor data that belongs to one requirement rather than to the document, use that object's own fields — a document-level bag cannot say which requirement it describes.",
|
|
3162
|
+
"examples": [
|
|
3163
|
+
{
|
|
3164
|
+
"auxiliary_data": [
|
|
3165
|
+
{
|
|
3166
|
+
"name": "Scoutsuite",
|
|
3167
|
+
"data": {
|
|
3168
|
+
"last_run": {
|
|
3169
|
+
"ruleset_about": "This ruleset consists of numerous rules that are considered standard by NCC Group"
|
|
3170
|
+
}
|
|
3171
|
+
}
|
|
3172
|
+
}
|
|
3173
|
+
]
|
|
3174
|
+
},
|
|
3175
|
+
{
|
|
3176
|
+
"audit": {
|
|
3177
|
+
"runId": "r-123"
|
|
3178
|
+
}
|
|
3179
|
+
}
|
|
3180
|
+
],
|
|
3181
|
+
"$comment": "Examples, in order: 1) heimdall2's auxiliary_data shape, the data a v2 mapper carried with nowhere else to put it; 2) the legacy top-level `passthrough` an HDF document arrived with, relocated here verbatim by the SAF-supplement normalizer."
|
|
3182
|
+
},
|
|
3183
|
+
"rawSourceArtifacts": {
|
|
3184
|
+
"type": "array",
|
|
3185
|
+
"items": {
|
|
3186
|
+
"$ref": "#/components/schemas/Raw_Source_Artifact"
|
|
3187
|
+
},
|
|
3188
|
+
"description": "The input(s) this document was converted from, verbatim.\n\nAn array because a conversion can consume more than one artifact — the OSCAL profile path takes a profile and a catalog. Every other converter takes one input, and an array of one costs nothing.\n\nPopulating this is required of ingest converters by policy, enforced by the converter contract and test harness rather than by a schema `required`: a tool that emits HDF natively has no source artifact, and requiring the field would make valid native HDF invalid."
|
|
3189
|
+
}
|
|
3190
|
+
},
|
|
3191
|
+
"title": "Extensions",
|
|
3192
|
+
"description": "Carrier for data outside the HDF model: `passthrough` for producer data HDF does not model, `rawSourceArtifacts` for the pre-converted input(s).\n\nCLOSED: these two members are the whole of it. A key HDF does not define goes inside `passthrough` — that is what `passthrough` is for — so `extensions` never becomes a second, unnamed schema that consumers must reverse-engineer from the producers that happen to write it.\n\nClosed with `additionalProperties` rather than the house `unevaluatedProperties` because this definition composes nothing, and the shipped Go validator is a draft-07 engine that does not implement `unevaluatedProperties` — a closure only one of the two validators enforces is not a closure.\n\nDeclared on every HDF document type that carries a producer envelope (`generator` / `integrity`), and on `Evaluated_Baseline`, so one rule governs both sites.",
|
|
3193
|
+
"$comment": "Examples, in order: 1) the whole contract in one object — a converter's input embedded beside the producer data it could not map; 2) carriage alone, the shape a converter emits when it has nothing homeless to record.",
|
|
3194
|
+
"examples": [
|
|
3195
|
+
{
|
|
3196
|
+
"passthrough": {
|
|
3197
|
+
"auxiliary_data": [
|
|
3198
|
+
{
|
|
3199
|
+
"name": "Grype",
|
|
3200
|
+
"data": {
|
|
3201
|
+
"descriptor": {
|
|
3202
|
+
"name": "grype",
|
|
3203
|
+
"version": "0.74.0"
|
|
3204
|
+
}
|
|
3205
|
+
}
|
|
3206
|
+
}
|
|
3207
|
+
]
|
|
3208
|
+
},
|
|
3209
|
+
"rawSourceArtifacts": [
|
|
3210
|
+
{
|
|
3211
|
+
"sourceName": "grype",
|
|
3212
|
+
"rel": "raw-source",
|
|
3213
|
+
"mediaType": "application/json",
|
|
3214
|
+
"encoding": "utf-8",
|
|
3215
|
+
"content": "{\"matches\":[{\"vulnerability\":{\"id\":\"CVE-2021-36159\",\"severity\":\"Critical\"}}]}",
|
|
3216
|
+
"checksum": {
|
|
3217
|
+
"algorithm": "sha256",
|
|
3218
|
+
"value": "4b33be77f104d6ee323ff2c945d1c3f9a151606b2d263ea7932716844c75920c"
|
|
3219
|
+
}
|
|
3220
|
+
}
|
|
3221
|
+
]
|
|
3222
|
+
},
|
|
3223
|
+
{
|
|
3224
|
+
"rawSourceArtifacts": [
|
|
3225
|
+
{
|
|
3226
|
+
"sourceName": "fortify",
|
|
3227
|
+
"rel": "raw-source",
|
|
3228
|
+
"mediaType": "application/zip",
|
|
3229
|
+
"encoding": "base64",
|
|
3230
|
+
"content": "UEsDBBQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAYXVkaXQuZnZkbLOxr8jNUShLLSrOzM+zVTLUM1Cyt7NxC3Px0bcDAFBLAQIUAxQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAAAAAAAAAAACAAQAAAABhdWRpdC5mdmRsUEsFBgAAAAABAAEAOAAAAEYAAAAAAA==",
|
|
3231
|
+
"checksum": {
|
|
3232
|
+
"algorithm": "sha256",
|
|
3233
|
+
"value": "c7e4cefceecb83511ae6174c7d22584061671dee6dc5f27243503b47532a66b1"
|
|
3234
|
+
}
|
|
3235
|
+
}
|
|
3236
|
+
]
|
|
3237
|
+
}
|
|
3238
|
+
]
|
|
3239
|
+
},
|
|
2959
3240
|
"Status_Override": {
|
|
2960
3241
|
"type": "object",
|
|
2961
3242
|
"unevaluatedProperties": false,
|
|
@@ -2966,16 +3247,71 @@
|
|
|
2966
3247
|
"appliedAt",
|
|
2967
3248
|
"expiresAt"
|
|
2968
3249
|
],
|
|
2969
|
-
"
|
|
3250
|
+
"allOf": [
|
|
2970
3251
|
{
|
|
2971
|
-
"
|
|
2972
|
-
"
|
|
2973
|
-
|
|
3252
|
+
"if": {
|
|
3253
|
+
"properties": {
|
|
3254
|
+
"type": {
|
|
3255
|
+
"enum": [
|
|
3256
|
+
"operationalRequirement"
|
|
3257
|
+
]
|
|
3258
|
+
}
|
|
3259
|
+
},
|
|
3260
|
+
"required": [
|
|
3261
|
+
"type"
|
|
3262
|
+
]
|
|
3263
|
+
},
|
|
3264
|
+
"then": {
|
|
3265
|
+
"not": {
|
|
3266
|
+
"anyOf": [
|
|
3267
|
+
{
|
|
3268
|
+
"required": [
|
|
3269
|
+
"status"
|
|
3270
|
+
]
|
|
3271
|
+
},
|
|
3272
|
+
{
|
|
3273
|
+
"required": [
|
|
3274
|
+
"impact"
|
|
3275
|
+
]
|
|
3276
|
+
}
|
|
3277
|
+
]
|
|
3278
|
+
}
|
|
3279
|
+
},
|
|
3280
|
+
"else": {
|
|
3281
|
+
"anyOf": [
|
|
3282
|
+
{
|
|
3283
|
+
"required": [
|
|
3284
|
+
"status"
|
|
3285
|
+
]
|
|
3286
|
+
},
|
|
3287
|
+
{
|
|
3288
|
+
"required": [
|
|
3289
|
+
"impact"
|
|
3290
|
+
]
|
|
3291
|
+
}
|
|
3292
|
+
]
|
|
3293
|
+
}
|
|
2974
3294
|
},
|
|
2975
3295
|
{
|
|
2976
|
-
"
|
|
2977
|
-
"
|
|
2978
|
-
|
|
3296
|
+
"if": {
|
|
3297
|
+
"properties": {
|
|
3298
|
+
"type": {
|
|
3299
|
+
"enum": [
|
|
3300
|
+
"riskAdjustment"
|
|
3301
|
+
]
|
|
3302
|
+
}
|
|
3303
|
+
},
|
|
3304
|
+
"required": [
|
|
3305
|
+
"type"
|
|
3306
|
+
]
|
|
3307
|
+
},
|
|
3308
|
+
"then": {
|
|
3309
|
+
"not": {
|
|
3310
|
+
"required": [
|
|
3311
|
+
"status"
|
|
3312
|
+
]
|
|
3313
|
+
}
|
|
3314
|
+
}
|
|
2979
3315
|
}
|
|
2980
3316
|
],
|
|
2981
3317
|
"properties": {
|
|
@@ -2992,11 +3328,11 @@
|
|
|
2992
3328
|
},
|
|
2993
3329
|
"status": {
|
|
2994
3330
|
"$ref": "#/components/schemas/Result_Status",
|
|
2995
|
-
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden."
|
|
3331
|
+
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden; forbidden on an operationalRequirement, which adjudicates nothing, and on a riskAdjustment, which re-rates impact only."
|
|
2996
3332
|
},
|
|
2997
3333
|
"impact": {
|
|
2998
3334
|
"$ref": "#/components/schemas/Impact_Override",
|
|
2999
|
-
"description": "Override to the requirement's impact score.
|
|
3335
|
+
"description": "Override to the requirement's impact score. For every type except operationalRequirement, at least one of status or impact must be set; an operationalRequirement carries neither."
|
|
3000
3336
|
},
|
|
3001
3337
|
"reason": {
|
|
3002
3338
|
"type": "string",
|
|
@@ -3041,7 +3377,7 @@
|
|
|
3041
3377
|
"description": "Structured controlled-vocabulary classification for why this override applies. Complements (does not replace) the free-text 'reason' field. Most useful on falsePositive and attestation overrides where the structured category enables filtering and lossless round-trip with VEX / OSCAL / FedRAMP DR. See the Justification primitive for the precedent vocabulary and rationale."
|
|
3042
3378
|
}
|
|
3043
3379
|
},
|
|
3044
|
-
"$comment": "Example 3: Inline riskAdjustment carrying the STIX source that motivated it via externalReferences (the enrichment envelope, with the raw sighting embedded losslessly in document). This is the shape the enrich pass writes onto Evaluated_Requirement.overrides[] for the E:A recompute.",
|
|
3380
|
+
"$comment": "Example 3: Inline riskAdjustment carrying the STIX source that motivated it via externalReferences (the enrichment envelope, with the raw sighting embedded losslessly in document). This is the shape the enrich pass writes onto Evaluated_Requirement.overrides[] for the E:A recompute. Example 7: operationalRequirement as it sits on the requirement after apply: no status, no impact; the finding stays failed and disposition reports operationalRequirement.",
|
|
3045
3381
|
"examples": [
|
|
3046
3382
|
{
|
|
3047
3383
|
"type": "waiver",
|
|
@@ -3141,9 +3477,19 @@
|
|
|
3141
3477
|
}
|
|
3142
3478
|
}
|
|
3143
3479
|
]
|
|
3480
|
+
},
|
|
3481
|
+
{
|
|
3482
|
+
"type": "operationalRequirement",
|
|
3483
|
+
"reason": "Air-gapped ingest requires USB transfer per operational procedure OP-2026-003. Ports are physically secured, transfers are logged and need two-person integrity.",
|
|
3484
|
+
"appliedBy": {
|
|
3485
|
+
"type": "email",
|
|
3486
|
+
"identifier": "system-owner@agency.gov"
|
|
3487
|
+
},
|
|
3488
|
+
"appliedAt": "2026-01-20T10:00:00Z",
|
|
3489
|
+
"expiresAt": "2099-12-31T00:00:00Z"
|
|
3144
3490
|
}
|
|
3145
3491
|
],
|
|
3146
|
-
"description": "An intentional change to a requirement's compliance status and/or impact score.
|
|
3492
|
+
"description": "An intentional change to a requirement's compliance status and/or impact score, as it sits on the requirement once applied. The same type-conditional rule as Standalone_Override: when type is 'operationalRequirement', neither status nor impact may be set, because the override records an accepted deviation without adjudicating the finding; it still governs disposition, and effectiveStatus stays what the results decided. When type is 'riskAdjustment', status may not be set: it re-rates the risk through impact and never changes pass/fail. For every other type, at least one of status or impact must be set. All overrides must have an expiration date to enforce periodic review.",
|
|
3147
3493
|
"title": "Status Override"
|
|
3148
3494
|
},
|
|
3149
3495
|
"POAM": {
|
|
@@ -3348,14 +3694,6 @@
|
|
|
3348
3694
|
"Integrity": {
|
|
3349
3695
|
"type": "object",
|
|
3350
3696
|
"unevaluatedProperties": false,
|
|
3351
|
-
"dependentRequired": {
|
|
3352
|
-
"algorithm": [
|
|
3353
|
-
"checksum"
|
|
3354
|
-
],
|
|
3355
|
-
"checksum": [
|
|
3356
|
-
"algorithm"
|
|
3357
|
-
]
|
|
3358
|
-
},
|
|
3359
3697
|
"properties": {
|
|
3360
3698
|
"algorithm": {
|
|
3361
3699
|
"$ref": "#/components/schemas/Hash_Algorithm",
|
|
@@ -3387,7 +3725,33 @@
|
|
|
3387
3725
|
}
|
|
3388
3726
|
],
|
|
3389
3727
|
"description": "Cryptographic integrity information for verifying the HDF file has not been tampered with. If algorithm is provided, checksum must also be provided, and vice versa.",
|
|
3390
|
-
"title": "Integrity"
|
|
3728
|
+
"title": "Integrity",
|
|
3729
|
+
"allOf": [
|
|
3730
|
+
{
|
|
3731
|
+
"if": {
|
|
3732
|
+
"required": [
|
|
3733
|
+
"algorithm"
|
|
3734
|
+
]
|
|
3735
|
+
},
|
|
3736
|
+
"then": {
|
|
3737
|
+
"required": [
|
|
3738
|
+
"checksum"
|
|
3739
|
+
]
|
|
3740
|
+
}
|
|
3741
|
+
},
|
|
3742
|
+
{
|
|
3743
|
+
"if": {
|
|
3744
|
+
"required": [
|
|
3745
|
+
"checksum"
|
|
3746
|
+
]
|
|
3747
|
+
},
|
|
3748
|
+
"then": {
|
|
3749
|
+
"required": [
|
|
3750
|
+
"algorithm"
|
|
3751
|
+
]
|
|
3752
|
+
}
|
|
3753
|
+
}
|
|
3754
|
+
]
|
|
3391
3755
|
},
|
|
3392
3756
|
"Override_Type": {
|
|
3393
3757
|
"type": "string",
|
|
@@ -3400,7 +3764,7 @@
|
|
|
3400
3764
|
"riskAdjustment",
|
|
3401
3765
|
"operationalRequirement"
|
|
3402
3766
|
],
|
|
3403
|
-
"description": "The type of amendment, aligned with FedRAMP deviation request categories.\n\n- 'waiver': risk accepted by Authorizing Official.\n- 'attestation': manually verified by assessor.\n- 'poam': remediation tracked (no status change).\n- 'inherited': control provided by another component or system.\n- 'falsePositive': scanner incorrectly identified a finding — for compliance scans (STIG, CIS), the check actually passes, so status is typically set to 'passed'; for vulnerability scans (CVE, SCA), the flagged vulnerability does not apply to this system, so status is typically set to 'notApplicable'. The disposition field on the requirement distinguishes false positives from genuinely not-applicable findings.\n- 'riskAdjustment': impact score adjusted based on environmental context (FedRAMP Risk Adjustment); does not change pass/fail status, only impact via the impact field.\n- 'operationalRequirement': deviation required by operational constraints (FedRAMP Operational Requirement); the finding cannot be remediated because the system requires the affected functionality. Remains an open risk.\n\nMigration note: 'exception' was removed in v3.1.0 — use 'waiver' with status 'notApplicable' instead.",
|
|
3767
|
+
"description": "The type of amendment, aligned with FedRAMP deviation request categories.\n\n- 'waiver': risk accepted by Authorizing Official.\n- 'attestation': manually verified by assessor.\n- 'poam': remediation tracked (no status change).\n- 'inherited': control provided by another component or system.\n- 'falsePositive': scanner incorrectly identified a finding — for compliance scans (STIG, CIS), the check actually passes, so status is typically set to 'passed'; for vulnerability scans (CVE, SCA), the flagged vulnerability does not apply to this system, so status is typically set to 'notApplicable'. The disposition field on the requirement distinguishes false positives from genuinely not-applicable findings.\n- 'riskAdjustment': impact score adjusted based on environmental context (FedRAMP Risk Adjustment); does not change pass/fail status, only impact via the impact field; a status on it is rejected by validation.\n- 'operationalRequirement': deviation required by operational constraints (FedRAMP Operational Requirement); the finding cannot be remediated because the system requires the affected functionality. Remains an open risk.\n\nMigration note: 'exception' was removed in v3.1.0 — use 'waiver' with status 'notApplicable' instead.",
|
|
3404
3768
|
"title": "Override Type"
|
|
3405
3769
|
},
|
|
3406
3770
|
"Justification": {
|
|
@@ -3440,7 +3804,7 @@
|
|
|
3440
3804
|
},
|
|
3441
3805
|
"Standalone_Override": {
|
|
3442
3806
|
"type": "object",
|
|
3443
|
-
"description": "A standalone override to a requirement's compliance status or risk impact.\n\nValidation
|
|
3807
|
+
"description": "A standalone override to a requirement's compliance status or risk impact.\n\nValidation is gated on 'type': when type is 'operationalRequirement', neither 'status' nor 'impact' may be set — the override records accepted risk without changing the finding (documentation-only). When type is 'riskAdjustment', 'status' may not be set — it re-rates the risk through 'impact' and never changes the finding's pass/fail; an override that must change status is a waiver or falsePositive. For all other types, at least one of 'status' or 'impact' must be set.\n\nThis rule aligns with:\n- OSCAL Assessment Results — finding.target.status and finding.associated-risk[].facet[] are separate axes (https://pages.nist.gov/OSCAL/learn/concepts/layer/assessment/assessment-results/)\n- FedRAMP deviation request types — Risk Adjustment changes impact only, Operational Requirement documents acceptance only, False Positive changes status (https://www.ignyteplatform.com/blog/fedramp/fedramp-deviation-requests-submit/)\n- NIST SP 800-37 RMF — risk response (accept/mitigate/transfer) is a separate step from control assessment status (https://csrc.nist.gov/pubs/sp/800/37/r2/final).",
|
|
3444
3808
|
"unevaluatedProperties": false,
|
|
3445
3809
|
"required": [
|
|
3446
3810
|
"type",
|
|
@@ -3450,48 +3814,73 @@
|
|
|
3450
3814
|
"appliedAt",
|
|
3451
3815
|
"expiresAt"
|
|
3452
3816
|
],
|
|
3453
|
-
"
|
|
3454
|
-
|
|
3455
|
-
"
|
|
3456
|
-
"
|
|
3457
|
-
"
|
|
3817
|
+
"allOf": [
|
|
3818
|
+
{
|
|
3819
|
+
"if": {
|
|
3820
|
+
"properties": {
|
|
3821
|
+
"type": {
|
|
3822
|
+
"enum": [
|
|
3823
|
+
"operationalRequirement"
|
|
3824
|
+
]
|
|
3825
|
+
}
|
|
3826
|
+
},
|
|
3827
|
+
"required": [
|
|
3828
|
+
"type"
|
|
3829
|
+
]
|
|
3830
|
+
},
|
|
3831
|
+
"then": {
|
|
3832
|
+
"not": {
|
|
3833
|
+
"anyOf": [
|
|
3834
|
+
{
|
|
3835
|
+
"required": [
|
|
3836
|
+
"status"
|
|
3837
|
+
]
|
|
3838
|
+
},
|
|
3839
|
+
{
|
|
3840
|
+
"required": [
|
|
3841
|
+
"impact"
|
|
3842
|
+
]
|
|
3843
|
+
}
|
|
3844
|
+
]
|
|
3845
|
+
}
|
|
3846
|
+
},
|
|
3847
|
+
"else": {
|
|
3848
|
+
"anyOf": [
|
|
3849
|
+
{
|
|
3850
|
+
"required": [
|
|
3851
|
+
"status"
|
|
3852
|
+
]
|
|
3853
|
+
},
|
|
3854
|
+
{
|
|
3855
|
+
"required": [
|
|
3856
|
+
"impact"
|
|
3857
|
+
]
|
|
3858
|
+
}
|
|
3458
3859
|
]
|
|
3459
3860
|
}
|
|
3460
3861
|
},
|
|
3461
|
-
|
|
3462
|
-
"
|
|
3463
|
-
|
|
3464
|
-
|
|
3465
|
-
|
|
3466
|
-
|
|
3467
|
-
|
|
3468
|
-
|
|
3469
|
-
"required": [
|
|
3470
|
-
"status"
|
|
3471
|
-
]
|
|
3862
|
+
{
|
|
3863
|
+
"if": {
|
|
3864
|
+
"properties": {
|
|
3865
|
+
"type": {
|
|
3866
|
+
"enum": [
|
|
3867
|
+
"riskAdjustment"
|
|
3868
|
+
]
|
|
3869
|
+
}
|
|
3472
3870
|
},
|
|
3473
|
-
{
|
|
3474
|
-
"required": [
|
|
3475
|
-
"impact"
|
|
3476
|
-
]
|
|
3477
|
-
}
|
|
3478
|
-
]
|
|
3479
|
-
}
|
|
3480
|
-
},
|
|
3481
|
-
"else": {
|
|
3482
|
-
"anyOf": [
|
|
3483
|
-
{
|
|
3484
3871
|
"required": [
|
|
3485
|
-
"
|
|
3872
|
+
"type"
|
|
3486
3873
|
]
|
|
3487
3874
|
},
|
|
3488
|
-
{
|
|
3489
|
-
"
|
|
3490
|
-
"
|
|
3491
|
-
|
|
3875
|
+
"then": {
|
|
3876
|
+
"not": {
|
|
3877
|
+
"required": [
|
|
3878
|
+
"status"
|
|
3879
|
+
]
|
|
3880
|
+
}
|
|
3492
3881
|
}
|
|
3493
|
-
|
|
3494
|
-
|
|
3882
|
+
}
|
|
3883
|
+
],
|
|
3495
3884
|
"properties": {
|
|
3496
3885
|
"externalReferences": {
|
|
3497
3886
|
"type": "array",
|
|
@@ -3507,7 +3896,7 @@
|
|
|
3507
3896
|
"requirementId": {
|
|
3508
3897
|
"type": "string",
|
|
3509
3898
|
"minLength": 1,
|
|
3510
|
-
"description": "The
|
|
3899
|
+
"description": "The id of the requirement being amended. An id names the requirement, not one finding, so the override applies to every requirement entry carrying that id in the baseline(s) it targets."
|
|
3511
3900
|
},
|
|
3512
3901
|
"baselineRef": {
|
|
3513
3902
|
"type": "string",
|
|
@@ -3515,7 +3904,7 @@
|
|
|
3515
3904
|
},
|
|
3516
3905
|
"status": {
|
|
3517
3906
|
"$ref": "#/components/schemas/Result_Status",
|
|
3518
|
-
"description": "The new status this
|
|
3907
|
+
"description": "The new status this override sets for the requirement. Optional when only impact is being overridden; forbidden on an operationalRequirement, which adjudicates nothing, and on a riskAdjustment, which re-rates impact only."
|
|
3519
3908
|
},
|
|
3520
3909
|
"impact": {
|
|
3521
3910
|
"$ref": "#/components/schemas/Impact_Override",
|
|
@@ -3775,6 +4164,10 @@
|
|
|
3775
4164
|
"type": "string"
|
|
3776
4165
|
},
|
|
3777
4166
|
"description": "The stacktrace/backtrace of the exception if one occurred."
|
|
4167
|
+
},
|
|
4168
|
+
"rawSourceRecord": {
|
|
4169
|
+
"$ref": "#/components/schemas/Raw_Source_Record",
|
|
4170
|
+
"description": "The source tool's own record for this result, carrying every field the record had. Complete, not necessarily byte-exact: see Raw_Source_Record.content for the producer and consumer obligations, and extensions.rawSourceArtifacts[] when byte-exact carriage is required."
|
|
3778
4171
|
}
|
|
3779
4172
|
},
|
|
3780
4173
|
"examples": [
|
|
@@ -3805,6 +4198,60 @@
|
|
|
3805
4198
|
"description": "A test within a requirement and its results and findings such as how long it took to run.",
|
|
3806
4199
|
"title": "Requirement Result"
|
|
3807
4200
|
},
|
|
4201
|
+
"Raw_Source_Record": {
|
|
4202
|
+
"type": "object",
|
|
4203
|
+
"additionalProperties": false,
|
|
4204
|
+
"required": [
|
|
4205
|
+
"content",
|
|
4206
|
+
"encoding",
|
|
4207
|
+
"mediaType"
|
|
4208
|
+
],
|
|
4209
|
+
"properties": {
|
|
4210
|
+
"content": {
|
|
4211
|
+
"type": "string",
|
|
4212
|
+
"description": "The source tool's own record for this result, carrying every field the record had.\n\nCOMPLETE, NOT NECESSARILY BYTE-EXACT. A producer SHOULD write the record's bytes unchanged where it can. A producer that cannot — notably one implemented in two languages whose JSON serializers disagree on key order, HTML escaping and number rendering, and which therefore MUST canonicalize to stay byte-identical with its twin — MAY write a canonically serialized form instead. Such a form preserves every field and value but not the original key order, insignificant whitespace, or duplicate keys. A consumer MUST therefore compare records by parsing them, not by comparing bytes, and MUST NOT checksum this field and expect the result to match a checksum of the input.\n\nFor carriage that IS byte-exact, use `extensions.rawSourceArtifacts[]`, which forbids a parsed `document` precisely so the bytes and their checksum survive; `pointer` ties this record to its position within that artifact."
|
|
4213
|
+
},
|
|
4214
|
+
"encoding": {
|
|
4215
|
+
"$ref": "#/components/schemas/External_Reference_Encoding",
|
|
4216
|
+
"description": "How to read `content`: 'utf-8' for text, 'base64' for bytes that are not valid UTF-8 text."
|
|
4217
|
+
},
|
|
4218
|
+
"mediaType": {
|
|
4219
|
+
"type": "string",
|
|
4220
|
+
"description": "The record's IANA media type — the type of this record, which for a fragment of a larger artifact may be narrower than the artifact's own. Example: 'application/json' for one match object out of a JSON report."
|
|
4221
|
+
},
|
|
4222
|
+
"pointer": {
|
|
4223
|
+
"type": "string",
|
|
4224
|
+
"description": "Where this record sits inside the artifact it came from, as a JSON Pointer (RFC 6901) for JSON sources or an XPath for XML ones. Example: '/matches/3'.\n\nOptional, and the link that makes carriage verifiable rather than merely present: with it a consumer can confirm the record really is the subtree of `extensions.rawSourceArtifacts[]` it claims to be. Omit it when the source's shape gives a record no addressable location."
|
|
4225
|
+
}
|
|
4226
|
+
},
|
|
4227
|
+
"description": "The source tool's own record for this result — the one entry in the converter's input that produced it, complete though not necessarily byte-for-byte (see `content`).\n\nSCOPED TO THE RESULT DELIBERATELY. For a vulnerability scanner the native record is one (vulnerability, package) pair, which is exactly one result: a CVE reported against two packages yields two entries whose records differ only in the package they matched. Held on the requirement instead, those two records would collide, and merging entries that share an id would have to discard one — so the result is not merely an available home but the correct one.\n\nDistinct from `extensions.rawSourceArtifacts[]`, which carries whole input artifacts: this carries the one record inside one of them, and `pointer` ties the two together. A consumer that wants the whole input reads the artifact; one that wants provenance for a single finding reads this.\n\nDistinct from `code`, which means the code that ran to evaluate the requirement — an InSpec control's source, or a check reference. A serialized finding is not code, and putting one there overloaded a field whose meaning came from InSpec.\n\nCLOSED, and deliberately not a passthrough bag: three required members and an optional pointer are the whole of it. Producer data that HDF does not model belongs in `extensions.passthrough`, which is document-scoped and permissive by design; this field is neither.\n\nClosed with `additionalProperties` rather than the house `unevaluatedProperties` because this definition composes nothing, and the shipped Go validator is a draft-07 engine that does not implement `unevaluatedProperties` — a closure only one of the two validators enforces is not a closure.",
|
|
4228
|
+
"$comment": "Examples, in order: 1) one grype match — the shape that moves out of `code` — located in the carried artifact by pointer; 2) an XCCDF rule-result, where the record is XML although the document embedding it is JSON, so mediaType is per record and not per document; 3) a record whose bytes are not text, carried as base64; 4) the minimum: a record whose source shape gives it no addressable location, so pointer is omitted.",
|
|
4229
|
+
"examples": [
|
|
4230
|
+
{
|
|
4231
|
+
"content": "{\"vulnerability\":{\"id\":\"CVE-2022-48174\",\"severity\":\"Critical\"},\"artifact\":{\"name\":\"ssl_client\",\"version\":\"1.31.1-r9\",\"type\":\"apk\"}}",
|
|
4232
|
+
"encoding": "utf-8",
|
|
4233
|
+
"mediaType": "application/json",
|
|
4234
|
+
"pointer": "/matches/3"
|
|
4235
|
+
},
|
|
4236
|
+
{
|
|
4237
|
+
"content": "<rule-result idref=\"xccdf_org.ssgproject.content_rule_sshd_disable_root_login\" severity=\"medium\">\n <result>fail</result>\n</rule-result>",
|
|
4238
|
+
"encoding": "utf-8",
|
|
4239
|
+
"mediaType": "application/xml",
|
|
4240
|
+
"pointer": "/Benchmark/TestResult/rule-result[4]"
|
|
4241
|
+
},
|
|
4242
|
+
{
|
|
4243
|
+
"content": "UEsDBBQAAAAIAEVnPF20b/JoHgAAABwAAAAKAAAAYXVkaXQuZnZkbA==",
|
|
4244
|
+
"encoding": "base64",
|
|
4245
|
+
"mediaType": "application/octet-stream"
|
|
4246
|
+
},
|
|
4247
|
+
{
|
|
4248
|
+
"content": "host-01,Ubuntu 22.04,CVE-2021-36159,,image,critical,apk-tools,apk-tools,2.12.5-r1",
|
|
4249
|
+
"encoding": "utf-8",
|
|
4250
|
+
"mediaType": "text/csv"
|
|
4251
|
+
}
|
|
4252
|
+
],
|
|
4253
|
+
"title": "Raw Source Record"
|
|
4254
|
+
},
|
|
3808
4255
|
"Requirement_Description": {
|
|
3809
4256
|
"type": "object",
|
|
3810
4257
|
"unevaluatedProperties": false,
|
|
@@ -4287,7 +4734,7 @@
|
|
|
4287
4734
|
"systemRef": "apptier.hdf-system.json",
|
|
4288
4735
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
4289
4736
|
"timestamp": "2026-07-22T14:03:11Z",
|
|
4290
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
4737
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
4291
4738
|
"priorChecksum": {
|
|
4292
4739
|
"algorithm": "sha256",
|
|
4293
4740
|
"value": "704f62b2d0803438ad6b7b9bab45e2c4f350b7344135a2a7f8ef986d98669021"
|
|
@@ -4485,7 +4932,8 @@
|
|
|
4485
4932
|
},
|
|
4486
4933
|
"allowedValues": {
|
|
4487
4934
|
"type": "array",
|
|
4488
|
-
"
|
|
4935
|
+
"items": true,
|
|
4936
|
+
"description": "Enumeration of permitted values. Each entry may be any JSON value, the same freedom Input.value has: an Array or Hash input enumerates container values, so no element type is imposed."
|
|
4489
4937
|
}
|
|
4490
4938
|
},
|
|
4491
4939
|
"description": "Validation constraints for an input value.",
|
|
@@ -5120,7 +5568,7 @@
|
|
|
5120
5568
|
"total": {
|
|
5121
5569
|
"type": "integer",
|
|
5122
5570
|
"minimum": 0,
|
|
5123
|
-
"description": "Total number of
|
|
5571
|
+
"description": "Total number of distinct requirement ids across all sources; an id carried by several entries counts once."
|
|
5124
5572
|
},
|
|
5125
5573
|
"matchedCount": {
|
|
5126
5574
|
"type": "integer",
|
|
@@ -5205,6 +5653,21 @@
|
|
|
5205
5653
|
"description": "Summary statistics for the overall comparison.",
|
|
5206
5654
|
"title": "Comparison Summary"
|
|
5207
5655
|
},
|
|
5656
|
+
"Baseline_Diff_State": {
|
|
5657
|
+
"type": "string",
|
|
5658
|
+
"enum": [
|
|
5659
|
+
"new",
|
|
5660
|
+
"absent",
|
|
5661
|
+
"unchanged",
|
|
5662
|
+
"updated"
|
|
5663
|
+
],
|
|
5664
|
+
"description": "How a baseline or component fared across the compared documents: new (only in the newer), absent (only in the older), unchanged, or updated (present in both with a changed version).",
|
|
5665
|
+
"title": "Baseline Diff State",
|
|
5666
|
+
"examples": [
|
|
5667
|
+
"updated"
|
|
5668
|
+
],
|
|
5669
|
+
"$comment": "Examples, in order: 1) a baseline present in both documents whose version moved."
|
|
5670
|
+
},
|
|
5208
5671
|
"Baseline_Diff": {
|
|
5209
5672
|
"type": "object",
|
|
5210
5673
|
"unevaluatedProperties": false,
|
|
@@ -5218,14 +5681,7 @@
|
|
|
5218
5681
|
"description": "Name of the baseline being compared."
|
|
5219
5682
|
},
|
|
5220
5683
|
"state": {
|
|
5221
|
-
"
|
|
5222
|
-
"title": "Baseline Diff State",
|
|
5223
|
-
"enum": [
|
|
5224
|
-
"new",
|
|
5225
|
-
"absent",
|
|
5226
|
-
"unchanged",
|
|
5227
|
-
"updated"
|
|
5228
|
-
],
|
|
5684
|
+
"$ref": "#/components/schemas/Baseline_Diff_State",
|
|
5229
5685
|
"description": "The state of this baseline in the comparison."
|
|
5230
5686
|
},
|
|
5231
5687
|
"oldVersion": {
|
|
@@ -5257,14 +5713,7 @@
|
|
|
5257
5713
|
"description": "Component name used for matching across system versions."
|
|
5258
5714
|
},
|
|
5259
5715
|
"state": {
|
|
5260
|
-
"
|
|
5261
|
-
"title": "Baseline Diff State",
|
|
5262
|
-
"enum": [
|
|
5263
|
-
"new",
|
|
5264
|
-
"absent",
|
|
5265
|
-
"unchanged",
|
|
5266
|
-
"updated"
|
|
5267
|
-
],
|
|
5716
|
+
"$ref": "#/components/schemas/Baseline_Diff_State",
|
|
5268
5717
|
"description": "The state of this component in the comparison."
|
|
5269
5718
|
},
|
|
5270
5719
|
"before": {
|
|
@@ -5524,6 +5973,10 @@
|
|
|
5524
5973
|
"type": "string",
|
|
5525
5974
|
"description": "The requirement title for human readability."
|
|
5526
5975
|
},
|
|
5976
|
+
"baseline": {
|
|
5977
|
+
"type": "string",
|
|
5978
|
+
"description": "Name of the baseline the requirement belongs to, so a consumer can group diffs the way hdf diff --group-by baseline does. '(multiple)' when the id appears in more than one baseline of the same document."
|
|
5979
|
+
},
|
|
5527
5980
|
"oldEffectiveStatus": {
|
|
5528
5981
|
"type": "string",
|
|
5529
5982
|
"description": "The effective status of the requirement in the old source."
|
|
@@ -5589,7 +6042,79 @@
|
|
|
5589
6042
|
}
|
|
5590
6043
|
},
|
|
5591
6044
|
"description": "A comparison of a single requirement between sources, including state, changes, and full before/after snapshots.",
|
|
5592
|
-
"title": "Requirement Diff"
|
|
6045
|
+
"title": "Requirement Diff",
|
|
6046
|
+
"examples": [
|
|
6047
|
+
{
|
|
6048
|
+
"id": "SV-257777",
|
|
6049
|
+
"baseline": "rhel9-stig-baseline",
|
|
6050
|
+
"title": "RHEL 9 must prevent the loading of the USB storage kernel module.",
|
|
6051
|
+
"state": "fixed",
|
|
6052
|
+
"changeReasons": [
|
|
6053
|
+
"resultChanged"
|
|
6054
|
+
],
|
|
6055
|
+
"before": {
|
|
6056
|
+
"id": "SV-257777",
|
|
6057
|
+
"title": "RHEL 9 must prevent the loading of the USB storage kernel module.",
|
|
6058
|
+
"impact": 0.5,
|
|
6059
|
+
"tags": {
|
|
6060
|
+
"nist": [
|
|
6061
|
+
"CM-7"
|
|
6062
|
+
]
|
|
6063
|
+
},
|
|
6064
|
+
"sourceLocation": {},
|
|
6065
|
+
"descriptions": [
|
|
6066
|
+
{
|
|
6067
|
+
"label": "default",
|
|
6068
|
+
"data": "USB mass storage must be disabled unless an operational need is documented."
|
|
6069
|
+
}
|
|
6070
|
+
],
|
|
6071
|
+
"results": [
|
|
6072
|
+
{
|
|
6073
|
+
"status": "failed",
|
|
6074
|
+
"codeDesc": "Kernel module usb-storage is loadable",
|
|
6075
|
+
"startTime": "2026-03-01T10:00:00Z"
|
|
6076
|
+
}
|
|
6077
|
+
]
|
|
6078
|
+
},
|
|
6079
|
+
"after": {
|
|
6080
|
+
"id": "SV-257777",
|
|
6081
|
+
"title": "RHEL 9 must prevent the loading of the USB storage kernel module.",
|
|
6082
|
+
"impact": 0.5,
|
|
6083
|
+
"tags": {
|
|
6084
|
+
"nist": [
|
|
6085
|
+
"CM-7"
|
|
6086
|
+
]
|
|
6087
|
+
},
|
|
6088
|
+
"sourceLocation": {},
|
|
6089
|
+
"descriptions": [
|
|
6090
|
+
{
|
|
6091
|
+
"label": "default",
|
|
6092
|
+
"data": "USB mass storage must be disabled unless an operational need is documented."
|
|
6093
|
+
}
|
|
6094
|
+
],
|
|
6095
|
+
"results": [
|
|
6096
|
+
{
|
|
6097
|
+
"status": "passed",
|
|
6098
|
+
"codeDesc": "Kernel module usb-storage is blacklisted",
|
|
6099
|
+
"startTime": "2026-03-30T10:00:00Z"
|
|
6100
|
+
}
|
|
6101
|
+
]
|
|
6102
|
+
},
|
|
6103
|
+
"oldEffectiveStatus": "failed",
|
|
6104
|
+
"newEffectiveStatus": "passed",
|
|
6105
|
+
"fieldChanges": [
|
|
6106
|
+
{
|
|
6107
|
+
"op": "replace",
|
|
6108
|
+
"path": "/results/0/status",
|
|
6109
|
+
"oldValue": "failed",
|
|
6110
|
+
"newValue": "passed"
|
|
6111
|
+
}
|
|
6112
|
+
],
|
|
6113
|
+
"matchStrategy": "exactId",
|
|
6114
|
+
"matchConfidence": 1
|
|
6115
|
+
}
|
|
6116
|
+
],
|
|
6117
|
+
"$comment": "Examples, in order: 1) a requirement fixed between two scans of the same baseline, carrying the owning baseline name and the exact-id match that paired it."
|
|
5593
6118
|
},
|
|
5594
6119
|
"Cross_System_Reference": {
|
|
5595
6120
|
"type": "object",
|
|
@@ -5881,6 +6406,7 @@
|
|
|
5881
6406
|
"title": "Content Type"
|
|
5882
6407
|
},
|
|
5883
6408
|
"Content_Reference": {
|
|
6409
|
+
"$comment": "Examples, in order: 1) the system document at the package root; 2) a results document with a per-entry description; 3) a BOM in a subdirectory, which also shows that checksum is optional. Every example uri is package-relative on purpose — an earlier one was an absolute https URL, which demonstrated a package the tooling refuses to resolve. A remote artifact belongs in externalEvidence[].",
|
|
5884
6410
|
"type": "object",
|
|
5885
6411
|
"unevaluatedProperties": false,
|
|
5886
6412
|
"required": [
|
|
@@ -5895,7 +6421,7 @@
|
|
|
5895
6421
|
"uri": {
|
|
5896
6422
|
"type": "string",
|
|
5897
6423
|
"format": "uri-reference",
|
|
5898
|
-
"description": "
|
|
6424
|
+
"description": "A uri-reference whose DECODED form is a path relative to the package document's own directory — that is what the reference MEANS, independently of any one consumer. Percent-escapes are part of the encoding, not the name: `my%20scans/q4.json` and `my scans/q4.json` name the same file, and the escaped spelling is the one this field's format admits. A consumer decodes before it resolves, never after, because decoding can produce a parent traversal that containment must then see. It is never fetched: there is no network retrieval anywhere in evidence handling. `uri-reference` admits shapes other than a relative path and they stay schema-valid; how a consumer resolves one, and what it does when it cannot, is that consumer's own contract. An artifact deliberately held elsewhere belongs in externalEvidence[], which references it by URI and checksum without retrieving it."
|
|
5899
6425
|
},
|
|
5900
6426
|
"checksum": {
|
|
5901
6427
|
"$ref": "#/components/schemas/Checksum",
|
|
@@ -5931,7 +6457,7 @@
|
|
|
5931
6457
|
},
|
|
5932
6458
|
{
|
|
5933
6459
|
"type": "bom",
|
|
5934
|
-
"uri": "
|
|
6460
|
+
"uri": "boms/webtier.cdx.json",
|
|
5935
6461
|
"description": "WebTier CycloneDX SBOM (bomType=sbom)"
|
|
5936
6462
|
}
|
|
5937
6463
|
],
|
|
@@ -6218,9 +6744,8 @@
|
|
|
6218
6744
|
"description": "Present ONLY on reconciled result sets: lineage recording the seed snapshot and event watermark this document was reassembled from (ADR-0005). Documents produced directly by a scan omit this field. When present, generator names the reconciling tool."
|
|
6219
6745
|
},
|
|
6220
6746
|
"extensions": {
|
|
6221
|
-
"
|
|
6222
|
-
"
|
|
6223
|
-
"description": "Reserved for tool-specific data not defined in the HDF standard. Use this to preserve original tool output, auxiliary data, or custom metadata."
|
|
6747
|
+
"$ref": "#/components/schemas/Extensions",
|
|
6748
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) these results were converted from."
|
|
6224
6749
|
}
|
|
6225
6750
|
},
|
|
6226
6751
|
"examples": [
|
|
@@ -6356,12 +6881,17 @@
|
|
|
6356
6881
|
"generator": {
|
|
6357
6882
|
"$ref": "#/components/schemas/Generator",
|
|
6358
6883
|
"description": "The tool that generated this file."
|
|
6884
|
+
},
|
|
6885
|
+
"extensions": {
|
|
6886
|
+
"$ref": "#/components/schemas/Extensions",
|
|
6887
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) this baseline was converted from."
|
|
6359
6888
|
}
|
|
6360
6889
|
},
|
|
6361
6890
|
"examples": [
|
|
6362
6891
|
{
|
|
6363
6892
|
"name": "ubuntu-2204-stig-baseline",
|
|
6364
6893
|
"title": "Canonical Ubuntu 22.04 LTS STIG Baseline",
|
|
6894
|
+
"description": "Requirements from the DISA STIG for Canonical Ubuntu 22.04 LTS, tailored for hosts in the CUI enclave; checks that need a graphical session are marked not applicable.",
|
|
6365
6895
|
"version": "1.2.0",
|
|
6366
6896
|
"maintainer": "DISA STIG Team",
|
|
6367
6897
|
"license": "Apache-2.0",
|
|
@@ -6539,9 +7069,8 @@
|
|
|
6539
7069
|
"description": "Cryptographic integrity information for verifying this comparison document."
|
|
6540
7070
|
},
|
|
6541
7071
|
"extensions": {
|
|
6542
|
-
"
|
|
6543
|
-
"
|
|
6544
|
-
"description": "Reserved for tool-specific data not defined in the HDF standard."
|
|
7072
|
+
"$ref": "#/components/schemas/Extensions",
|
|
7073
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) this comparison was derived from."
|
|
6545
7074
|
}
|
|
6546
7075
|
},
|
|
6547
7076
|
"examples": [
|
|
@@ -6885,6 +7414,10 @@
|
|
|
6885
7414
|
"generator": {
|
|
6886
7415
|
"$ref": "#/components/schemas/Generator",
|
|
6887
7416
|
"description": "Information about the tool that generated this system document."
|
|
7417
|
+
},
|
|
7418
|
+
"extensions": {
|
|
7419
|
+
"$ref": "#/components/schemas/Extensions",
|
|
7420
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) this system document was converted from."
|
|
6888
7421
|
}
|
|
6889
7422
|
},
|
|
6890
7423
|
"examples": [
|
|
@@ -7005,6 +7538,10 @@
|
|
|
7005
7538
|
"generator": {
|
|
7006
7539
|
"$ref": "#/components/schemas/Generator",
|
|
7007
7540
|
"description": "Information about the tool that generated this plan."
|
|
7541
|
+
},
|
|
7542
|
+
"extensions": {
|
|
7543
|
+
"$ref": "#/components/schemas/Extensions",
|
|
7544
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) this plan was converted from."
|
|
7008
7545
|
}
|
|
7009
7546
|
},
|
|
7010
7547
|
"examples": [
|
|
@@ -7103,6 +7640,10 @@
|
|
|
7103
7640
|
"generator": {
|
|
7104
7641
|
"$ref": "#/components/schemas/Generator",
|
|
7105
7642
|
"description": "Information about the tool that generated this document."
|
|
7643
|
+
},
|
|
7644
|
+
"extensions": {
|
|
7645
|
+
"$ref": "#/components/schemas/Extensions",
|
|
7646
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) these amendments were converted from — the VEX family and oscal-poam-to-hdf all emit this document type."
|
|
7106
7647
|
}
|
|
7107
7648
|
},
|
|
7108
7649
|
"examples": [
|
|
@@ -7228,6 +7769,10 @@
|
|
|
7228
7769
|
"generator": {
|
|
7229
7770
|
"$ref": "#/components/schemas/Generator",
|
|
7230
7771
|
"description": "Information about the tool that generated this document."
|
|
7772
|
+
},
|
|
7773
|
+
"extensions": {
|
|
7774
|
+
"$ref": "#/components/schemas/Extensions",
|
|
7775
|
+
"description": "Producer data outside the HDF model, and the pre-converted source artifact(s) this package was assembled from."
|
|
7231
7776
|
}
|
|
7232
7777
|
},
|
|
7233
7778
|
"examples": [
|
|
@@ -7419,7 +7964,7 @@
|
|
|
7419
7964
|
"systemRef": "apptier.hdf-system.json",
|
|
7420
7965
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
7421
7966
|
"timestamp": "2026-07-22T14:03:11Z",
|
|
7422
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
7967
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
7423
7968
|
"priorChecksum": {
|
|
7424
7969
|
"algorithm": "sha256",
|
|
7425
7970
|
"value": "704f62b2d0803438ad6b7b9bab45e2c4f350b7344135a2a7f8ef986d98669021"
|
|
@@ -7469,7 +8014,7 @@
|
|
|
7469
8014
|
"systemRef": "apptier.hdf-system.json",
|
|
7470
8015
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
7471
8016
|
"timestamp": "2026-07-21T00:00:05Z",
|
|
7472
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
8017
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
7473
8018
|
"priorChecksum": {
|
|
7474
8019
|
"algorithm": "sha256",
|
|
7475
8020
|
"value": "d11c074ab9131807816013a71d986f1ceb2e5871a8a01dee4043391b7a6bf37b"
|
|
@@ -7533,7 +8078,7 @@
|
|
|
7533
8078
|
"systemRef": "apptier.hdf-system.json",
|
|
7534
8079
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
7535
8080
|
"timestamp": "2026-07-22T14:03:12Z",
|
|
7536
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
8081
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
7537
8082
|
"priorChecksum": null,
|
|
7538
8083
|
"requirementId": "RHEL-09-671010",
|
|
7539
8084
|
"state": "new",
|
|
@@ -7574,7 +8119,7 @@
|
|
|
7574
8119
|
"systemRef": "apptier.hdf-system.json",
|
|
7575
8120
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
7576
8121
|
"timestamp": "2026-07-23T08:00:00Z",
|
|
7577
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
8122
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
7578
8123
|
"priorChecksum": {
|
|
7579
8124
|
"algorithm": "sha256",
|
|
7580
8125
|
"value": "704f62b2d0803438ad6b7b9bab45e2c4f350b7344135a2a7f8ef986d98669021"
|
|
@@ -7594,7 +8139,7 @@
|
|
|
7594
8139
|
"systemRef": "apptier.hdf-system.json",
|
|
7595
8140
|
"componentId": "6e0f2a3b-9c01-4d5e-8f7a-1b2c3d4e5f60",
|
|
7596
8141
|
"timestamp": "2026-07-24T10:15:00Z",
|
|
7597
|
-
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.
|
|
8142
|
+
"schemaRef": "https://mitre.github.io/hdf-libs/schemas/hdf-requirement-change-event/v3.8.0",
|
|
7598
8143
|
"priorChecksum": {
|
|
7599
8144
|
"algorithm": "sha256",
|
|
7600
8145
|
"value": "704f62b2d0803438ad6b7b9bab45e2c4f350b7344135a2a7f8ef986d98669021"
|