1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 18:15:42 +01:00
Commit graph

38 commits

Author SHA1 Message Date
JanHoefelmeyer
01645f5559 Fix: Update downloader docs 2024-11-21 14:55:41 +01:00
4echow
c148a18dba docs:: fix miner typo in csaf_downloader.md 2024-09-12 10:09:34 +02:00
Bernhard Reiter
1a2ce684ff
improve default header
* use `csaf_distribution` with an underscore as underscores
   are allowed by RFC9110 and it is more consistent as it is used
   with underscore at other places.
 * change example to `VERSION` to indicate that this is dynamic.
2024-08-01 14:53:23 +02:00
koplas
3a67fb5210
Add user-agent documentation 2024-07-31 11:00:40 +02:00
JanHoefelmeyer
086c4ab48b
Convert a lot of command line arguments to snake case (#498)
* Convert a lot of variables to snake case

* Add snakecase for variables made out of two words that had it in no version yet (for consistency)

* Adjust example files too

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
2023-11-06 14:33:05 +01:00
Sascha L. Teichmann
455010dc64
Accept days, months and years in time ranges. (#483) 2023-10-19 13:13:11 +02:00
Bernhard E. Reiter
abc8b10988
docs: improve timerange documentation (#482)
* docs: improve timerange documentation

 * add a documentation section to the downloader docs for the
   timerange-option.
 * point aggregator and checker docs to the downloader section for
   timerange.

* docs: use a better example for timerange minutes
2023-10-17 18:53:53 +02:00
JanHoefelmeyer
2e5038f06d
Merge pull request #465 from csaf-poc/downloader-document-forward
Downloader: Document the implementes forward API
2023-09-27 12:16:24 +02:00
JanHoefelmeyer
0ec5f22a74 Removed subjective informal 'little bit' phrasing 2023-09-27 11:30:35 +02:00
Sascha L. Teichmann
7cd076d4f8
Downloader: Remove verbose flag (#464)
* Remove verbose flag from downloader.

* Do structured http logging in forwarder, too.

* Use structured logging to separate http traffic of downloader from forwarder.
2023-09-27 11:30:24 +02:00
Sascha L. Teichmann
e470529dfb Add a paragraph about the remote forward API. 2023-09-27 10:13:15 +02:00
Sascha L. Teichmann
018e0e55f7
Fix downloader logging docs and some comments. (#447) 2023-08-29 10:24:02 +02:00
Sascha L. Teichmann
e0475791ff
Downloader: Add forwarding to HTTP endpoint (#442)
* started with forwarding support in downloader

* Add missing files.

* Add missing files.

* Raise needed Go version

* More Go version bumping.

* Fix forwarding

* Go 1.21+ needed

* Make terminating forwarder more robust.

* Better var naming

* Remove dead code. Improve commentary.

* Prepare validation status adjustment.

* Move validations to functions to make them executable in a loop.

* Introduce validation mode flag (strict, unsafe)
2023-08-25 10:31:27 +02:00
Sascha L. Teichmann
a153906d03
Document that client-passphrase option is experimental
* Label the option experimental and limited at all places.
 * Point to the downloader documentation as single point to write more.
 * Add more hints on how the old PEM block encryption is experimental
   and why it often shall not be used.
---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2023-08-18 11:24:39 +02:00
Sascha L. Teichmann
0b914f7e7a
Document regular expression syntax used for filtering URLs. (#433)
* Document regular expression syntax used for filtering URLs.

* Typo: describes -> described

* Forget to add aggregator doc

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
2023-08-17 17:02:10 +02:00
Sascha L. Teichmann
a7be72b740 Merge branch 'main' into downloader-client-certs 2023-08-16 11:23:14 +02:00
Bernhard Reiter
6276866cad
Merge branch 'main' into download-ignore-pattern
* Improve some text parts during the merge.
2023-08-16 08:59:42 +02:00
Sascha L. Teichmann
8c95795b96
Add option to specify download folder
* Add an option to downloader to store advisories into a given subfolder.

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2023-08-16 08:45:34 +02:00
Sascha L. Teichmann
f31ee53c27 Add client certificate support to the downloader 2023-08-02 21:16:32 +02:00
Sascha L. Teichmann
97304ab38e Typo fix. 2023-08-01 16:43:31 +02:00
Sascha L. Teichmann
8aa31984df Add docs and fix output. 2023-08-01 09:54:43 +02:00
Sascha L. Teichmann
383b0ca77b Add an option to downloader to store advisories into a given folder. 2023-07-31 17:19:38 +02:00
Sascha L. Teichmann
1d892ff681 Fix docs. 2023-07-26 11:07:30 +02:00
Sascha L. Teichmann
5e6fb8241c Prettifying docs 2023-07-26 04:28:42 +02:00
Sascha L. Teichmann
975e350510 Prettifying docs 2023-07-26 04:27:04 +02:00
Sascha L. Teichmann
1f301b6301 Prettifying docs 2023-07-26 04:25:45 +02:00
Sascha L. Teichmann
9e665a2fa1 Adjust docs 2023-07-26 04:18:54 +02:00
Sascha L. Teichmann
81ead2776b
Use TOML as config file format in downloader (#405)
* Use TOML as config file format.

* Parse command line a second time if config file was loaded.

* Handle default values correctly.

* Use same names for config file options and command line options.
2023-07-20 11:05:20 +02:00
Sascha L. Teichmann
8630e8bac2
Add support for config files in downloader. (#404)
* Add support for config files in downloader.

* Add no-ini for the version flag, too.

* Add config file options in doc to downloader.
2023-07-19 10:49:17 +02:00
Sascha L. Teichmann
f32fba683d
Add concurrent downloads to downloader. (#363)
* Add concurrent downloads to downloader.

* Moved to Go 1.20

* close files channel on producer side.

* Improve error handling

* New flag to ignore signature check results. Improve docs. Do not use number of CPUs to determine number of download workers.

* Set number of default workers in downloader to two.
2023-05-02 10:10:12 +02:00
Bernhard E. Reiter
8ad805e1e5
doc: improve rate default documentation (#364)
* 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>
2023-05-01 20:38:19 +02:00
JanHoefelmeyer
39b48e083c
Improve docs for checker and downloader
* make it more clear that a domain can also be interpreted as a direct URL.

resolve #316 
---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de>
Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2023-02-28 14:11:15 +01:00
Sascha L. Teichmann
c8e0804eba Merged main into branch 2023-01-27 18:25:22 +01:00
Sascha L. Teichmann
9abc83edc1 Set the default of 'validatorpresets' to 'mandatory'. 2023-01-27 17:40:17 +01:00
Sascha L. Teichmann
51fba46893 Add extra http header support to downloader and checker. 2023-01-26 22:09:38 +01:00
Sascha L. Teichmann
bcc31c0cd6 Add remote validator support to downloader. 2023-01-25 01:12:18 +01:00
Omar Santos
0171715390
Correcting documentation (#229)
The title of the .md file should be csaf_downloader, not "uploader". Also added an introductory sentence.
2022-07-15 07:43:57 +02:00
Sascha L. Teichmann
b359fd0a62
Add CSAF downloader
* Dense and refactor ROLIE code in aggregator a bit.
* Move  advisory file processor to csaf package.
* Fix minor typo on main readme
2022-06-23 14:14:44 +02:00