mirror of
https://github.com/gocsaf/csaf.git
synced 2025-12-22 11:55:40 +01:00
8ad805e1e5
* doc: improve rate default documentation solve #359 * Adjust downloader doc, too. * doc(csaf_checker): Add missing phrase, correct spelling * docs(csaf_checker): correct format mistake --------- Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de> Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
51 lines
1.8 KiB
Markdown
51 lines
1.8 KiB
Markdown
## csaf_checker
|
|
|
|
### Usage
|
|
|
|
```
|
|
Usage:
|
|
csaf_checker [OPTIONS] domain...
|
|
|
|
Application Options:
|
|
-o, --output=REPORT-FILE File name of the generated report
|
|
-f, --format=[json|html] Format of report (default: json)
|
|
--insecure Do not check TLS certificates from provider
|
|
--client-cert=CERT-FILE TLS client certificate file (PEM encoded data)
|
|
--client-key=KEY-FILE TLS client private key file (PEM encoded data)
|
|
--version Display version of the binary
|
|
-v, --verbose Verbose output
|
|
-r, --rate= The average upper limit of https operations per second (defaults to unlimited)
|
|
-y, --years=YEARS Number of years to look back from now
|
|
-H, --header= One or more extra HTTP header fields
|
|
--validator=URL URL to validate documents remotely
|
|
--validatorcache=FILE FILE to cache remote validations
|
|
--validatorpreset= One or more presets to validate remotely (default: mandatory)
|
|
|
|
|
|
Help Options:
|
|
-h, --help Show this help message
|
|
```
|
|
|
|
Will check all given _domains_, by trying each as a CSAF provider.
|
|
|
|
If a _domain_ starts with `https://` it is instead considered a direct URL to the `provider-metadata.json` and checking proceeds from there.
|
|
|
|
|
|
Usage example:
|
|
` ./csaf_checker example.com -f html --rate=5.3 -H apikey:SECRET -o check-results.html`
|
|
|
|
Each performed check has a return type of either 0,1 or 2:
|
|
```
|
|
type 0: success
|
|
type 1: warning
|
|
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 .
|