mirror of
https://github.com/gocsaf/csaf.git
synced 2025-12-22 05:40:11 +01:00
0b914f7e7a
* Document regular expression syntax used for filtering URLs. * Typo: describes -> described * Forget to add aggregator doc --------- Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
123 lines
4.9 KiB
Markdown
123 lines
4.9 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)
|
|
--client-passphrase=PASSPHRASE Optional passphrase for the client certificate
|
|
--version Display version of the binary
|
|
-v, --verbose Verbose output
|
|
-r, --rate= The average upper limit of https operations per second (defaults to unlimited)
|
|
-t, --timerange=RANGE RANGE of time from which advisories to download
|
|
-i, --ignorepattern=PATTERN Do not download files if their URLs match any of the given PATTERNs
|
|
-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])
|
|
-c, --config=TOML-FILE Path to config TOML file
|
|
|
|
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.
|
|
|
|
If no config file is explictly given the follwing places are searched for a config file:
|
|
```
|
|
~/.config/csaf/checker.toml
|
|
~/.csaf_checker.toml
|
|
csaf_checker.toml
|
|
```
|
|
|
|
with `~` expanding to `$HOME` on unixoid systems and `%HOMEPATH` on Windows systems.
|
|
Supported options in config files:
|
|
```
|
|
output = ""
|
|
format = "json"
|
|
insecure = false
|
|
# client_cert # not set by default
|
|
# client_key # not set by default
|
|
# client_passphrase # not set by default
|
|
verbose = false
|
|
# rate # not set by default
|
|
# timerange # not set by default
|
|
# header # not set by default
|
|
# validator # not set by default
|
|
# validatorcache # not set by default
|
|
validatorpreset = ["mandatory"]
|
|
```
|
|
|
|
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.
|
|
|
|
The option `timerange` allows to only check advisories from a given time interval.
|
|
It is only allowed to specify one off them.
|
|
There are following variants:
|
|
|
|
1. Relative. If the given string follows the rules of being a [Go duration](https://pkg.go.dev/time@go1.20.6#ParseDuration)
|
|
the time interval from now minus that duration till now is used.
|
|
E.g. `"3h"` means checking the advisories that have changed in the last three hours.
|
|
|
|
2. Absolute. If the given string is an RFC 3339 date timestamp the time interval between
|
|
this date and now is used.
|
|
E.g. `"2006-01-02"` means that all files between 2006 January 2nd and now going to be
|
|
checked.
|
|
Accepted patterns are:
|
|
- `"2006-01-02T15:04:05Z"`
|
|
- `"2006-01-02T15:04:05+07:00"`
|
|
- `"2006-01-02T15:04:05-07:00"`
|
|
- `"2006-01-02T15:04:05"`
|
|
- `"2006-01-02T15:04"`
|
|
- `"2006-01-02T15"`
|
|
- `"2006-01-02"`
|
|
- `"2006-01"`
|
|
- `"2006"`
|
|
|
|
Missing parts are set to the smallest value possible in that field.
|
|
|
|
3. Range. Same as 2 but separated by a `,` to span an interval. e.g `2019,2024`
|
|
spans an interval from 1st January 2019 to the 1st January of 2024.
|
|
|
|
All interval boundaries are inclusive.
|
|
|
|
You can ignore certain advisories while checking by specifying a list
|
|
of regular expressions[^1] to match their URLs by using the `ignorepattern`
|
|
option.
|
|
E.g. `-i='.*white.*' -i='*.red.*'` will ignore files which URLs contain
|
|
the sub strings **white** or **red**.
|
|
In the config file this has to be noted as:
|
|
```
|
|
ignorepattern = [".*white.*", ".*red.*"]
|
|
```
|
|
|
|
### 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 .
|
|
|
|
If a provider hosts one or more advisories with a TLP level of AMBER or RED, then these advisories must be access protected.
|
|
To check these advisories, authorization can be given via custom headers or certificates.
|
|
The authorization method chosen needs to grant access to all advisories, as otherwise the
|
|
checker will be unable to check the advisories it doesn't have permission for, falsifying the result.
|
|
|
|
[^1]: Accepted syntax is described [here](https://github.com/google/re2/wiki/Syntax).
|