{ "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/hdf-amendments/v3.3.0", "title": "HDF Amendments", "description": "Waivers, attestations, and POA&Ms that modify requirement compliance status or impact. Amendments are standalone documents that can be applied to results via merge operations.", "type": "object", "unevaluatedProperties": false, "required": [ "name", "overrides" ], "properties": { "amendmentId": { "type": "string", "format": "uuid", "description": "Unique identifier for this amendments document. Useful for cross-referencing when multiple amendment documents target the same results." }, "name": { "type": "string", "description": "Human-readable name for this amendments document. Example: 'Portal Q1 2026 Waivers'." }, "description": { "type": "string", "description": "Description of the amendments' purpose and scope." }, "systemRef": { "type": "string", "format": "uri-reference", "description": "URI to the hdf-system document these amendments apply to." }, "appliedBy": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity", "description": "Default identity of who created this amendments document. Individual overrides may specify their own appliedBy." }, "approvedBy": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity", "description": "Identity of the authorizing official who approved these amendments." }, "overrides": { "type": "array", "minItems": 1, "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Standalone_Override" }, "description": "The set of amendments (waivers, attestations, POA&Ms, and other overrides)." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional key-value labels for grouping and querying amendments." }, "integrity": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Integrity", "description": "Cryptographic integrity information for verifying this amendments document has not been tampered with." }, "signature": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature", "description": "Document-level digital signature covering all amendments." }, "version": { "type": "string", "description": "Version of this amendments document." }, "generator": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0#/$defs/Generator", "description": "Information about the tool that generated this document." } }, "examples": [ { "name": "Portal Q1 2026 Waivers", "systemRef": "portal-prod.hdf-system.json", "approvedBy": { "type": "email", "identifier": "ao@agency.gov" }, "overrides": [ { "type": "waiver", "requirementId": "SV-257777", "baselineRef": "RHEL9-STIG", "status": "passed", "reason": "Compensating control: session timeout set to 15 min", "appliedBy": { "type": "email", "identifier": "ao@agency.gov" }, "appliedAt": "2026-01-15T10:00:00Z", "expiresAt": "2026-06-30T00:00:00Z", "evidence": [ { "type": "url", "data": "https://jira.agency.gov/CYBER-4521", "description": "ISSM approval with compensating control documentation" } ] } ] } ], "$defs": { "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0", "title": "HDF Common Primitives", "description": "Shared building blocks used by hdf-results and hdf-baseline schemas.", "$defs": { "Hash_Algorithm": { "type": "string", "enum": [ "sha256", "sha384", "sha512", "blake3" ], "description": "Supported cryptographic hash algorithms for checksums and integrity verification. blake3 covers container-image and other artifact digests that use it.", "title": "Hash Algorithm" }, "Requirement_Group": { "type": "object", "unevaluatedProperties": false, "required": [ "id", "requirements" ], "properties": { "id": { "type": "string", "description": "The unique identifier for the group. Example: the relative path to the file specifying the requirements." }, "title": { "type": "string", "description": "The title of the group - should be human readable." }, "requirements": { "type": "array", "items": { "type": "string" }, "description": "The set of requirements as specified by their ids in this group. Example: 'SV-238196'." } }, "description": "Describes a group of requirements, such as those defined in a single file.", "title": "Requirement Group" }, "Dependency": { "type": "object", "unevaluatedProperties": false, "required": [], "properties": { "name": { "type": "string", "description": "The name or assigned alias." }, "url": { "type": "string", "format": "uri-reference", "description": "The address of the dependency." }, "branch": { "type": "string", "description": "The branch name for a git repo." }, "path": { "type": "string", "description": "The relative path if the dependency is locally available." }, "statusMessage": { "type": "string", "description": "The reason for the status if it is 'failed' or 'skipped'." }, "status": { "type": "string", "description": "The status. Should be: 'loaded', 'failed', or 'skipped'." }, "git": { "type": "string", "format": "uri", "description": "The location of the git repo. Example: 'https://github.com/my-org/ubuntu-22.04-stig-baseline.git'." }, "supermarket": { "type": "string", "description": "The 'user/profilename' attribute for a Supermarket server." }, "compliance": { "type": "string", "description": "The 'user/profilename' attribute for an Automate server." } }, "examples": [ { "name": "ubuntu-22.04-baseline", "url": "https://github.com/my-org/ubuntu-22.04-stig-baseline", "git": "https://github.com/my-org/ubuntu-22.04-stig-baseline.git", "branch": "main", "status": "loaded" }, { "name": "ssl-tls-baseline", "path": "../shared-baselines/ssl-tls", "status": "loaded" }, { "name": "windows-2022-baseline", "git": "https://github.com/security-org/windows-2022-stig.git", "branch": "v1.2.0", "status": "failed", "statusMessage": "Unable to clone repository: authentication failed" }, { "name": "chef-supermarket-baseline", "supermarket": "dev-sec/linux-baseline", "status": "loaded" } ], "description": "A dependency for a baseline. Can include relative paths or URLs for where to find the dependency.", "title": "Dependency" }, "Reference": { "anyOf": [ { "type": "object", "required": [ "ref" ], "properties": { "ref": { "anyOf": [ { "type": "string", "description": "A human readable/meaningful reference. Example: a book title." }, { "type": "array", "items": { "type": "object", "additionalProperties": true }, "description": "An array of reference objects." } ] } }, "description": "A reference using the 'ref' field." }, { "type": "object", "required": [ "url" ], "properties": { "url": { "type": "string", "format": "uri" } }, "description": "A URL pointing at the reference." }, { "type": "object", "required": [ "uri" ], "properties": { "uri": { "type": "string", "format": "uri" } }, "description": "A URI pointing at the reference." } ], "description": "A reference to an external document.", "title": "Reference" }, "Source_Location": { "type": "object", "unevaluatedProperties": false, "required": [], "properties": { "ref": { "type": "string", "description": "Path to the file that this requirement originates from." }, "line": { "type": "number", "description": "The line on which this requirement is located." } }, "examples": [ { "ref": "controls/SV-260476.rb", "line": 1 }, { "ref": "profiles/ubuntu/controls/configure_audit.rb", "line": 42 } ], "description": "The explicit location of a requirement within source code.", "title": "Source Location" }, "Supported_Platform": { "type": "object", "unevaluatedProperties": false, "required": [], "properties": { "platformFamily": { "type": "string", "description": "The platform family. Example: 'redhat'." }, "platformName": { "type": "string", "description": "The platform name - can include wildcards. Example: 'debian'." }, "platform": { "type": "string", "description": "The location of the platform. Can be: 'os', 'aws', 'azure', or 'gcp'." }, "release": { "type": "string", "description": "The release of the platform. Example: '20.04' for 'ubuntu'." } }, "description": "A supported platform target. Example: the platform name being 'ubuntu'.", "title": "Supported Platform" }, "Checksum": { "type": "object", "unevaluatedProperties": false, "required": [ "algorithm", "value" ], "properties": { "algorithm": { "$ref": "#/$defs/Hash_Algorithm", "description": "The hash algorithm used for the checksum." }, "value": { "type": "string", "description": "The checksum value." } }, "examples": [ { "algorithm": "sha256", "value": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" }, { "algorithm": "sha512", "value": "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e" } ], "description": "Cryptographic checksum for baseline integrity verification.", "title": "Checksum" }, "Identity": { "type": "object", "unevaluatedProperties": false, "required": [ "identifier", "type" ], "properties": { "identifier": { "type": "string", "description": "The identifier value. Example: 'user@example.com', 'jdoe', 'automated-scanner-01'." }, "type": { "type": "string", "title": "Identity Type", "enum": [ "email", "username", "system", "agent", "simple", "other" ], "description": "The type of identifier. Use 'email' for email addresses, 'username' for user accounts, 'system' for deterministic non-interactive automation (CI jobs, cron, scanners), 'agent' for an AI/LLM agent acting with autonomy — kept distinct from 'system' so auditors can apply AI-specific scrutiny (e.g. 'an LLM proposed this' vs a deterministic job) and satisfy AI-source disclosure under frameworks like the EU AI Act and NIST AI RMF, 'simple' for basic string identifiers without additional classification, or 'other' for custom identity systems." }, "description": { "type": "string", "description": "Optional description of the identity or identity system, particularly useful when type is 'other'." } }, "examples": [ { "type": "email", "identifier": "admin@example.com" }, { "type": "username", "identifier": "jdoe", "description": "Security Operations Analyst" }, { "type": "system", "identifier": "automated-scanner-01", "description": "Nightly compliance scan pipeline" }, { "type": "agent", "identifier": "cve-enrichment-bot/v0.4.2", "description": "OpenAI GPT-4 via internal CVE-enrichment tool; proposes environmental CVSS for human review" } ], "description": "Represents an identity that performed an action, such as capturing evidence or applying an override.", "title": "Identity" }, "Evidence": { "type": "object", "unevaluatedProperties": false, "required": [ "type", "data" ], "properties": { "type": { "type": "string", "title": "Evidence Type", "enum": [ "screenshot", "code", "log", "url", "file", "other" ], "description": "The type of evidence being provided." }, "data": { "type": "string", "description": "The evidence content. For screenshots/files: base64-encoded data or URL. For code/logs: the raw text. For URLs: the URL string." }, "description": { "type": "string", "description": "Human-readable description of what this evidence shows." }, "mimeType": { "type": "string", "description": "MIME type of the evidence. Example: 'image/png', 'text/plain', 'application/json'." }, "encoding": { "type": "string", "description": "Encoding used for the data. Example: 'base64', 'utf-8'." }, "size": { "type": "number", "description": "Size of the evidence data in bytes." }, "capturedAt": { "type": "string", "format": "date-time", "description": "Timestamp when this evidence was captured. ISO 8601 format." }, "capturedBy": { "$ref": "#/$defs/Identity", "description": "Identity of who or what captured this evidence." } }, "examples": [ { "type": "screenshot", "data": "iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAYAAAAfFcSJAAAADUlEQVR42mNk+M9QDwADhgGAWjR9awAAAABJRU5ErkJggg==", "description": "Screenshot showing firewall configuration with required ports blocked", "mimeType": "image/png", "encoding": "base64", "size": 95, "capturedAt": "2025-12-14T10:30:00Z", "capturedBy": { "identifier": "security-auditor@example.com", "type": "email" } }, { "type": "code", "data": "# Nginx configuration\nserver {\n listen 443 ssl;\n ssl_protocols TLSv1.2 TLSv1.3;\n ssl_ciphers HIGH:!aNULL:!MD5;\n}", "description": "Server configuration showing TLS 1.2+ enforcement", "mimeType": "text/plain", "capturedAt": "2025-12-14T10:45:00Z" }, { "type": "log", "data": "[2025-12-14 10:00:15] INFO: Security scan completed - 0 critical vulnerabilities found\n[2025-12-14 10:00:16] INFO: All required security patches applied\n[2025-12-14 10:00:17] INFO: System compliant with security baseline", "description": "Security scan log output", "mimeType": "text/plain", "size": 256 }, { "type": "url", "data": "https://jira.example.com/browse/SEC-12345", "description": "Link to security ticket documenting remediation work", "capturedAt": "2025-12-14T11:00:00Z" }, { "type": "file", "data": "UEsDBBQAAAAIAI1ZX1YhQp8FHgAAABIAAAAIAAAAdGVzdC50eHRLy8nPS8lQSgIAUmNEBhQAAAA=", "description": "Compliance audit report PDF", "mimeType": "application/pdf", "encoding": "base64", "size": 2048, "capturedAt": "2025-12-14T12:00:00Z", "capturedBy": { "identifier": "compliance-system", "type": "system" } } ], "description": "Supporting evidence for a finding or override, such as screenshots, code samples, log excerpts, or URLs.", "title": "Evidence" }, "Remediation": { "type": "object", "unevaluatedProperties": false, "required": [ "uri" ], "properties": { "uri": { "type": "string", "format": "uri", "description": "URI pointing to automated remediation resources (Ansible playbooks, Terraform scripts, etc.). Examples: GitHub repository, DISA STIG Supplemental Automation Content, vendor-provided scripts." }, "checksum": { "$ref": "#/$defs/Checksum", "description": "Optional cryptographic checksum for verifying the integrity of remediation resources fetched from the URI. Recommended for security when referencing external automation scripts." } }, "examples": [ { "uri": "https://github.com/ansible-lockdown/RHEL9-STIG/tree/main/tasks" }, { "uri": "https://artifacts.example.com/remediation/ubuntu-22.04-hardening-v1.2.tar.gz", "checksum": { "algorithm": "sha256", "value": "a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2c3d4e5f6a1b2" } } ], "description": "Reference to automated remediation resources for implementing security controls. Points to external automation content like Ansible playbooks, Terraform scripts, or vendor-provided remediation tools.", "title": "Remediation" }, "Verification_Method": { "type": "object", "unevaluatedProperties": false, "required": [ "type", "controller" ], "properties": { "type": { "type": "string", "description": "The type of verification method. Example: 'JsonWebKey2020', 'RsaVerificationKey2018', 'Ed25519VerificationKey2020'." }, "controller": { "type": "string", "description": "The entity that controls this verification method. Can be a DID, URI, or other identifier." }, "publicKeyJwk": { "type": "object", "additionalProperties": true, "description": "Public key in JSON Web Key format." }, "publicKeyPem": { "type": "string", "description": "Public key in PEM format. Example: '-----BEGIN PUBLIC KEY-----...-----END PUBLIC KEY-----'." }, "publicKeyBase58": { "type": "string", "description": "Public key in Base58 format, commonly used with Ed25519 keys." } }, "description": "Verification method containing the public key needed to verify a digital signature. Supports multiple key formats including JWK (for RSA, EC), PEM, and Base58.", "title": "Verification Method" }, "Milestone": { "type": "object", "unevaluatedProperties": false, "required": [ "description", "estimatedCompletion", "status" ], "properties": { "description": { "type": "string", "description": "Description of this milestone or task." }, "estimatedCompletion": { "type": "string", "format": "date-time", "description": "Estimated completion date. ISO 8601 format." }, "status": { "type": "string", "title": "Milestone Status", "enum": [ "pending", "inProgress", "completed" ], "description": "Current status of this milestone." }, "completedAt": { "type": "string", "format": "date-time", "description": "Actual completion timestamp. ISO 8601 format." }, "completedBy": { "$ref": "#/$defs/Identity", "description": "Identity of who completed this milestone." } }, "description": "A milestone or task within a POA&M remediation plan.", "title": "Milestone" }, "Signature": { "type": "object", "unevaluatedProperties": false, "required": [ "type", "created", "creator", "signatureValue", "proofPurpose", "verificationMethod" ], "properties": { "type": { "type": "string", "description": "The signature suite type. Example: 'JsonWebSignature2020', 'RsaSignature2018', 'Ed25519Signature2020'." }, "created": { "type": "string", "format": "date-time", "description": "When the signature was created. ISO 8601 format." }, "creator": { "$ref": "#/$defs/Identity", "description": "The identity that created this signature." }, "signatureValue": { "type": "string", "description": "The base64-encoded or base58-encoded signature value." }, "proofPurpose": { "type": "string", "description": "The purpose of this signature. Example: 'attestation', 'authentication', 'assertionMethod'." }, "verificationMethod": { "$ref": "#/$defs/Verification_Method", "description": "The verification method containing the public key for signature verification." }, "nonce": { "type": "string", "description": "Random value to prevent replay attacks." }, "challenge": { "type": "string", "description": "Challenge value from the verifier, used in challenge-response authentication." }, "domain": { "type": "string", "description": "Domain restriction for the signature, prevents cross-domain replay attacks." } }, "examples": [ { "type": "JsonWebSignature2020", "created": "2025-12-14T10:00:00Z", "creator": { "identifier": "security-team@example.com", "type": "email" }, "signatureValue": "eyJhbGciOiJSUzI1NiIsImI2NCI6ZmFsc2UsImNyaXQiOlsiYjY0Il19..MEYCIQDvKbtLRhWAa", "proofPurpose": "attestation", "verificationMethod": { "type": "JsonWebKey2020", "controller": "did:example:123456789abcdefghi", "publicKeyJwk": { "kty": "RSA", "n": "0vx7agoebGcQSuuPiLJXZptN9nndrQmbXEps2aiAFbWhM78LhWx4cbbfAAtV", "e": "AQAB" } } }, { "type": "RsaSignature2018", "created": "2025-12-14T11:30:00Z", "creator": { "identifier": "ciso@example.com", "type": "email" }, "signatureValue": "pY9...Cg==", "proofPurpose": "authentication", "verificationMethod": { "type": "RsaVerificationKey2018", "controller": "https://example.com/issuers/565049", "publicKeyPem": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAryQICCl6NZ5gDKrnSztO\n-----END PUBLIC KEY-----" }, "nonce": "c0ae1c8e-c7e7-469f-b252-86e6a0e7387e" }, { "type": "Ed25519Signature2020", "created": "2025-12-14T14:00:00Z", "creator": { "identifier": "automated-signer", "type": "system", "description": "Hardware security module (HSM) for automated attestations" }, "signatureValue": "z58DAdFfa9SkqZMVMxABEBC59Ck6WibLZ", "proofPurpose": "assertionMethod", "verificationMethod": { "type": "Ed25519VerificationKey2020", "controller": "did:key:z6MkhaXgBZDvotDkL5257faiztiGiC2QtKLGpbnnEGta2doK", "publicKeyBase58": "H3C2AVvLMv6gmMNam3uVAjZpfkcJCwDwnZn6z3wXmqPV" }, "challenge": "1f44d2f3-d16c-47a4-9f5f-1d6e8f4e3a2b", "domain": "https://compliance.example.com" } ], "description": "A digital signature following W3C Data Integrity Proofs pattern. Supports hardware security tokens (PKCS#11/PKCS#12), Yubikeys, GPG keys, passkeys, and other cryptographic signing methods via JWK, PEM, or Base58 key formats.", "title": "Signature" }, "Baseline_Metadata": { "type": "object", "properties": { "name": { "type": "string", "description": "The name - must be unique." }, "title": { "type": "string", "description": "The title - should be human readable." }, "maintainer": { "type": "string", "description": "The maintainer(s)." }, "copyright": { "type": "string", "description": "The copyright holder(s)." }, "copyrightEmail": { "type": "string", "description": "The email address or other contact information of the copyright holder(s)." }, "license": { "type": "string", "description": "The copyright license. Example: 'Apache-2.0'." }, "summary": { "type": "string", "description": "The summary. Example: the Security Technical Implementation Guide (STIG) header." }, "version": { "type": "string", "description": "The version of the baseline." }, "supports": { "type": "array", "items": { "$ref": "#/$defs/Supported_Platform" }, "description": "The set of supported platform targets." }, "status": { "type": "string", "description": "The status. Example: 'loaded'." }, "labels": { "type": "object", "additionalProperties": { "type": "string" }, "description": "Optional key-value labels for flexible grouping. Well-known keys: system, component, environment, region, team. Values must be strings." } }, "examples": [ { "name": "rhel-9-stig-baseline", "title": "Red Hat Enterprise Linux 9 STIG Baseline", "maintainer": "MITRE SAF Team", "copyright": "The MITRE Corporation", "copyrightEmail": "saf@mitre.org", "license": "Apache-2.0", "summary": "InSpec baseline for RHEL 9 STIG compliance", "version": "1.0.0", "supports": [ { "platformName": "redhat", "platformFamily": "redhat", "release": "9" } ], "status": "loaded" } ], "description": "Shared metadata fields for baselines. Used in both standalone baseline documents and evaluated baseline results.", "title": "Baseline Metadata" }, "Requirement_Core": { "type": "object", "properties": { "id": { "type": "string", "description": "The requirement identifier. Example: 'SV-238196'." }, "title": { "type": "string", "description": "The title - is nullable." }, "descriptions": { "type": "array", "minItems": 1, "items": { "type": "object", "unevaluatedProperties": false, "required": [ "label", "data" ], "properties": { "label": { "type": "string", "description": "Description category. The 'default' label is required for the primary description. Common labels: 'default', 'check', 'fix', 'rationale'. Tools may use custom labels." }, "data": { "type": "string", "description": "The description text content." } } }, "description": "Array of labeled descriptions. At least one description with label 'default' must be present. Convention: place default description first. Common labels: 'default', 'check', 'fix', 'rationale'." }, "impact": { "type": "number", "minimum": 0, "maximum": 1, "description": "The impactfulness or severity (0.0 to 1.0)." }, "refs": { "type": "array", "items": { "$ref": "#/$defs/Reference" }, "description": "The set of references to external documents." }, "tags": { "type": "object", "additionalProperties": true, "description": "A set of tags - usually metadata like CCI, STIG ID, severity." }, "code": { "type": "string", "description": "The raw source code of the requirement. Set to null for manual-only requirements or requirements not yet implemented; use verificationMethod to disambiguate manual-by-design from manual-pending-automation. Note that if this is an overlay, it does not include the underlying source code." }, "sourceLocation": { "$ref": "#/$defs/Source_Location", "description": "The explicit location of the requirement within the source code." }, "controlType": { "type": "string", "title": "Control Type", "enum": [ "policy", "procedure", "technical", "management", "operational" ], "description": "Classification of the control's nature, aligning with NIST SP 800-53 / SP 800-53A categories. 'policy' = an authored governance statement; 'procedure' = a documented process; 'technical' = an enforced technical configuration; 'management' = a programmatic/management activity; 'operational' = a recurring operational activity (e.g. AT, IR, MA families). Optional: when omitted, consumers may infer heuristically from family/id but should not assume a default." }, "verificationMethod": { "$ref": "#/$defs/Verification_Method_Enum", "description": "How this requirement is intended to be verified. Disambiguates the two cases that null 'code' overloads: 'manual-by-design' (the requirement is statement-form and not amenable to automation, e.g. FedRAMP 20x KSIs); 'manual-pending-automation' (automation could exist but does not yet, e.g. a STIG rule lacking a fix). 'automated' = a check exists and runs without operator action; 'hybrid' = part automated, part manual. Optional: when omitted, consumers should not infer a default." }, "applicability": { "type": "string", "title": "Applicability", "enum": [ "required", "optional", "advisory" ], "description": "Whether the requirement is mandatory within its baseline. Distinct from severity (risk weight) and status (lifecycle state). Maps cleanly onto: FedRAMP rev5 OSCAL 'CORE' prop, FedRAMP 20x inline 'Optional:' markers, CMMC sublevel rows, and CIS Implementation Group memberships (IG1/IG2/IG3 may carry richer semantics; layer those onto props[]/tags{}). Optional: when omitted, consumers should treat the requirement as 'required' by convention." } }, "examples": [ { "$comment": "v3.1.x-style requirement: classification fields omitted. Consumers must continue to handle this shape under v3.3.0 (backward compatibility).", "id": "SV-238196", "title": "The Ubuntu operating system must enforce password complexity", "impact": 0.5, "tags": { "nist": [ "IA-5" ], "severity": "medium", "cci": [ "CCI-000192" ] }, "refs": [ { "url": "https://public.cyber.mil/stigs/" } ], "descriptions": [ { "label": "default", "data": "Use of a complex password helps to increase the time and resources required to compromise the password." }, { "label": "check", "data": "Verify the value of 'minlen' in /etc/security/pwquality.conf." } ] }, { "$comment": "v3.2 example populating all three classification fields. controlType=technical because AC-3 is enforced via configuration, not policy text. verificationMethod=automated because a check exists. applicability=required because this is a CORE control in the source baseline.", "id": "AC-3", "title": "Access Enforcement", "impact": 0.7, "tags": { "nist": [ "AC-3" ], "severity": "high" }, "descriptions": [ { "label": "default", "data": "The information system enforces approved authorizations for logical access to information and system resources." } ], "code": "control 'AC-3' do; impact 0.7; end", "controlType": "technical", "verificationMethod": "automated", "applicability": "required" }, { "$comment": "v3.2 example for a manual-by-design requirement. FedRAMP 20x KSIs are statement-form: code is omitted (not null) and verificationMethod=manual-by-design distinguishes this from 'automation could exist but doesn't yet'. controlType=policy because this is an authored governance statement.", "id": "KSI-CNA-01", "title": "Cyber Security Plan documents the system", "impact": 0.5, "tags": { "ksi": [ "KSI-CNA" ] }, "descriptions": [ { "label": "default", "data": "The Cyber Security Plan documents the system, its boundary, and its components." } ], "controlType": "policy", "verificationMethod": "manual-by-design", "applicability": "required" }, { "$comment": "v3.2 example for a STIG rule lacking a . Differs from manual-by-design: automation should exist, just not yet. applicability=advisory used here because the source format flagged it as recommended-but-not-mandatory; CIS-style IG memberships and FedRAMP 'Optional:' markers map onto applicability=optional or advisory similarly.", "id": "SV-999999", "title": "Example STIG rule pending automation", "impact": 0.3, "tags": { "stig_id": "SV-999999" }, "descriptions": [ { "label": "default", "data": "Example requirement that is intended to be automated but currently lacks a fix block." }, { "label": "check", "data": "Manual review of system configuration is required." } ], "verificationMethod": "manual-pending-automation", "applicability": "advisory" } ], "description": "Core requirement fields shared between baseline requirements and evaluated requirements. Contains the fundamental requirement definition without assessment results.", "title": "Requirement Core" }, "Verification_Method_Enum": { "type": "string", "enum": [ "automated", "manual-by-design", "manual-pending-automation", "hybrid" ], "description": "How a requirement is intended to be verified. Disambiguates the two cases that null 'code' overloads: 'manual-by-design' (the requirement is statement-form and not amenable to automation, e.g. FedRAMP 20x KSIs); 'manual-pending-automation' (automation could exist but does not yet, e.g. a STIG rule lacking a fix). 'automated' = a check exists and runs without operator action; 'hybrid' = part automated, part manual. Named '_Enum' to disambiguate from the unrelated Verification_Method DID-context struct.", "title": "Verification Method Enum" }, "Severity": { "type": "string", "enum": [ "critical", "high", "medium", "low", "informational" ], "description": "Severity rating for a requirement. Typically derived from the numeric impact score.", "title": "Severity" }, "Cloud_Provider": { "type": [ "string", "null" ], "enum": [ "aws", "azure", "gcp", "oci", "other", null ], "description": "Cloud service provider identifier.", "title": "Cloud Provider" } } }, "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0", "title": "HDF Amendment Primitives", "description": "Types for waivers, attestations, and POA&Ms that modify requirement compliance status.", "$defs": { "Override_Type": { "type": "string", "enum": [ "waiver", "attestation", "poam", "inherited", "falsePositive", "riskAdjustment", "operationalRequirement" ], "description": "The type of amendment, aligned with FedRAMP deviation request categories. 'waiver': risk accepted by Authorizing Official. 'attestation': manually verified by assessor. 'poam': remediation tracked (no status change). 'inherited': control provided by another component or system. '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. 'riskAdjustment': impact score adjusted based on environmental context (FedRAMP Risk Adjustment); does not change pass/fail status, only impact via the impact field. '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. Migration note: 'exception' was removed in v3.1.0 — use 'waiver' with status 'notApplicable' instead.", "title": "Override Type" }, "Justification": { "type": "string", "enum": [ "component_not_present", "vulnerable_code_not_present", "vulnerable_code_not_in_execute_path", "vulnerable_code_cannot_be_controlled_by_adversary", "inline_mitigations_already_exist", "requires_configuration", "requires_dependency", "requires_environment", "protected_by_compiler", "protected_at_runtime", "protected_at_perimeter" ], "description": "Structured controlled-vocabulary reason for an override, complementing the free-text 'reason' field. 'reason' carries the human-readable rationale an auditor reads; 'justification' carries the machine-readable category enabling filtering, aggregation, and lossless round-trip with structured ecosystems (VEX, OSCAL, FedRAMP DR). Both fields may be present simultaneously and are NOT redundant: 'reason' explains the specific circumstance; 'justification' classifies it. Authors SHOULD populate both when a controlled-vocabulary value applies — the enum value alone is not self-explanatory to an auditor. The vocabulary is drawn from the VEX ecosystem: the first five values are common across OpenVEX, CSAF VEX, and CycloneDX VEX; the remaining six (requires_configuration / requires_dependency / requires_environment / protected_by_compiler / protected_at_runtime / protected_at_perimeter) are CycloneDX-specific and describe why the vulnerable code path is unreachable in the deployed configuration. The enum is extended additively across schema versions as other ecosystems' controlled vocabularies are integrated; documents using values added in a newer schema version will fail validation against an older schema. Consumers SHOULD validate against the schema version declared by the document ($schema) rather than assume a fixed vocabulary.", "title": "Justification" }, "Impact_Override": { "type": "object", "required": [ "value" ], "unevaluatedProperties": false, "properties": { "value": { "type": "number", "minimum": 0, "maximum": 1, "description": "The overridden impact score (0.0–1.0)." } }, "description": "An override to the requirement's impact score. The prior impact is the original result value or the preceding override in the chain.", "title": "Impact Override" }, "Standalone_Override": { "type": "object", "description": "A standalone override to a requirement's compliance status or risk impact. Validation has two branches 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). For all other types, at least one of 'status' or 'impact' must be set. This rule aligns with: (1) 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/); (2) 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/); (3) 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).", "unevaluatedProperties": false, "required": [ "type", "requirementId", "reason", "appliedBy", "appliedAt", "expiresAt" ], "if": { "properties": { "type": { "enum": [ "operationalRequirement" ] } }, "required": [ "type" ] }, "then": { "not": { "anyOf": [ { "required": [ "status" ] }, { "required": [ "impact" ] } ] } }, "else": { "anyOf": [ { "required": [ "status" ] }, { "required": [ "impact" ] } ] }, "properties": { "type": { "$ref": "#/$defs/Override_Type", "description": "The type of amendment." }, "requirementId": { "type": "string", "description": "The ID of the requirement being amended. Must match a requirement ID in the referenced baseline." }, "baselineRef": { "type": "string", "description": "Name of the baseline containing the requirement. Required when the system has multiple baselines with potentially overlapping requirement IDs." }, "status": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status", "description": "The new status this amendment sets. Optional when only impact is being overridden." }, "impact": { "$ref": "#/$defs/Impact_Override", "description": "Override to the requirement's impact score. At least one of status or impact must be set." }, "reason": { "type": "string", "description": "Justification for this amendment." }, "appliedBy": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity", "description": "Identity of who applied this amendment." }, "appliedAt": { "type": "string", "format": "date-time", "description": "When this amendment was applied. ISO 8601 format." }, "expiresAt": { "type": "string", "format": "date-time", "description": "When this amendment expires and must be reviewed. No permanent amendments. ISO 8601 format." }, "evidence": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence" }, "description": "Supporting evidence (screenshots, logs, URLs, documents)." }, "signature": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature", "description": "Digital signature for non-repudiation." }, "previousChecksum": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum", "description": "Checksum of the prior amendment in the chain. Creates a tamper-evident linked list. Null for the first amendment." }, "cvss": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss", "$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.", "description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context." }, "justification": { "$ref": "#/$defs/Justification", "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." }, "milestones": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone" }, "description": "Remediation milestones (primarily for POA&M type amendments)." }, "inheritedFrom": { "type": "string", "format": "uuid", "description": "componentId of the local component that provides this control. Set when the provider is in the same system. Omit for external or cross-system providers; the reason field explains the source. Primarily used with type 'inherited'." }, "componentRef": { "type": "string", "format": "uuid", "description": "componentId of the component this amendment is scoped to. When set, the amendment only applies to the specified component. When omitted, the amendment applies system-wide." }, "affectedPackages": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0#/$defs/Affected_Package" }, "description": "Software packages this amendment is scoped to, distinct from componentRef (which scopes to an HDF-internal Component by UUID). Use when the source amendment format references packages by purl/cpe/name+version — e.g., VEX `affects[]` / `products[]`, OSCAL POA&M `subjects[]`, FedRAMP component-aware amendments. Symmetric with Evaluated_Requirement.affectedPackages, which scopes findings to the same package vocabulary. When omitted, the amendment applies system-wide (or only to componentRef when that is set)." } }, "examples": [ { "type": "waiver", "requirementId": "SV-257777", "baselineRef": "RHEL9-STIG", "status": "passed", "reason": "Compensating control: session timeout set to 15 min", "appliedBy": { "type": "email", "identifier": "ao@agency.gov" }, "appliedAt": "2026-01-15T10:00:00Z", "expiresAt": "2026-06-30T00:00:00Z", "evidence": [ { "type": "url", "data": "https://jira.agency.gov/CYBER-4521", "description": "ISSM approval with compensating control documentation" } ] }, { "type": "falsePositive", "requirementId": "SV-258010", "baselineRef": "RHEL9-STIG", "status": "passed", "reason": "STIG check misidentified sshd_config syntax; manual review confirms compliant configuration", "appliedBy": { "type": "email", "identifier": "assessor@agency.gov" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "falsePositive", "requirementId": "CVE-2026-12345", "status": "notApplicable", "reason": "CVE scanner matched library signature but the vulnerable code path is not present in our build — dependency is compiled with the affected module disabled", "appliedBy": { "type": "email", "identifier": "dev@org.gov" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "riskAdjustment", "requirementId": "SV-258020", "baselineRef": "RHEL9-STIG", "impact": { "value": 0.3 }, "reason": "CVE-123 is in a dead code path, unreachable from any entry point", "appliedBy": { "type": "email", "identifier": "dev@org.gov" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "poam", "requirementId": "SV-258001", "baselineRef": "RHEL9-STIG", "status": "failed", "reason": "Patch requires vendor release, expected Q2 2026", "appliedBy": { "type": "email", "identifier": "sysadmin@agency.gov" }, "appliedAt": "2026-01-20T09:00:00Z", "expiresAt": "2026-07-01T00:00:00Z", "milestones": [ { "description": "Vendor patch release", "estimatedCompletion": "2026-04-15T00:00:00Z", "status": "pending" }, { "description": "Apply patch to all servers", "estimatedCompletion": "2026-05-01T00:00:00Z", "status": "pending" } ] }, { "type": "inherited", "requirementId": "SV-230368", "baselineRef": "RHEL9-STIG", "status": "notApplicable", "reason": "IA-2 is a common control provided by Keycloak SSO. This application has no local authentication mechanism.", "inheritedFrom": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", "appliedBy": { "type": "email", "identifier": "issm@agency.gov" }, "appliedAt": "2026-03-26T10:00:00Z", "expiresAt": "2026-09-26T00:00:00Z" }, { "$comment": "VEX-style import — falsePositive scoped to specific packages by purl. The affectedPackages array carries structured product identity instead of squeezing 'Products: …' into the reason free-text field.", "type": "falsePositive", "requirementId": "CVE-2026-12345", "status": "notApplicable", "reason": "Vulnerable code path is not present in our build — dependency compiled with the affected module disabled", "justification": "vulnerable_code_not_present", "appliedBy": { "type": "email", "identifier": "secops@org.gov" }, "appliedAt": "2026-05-01T10:00:00Z", "expiresAt": "2027-05-01T00:00:00Z", "affectedPackages": [ { "purl": "pkg:npm/lodash@4.17.20" }, { "purl": "pkg:rpm/openssl@1.1.1k-2.el8", "fixedInVersion": "1.1.1k-3.el8" } ] } ], "title": "Standalone Override" } } }, "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0", "title": "HDF Result Primitives", "description": "Types for representing assessment results and statuses.", "$defs": { "Result_Status": { "type": "string", "enum": [ "passed", "failed", "notApplicable", "notReviewed", "error" ], "description": "The status of an individual test result. 'notApplicable' indicates the requirement does not apply to the target. 'notReviewed' indicates the requirement was not assessed (e.g., requires manual verification).", "title": "Result Status" }, "Requirement_Result": { "type": "object", "unevaluatedProperties": false, "required": [ "status", "codeDesc", "startTime" ], "properties": { "status": { "$ref": "#/$defs/Result_Status", "description": "The status of this test within the requirement. Example: 'failed'." }, "codeDesc": { "type": "string", "description": "A description of this test. Example: 'limits.conf * is expected to include [\"hard\", \"maxlogins\", \"10\"]'." }, "runTime": { "type": "number", "minimum": 0, "description": "The execution time in seconds for the test." }, "startTime": { "type": "string", "format": "date-time", "description": "The time at which the test started." }, "resource": { "type": "string", "description": "The resource used in the test. Example: 'file', 'command', 'service'." }, "resourceId": { "type": "string", "description": "The unique identifier of the resource. Example: '/etc/passwd'." }, "message": { "type": "string", "description": "An explanation of the test result. Typically provided for failed tests, errors, or to explain why a test was not applicable or not reviewed." }, "exception": { "type": "string", "description": "The type of exception if an exception was thrown." }, "backtrace": { "type": "array", "items": { "type": "string" }, "description": "The stacktrace/backtrace of the exception if one occurred." } }, "examples": [ { "status": "passed", "codeDesc": "File /etc/ssh/sshd_config content is expected to match /Protocol\\s+2/", "startTime": "2025-06-15T10:30:00Z", "runTime": 0.015 }, { "status": "failed", "codeDesc": "Service 'telnet' is expected not to be enabled", "startTime": "2025-06-15T10:30:01Z", "runTime": 0.008, "message": "expected that 'Service telnet' is not enabled" }, { "status": "error", "codeDesc": "File /etc/audit/auditd.conf content is expected to include 'max_log_file'", "startTime": "2025-06-15T10:30:02Z", "exception": "Errno::ENOENT", "backtrace": [ "/opt/inspec/lib/resources/file.rb:42:in 'read'", "/opt/inspec/lib/resources/file.rb:15:in 'content'" ] } ], "description": "A test within a requirement and its results and findings such as how long it took to run.", "title": "Requirement Result" }, "Requirement_Description": { "type": "object", "unevaluatedProperties": false, "required": [ "label", "data" ], "properties": { "label": { "type": "string", "description": "The type of description. Examples: 'fix', 'check', 'rationale'." }, "data": { "type": "string", "description": "The text of the description." } }, "examples": [ { "label": "default", "data": "Verify the SSH daemon is configured to only use FIPS-validated key exchange algorithms." }, { "label": "check", "data": "Run 'sshd -T | grep kexalgorithms' and verify only FIPS-compliant algorithms are listed." }, { "label": "fix", "data": "Add 'KexAlgorithms ecdh-sha2-nistp256,ecdh-sha2-nistp384' to /etc/ssh/sshd_config and restart sshd." } ], "description": "A labeled description for a requirement, such as fix text or check instructions.", "title": "Requirement Description" } } }, "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0", "title": "HDF CVSS Primitives", "description": "Types for representing CVSS (Common Vulnerability Scoring System) data attached to assessment findings. Supports CVSS v2.0, v3.0, v3.1, and v4.0 metric groups (Base, Threat, Environmental, Supplemental).", "$defs": { "Cvss_Severity": { "type": "string", "enum": [ "none", "low", "medium", "high", "critical" ], "description": "Qualitative CVSS severity band. Aligns with FIRST/NVD bands: none=0.0, low=0.1-3.9, medium=4.0-6.9, high=7.0-8.9, critical=9.0-10.0. Distinct from the broader Severity enum used on Requirement_Core (which includes 'informational').", "title": "CVSS Severity" }, "Cvss": { "type": "object", "unevaluatedProperties": false, "required": [ "version" ], "anyOf": [ { "required": [ "baseScore" ] }, { "required": [ "baseVector" ] }, { "required": [ "threatVector" ] }, { "required": [ "threatScore" ] }, { "required": [ "environmentalVector" ] }, { "required": [ "environmentalScore" ] }, { "required": [ "supplementalVector" ] }, { "required": [ "computedScore" ] } ], "$comment": "Only `version` is required; every metric/score field is optional because a single Cvss instance may represent vendor-supplied Base data (on a finding's cvss[]), consumer-supplied enrichment (on a riskAdjustment override — Environmental/Threat/Supplemental deltas with NO base, since base is the finding's scan-specific vendor data), or a fully-resolved effectiveCvss. The Base/Threat/Environmental/Supplemental groups do not partition cleanly into vendor-vs-consumer (Threat straddles: vendor temporal data and consumer exploit-maturity both live here), so a single permissive type is more honest than separate vendor/consumer types. The anyOf guardrail rejects a content-free object (e.g. {version} alone) by requiring at least one substantive metric or score. baseVector remains optional even when baseScore is present: some vendor tools (Twistlock/Prisma Cloud) emit a final score without the vector that derived it — that score is captured structurally rather than lost.", "properties": { "version": { "type": "string", "enum": [ "2.0", "3.0", "3.1", "4.0" ], "description": "The CVSS specification version this entry conforms to. Vendor scanners typically emit 3.1 or 4.0; legacy data may use 2.0 or 3.0." }, "source": { "type": "string", "description": "Optional identifier the CVSS data is associated with — most commonly a CVE ID (e.g., 'CVE-2024-12345'), but may also be a vendor advisory ID, GHSA, or similar.", "examples": [ "CVE-2024-12345", "GHSA-9hjg-9r4m-mvj7", "RHSA-2024:0123" ] }, "baseVector": { "type": "string", "$comment": "Optional. Permissive umbrella pattern accepting any FIRST CVSS vector shape — version prefix is optional (CVSS 2.0 has no prefix), metric tokens are alphanumeric uppercase pairs separated by '/'. Strict per-version semantic validation belongs in a separate utility (hdf-utilities `validateCvssVector`), not in the schema. See https://www.first.org/cvss/v4.0/specification-document for the v4 grammar and earlier-version documents for v2/v3.", "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$", "description": "Optional Base metric group vector string as emitted by the source (e.g., 'CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H'). For CVSS 2.0 the version prefix is omitted. Some vendor tools emit a final baseScore without the vector — in that case this field is absent and the score cannot be recomputed or decomposed. The pattern accepts any version-prefixed or prefix-less metric token sequence; semantic validity of individual metrics is checked by hdf-utilities, not by the schema." }, "baseScore": { "type": "number", "minimum": 0, "maximum": 10, "description": "The Base score (0.0–10.0) computed from the base vector. Reflects the intrinsic, vendor-published severity before consumer enrichment." }, "baseSeverity": { "$ref": "#/$defs/Cvss_Severity", "description": "Qualitative severity band corresponding to baseScore. CVSS 2.0 does not natively use 'none' or 'critical' bands; map accordingly when populating." }, "threatVector": { "type": "string", "$comment": "Threat (formerly Temporal in v3.x) metric group. Consumer-side metrics: Exploit Maturity, Remediation Level, Report Confidence (v3 added E/RL/RC; v4 keeps E only). Same permissive grammar as baseVector but the CVSS version prefix is rarely repeated here.", "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$", "description": "Optional Threat metric group vector segment (e.g., 'E:U/RL:O/RC:C' for CVSS 3.1, or 'E:A' for CVSS 4.0). Consumer-supplied — captures real-world exploitation and remediation context the vendor cannot know." }, "threatScore": { "type": "number", "minimum": 0, "maximum": 10, "description": "Optional score (0.0–10.0) recomputed after applying Threat metrics. Always less than or equal to baseScore in practice." }, "environmentalVector": { "type": "string", "$comment": "Environmental metric group. Consumer-side: Modified Base metrics (MAV, MAC, MC, MI, MA, ...) plus Security Requirements (CR, IR, AR). Captures how a particular consumer's environment changes the impact of the vulnerability.", "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$", "description": "Optional Environmental metric group vector segment (e.g., 'MAV:N/CR:H/IR:H/AR:H'). Consumer-supplied — reflects the deployment context (criticality, mitigations, network exposure)." }, "environmentalScore": { "type": "number", "minimum": 0, "maximum": 10, "description": "Optional score (0.0–10.0) recomputed after applying Environmental metrics." }, "supplementalVector": { "type": "string", "$comment": "Supplemental metric group is unique to CVSS 4.0. It conveys context (Safety, Automatable, Recovery, Value Density, Vulnerability Response Effort, Provider Urgency) but by spec does NOT affect any score — purely informational.", "pattern": "^(CVSS:[234]\\.[01]/)?[A-Za-z]+:[A-Za-z]+(/[A-Za-z]+:[A-Za-z]+)*$", "description": "Optional Supplemental metric group vector segment (CVSS 4.0 only). Examples: 'S:P/AU:N/V:C/RE:M/U:Amber'. Per CVSS 4.0 spec, supplemental metrics convey additional context but have no impact on the computed score." }, "computedScore": { "type": "number", "minimum": 0, "maximum": 10, "description": "Optional final score after combining Base + Threat + Environmental metrics. This is the score consumers should treat as authoritative for risk decisions when present." }, "computedSeverity": { "$ref": "#/$defs/Cvss_Severity", "description": "Qualitative severity band corresponding to computedScore. Same band convention as baseSeverity." } }, "examples": [ { "$comment": "Base-only: vendor-supplied CVSS 3.1 data exactly as a scanner (e.g., Nessus, Grype) would emit it. No consumer enrichment yet.", "version": "3.1", "source": "CVE-2024-12345", "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:H/A:H", "baseScore": 9.8, "baseSeverity": "critical" }, { "$comment": "Base + Threat: consumer added Exploit Maturity ('E:U' = Unproven) and Remediation Level ('RL:O' = Official Fix) to a HTTP/2 'Rapid Reset' DoS finding. Threat score drops from base 7.5 to 5.5.", "version": "3.1", "source": "CVE-2023-44487", "baseVector": "CVSS:3.1/AV:N/AC:L/PR:N/UI:N/S:U/C:N/I:N/A:H", "baseScore": 7.5, "baseSeverity": "high", "threatVector": "E:U/RL:O/RC:C", "threatScore": 5.5 }, { "$comment": "Base + Environmental: consumer asserts the affected system is high-criticality (CR:H, IR:H, AR:H) AND network-reachable in their environment (MAV:N). Environmental score reflects deployment risk for the xz-utils backdoor.", "version": "3.1", "source": "CVE-2024-3094", "baseVector": "CVSS:3.1/AV:L/AC:H/PR:H/UI:N/S:U/C:H/I:H/A:H", "baseScore": 6.7, "baseSeverity": "medium", "environmentalVector": "MAV:N/CR:H/IR:H/AR:H", "environmentalScore": 9, "computedScore": 9, "computedSeverity": "critical" }, { "$comment": "Full CVSS 4.0: vendor base + consumer threat (E:A = Attacked, exploits seen in the wild) + environmental (high CIA requirements) + supplemental context (S:P = present safety impact, AU:N = no autonomous spread, RE:M = moderate response effort) for the Fortinet FortiOS pre-auth RCE. computedScore reflects post-mitigation final risk.", "version": "4.0", "source": "CVE-2024-21762", "baseVector": "CVSS:4.0/AV:N/AC:L/AT:N/PR:N/UI:N/VC:H/VI:H/VA:H/SC:N/SI:N/SA:N", "baseScore": 9.8, "baseSeverity": "critical", "threatVector": "E:A", "threatScore": 9.3, "environmentalVector": "MAV:N/CR:H/IR:H/AR:H", "environmentalScore": 9.5, "supplementalVector": "S:P/AU:N/V:C/RE:M", "computedScore": 4.2, "computedSeverity": "medium" }, { "$comment": "CVSS 2.0 legacy: Heartbleed (CVE-2014-0160) as still reported by older scanner output and legacy NVD data. CVSS 2.0 vectors have no 'CVSS:2.0/' prefix.", "version": "2.0", "source": "CVE-2014-0160", "baseVector": "AV:N/AC:L/Au:N/C:P/I:N/A:N", "baseScore": 5, "baseSeverity": "medium" } ], "description": "A CVSS (Common Vulnerability Scoring System) score record for a vulnerability finding. Captures the vendor-supplied Base metric group and optional consumer-supplied Threat, Environmental, and Supplemental metric groups. Supports all four CVSS major versions (2.0, 3.0, 3.1, 4.0). Vector strings are validated against a permissive umbrella grammar; semantic validation (correct metrics per version, correct values per metric) is performed by the hdf-utilities `validateCvssVector` helper rather than at the schema layer.", "title": "CVSS" } } }, "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/affected-package/v3.3.0", "title": "HDF Affected Package Primitives", "description": "Types for representing the software package(s) affected by a vulnerability finding.", "$defs": { "Affected_Package": { "type": "object", "unevaluatedProperties": false, "anyOf": [ { "required": [ "name", "version", "ecosystem" ] }, { "required": [ "purl" ] }, { "required": [ "cpe" ] } ], "properties": { "name": { "type": "string", "description": "The package name as published in its ecosystem. Examples: 'openssl' (rpm), 'lodash' (npm), 'org.apache.logging.log4j:log4j-core' (maven, group:artifact)." }, "version": { "type": "string", "description": "The exact version of the package that the vulnerability scanner observed. Use the ecosystem's native version string verbatim (e.g., '1.1.1k-7.el8_4' for rpm, '4.17.20' for npm)." }, "ecosystem": { "type": "string", "enum": [ "npm", "pypi", "rpm", "deb", "maven", "gem", "nuget", "go", "cargo", "generic" ], "description": "The packaging ecosystem the package belongs to. Use 'generic' for hardware, firmware, or anything outside the listed language/OS package managers." }, "cpe": { "type": "string", "pattern": "^cpe:2\\.3:[aho]:.*", "description": "Optional CPE 2.3 URI identifying the affected product. Validated leniently: only the 'cpe:2.3:' prefix and the part-type letter ('a' application, 'h' hardware, 'o' operating system) are enforced here. Use `hdf-utilities.parseCpe` for full-grammar parsing. Example: 'cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*'." }, "purl": { "type": "string", "pattern": "^pkg:[A-Za-z0-9.+-]+/.+", "description": "Optional Package URL (PURL) identifying the affected package. Validated leniently: only the 'pkg:TYPE/' scheme prefix is enforced here, where TYPE follows the PURL grammar (a letter followed by letters, digits, '.', '+', or '-') and is matched case-insensitively to mirror `hdf-utilities.parsePurl`'s accept-and-warn behavior. Use `parsePurl` for full PURL parsing. Example: 'pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64'." }, "fixedInVersion": { "type": "string", "description": "Optional version string identifying the first release that contains the fix for the vulnerability. Use the same version syntax as `version`. Example: '1.1.1l' fixes 'openssl@1.1.1k'." } }, "examples": [ { "$comment": "RPM ecosystem with full CPE + PURL — typical Grype/Trivy output for a RHEL host scan.", "name": "openssl", "version": "1.1.1k-7.el8_4", "ecosystem": "rpm", "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*", "purl": "pkg:rpm/redhat/openssl@1.1.1k-7.el8_4?arch=x86_64", "fixedInVersion": "1.1.1l" }, { "$comment": "NPM ecosystem with PURL only — the JavaScript world rarely emits CPEs; PURL is the canonical identifier.", "name": "lodash", "version": "4.17.20", "ecosystem": "npm", "purl": "pkg:npm/lodash@4.17.20", "fixedInVersion": "4.17.21" }, { "$comment": "Minimal valid AffectedPackage — only the three required fields. Use when the scanner reports a package by name+version without emitting CPE or PURL strings.", "name": "requests", "version": "2.28.1", "ecosystem": "pypi" }, { "$comment": "Maven ecosystem with full identifiers + fixedInVersion — log4j Log4Shell-style finding showing the patch path from vulnerable to fixed.", "name": "org.apache.logging.log4j:log4j-core", "version": "2.14.1", "ecosystem": "maven", "cpe": "cpe:2.3:a:apache:log4j:2.14.1:*:*:*:*:*:*:*", "purl": "pkg:maven/org.apache.logging.log4j/log4j-core@2.14.1", "fixedInVersion": "2.17.1" }, { "$comment": "purl-only — VEX import path where the source format gives a purl and we choose not to decompose it. Valid because purl encodes name/version/ecosystem implicitly.", "purl": "pkg:npm/lodash@4.17.20" }, { "$comment": "cpe-only — NIST-flavored scopes where the consumer carries a CPE 2.3 string and no purl. Valid because cpe encodes vendor/product/version.", "cpe": "cpe:2.3:a:openssl:openssl:1.1.1k:*:*:*:*:*:*:*" } ], "description": "Represents a package referenced by a vulnerability finding or by an amendment's scope. On Evaluated_Requirement.affectedPackages it says 'this CVE affects these package versions'. On Standalone_Override.affectedPackages it says 'this amendment is scoped to these packages' (used by VEX, OSCAL POA&M, FedRAMP component-aware amendments). NOT a system-level component identifier — see `components[]` on hdf-system for those. Validity requires at least one of: (name + version + ecosystem), purl alone, or cpe alone. purl and cpe are self-describing identifiers that encode name/version implicitly, so either may stand on its own; the name+version+ecosystem combination is the explicit form for sources without formal identifiers.", "title": "Affected Package" } } }, "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0": { "$schema": "https://json-schema.org/draft/2020-12/schema", "$id": "https://mitre.github.io/hdf-libs/schemas/primitives/extensions/v3.3.0", "title": "HDF Extension Primitives", "description": "Extension types for waivers, attestations, generators, and integrity.", "$defs": { "Status_Override": { "type": "object", "unevaluatedProperties": false, "required": [ "type", "reason", "appliedBy", "appliedAt", "expiresAt" ], "anyOf": [ { "required": [ "status" ] }, { "required": [ "impact" ] } ], "properties": { "type": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Override_Type", "description": "The type of override applied to this requirement." }, "status": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/result/v3.3.0#/$defs/Result_Status", "description": "The new status this override sets for the requirement. Optional when only impact is being overridden." }, "impact": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Impact_Override", "description": "Override to the requirement's impact score. At least one of status or impact must be set." }, "reason": { "type": "string", "description": "Explanation for why this override was applied." }, "appliedBy": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity", "description": "Identity of who applied this override. For simple cases, use type 'simple' with just an identifier." }, "appliedAt": { "type": "string", "format": "date-time", "description": "Timestamp when this override was applied. ISO 8601 format." }, "expiresAt": { "type": "string", "format": "date-time", "description": "Timestamp when this override expires and must be reviewed/renewed. REQUIRED - no permanent overrides allowed. ISO 8601 format." }, "signature": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature", "description": "Optional digital signature for enhanced trust and non-repudiation. Supports hardware security tokens (PKCS#11/PKCS#12), Yubikeys, GPG keys, passkeys, and other signing methods." }, "evidence": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence" }, "description": "Supporting evidence for this override, such as screenshots demonstrating manual verification for attestations." }, "previousChecksum": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum", "description": "SHA-256 checksum of the previous amendment in chronological order. Creates a tamper-evident chain of amendments (similar to blockchain). Null for the first amendment on a requirement." }, "cvss": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/cvss/v3.3.0#/$defs/Cvss", "$comment": "When present alongside impact.value on a riskAdjustment override, impact.value should be approximately cvss.computedScore / 10.0. Soft consistency rule — validators may warn but should not error. The cvss block makes Environmental/Threat enrichment auditable.", "description": "Structured CVSS scoring data backing this override. Captures the rubric (which Environmental/Threat metrics the consumer modified, the recomputed score) used to justify a riskAdjustment. For other override types this is optional context." }, "justification": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/amendments/v3.3.0#/$defs/Justification", "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." } }, "examples": [ { "type": "waiver", "status": "notApplicable", "reason": "This control does not apply to containerized environments as the application runs in ephemeral containers without persistent storage", "appliedBy": { "identifier": "security-team@example.com", "type": "email" }, "appliedAt": "2025-12-01T10:00:00Z", "expiresAt": "2026-12-01T00:00:00Z" }, { "type": "riskAdjustment", "impact": { "value": 0.3 }, "reason": "CVE-123 is in a dead code path, unreachable from any entry point", "appliedBy": { "identifier": "dev@org.gov", "type": "email" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "falsePositive", "status": "passed", "reason": "STIG check misidentified sshd_config syntax; manual review confirms compliant configuration", "appliedBy": { "identifier": "assessor@agency.gov", "type": "email" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "falsePositive", "status": "notApplicable", "reason": "CVE scanner matched library signature but the vulnerable code path is not present — dependency compiled with affected module disabled", "appliedBy": { "identifier": "dev@org.gov", "type": "email" }, "appliedAt": "2026-04-14T10:00:00Z", "expiresAt": "2026-10-14T00:00:00Z" }, { "type": "attestation", "status": "passed", "reason": "Manual verification completed: Reviewed firewall rules and confirmed all required ports are properly restricted per security policy", "appliedBy": { "identifier": "john.doe", "type": "username", "description": "Senior Security Engineer" }, "appliedAt": "2025-11-30T14:30:00Z", "expiresAt": "2026-05-30T00:00:00Z", "evidence": [ { "type": "screenshot", "data": "base64-encoded-screenshot-data-here", "description": "Screenshot showing firewall configuration", "mimeType": "image/png", "encoding": "base64", "capturedAt": "2025-11-30T14:25:00Z", "capturedBy": { "identifier": "john.doe", "type": "username" } } ] } ], "description": "An intentional change to a requirement's compliance status and/or impact score. At least one of status or impact must be set. Overrides change the effectiveStatus or impact of the requirement. All overrides must have an expiration date to enforce periodic review.", "title": "Status Override" }, "POAM": { "type": "object", "unevaluatedProperties": false, "required": [ "type", "explanation", "appliedBy", "appliedAt" ], "properties": { "type": { "type": "string", "title": "POAM Type", "enum": [ "remediation", "mitigation", "riskAcceptance", "vendorDependency" ], "description": "The type of POA&M. 'remediation' fixes root cause. 'mitigation' reduces risk via compensating controls. 'riskAcceptance' documents decision to accept risk. 'vendorDependency' tracks a fix that depends on a vendor releasing a patch or update." }, "explanation": { "type": "string", "description": "Detailed explanation of the plan, including what actions will be taken." }, "appliedBy": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Identity", "description": "Identity of who created this POA&M. For simple cases, use type 'simple' with just an identifier." }, "appliedAt": { "type": "string", "format": "date-time", "description": "Timestamp when this POA&M was created. ISO 8601 format." }, "expiresAt": { "type": "string", "format": "date-time", "description": "Optional expiration date for this POA&M requiring review/renewal. ISO 8601 format." }, "milestones": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Milestone" }, "description": "Optional array of milestones tracking progress toward completion." }, "signature": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Signature", "description": "Optional digital signature for enhanced trust and non-repudiation." }, "evidence": { "type": "array", "items": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Evidence" }, "description": "Supporting evidence for this POA&M, such as documentation of compensating controls or mitigation implementation." }, "previousChecksum": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Checksum", "description": "SHA-256 checksum of the previous amendment in chronological order. Creates a tamper-evident chain of amendments (similar to blockchain). Null for the first amendment on a requirement." } }, "examples": [ { "type": "remediation", "explanation": "Upgrade OpenSSL to version 3.0.x to address CVE-2024-XXXXX vulnerability. Root cause: outdated dependency version in base image.", "appliedBy": { "identifier": "devops-team@example.com", "type": "email" }, "appliedAt": "2025-12-01T09:00:00Z", "milestones": [ { "description": "Update base Docker image to use OpenSSL 3.0.x", "estimatedCompletion": "2025-12-15T00:00:00Z", "status": "completed", "completedAt": "2025-12-10T16:30:00Z", "completedBy": { "identifier": "alice.smith", "type": "username" } }, { "description": "Deploy updated image to production", "estimatedCompletion": "2025-12-20T00:00:00Z", "status": "inProgress" }, { "description": "Verify vulnerability no longer present via security scan", "estimatedCompletion": "2025-12-22T00:00:00Z", "status": "pending" } ] }, { "type": "mitigation", "explanation": "Implement network segmentation as compensating control while awaiting vendor patch for database vulnerability. Traffic to vulnerable database server is restricted to internal management VLAN only.", "appliedBy": { "identifier": "security-architect", "type": "system", "description": "Automated POA&M creation from vulnerability scan" }, "appliedAt": "2025-11-28T14:00:00Z", "expiresAt": "2026-02-28T00:00:00Z", "milestones": [ { "description": "Configure firewall rules to restrict database access to management VLAN", "estimatedCompletion": "2025-12-02T00:00:00Z", "status": "completed", "completedAt": "2025-11-29T11:15:00Z", "completedBy": { "identifier": "network-ops@example.com", "type": "email" } }, { "description": "Monitor for vendor security patch release", "estimatedCompletion": "2026-02-28T00:00:00Z", "status": "inProgress" } ], "evidence": [ { "type": "code", "data": "# Firewall rule configuration\niptables -A INPUT -s 10.0.1.0/24 -p tcp --dport 5432 -j ACCEPT\niptables -A INPUT -p tcp --dport 5432 -j DROP", "description": "Firewall rules restricting database access", "mimeType": "text/plain" } ] }, { "type": "riskAcceptance", "explanation": "Risk accepted for legacy system scheduled for decommissioning in Q1 2026. Cost of remediation ($50K for emergency upgrade) exceeds residual risk given 3-month remaining lifespan. Compensating controls: isolated network segment, enhanced monitoring.", "appliedBy": { "identifier": "ciso@example.com", "type": "email" }, "appliedAt": "2025-12-05T10:00:00Z", "expiresAt": "2026-04-01T00:00:00Z", "milestones": [ { "description": "Complete migration to replacement system", "estimatedCompletion": "2026-03-15T00:00:00Z", "status": "inProgress" }, { "description": "Decommission legacy system", "estimatedCompletion": "2026-03-31T00:00:00Z", "status": "pending" } ] } ], "description": "Plan of Action and Milestones for tracking remediation, mitigation, or risk acceptance. POAMs do NOT change the effectiveStatus - the requirement remains in its current state while the POA&M tracks remediation efforts.", "title": "POAM" }, "Generator": { "type": "object", "unevaluatedProperties": false, "required": [ "name", "version" ], "properties": { "name": { "type": "string", "description": "The name of the software that produced this HDF file. Example: 'gosec-to-hdf'." }, "version": { "type": "string", "description": "The version of the tool. Example: '5.22.3'." } }, "description": "Information about the tool that generated this HDF file.", "title": "Generator" }, "Tool": { "type": "object", "unevaluatedProperties": false, "properties": { "name": { "type": "string", "description": "The name of the security tool that produced the data. Examples: 'gosec', 'Semgrep', 'OpenSCAP', 'AWS Config', 'Nessus'. Omit if the tool cannot be identified." }, "version": { "type": "string", "description": "Version of the source tool, if available in the tool's output. Example: '5.22.3'." }, "format": { "type": "string", "description": "The file format, if it is a recognized named format shared by multiple tools. Examples: 'SARIF', 'XCCDF'. Omit for tool-specific formats where the tool name already implies the format (Nessus XML, gosec JSON)." } }, "description": "The security tool that produced the assessment data represented in this HDF file. Aligns with SARIF, OSCAL, and CycloneDX terminology.", "title": "Tool" }, "Integrity": { "type": "object", "unevaluatedProperties": false, "dependentRequired": { "algorithm": [ "checksum" ], "checksum": [ "algorithm" ] }, "properties": { "algorithm": { "$ref": "https://mitre.github.io/hdf-libs/schemas/primitives/common/v3.3.0#/$defs/Hash_Algorithm", "description": "The hash algorithm used for the checksum." }, "checksum": { "type": "string", "description": "The checksum value." }, "signature": { "type": "string", "description": "Optional cryptographic signature." }, "signedBy": { "type": "string", "description": "Identifier of who signed this file." } }, "examples": [ { "algorithm": "sha256", "checksum": "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855" }, { "algorithm": "sha512", "checksum": "cf83e1357eefb8bdf1542850d66d8007d620e4050b5715dc83f4a921d36ce9ce47d0d13c5d85f2b0ff8318d2877eec2f63b931bd47417a81a538327af927da3e", "signature": "MEUCIQDx1y2hKl3mN8vP9qRz4tJ2sW5nX6cY8bD9aE3fG4hI5wIgK7mN8oP9qR0zS1tU2vW3xY4zA5bC6dD7eE8fG9hI0jK=", "signedBy": "security-automation@example.com" } ], "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.", "title": "Integrity" } } } } }