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

36 commits

Author SHA1 Message Date
JanHoefelmeyer
7ab964a3e3
Doc: Highlight the reason for the rate options existence (#662)
* Doc: Highlight the reason for the rate options existence

* Fix typos
2025-09-01 11:48:56 +02:00
Bernhard Reiter
e8706e5eb9 feat: perform go path repo move
* Change the go module path
   from github.com/csaf-poc/csaf_distribution to github.com/gocsaf/csaf.
 * Rename archive for release tarballs.
 * Adjust testing scripts and documentation.
2024-11-04 13:20:47 +01: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
03a907b9b8
Fix checker doc of TOML config of validator (#492) 2023-11-02 12:19:16 +01: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
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
468e91cb8b Remove the years flag from checker. 2023-08-17 11:01:45 +02:00
JanHoefelmeyer
7a6cbd182c merge branch 'main' into checker-timerange-report 2023-08-17 09:35:52 +02:00
Sascha L. Teichmann
7464ade6ae Fix merge conflict oversight in doc. 2023-08-16 20:29:25 +02:00
Sascha L. Teichmann
3bfff999e1 Merge branch 'main' into downloader-client-certs 2023-08-16 17:54:53 +02:00
Sascha L. Teichmann
dd1e38fc0c Merge branch 'main' into checker-timerange-report 2023-08-16 17:47:27 +02:00
Sascha L. Teichmann
7bab18fc41
Checker: ignore advisories by given patterns
* Ignore advisories in checker.
---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
2023-08-16 17:22:19 +02:00
Sascha L. Teichmann
017a6b0a10 Move cert handling into library and add option passphrase. Adjust uploader and checker. 2023-08-02 21:02:58 +02:00
Sascha L. Teichmann
98bf2990ae Ignore advisories in checker. 2023-08-01 21:38:55 +02:00
Sascha L. Teichmann
ac8d8a9196 Improve wording of docs a bit. 2023-07-26 13:46:13 +02:00
Sascha L. Teichmann
5e5074fbf1 Add time range to checker. 2023-07-26 13:34:15 +02:00
Sascha L. Teichmann
19433856ca Adjusted docs. 2023-07-24 23:42:21 +02:00
JanHoefelmeyer
569822486b
Update docs/csaf_checker.md
Fix wrong keyword in checker docs

Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
2023-06-27 09:58:38 +02:00
JanHoefelmeyer
9967bfffe6 Amend checker docs to explain why authorization for RED/AMBER advisories needs to be genuine 2023-06-22 13:46:16 +02:00
JanHoefelmeyer
18732f26ba Amend checker docs to explain why authorization for RED/AMBER advisories needs to be genuine 2023-06-22 13:45:34 +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
tschmidtb51
2b55bbb341
gt the order right 2023-01-27 18:44:08 +01:00
tschmidtb51
0383e951a8
Merge branch 'main' into checker-validator 2023-01-27 17:58:37 +01:00
Sascha L. Teichmann
2a40ab6393 Set the default of 'validatorpresets' to 'mandatory'. 2023-01-27 17:16:45 +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
e004939abf Implement remote validation in checker. 2023-01-25 10:27:44 +01:00
Bernhard Reiter
6a605fdbcc
Add checker hint about not yet using role 2022-07-21 16:31:22 +02:00
Sascha L. Teichmann
7f113f1f30 Adjusted documentation 2022-07-17 15:01:15 +02:00
JanHoefelmeyer
15f05fc122
Adds explanation of type returns of individual checkers to csaf_checker.md (#215)
Co-authored-by: Jan Höfelmeyer <Jan Höfelmeyer jhoefelmeyer@intevation.de>
2022-07-11 12:30:57 +02:00
Bernhard E. Reiter
a849ac0d5f
Improve https get diagnostics, add verbose option
* Implement a logging client and activate it using verbose parameter or option
   in checker and aggregator.

Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de>
2022-06-02 15:07:55 +02:00
Bernhard Reiter
cac8f6c427
Improve docs
* Add --help from ./csaf_checker --version 0.3.1-8-gd5d48c7
2022-05-16 16:32:49 +02:00
Fadi Abbud
6f02e6f5a5
Improve documentation and its structure
* Add short description for each component in the main README
* Move more Info in separated files.
* Add hint that csaf_provider offers a service interface.
* Explain why windows only has uploader and checker.

Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2022-05-13 11:04:38 +02:00