Skip to content

Commit 467be9e

Browse files
committed
docs: update readme for csaf 2.1 experimental release
1 parent 5371f90 commit 467be9e

File tree

1 file changed

+92
-6
lines changed

1 file changed

+92
-6
lines changed

README.md

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,8 @@
1414
- [Module `basic.js`](#module-basicjs)
1515
- [Module `extended.js`](#module-extendedjs)
1616
- [Module `full.js`](#module-fulljs)
17-
- CSAF 2.1
17+
- CSAF 2.1 (experimental)
18+
- [Known Issues](#known-issues)
1819
- [Module `csaf_2_1/schemaTests.js`](#module-csaf_2_1schematestsjs)
1920
- [Module `csaf_2_1/mandatoryTests.js`](#module-csaf_2_1mandatorytestsjs)
2021
- [Module `csaf_2_1/recommendedTests.js`](#module-csaf_2_1recommendedtestsjs)
@@ -296,7 +297,83 @@ This module exports all tests included in `extended.js` and all informative test
296297
297298
[(back to top)](#bsi-csaf-validator-lib)
298299
299-
### CSAF 2.1
300+
### CSAF 2.1 (experimental)
301+
302+
**HEADS UP**: The feature set in this section is not stable nor complete yet and changes without introducing a major version update. Please use it with caution! As soon as it becomes stable this README will be updated.
303+
304+
In CSAF 2.1 the "optional tests" have been renamed to "recommended tests".
305+
306+
#### Known Issues
307+
308+
The following tests are not yet implemented and therefore missing:
309+
310+
**Mandatory Tests**
311+
312+
- Mandatory Test 6.1.7
313+
- Mandatory Test 6.1.10
314+
- Mandatory Test 6.1.14
315+
- Mandatory Test 6.1.16
316+
- Mandatory Test 6.1.27.12
317+
- Mandatory Test 6.1.27.13
318+
- Mandatory Test 6.1.27.14
319+
- Mandatory Test 6.1.27.15
320+
- Mandatory Test 6.1.27.16
321+
- Mandatory Test 6.1.27.17
322+
- Mandatory Test 6.1.27.18
323+
- Mandatory Test 6.1.27.19
324+
- Mandatory Test 6.1.36
325+
- Mandatory Test 6.1.42
326+
- Mandatory Test 6.1.43
327+
- Mandatory Test 6.1.44
328+
- Mandatory Test 6.1.45
329+
- Mandatory Test 6.1.46
330+
- Mandatory Test 6.1.47
331+
- Mandatory Test 6.1.48
332+
- Mandatory Test 6.1.49
333+
- Mandatory Test 6.1.50
334+
- Mandatory Test 6.1.51
335+
- Mandatory Test 6.1.52
336+
- Mandatory Test 6.1.53
337+
- Mandatory Test 6.1.54
338+
- Mandatory Test 6.1.55
339+
340+
**Recommended Tests**
341+
342+
- Recommeded Test 6.2.21
343+
- Recommeded Test 6.2.22
344+
- Recommeded Test 6.2.23
345+
- Recommeded Test 6.2.24
346+
- Recommeded Test 6.2.25
347+
- Recommeded Test 6.2.26
348+
- Recommeded Test 6.2.27
349+
- Recommeded Test 6.2.28
350+
- Recommeded Test 6.2.29
351+
- Recommeded Test 6.2.30
352+
- Recommeded Test 6.2.31
353+
- Recommeded Test 6.2.32
354+
- Recommeded Test 6.2.33
355+
- Recommeded Test 6.2.34
356+
- Recommeded Test 6.2.35
357+
- Recommeded Test 6.2.36
358+
- Recommeded Test 6.2.37
359+
- Recommeded Test 6.2.38
360+
- Recommeded Test 6.2.39
361+
- Recommeded Test 6.2.40
362+
- Recommeded Test 6.2.41
363+
- Recommeded Test 6.2.42
364+
- Recommeded Test 6.2.43
365+
- Recommeded Test 6.2.44
366+
- Recommeded Test 6.2.45
367+
- Recommeded Test 6.2.46
368+
369+
**Informative Tests**
370+
371+
- Informative Test 6.2.12
372+
- Informative Test 6.2.13
373+
- Informative Test 6.2.14
374+
- Informative Test 6.2.15
375+
- Informative Test 6.2.16
376+
- Informative Test 6.2.17
300377
301378
#### Module `csaf_2_1/schemaTests.js`
302379
@@ -316,16 +393,12 @@ export const mandatoryTest_6_1_3: DocumentTest
316393
export const mandatoryTest_6_1_4: DocumentTest
317394
export const mandatoryTest_6_1_5: DocumentTest
318395
export const mandatoryTest_6_1_6: DocumentTest
319-
export const mandatoryTest_6_1_7: DocumentTest
320396
export const mandatoryTest_6_1_8: DocumentTest
321397
export const mandatoryTest_6_1_9: DocumentTest
322-
export const mandatoryTest_6_1_10: DocumentTest
323398
export const mandatoryTest_6_1_11: DocumentTest
324399
export const mandatoryTest_6_1_12: DocumentTest
325400
export const mandatoryTest_6_1_13: DocumentTest
326-
export const mandatoryTest_6_1_14: DocumentTest
327401
export const mandatoryTest_6_1_15: DocumentTest
328-
export const mandatoryTest_6_1_16: DocumentTest
329402
export const mandatoryTest_6_1_17: DocumentTest
330403
export const mandatoryTest_6_1_18: DocumentTest
331404
export const mandatoryTest_6_1_19: DocumentTest
@@ -353,6 +426,13 @@ export const mandatoryTest_6_1_30: DocumentTest
353426
export const mandatoryTest_6_1_31: DocumentTest
354427
export const mandatoryTest_6_1_32: DocumentTest
355428
export const mandatoryTest_6_1_33: DocumentTest
429+
export const mandatoryTest_6_1_34: DocumentTest
430+
export const mandatoryTest_6_1_35: DocumentTest
431+
export const mandatoryTest_6_1_37: DocumentTest
432+
export const mandatoryTest_6_1_38: DocumentTest
433+
export const mandatoryTest_6_1_39: DocumentTest
434+
export const mandatoryTest_6_1_40: DocumentTest
435+
export const mandatoryTest_6_1_41: DocumentTest
356436
```
357437
358438
[(back to top)](#bsi-csaf-validator-lib)
@@ -380,6 +460,7 @@ export const recommendedTest_6_2_17: DocumentTest
380460
export const recommendedTest_6_2_18: DocumentTest
381461
export const recommendedTest_6_2_19: DocumentTest
382462
export const recommendedTest_6_2_20: DocumentTest
463+
export const recommendedTest_6_2_22: DocumentTest
383464
```
384465
385466
[(back to top)](#bsi-csaf-validator-lib)
@@ -489,5 +570,10 @@ For the complete list of dependencies please take a look at [package.json](https
489570
- [cvss2js](https://github.com/sparticvs/cvss2js)
490571
- [json-pointer](https://github.com/manuelstofer/json-pointer)
491572
- [lodash](https://lodash.com/)
573+
- [packageurl-js](https://github.com/package-url/packageurl-js)
574+
- [semver](https://github.com/npm/node-semver)
575+
- [undici](https://undici.nodejs.org)
576+
- [@js-joda/core](https://js-joda.github.io/js-joda/)
577+
- [@js-joda/timezone](https://js-joda.github.io/js-joda/)
492578

493579
[(back to top)](#bsi-csaf-validator-lib)

0 commit comments

Comments
 (0)