diff --git a/README.md b/README.md index ebb45f8d..928176fa 100644 --- a/README.md +++ b/README.md @@ -357,7 +357,6 @@ The following tests are not yet implemented and therefore missing: - Recommended Test 6.2.34 - Recommended Test 6.2.35 - Recommended Test 6.2.36 -- Recommended Test 6.2.37 - Recommended Test 6.2.38 - Recommended Test 6.2.39 - Recommended Test 6.2.40 @@ -462,6 +461,7 @@ export const recommendedTest_6_2_16: DocumentTest export const recommendedTest_6_2_17: DocumentTest export const recommendedTest_6_2_18: DocumentTest export const recommendedTest_6_2_22: DocumentTest +export const recommendedTest_6_2_37: DocumentTest ``` [(back to top)](#bsi-csaf-validator-lib) diff --git a/csaf_2_1/recommendedTests.js b/csaf_2_1/recommendedTests.js index aeb25c42..25e477bb 100644 --- a/csaf_2_1/recommendedTests.js +++ b/csaf_2_1/recommendedTests.js @@ -30,4 +30,5 @@ export { recommendedTest_6_2_22 } from './recommendedTests/recommendedTest_6_2_2 export { recommendedTest_6_2_27 } from './recommendedTests/recommendedTest_6_2_27.js' export { recommendedTest_6_2_28 } from './recommendedTests/recommendedTest_6_2_28.js' export { recommendedTest_6_2_29 } from './recommendedTests/recommendedTest_6_2_29.js' +export { recommendedTest_6_2_37 } from './recommendedTests/recommendedTest_6_2_37.js' export { recommendedTest_6_2_38 } from './recommendedTests/recommendedTest_6_2_38.js' diff --git a/csaf_2_1/recommendedTests/recommendedTest_6_2_37.js b/csaf_2_1/recommendedTests/recommendedTest_6_2_37.js new file mode 100644 index 00000000..a98a8d82 --- /dev/null +++ b/csaf_2_1/recommendedTests/recommendedTest_6_2_37.js @@ -0,0 +1,72 @@ +import Ajv from 'ajv/dist/jtd.js' + +const ajv = new Ajv() + +const inputSchema = /** @type {const} */ ({ + additionalProperties: true, + properties: { + vulnerabilities: { + elements: { + additionalProperties: true, + optionalProperties: { + metrics: { + elements: { + additionalProperties: true, + optionalProperties: { + content: { + additionalProperties: true, + optionalProperties: { + ssvc_v1: { + additionalProperties: true, + optionalProperties: { + role: { + type: 'string', + }, + }, + }, + }, + }, + }, + }, + }, + }, + }, + }, + }, +}) + +const validate = ajv.compile(inputSchema) + +/** + * This implements the recommended test 6.2.37 of the CSAF 2.1 standard. + * + * @param {any} doc + */ +export function recommendedTest_6_2_37(doc) { + /** @type {Array<{ message: string; instancePath: string }>} */ + const warnings = [] + const context = { warnings } + + if (!validate(doc)) { + return context + } + + /* + * Please note that this list can change + * */ + const registeredSsvcRoles = ['Supplier', 'Deployer', 'Coordinator'] + + doc.vulnerabilities?.forEach((vulnerability, vulnerabilityIndex) => { + vulnerability.metrics?.forEach((metric, metricIndex) => { + const role = metric.content?.ssvc_v1?.role + if (role !== undefined && !registeredSsvcRoles.includes(role)) { + context.warnings.push({ + message: `The used role "${role}" is not registered`, + instancePath: `/vulnerabilities/${vulnerabilityIndex}/metrics/${metricIndex}/content/ssvc_v1/role`, + }) + } + }) + }) + + return context +} diff --git a/tests/csaf_2_1/oasis.js b/tests/csaf_2_1/oasis.js index 31ce644c..68f54a9d 100644 --- a/tests/csaf_2_1/oasis.js +++ b/tests/csaf_2_1/oasis.js @@ -55,7 +55,6 @@ const excluded = [ '6.2.34', '6.2.35', '6.2.36', - '6.2.37', '6.2.39.1', '6.2.39.2', '6.2.39.3', diff --git a/tests/csaf_2_1/recommendedTest_6_2_37.js b/tests/csaf_2_1/recommendedTest_6_2_37.js new file mode 100644 index 00000000..76cdfa5f --- /dev/null +++ b/tests/csaf_2_1/recommendedTest_6_2_37.js @@ -0,0 +1,11 @@ +import assert from 'node:assert' +import { recommendedTest_6_2_37 } from '../../csaf_2_1/recommendedTests.js' + +describe('recommendedTest_6_2_37', function () { + it('only runs on relevant documents', function () { + assert.equal( + recommendedTest_6_2_37({ vulnerabilities: 'mydoc' }).warnings.length, + 0 + ) + }) +})