Add 'inventory-item-has-hardware-model' constraints and tests

GSA · Jan 9, 2025 · 56e3e28 · 56e3e28
1 parent 719cf2c
commit 56e3e28
Show file tree

Hide file tree

Showing 6 changed files with 43 additions and 0 deletions.
diff --git a/features/fedramp_extensions.feature b/features/fedramp_extensions.feature
@@ -120,6 +120,7 @@ Examples:
   | interconnection-security |
   | inventory-item-allows-authenticated-scan |
   | inventory-item-and-component-has-public |
+  | inventory-item-has-hardware-model |
   | inventory-item-has-software-name |
   | inventory-item-has-software-version |
   | inventory-item-has-valid-mac-address |
@@ -375,6 +376,8 @@ Examples:
   | inventory-item-allows-authenticated-scan-PASS.yaml |
   | inventory-item-and-component-has-public-FAIL.yaml |
   | inventory-item-and-component-has-public-PASS.yaml |
+  | inventory-item-has-hardware-model-FAIL.yaml |
+  | inventory-item-has-hardware-model-PASS.yaml |
   | inventory-item-has-software-name-FAIL.yaml |
   | inventory-item-has-software-name-PASS.yaml |
   | inventory-item-has-software-version-FAIL.yaml |

diff --git a/src/content/rev5/examples/ssp/xml/fedramp-ssp-example.oscal.xml b/src/content/rev5/examples/ssp/xml/fedramp-ssp-example.oscal.xml
@@ -2293,6 +2293,7 @@ approved.</p>
       <description>
         <p>Legacy Example (No implemented-component).</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-01"/>
       <prop name="software-version" value="software-version"/>
       <prop name="ipv4-address" value="10.1.1.1"/>
@@ -2348,6 +2349,7 @@ approved.</p>
       <description>
         <p>Component Inventory Example</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-02"/>
       <prop name="ipv4-address" value="10.2.2.2"/>
       <prop name="ipv6-address" value="0000:0000:0000:0000:0000:ffff:0a02:0202"/>
@@ -2387,6 +2389,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-03"/>
       <prop name="asset-type" value="web-server"/>
       <prop name="virtual" value="yes"/>
@@ -2403,6 +2406,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-04"/>
       <prop name="asset-type" value="appliance"/>
       <prop name="virtual" value="yes"/>
@@ -2418,6 +2422,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-05"/>
       <prop name="asset-type" value="firewall"/>
       <prop name="ipv4-address" value="10.5.5.5"/>
@@ -2433,6 +2438,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-06"/>
       <prop name="ipv4-address" value="10.6.6.6"/>
       <prop name="ipv6-address" value="0000:0000:0000:0000:0000:ffff:0a06:0606"/>
@@ -2451,6 +2457,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-07"/>
       <prop name="asset-type" value="switch"/>
       <prop name="ipv4-address" value="10.7.7.7"/>
@@ -2466,6 +2473,7 @@ approved.</p>
       <description>
         <p>None.</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-08"/>
       <prop name="asset-type" value="web-server"/>
       <prop name="ipv4-address" value="10.8.8.8"/>
@@ -2484,6 +2492,7 @@ approved.</p>
       <description>
         <p>Email-Service</p>
       </description>
+      <prop name="hardware-model" value="model"/>
       <prop name="asset-id" value="unique-asset-ID-09"/>
       <prop name="asset-type" value="email-server"/>
       <prop name="ipv4-address" value="10.10.10.100"/>

diff --git a/src/validations/constraints/content/ssp-inventory-item-has-hardware-model-INVALID.xml b/src/validations/constraints/content/ssp-inventory-item-has-hardware-model-INVALID.xml
@@ -0,0 +1,7 @@
+<system-security-plan xmlns="http://csrc.nist.gov/ns/oscal/1.0" uuid="11111111-2222-4000-8000-000000000000">
+  <system-implementation>
+    <inventory-item uuid="11111111-2222-4000-8000-011000000001">
+      <!-- <prop name="hardware-model" value="model"/> Missing "hardware-model" prop. -->
+    </inventory-item>
+  </system-implementation>
+</system-security-plan>
diff --git a/src/validations/constraints/fedramp-external-constraints.xml b/src/validations/constraints/fedramp-external-constraints.xml
@@ -663,10 +663,16 @@
         <metapath target="/system-security-plan/system-implementation/inventory-item"/>
         <constraints>
             <let var ="component-uuid" expression="implemented-component/@component-uuid"/>
+             <expect id="inventory-item-has-hardware-model" target="." test="count(prop[@name='hardware-model' ]) >= 1 or count(../component[@uuid=$component-uuid]/prop[@name='hardware-model' ]) >= 1" level="ERROR">
+                <formal-name>Inventory Item Has Hardware Model</formal-name>
+                <prop namespace="https://docs.oasis-open.org/sarif/sarif/v2.1.0" name="help-url" value="https://automate.fedramp.gov/documentation/ssp/5-attachments/#system-inventory-approach"/>
+                <message>In a FedRAMP SSP, each inventory item MUST provide the hardware model either in the inventory item itself or within the linked component.</message>
+            </expect>
             <expect id="inventory-item-has-software-name" target=".[prop[@name='asset-type' and @value=('operating-system', 'container', 'image')] or ../component[uuid=$component-uuid and type='software']]" test="count(prop[@name=('software-name', 'os-name')]) = 1 or count(../component[@uuid=$component-uuid]/prop[@name=('software-name', 'os-name')]) = 1" level="ERROR">
                 <formal-name>Inventory Item Has Software Name</formal-name>
                 <prop namespace="https://docs.oasis-open.org/sarif/sarif/v2.1.0" name="help-url" value="https://automate.fedramp.gov/documentation/ssp/5-attachments/#system-inventory-approach"/>
                 <message>In a FedRAMP SSP, each inventory item MUST include the software name in the inventory item itself or within the linked component.</message>
+            </expect>
             <expect id="inventory-item-has-software-version" target=".[prop[@name='asset-type' and @value=('operating-system', 'container', 'image')] or ../component[uuid=$component-uuid and type='software']]" test="count(prop[@name=('software-version', 'os-version')]) = 1 or count(../component[@uuid=$component-uuid]/prop[@name=('software-version', 'os-version')]) = 1" level="ERROR">
                 <formal-name>Inventory Item Has Software Version</formal-name>
                 <prop namespace="https://docs.oasis-open.org/sarif/sarif/v2.1.0" name="help-url" value="https://automate.fedramp.gov/documentation/ssp/5-attachments/#system-inventory-approach"/>

diff --git a/src/validations/constraints/unit-tests/inventory-item-has-hardware-model-FAIL.yaml b/src/validations/constraints/unit-tests/inventory-item-has-hardware-model-FAIL.yaml
@@ -0,0 +1,9 @@
+test-case:
+  name: Negative Test for inventory-item-has-hardware-model
+  description: >-
+    This test case validates the behavior of constraint
+    inventory-item-has-hardware-model
+  content: ../content/ssp-inventory-item-has-hardware-model-INVALID.xml
+  expectations:
+    - constraint-id: inventory-item-has-hardware-model
+      result: fail
diff --git a/src/validations/constraints/unit-tests/inventory-item-has-hardware-model-PASS.yaml b/src/validations/constraints/unit-tests/inventory-item-has-hardware-model-PASS.yaml
@@ -0,0 +1,9 @@
+test-case:
+  name: Positive Test for inventory-item-has-hardware-model
+  description: >-
+    This test case validates the behavior of constraint
+    inventory-item-has-hardware-model
+  content: ../../../content/rev5/examples/ssp/xml/fedramp-ssp-example.oscal.xml
+  expectations:
+    - constraint-id: inventory-item-has-hardware-model
+      result: pass