Merge pull request #339 from secvisogram/316-mandatory-test-6.1.27.14

feat: add mandatory test 6.1.27.14

Author: domachine

README.md

@@ -315,7 +315,6 @@ The following tests are not yet implemented and therefore missing:
 - Mandatory Test 6.1.16
 - Mandatory Test 6.1.27.12
 - Mandatory Test 6.1.27.13
-- Mandatory Test 6.1.27.14
 - Mandatory Test 6.1.27.15
 - Mandatory Test 6.1.27.16
 - Mandatory Test 6.1.27.17
@@ -422,6 +421,7 @@ export const mandatoryTest_6_1_27_8: DocumentTest
 export const mandatoryTest_6_1_27_9: DocumentTest
 export const mandatoryTest_6_1_27_10: DocumentTest
 export const mandatoryTest_6_1_27_11: DocumentTest
+export const mandatoryTest_6_1_27_14: DocumentTest
 export const mandatoryTest_6_1_28: DocumentTest
 export const mandatoryTest_6_1_29: DocumentTest
 export const mandatoryTest_6_1_30: DocumentTest

csaf_2_1/mandatoryTests.js

@@ -40,6 +40,7 @@ export { mandatoryTest_6_1_8 } from './mandatoryTests/mandatoryTest_6_1_8.js'
 export { mandatoryTest_6_1_11 } from './mandatoryTests/mandatoryTest_6_1_11.js'
 export { mandatoryTest_6_1_13 } from './mandatoryTests/mandatoryTest_6_1_13.js'
 export { mandatoryTest_6_1_10 } from './mandatoryTests/mandatoryTest_6_1_10.js'
+export { mandatoryTest_6_1_27_14 } from './mandatoryTests/mandatoryTest_6_1_27_14.js'
 export { mandatoryTest_6_1_34 } from './mandatoryTests/mandatoryTest_6_1_34.js'
 export { mandatoryTest_6_1_35 } from './mandatoryTests/mandatoryTest_6_1_35.js'
 export { mandatoryTest_6_1_9 } from './mandatoryTests/mandatoryTest_6_1_9.js'

csaf_2_1/mandatoryTests/mandatoryTest_6_1_27_14.js

@@ -0,0 +1,70 @@
+import Ajv from 'ajv/dist/jtd.js'
+
+const ajv = new Ajv()
+
+/*
+  This is the jtd schema that needs to match the input document so that the
+  test is activated. If this schema doesn't match it normally means that the input
+  document does not validate against the csaf json schema or optional fields that
+  the test checks are not present.
+ */
+const inputSchema = /** @type {const} */ ({
+  additionalProperties: true,
+  properties: {
+    document: {
+      additionalProperties: true,
+      properties: {
+        category: {
+          type: 'string',
+        },
+      },
+      optionalProperties: {
+        notes: {
+          elements: {
+            additionalProperties: true,
+            optionalProperties: {
+              category: {
+                type: 'string',
+              },
+            },
+          },
+        },
+      },
+    },
+  },
+})
+
+const validate = ajv.compile(inputSchema)
+
+/**
+ * This implements the mandatory test 6.1.27.14 of the CSAF 2.1 standard.
+ *
+ * @param {unknown} doc
+ */
+export function mandatoryTest_6_1_27_14(doc) {
+  /*
+    The `ctx` variable holds the state that is accumulated during the test ran and is
+    finally returned by the function.
+   */
+  const ctx = {
+    errors:
+      /** @type {Array<{ instancePath: string; message: string }>} */ ([]),
+    isValid: true,
+  }
+
+  if (
+    !validate(doc) ||
+    !['csaf_withdrawn', 'csaf_superseded'].includes(doc.document.category)
+  )
+    return ctx
+
+  if (!doc.document.notes?.find((n) => n.category === 'description')) {
+    ctx.isValid = false
+    ctx.errors.push({
+      instancePath: '/document/notes',
+      message: 'needs at least one note with the category "description"',
+    })
+  }
+
+  return ctx
+}

tests/csaf_2_1/mandatoryTest_6_1_27_14.js

@@ -0,0 +1,24 @@
+import assert from 'node:assert/strict'
+import { mandatoryTest_6_1_27_14 } from '../../csaf_2_1/mandatoryTests/mandatoryTest_6_1_27_14.js'
+
+describe('mandatoryTest_6_1_27_14', function () {
+  it('only runs on documents matching the input schema', function () {
+    assert.equal(
+      mandatoryTest_6_1_27_14({
+        document: 'invalid json',
+      }).isValid,
+      true
+    )
+  })
+
+  it('only runs on csaf_withdrawn and csaf_superseded documents', function () {
+    assert.equal(
+      mandatoryTest_6_1_27_14({
+        document: {
+          category: 'unknown category',
+        },
+      }).isValid,
+      true
+    )
+  })
+})

tests/csaf_2_1/oasis.js

@@ -20,7 +20,6 @@ const excluded = [
   '6.1.27.11',
   '6.1.27.12',
   '6.1.27.13',
-  '6.1.27.14',
   '6.1.27.15',
   '6.1.27.16',
   '6.1.27.17',