Skip to content

feat(CSAF2.1): #196 add optionalTest_6_2_30.js #265

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -345,10 +345,6 @@ The following tests are not yet implemented and therefore missing:
- Recommeded Test 6.2.24
- Recommeded Test 6.2.25
- Recommeded Test 6.2.26
- Recommeded Test 6.2.27
- Recommeded Test 6.2.28
- Recommeded Test 6.2.29
- Recommeded Test 6.2.30
- Recommeded Test 6.2.31
- Recommeded Test 6.2.32
- Recommeded Test 6.2.33
Expand Down Expand Up @@ -463,6 +459,10 @@ export const recommendedTest_6_2_18: DocumentTest
export const recommendedTest_6_2_19: DocumentTest
export const recommendedTest_6_2_20: DocumentTest
export const recommendedTest_6_2_22: DocumentTest
export const recommendedTest_6_2_27: DocumentTest
export const recommendedTest_6_2_28: DocumentTest
export const recommendedTest_6_2_29: DocumentTest
export const recommendedTest_6_2_30: DocumentTest
```

[(back to top)](#bsi-csaf-validator-lib)
Expand Down
1 change: 1 addition & 0 deletions csaf_2_1/recommendedTests.js
Original file line number Diff line number Diff line change
Expand Up @@ -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_30 } from './recommendedTests/recommendedTest_6_2_30.js'
export { recommendedTest_6_2_38 } from './recommendedTests/recommendedTest_6_2_38.js'
64 changes: 64 additions & 0 deletions csaf_2_1/recommendedTests/recommendedTest_6_2_30.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,64 @@
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: {
distribution: {
additionalProperties: true,
properties: {
sharing_group: {
additionalProperties: true,
properties: {},
},
tlp: {
additionalProperties: true,
properties: {
label: { type: 'string' },
},
},
},
},
},
},
},
})
const validateInput = ajv.compile(inputSchema)

/**
* This implements the optional test 6.2.30 of the CSAF 2.1 standard.
* @param {any} doc
*/
export function recommendedTest_6_2_30(doc) {
const ctx = {
warnings:
/** @type {Array<{ instancePath: string; message: string }>} */ ([]),
}

if (!validateInput(doc)) {
return ctx
}

// Check for sharing_group usage when TLP is CLEAR
if (
doc.document.distribution.tlp.label === 'CLEAR' &&
doc.document.distribution.sharing_group
) {
ctx.warnings.push({
instancePath: '/document/distribution/sharing_group',
message: `TLP:CLEAR documents should not use a 'sharing_group'`,
})
}

return ctx
}
1 change: 0 additions & 1 deletion tests/csaf_2_1/oasis.js
Original file line number Diff line number Diff line change
Expand Up @@ -49,7 +49,6 @@ const excluded = [
'6.2.24',
'6.2.25',
'6.2.26',
'6.2.30',
'6.2.31',
'6.2.32',
'6.2.33',
Expand Down
11 changes: 11 additions & 0 deletions tests/csaf_2_1/recommendedTest_6_2_30.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
import assert from 'node:assert'
import { recommendedTest_6_2_30 } from '../../csaf_2_1/recommendedTests.js'

describe('recommendedTest_6_2_30', function () {
it('only runs on relevant documents', function () {
assert.equal(
recommendedTest_6_2_30({ vulnerabilities: 'mydoc' }).warnings.length,
0
)
})
})