Example Use
Synopsis
No args execution yields usage information:
% csaf
Usage: csaf [OPTIONS] COMMAND [ARGS]...
Common Security Advisory Framework (CSAF) Verification and Validation.
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --version -V Display the csaf version and exit │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Commands ─────────────────────────────────────────────────────────────────╮
│ report Output the report of the environment for support. │
│ template Write a template of a well-formed JSON configuration to standard │
│ out and exit │
│ validate Common Security Advisory Framework (CSAF) Verification and │
│ Validation. │
│ version Display the csaf version and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
Validate
Initial test (an empty file is not valid):
% csaf validate empty.json
2022-03-13T20:40:29.067 ERROR [CSAF]: advisory is too short to be valid
Hypothetical valid file:
% csaf validate minimal_whatever.json
2022-03-13T20:46:30.618 INFO [CSAF]: set of document properties only contains known properties
2022-03-13T20:46:30.618 INFO [CSAF]: set of document properties is a proper subset of the known properties
with minimal_whatever.json:
{
"document": {
"category": "1",
"csaf_version": "2.0",
"publisher": {
"category": "user",
"name": "1",
"namespace": "a:b"
},
"title": "1",
"tracking": {
"current_release_date": "0001-01-01 00:00:00",
"id": "1",
"initial_release_date": "0001-01-01 00:00:00",
"revision_history": [
{
"date": "0001-01-01 00:00:00",
"number": "1",
"summary": "1"
}
],
"status": "final",
"version": "1"
}
}
}
Help
% csaf validate --help
Usage: csaf validate [OPTIONS] SOURCE...
Common Security Advisory Framework (CSAF) Verification and Validation.
You can set some options per environment variables:
* CSAF_USER='remote-user'
* CSAF_TOKEN='remote-secret'
* CSAF_BASE_URL='https://csaf.example.com/file/names/below/here/'
* CSAF_BAIL_OUT='AnythingTruthy'
* CSAF_DEBUG='AnythingTruthy'
* CSAF_VERBOSE='AnythingTruthy'
* CSAF_STRICT='AnythingTruthy'
The quiet option (if given) disables any conflicting verbosity setting.
╭─ Arguments ────────────────────────────────────────────────────────────────╮
│ * source SOURCE... [default: None] [required] │
╰────────────────────────────────────────────────────────────────────────────╯
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --input -i <sourcepath> Path to CSAF input file │
│ --config -c <configpath> Path to config file (default is │
│ $HOME/.csaf.json) │
│ --bail-out -b Bail out (exit) on first failure │
│ (default is False) │
│ --dry-run -n Dry run (default is False) │
│ --verbose -v Verbose output (default is False) │
│ --quiet -q Minimal output (default is False) │
│ --strict -s Ouput noisy warnings on console (default │
│ is False) │
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
Template
% csaf template
{
"remote": {
"user": "",
"token": "",
"base_url": ""
},
"local": {
"bail_out": false,
"quiet": false,
"verbose": false,
"strict": false
}
}
Help
% csaf template --help
Usage: csaf template [OPTIONS]
Write a template of a well-formed JSON configuration to standard out and
exit
The strategy for looking up configurations is to start at the current
working directory trying to read a file with the name `.csaf.json` else try
to read same named file in the user folder (home).
In case an explicit path is given to the config option of commands that
offer it, only that path is considered.
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
Report
% csaf report
--------------------------------------------------------------------------------
Date: Wed Oct 18 17:45:44 2023 CEST
OS : Darwin
CPU(s) : 8
Machine : arm64
Architecture : 64bit
RAM : 16.0 GiB
Environment : Python
File system : apfs
Python 3.10.12 (main, Jul 16 2023, 10:40:08) [Clang 16.0.6 ]
csaf : 2023.10.18+parent.g7f03927d
jmespath : 1.0.1
langcodes : 3.3.0
lazr.uri : 1.0.6
msgspec : 0.18.4
pydantic : 2.4.2
scooby : 0.7.4
setuptools : 68.2.2
typer : 0.9.0
--------------------------------------------------------------------------------
Help
% csaf report -h
Usage: csaf report [OPTIONS]
Output the report of the environment for support.
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯
Version
% csaf version
Common Security Advisory Framework (CSAF) Verification and Validation. version 2023.10.18+parent.g7f03927d
Help
% csaf version --help
Usage: csaf version [OPTIONS]
Display the csaf version and exit.
╭─ Options ──────────────────────────────────────────────────────────────────╮
│ --help -h Show this message and exit. │
╰────────────────────────────────────────────────────────────────────────────╯