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

55 commits

Author SHA1 Message Date
koplas
13a635c7e3
Add user-agent documentation to aggregator 2024-08-01 15:43:35 +02:00
immqu immqu@users.noreply.github.com
a608cb0b17 Apply automatic changes 2024-04-25 07:43:28 +00: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
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
7d3c3a68df
Let aggregator look for config files in similiar places like the other tools. (#440) 2023-08-22 17:37:57 +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
d49049c3af
Aggregator: Add time range filtering 2023-08-17 16:54:11 +02:00
JanHoefelmeyer
38dfabde1a Add documentation for extra headers for csaf_aggregator 2023-08-03 11:20:17 +02:00
JanHoefelmeyer
b0b3852e99 Add documentation for client_cert, client_key and client_passphrase for csaf_aggregator 2023-08-03 10:04:51 +02:00
JanHoefelmeyer
b6e5af9b49 Clarified docs on where and how to use ignorepattern for aggregator 2023-08-02 08:36:05 +02:00
Sascha L. Teichmann
607bd0ebe1 Add ignore patterns to aggreagtor. 2023-08-01 22:16:14 +02:00
Sascha L. Teichmann
1d9969162f Fix version config and make aggreator use new command line parser. 2023-07-30 22:37:32 +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
b0d7df69b8 Change default location of lock file for csaf aggregator and rephrase error message if lock is in use. 2023-03-27 11:05:59 +02:00
JanHoefelmeyer
f638ae9a23 Move disabling of lockfile from explicit option to empty string in lockfile 2023-03-21 08:26:51 +01:00
JanHoefelmeyer
a28ebe39cb Update doc to include default location instead of only name. (which is not the default) 2023-03-17 13:03:36 +01:00
JanHoefelmeyer
bb053bd427 Add option no_lock to use no lock file if none was configured 2023-03-17 13:00:51 +01:00
Bernhard Reiter
dbad3e3c7f remove two typos 2023-02-28 15:09:56 +01:00
Bernhard Reiter
1bdf207e4b Improve aggregator docs and config
* Fix that TOML key `update_interval` can be processed on top level.
 * Add missing keys to top level and provider entries.
 * Move explanations to first mention of keys.
 * Describe overriding ability and defaults early on and only once.
2023-02-28 15:09:56 +01:00
Bernhard Reiter
704a98ab38 Improve aggregator docs 2023-02-28 15:09:56 +01:00
Bernhard Reiter
a3ee00568f Improve aggregator docs
* improve phrasings and remove some typos
2023-02-28 15:09:56 +01:00
JanHoefelmeyer
bebeec30e0 Adds explanations about which options are mandatory and which are optional 2023-02-28 15:09:56 +01:00
JanHoefelmeyer
f38cff13d6 Add explanation of order in which rate variables are taken into account if existant. 2023-02-28 15:09:56 +01:00
JanHoefelmeyer
05ad714619 Update csaf_aggregator.md
add comma to the end of subordinate clause
2023-02-08 16:17:19 +01:00
JanHoefelmeyer
4b4a6a4dbd Update docs/csaf_aggregator.md
Rephrases csaf_aggregator.md for better readability

Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
2023-02-08 16:17:19 +01:00
JanHoefelmeyer
38c6da8212 Update docs/csaf_aggregator.md
Refer to specific section of provider options instead just provider options

Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
2023-02-08 16:17:19 +01:00
JanHoefelmeyer
35dc25a5e7 Splits overly long sentence into two. Adds reference to provider documentation 2023-02-08 16:17:19 +01:00
JanHoefelmeyer
a3897ae21f improve phrasing 2023-02-08 16:17:19 +01:00
JanHoefelmeyer
3bf1af0e9f Add short explanations the createservicedocument and categories provider options. 2023-02-08 16:17:19 +01:00
Bernhard E. Reiter
8e5dd88a62
Update docs/csaf_aggregator.md
Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
2023-01-27 09:41:02 +01:00
Bernhard Reiter
c143a4620b
Further improve documentation for aggregator 2023-01-26 16:30:27 +01:00
Bernhard Reiter
de64b88491
Improve documentation for aggregator
* Add term "CSAF proxy provider", because it is mentioned now in
   https://docs.oasis-open.org/csaf/csaf/v2.0/os/csaf-v2.0-os.html .
 * Improve formatting and phrasing.
 * Improve description of configuration of update_intervall.
2023-01-26 16:23:08 +01:00
s-l-teichmann s-l-teichmann@users.noreply.github.com
f0567ffa15 Apply automatic changes 2022-08-17 11:16:10 +00:00
mfd2007
06bd16db47
Add documention for update_interval (#281)
Add documentation for new option "update_interval" and behavior from #278.
2022-08-17 13:15:03 +02:00
s-l-teichmann s-l-teichmann@users.noreply.github.com
4c0785c060 Apply automatic changes 2022-07-29 09:34:13 +00:00
Bernhard Reiter
4abddee3bb
Merge branch 'main' of github.com:csaf-poc/csaf_distribution into main 2022-07-25 15:24:51 +02:00
Bernhard Reiter
8df67a7b1d
Improve aggregator doc formatting (minor) 2022-07-25 15:24:26 +02:00
Bernhard E. Reiter
677b0fdd4f
Add docs for a provider proxy (#255)
* Add instructions for an internal proxy provider

* Improve example test config

 * .. by moving CSAF_CONFIG out of the common fcgiwrap.conf,
   so it can more easily be changed in a different context.

* Improve proxy-provider-for-aggregator.md

 * Add section to aggregator documentation.
 * Fix typos.
 * Improve instructions.

* Fix one path

* Complre proxy-provider-for-aggregator.md
2022-07-25 15:23:11 +02:00
Bernhard Reiter
c511a971d6
Improve aggregator docs (minor)
* Add hint to OpenPGP private key in case unattended usage
   is wanted.
2022-07-25 15:21:14 +02:00
bernhardreiter bernhardreiter@users.noreply.github.com
ca69997e2b Apply automatic changes 2022-07-21 16:00:56 +00:00
JanHoefelmeyer
3769f1d338
Add abilities to aggregator to mirror and list
* Aggregator now checks every provider on whether its mirrored or listed. 
*Add the option to the docs.
* Clean up the example  toml file to still contain two mirrors and one example-lister.

Co-authored-by: Jan Höfelmeyer <Jan Höfelmeyer jhoefelmeyer@intevation.de>
Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de>
Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2022-07-21 17:59:58 +02:00
s-l-teichmann s-l-teichmann@users.noreply.github.com
0375e22747 Apply automatic changes 2022-07-20 10:05:55 +00:00
bernhardreiter bernhardreiter@users.noreply.github.com
8e18b6f36f Apply automatic changes 2022-07-18 16:00:33 +00:00
bernhardreiter bernhardreiter@users.noreply.github.com
69c3030eef Apply automatic changes 2022-07-05 14:45:26 +00:00
Sascha L. Teichmann
20f5937240
Only create/update index.txt, changes.csv, security.txt when configured. (#210)
* Change default to not write index.txt, changes.csv and security.txt 
  (for provider and aggregator)
* Add config file options to reenable writing.
2022-07-05 16:44:45 +02:00
Sascha L. Teichmann
78d8b89aca
Add support for remote validation services. (#185)
* Simple tool to test the remote validation

* Added remote validator support to provider.

* Added remote validation to aggregator.

* Calm golint

* Removed csaf_remote_validator tool as it was only for dev.

* Re-added csaf_remote_validator tool. Testing is not done.

* Embed the document entirely

* Include testing the remote validator in the Itests

* Change permission of the script

* Remove code for Itests

* As these will be done in another branch

Co-authored-by: Fadi Abbud <fadi.abbud@intevation.de>
2022-06-21 14:47:06 +02:00
Bernhard E. Reiter
19d39b85d3
Improve aggregator setup docs (#163)
* Improve aggregator setup docs

 * Add hints how to serve the aggregator output using nginx.
 * Add hint that the permission of the aggregator config file should be
   restricted.
 * Add a setuid bit to the aggregator integration test script
   to easy manual serving.

* Wording

Co-authored-by: Sascha L. Teichmann <sascha.teichmann@intevation.de>
2022-06-09 11:00:30 +02:00
Sascha L. Teichmann
69f0f3499a
Change openpgp key providing code to use local directory
* Adjust provider and aggregator to copy the used openpgp pubkey into a locally
  provided directory `openpgp` beside the `prodiver-metadata.json`.
  This more robust and self-reliant than using a public pubkey server,
  which is the reason why the CSAF 2.0 csd02 mentions it as example in
  "7.1.20 Requirement 20: Public OpenPGP Key".
 * Improve aggregator by removing a typo `aggreator` from one written paths.
   (Done with this change as it also affects the openpgp/ paths writing.)

solve #85
2022-06-09 10:42:44 +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