diff --git a/README.md b/README.md index fb32847..4050766 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,7 @@ is a command line tool that uploads CSAF documents to the `csaf_provider`. is an implementation of the role CSAF Aggregator. ## [csaf_checker](docs/csaf_checker.md) -is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSAF standard](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#7-distributing-csaf-documents). +is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSAF standard](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#7-distributing-csaf-documents). Does check requirements without considering the indicated `role` yet. ## [csaf_downloader](docs/csaf_downloader.md) is a tool for downloading advisories from a provider. diff --git a/docs/csaf_checker.md b/docs/csaf_checker.md index 7e5b14e..39c265d 100644 --- a/docs/csaf_checker.md +++ b/docs/csaf_checker.md @@ -31,3 +31,10 @@ type 2: error ``` The checker result is a success if no checks resulted in type 2, and a failure otherwise. + + +### Remarks + +The `role` given in the `provider-metadata.json` is not +yet considered to change the overall result, +see https://github.com/csaf-poc/csaf_distribution/issues/221 .