SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 11:55:40 +01:00
Code Issues Releases Activity Actions

Fix downloader logging docs and some comments. (#447)

Browse source
This commit is contained in:
Sascha L. Teichmann 2023-08-29 10:24:02 +02:00 • committed by GitHub
parent 5459f10d39
commit 018e0e55f7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
4 changed files with 32 additions and 30 deletions
Download patch file Download diff file Expand all files Collapse all files

4
cmd/csaf_downloader/config.go
View file

@ -77,7 +77,7 @@ type config struct {
ForwardQueue int `long:"forwardqueue" description:"Maximal queue LENGTH before forwarder" value-name:"LENGTH" toml:"forward_queue"` ForwardQueue int `long:"forwardqueue" description:"Maximal queue LENGTH before forwarder" value-name:"LENGTH" toml:"forward_queue"`
ForwardInsecure bool `long:"forwardinsecure" description:"Do not check TLS certificates from forward endpoint" toml:"forward_insecure"` ForwardInsecure bool `long:"forwardinsecure" description:"Do not check TLS certificates from forward endpoint" toml:"forward_insecure"`
LogFile string `long:"logfile" description:"FILE to log download to" value-name:"FILE" toml:"log_file"` LogFile string `long:"logfile" description:"FILE to log downloading to" value-name:"FILE" toml:"log_file"`
//lint:ignore SA5008 We are using choice or than once: debug, info, warn, error //lint:ignore SA5008 We are using choice or than once: debug, info, warn, error
LogLevel logLevel `long:"loglevel" description:"LEVEL of logging details" value-name:"LEVEL" choice:"debug" choice:"info" choice:"warn" choice:"error" toml:"log_level"` LogLevel logLevel `long:"loglevel" description:"LEVEL of logging details" value-name:"LEVEL" choice:"debug" choice:"info" choice:"warn" choice:"error" toml:"log_level"`
@ -173,7 +173,7 @@ func (ll logLevel) slogLevel() slog.Level {
// prepareDirectory ensures that the working directory // prepareDirectory ensures that the working directory
// exists and is setup properly. // exists and is setup properly.
func (cfg *config) prepareDirectory() error { func (cfg *config) prepareDirectory() error {
// If no special given use current working directory. // If not given use current working directory.
if cfg.Directory == "" { if cfg.Directory == "" {
dir, err := os.Getwd() dir, err := os.Getwd()
if err != nil { if err != nil {

2
cmd/csaf_downloader/forwarder.go
View file

@ -130,7 +130,7 @@ func replaceExt(fname, nExt string) string {
return fname[:len(fname)-len(ext)] + nExt return fname[:len(fname)-len(ext)] + nExt
} }
// buildRequest creates an HTTP request suited ti forward the given advisory. // buildRequest creates an HTTP request suited to forward the given advisory.
func (f *forwarder) buildRequest( func (f *forwarder) buildRequest(
filename, doc string, filename, doc string,
status validationStatus, status validationStatus,

2
cmd/csaf_downloader/main.go
View file

@ -50,7 +50,7 @@ func main() {
options.ErrorCheck(cfg.prepare()) options.ErrorCheck(cfg.prepare())
if len(domains) == 0 { if len(domains) == 0 {
slog.Info("No domains given.") slog.Warn("No domains given.")
return return
} }

54
docs/csaf_downloader.md
View file

@ -7,34 +7,36 @@ A tool to download CSAF documents from CSAF providers.
csaf_downloader [OPTIONS] domain... csaf_downloader [OPTIONS] domain...
Application Options: Application Options:
-d, --directory=DIR DIRectory to store the downloaded files in -d, --directory=DIR DIRectory to store the downloaded files in
--insecure Do not check TLS certificates from provider --insecure Do not check TLS certificates from provider
--ignoresigcheck Ignore signature check results, just warn on mismatch --ignoresigcheck Ignore signature check results, just warn on mismatch
--client-cert=CERT-FILE TLS client certificate file (PEM encoded data) --client-cert=CERT-FILE TLS client certificate file (PEM encoded data)
--client-key=KEY-FILE TLS client private key file (PEM encoded data) --client-key=KEY-FILE TLS client private key file (PEM encoded data)
--client-passphrase=PASSPHRASE Optional passphrase for the client cert (limited, experimental, see doc) --client-passphrase=PASSPHRASE Optional passphrase for the client cert (limited, experimental, see doc)
--version Display version of the binary --version Display version of the binary
-v, --verbose Verbose output -v, --verbose Verbose output
-n, --nostore Do not store files -n, --nostore Do not store files
-r, --rate= The average upper limit of https operations per second (defaults to -r, --rate= The average upper limit of https operations per second (defaults to
unlimited) unlimited)
-w, --worker=NUM NUMber of concurrent downloads (default: 2) -w, --worker=NUM NUMber of concurrent downloads (default: 2)
-t, --timerange=RANGE RANGE of time from which advisories to download -t, --timerange=RANGE RANGE of time from which advisories to download
-f, --folder=FOLDER Download into a given subFOLDER -f, --folder=FOLDER Download into a given subFOLDER
-i, --ignorepattern=PATTERN Do not download files if their URLs match any of the given PATTERNs -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 -H, --header= One or more extra HTTP header fields
--validator=URL URL to validate documents remotely --validator=URL URL to validate documents remotely
--validatorcache=FILE FILE to cache remote validations --validatorcache=FILE FILE to cache remote validations
--validatorpreset=PRESETS One or more PRESETS to validate remotely (default: [mandatory]) --validatorpreset=PRESETS One or more PRESETS to validate remotely (default: [mandatory])
-m, --validationmode=MODE[strict|unsafe] MODE how strict the validation is (default: strict) -m, --validationmode=MODE[strict|unsafe] MODE how strict the validation is (default: strict)
--forwardurl=URL URL of HTTP endpoint to forward downloads to --forwardurl=URL URL of HTTP endpoint to forward downloads to
--forwardheader= One or more extra HTTP header fields used by forwarding --forwardheader= One or more extra HTTP header fields used by forwarding
--forwardqueue=LENGTH Maximal queue LENGTH before forwarder --forwardqueue=LENGTH Maximal queue LENGTH before forwarder (default: 5)
--forwardinsecure Do not check TLS certificates from forward endpoint --forwardinsecure Do not check TLS certificates from forward endpoint
-c, --config=TOML-FILE Path to config TOML file --logfile=FILE FILE to log downloading to (default: downloader.log)
--loglevel=LEVEL[debug|info|warn|error] LEVEL of logging details (default: info)
-c, --config=TOML-FILE Path to config TOML file
Help Options: Help Options:
-h, --help Show this help message -h, --help Show this help message
``` ```
Will download all CSAF documents for the given _domains_, by trying each as a CSAF provider. Will download all CSAF documents for the given _domains_, by trying each as a CSAF provider.