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

296 commits

Author SHA1 Message Date
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
Jan Höfelmeyer
7cbbb4bf81 formatting on provider-setup.md 2022-06-20 12:34:49 +02:00
Jan Höfelmeyer
05915526c2 Resolved merge conflict in csaf_provider.md 2022-06-20 11:54:46 +02:00
Jan Höfelmeyer
3f712584d0 Updates docs/provider-setup.md to no longer include information already given in csaf_provider.md as well as properly link to this doc 2022-06-17 14:14:00 +02:00
Jan Höfelmeyer
004519c9fc fixes formatting at the end of the file 2022-06-17 13:35:54 +02:00
Jan Höfelmeyer
aa523e5659 Fixes formatting of TOML table causing a line to not show up 2022-06-17 13:34:19 +02:00
Jan Höfelmeyer
aa7aadf3f1 Fixes formatting of TOML table at the end of csaf_provider.md 2022-06-17 13:33:14 +02:00
Jan Höfelmeyer
3465938508 Fixes last bit of TOML code not being highlighted 2022-06-17 13:23:44 +02:00
Jan Höfelmeyer
22a6543932 Fixes newlines at the end of docs/csaf_provider.md 2022-06-17 13:22:11 +02:00
Jan Höfelmeyer
a680d909e1 Fixes newlines at the end of docs/csaf_provider.md 2022-06-17 13:17:36 +02:00
Jan Höfelmeyer
21960febe1 Exchanges TOML inline table with standard table for better readability 2022-06-17 13:13:35 +02:00
Jan Höfelmeyer
80eca02ca0 Exchanges TOML inline table with standard table for better readability 2022-06-17 13:01:25 +02:00
JanHoefelmeyer
bb0a30aba3
Improve provider docs
* Add issuing_authority and contact_details to publisher info example
   in docs/csaf_provider.md.
* Add a link to toml's website.
2022-06-17 09:26:27 +02:00
Jan Höfelmeyer
0268d989b5 Adds a link to toml's website to docs/provider.md 2022-06-16 12:46:03 +02:00
Jan Höfelmeyer
8fdda14aee Improves Examples for issuing_authority and contact_details in csaf_provider.md 2022-06-16 12:32:11 +02:00
Jan Höfelmeyer
041621cda7 Added issuing_authority and contact_details to publisher info in docs/csaf_provider.md 2022-06-14 13:50:01 +02:00
s-l-teichmann s-l-teichmann@users.noreply.github.com
86a6f9abde Apply automatic changes 2022-06-14 11:20:09 +00:00
Bernhard E. Reiter
1e9d31277d
Improve nginx setup docs (#182)
* Change nginx config to return 403 on unauthorized access to
   the non-white TLP locations. We cannot hide the existence anyway,
   as it is listed in the provider-metadata.json, even when restricted.
2022-06-14 13:19:30 +02:00
Bernhard Reiter
7e7947a601
Improve integration test for checker
* Change checking to use client certs and verbose for html
   as this is what can be displayed on a webbrowser.
 * Rename the json result file to indicate why the result will differ
   without using the access of the client certificate.
2022-06-14 11:56:11 +02:00
Bernhard Reiter
d4f68a9b08
Improve integration test for checker
* Modify script to call checker twice with difference options,
   including one with json and --verbose.
 * Add json result as build artifact to be uploaded.
2022-06-14 11:10:52 +02:00
tschmidtb51
22b945a3c3
Improve provider example configuration and docs
* Change "Organization" to include the string "Company" to reflect common sense of category "vendor"
2022-06-14 08:58:11 +02:00
Bernhard Reiter
006f088082
Improve checker documentation for config file
* Move the config variables which could be specified as tables in TOML
   to the bottom of the documentation, to avoid that a regular toplevel
   variable is used below them (which would be wrong in TOML).
 * Be more specific about the value of the `upload_limit`.
2022-06-10 17:27:33 +02:00
Bernhard Reiter
8f396bbe31
Improve aggregator integration test
* Do chgrp and chmod not recursively as we have just created the
   directory and if taken as example the recursive chmod with the
   s bit will produce unwanted results on files.
2022-06-09 17:55:47 +02:00
Bernhard Reiter
57fc012ec2
Add a second OpenPGP test key-pair
* Add test key-pair with different properties.
2022-06-09 16:49:25 +02:00
bernhardreiter bernhardreiter@users.noreply.github.com
1e3f5ee1c4 Apply automatic changes 2022-06-09 14:21:06 +00:00
Bernhard Reiter
8c7e03c882
Improve documentation (minor)
* Change comment to better indicate setting in nginx example conf
   which serves the TLP != white locations of the prodiver.
   We do advertise them in the provider-metadata.json, but we still
   want to use 404 to not reveal more about the directory contents.
2022-06-09 16:18:09 +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
bernhardreiter bernhardreiter@users.noreply.github.com
25cb3b2c10 Apply automatic changes 2022-06-09 08:43:33 +00: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
s-l-teichmann s-l-teichmann@users.noreply.github.com
36785ac697 Apply automatic changes 2022-05-31 14:14:39 +00:00
Bernhard Reiter
873fa9ccb4
Improve docs
* Correct language in a few points.
 * Move upload example to use TLS client certificates as recommended.
2022-05-31 15:58:46 +02:00
Bernhard Reiter
773047a91d
Fix script at one mkdir for existing directory 2022-05-31 15:32:41 +02:00
Bernhard Reiter
2b3a71bca0
Improve setup documentation
* Add general hints that this example only shows how the components
   work together and that a GNU/Linux admin should be consulted for
   a secure setup.
 * Adjust the scripts that setup a testing instance to use better
   permissions as good example.
 * Add a section about security considerations.
2022-05-31 15:24:26 +02:00
Bernhard Reiter
bdc161504d
Fix test DNS setup 2022-05-17 20:44:08 +02:00
Bernhard E. Reiter
3e79671bb5
Add checker results as GH artifact for integration test
* Rename and upload checker-result.html to GH.
2022-05-17 10:18:50 +02:00
Fadi Abbud
b8a6c1914a
Add checker run to integration test scripts 2022-05-17 09:12:20 +02:00
s-l-teichmann s-l-teichmann@users.noreply.github.com
8bf769ab98 Apply automatic changes 2022-05-16 19:53:28 +00:00
Bernhard Reiter
c7481e3186
Add aggregator docs with crontab 2022-05-16 21:44:20 +02:00
Bernhard Reiter
7d3bc0e24b
Improve docs für aggregator 2022-05-16 16:42:02 +02:00
Bernhard Reiter
8b04945c3e
Improve docs
* Add --help from ./csaf_aggregator --version 0.3.1-8-gd5d48c7.
2022-05-16 16:34:02 +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
Bernhard Reiter
baea1eb134
Improve docs 2022-05-16 16:24:11 +02:00
Bernhard Reiter
ed9e026579
Improve documentation
* Fix doc long optionsname for the uploader.
 * Add more infos to the provider doc.
2022-05-16 16:21:16 +02:00
Bernhard Reiter
4dee128e96
Improve uploader doc
* Use output from 0.3.1-40-gdef8677 100 chars width.
* Add config paths to the doc.
* Add hint that most options work in the config file as well.
2022-05-16 16:02:53 +02:00
bernhardreiter bernhardreiter@users.noreply.github.com
6b377bb421 Apply automatic changes 2022-05-16 13:21:19 +00:00
Fadi Abbud
5577a0b088
Add dns config example and add it to integration tests
* Add action for starting integration tests
* Configure nginx to resolve DNS record
* Sync itest.yml and docs/scripts/Readme.md

resolve #100
2022-05-16 15:20:37 +02:00
Fadi Abbud
c4deef74eb
Add aggregator to the integration tests scripts 2022-05-16 10:45: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
Bernhard Reiter
cd9f29ef2f
Fix namespace example in aggregator example conf.
* Change namespace value in docs/examples/aggregator.toml to be of
   type uri, which is the required type in the aggregator.json.
2022-05-13 10:00:57 +02:00