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

307 commits

Author SHA1 Message Date
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
Sascha L. Teichmann
8a1ebe0b7a
Add aggregator; improve itest workflow
* Factor JSON evaluation and  construction base URLs out of of checker.
* Move json path matching to util.
* Add csaf_aggregator (as additional command)
* Improve itest workflow to checkout the branch where it is running on.

resolve #105
resolve  #72

Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
Co-authored-by: Fadi Abbud <fadi.abbud@intevation.de>
2022-05-10 18:12:38 +02:00
Sascha L. Teichmann
06c995c030 For issue #83 2022-04-29 08:52:39 +02:00
Fadi Abbud
13cd14738b
Add github action for integration test
* Add sudo to some commands for the github action.
* Change paths to also work within a github action.
2022-04-28 15:06:45 +02:00
Sascha L. Teichmann
05efc82bec
Improve scripts/prepareUbuntuInstanceForITests.sh
* Add code to fetch the lastest Go binary version.
2022-04-21 16:39:56 +02:00
Fadi Abbud
fb61bc349f
Merge pull request #104 from csaf-poc/dev-improve-itest-2
Improve integration test uploadToProvider.sh
2022-04-14 08:17:14 +02:00
Bernhard Reiter
d82be5c69e
Improve client cert setup instructions
* Add hint that the used client certification is logged by default
   when accessing the upload interface of the provider.

resolve #99
2022-04-13 17:59:16 +02:00
Bernhard Reiter
3da37a533b
Improve integration test uploadToProvider.sh
* Remove `let` from the script as it will return 1 (signalling an error) on the
   first iteration, which will stop the script when in `set -e` mode.
   It also is unnecessary, as the increment can be done at the place of
   usage directly.
 * Added a "remainder aka modulo" division, otherwise there will be no
   TLP option set, once we run out of the four entries in the TLSs
   list.
 * (Style) remove superfluous semicolons.
2022-04-13 17:46:10 +02:00
Bernhard Reiter
9af0471087
Add packages to prepareUbuntuInstanceForITests.sh 2022-04-13 14:32:18 +02:00
Bernhard Reiter
f04473874a
Improve client cert setup instructions
* Rephrase slightly and add hint that the issuer config
   will be checked against the `$ssl_client_i_dn` variable, so the
   example serves both uses.

resolve #46
2022-04-13 11:53:21 +02:00
bernhardreiter bernhardreiter@users.noreply.github.com
8711ea67fe Apply automatic changes 2022-04-12 14:06:26 +00:00
Fadi Abbud
e8166121c7
Improve nginx example config
* Make files more readable: Move ";" from variable and add it into the nginx config file.
* Add missing nginx option `disable_symlinks off;` to the tlp paths.
2022-04-12 16:05:45 +02:00
Fadi Abbud
9bbe3e1eb8
Add scripts for integration test setup and docs generation
* Add an OpenPGP test keypair.
 * Move script parts of documentation into script, so they can be used on a fresh Ubuntu 20.04 system
   for within a github action to setup a csaf_provider and upload documents to it for an integration test.
 * Use dineshsonachalam/markdown-autodocs in github action to automatically
   insert lines from the scripts into the docs.

Co-authored-by: Bernhard Reiter <bernhard@intevation.de>
2022-04-08 10:04:34 +02:00
tschmidtb51
f0359d982d
Correct double line in provider-setup.md 2022-04-07 18:20:21 +02:00
Fadi Abbud
43c9a25c34 Improve documentation (client-certificate-setup.md) 2022-03-25 07:45:02 +01:00
Fadi Abbud
782d653e59 Issuer documentation
* Documentation for the "issuer" option of the provider.
* More info of the format of the accepted file
* Print out the value of `SSL_CLIENT_I_DN` also when it is not match the issuer.
2022-03-24 16:46:47 +01:00
Fadi Abbud
1a2af34df0 Add example to README (client-certificate-setup.md) 2022-03-24 09:36:59 +01:00
Bernhard E. Reiter
1d7e7a3124
Merge branch 'main' into client-certificate 2022-03-23 20:19:51 +01:00
Bernhard Reiter
3753f08370
Merge branch 'main' into client-certificate 2022-03-23 20:12:36 +01:00
Fadi Abbud
5e1f2092e8
add setup options to provider docs
* Add a first description of the config options for csaf_provider.
 * Change option name from `domain` to `canonical_prefix_url`
    to make the usage more intuitively. Use`https` in the default,
    if unset.

resolve #32 

Co-authored-by: Bernhard E. Reiter <bernhard@intevation.de>
Co-authored-by: tschmidtb51 <65305130+tschmidtb51@users.noreply.github.com>
2022-03-23 19:48:05 +01:00
Fadi Abbud
7c64540c7e
Improve Documentation for provider (#61) 2022-03-03 11:57:41 +01:00
Fadi Abbud
1c59b671d5 Improve documentation 2022-03-03 11:22:41 +01:00
Fadi Abbud
cbf39f9806 Documentation 2022-02-22 11:06:51 +01:00
Fadi Abbud
a5d64a4038 Add info to one command (client-certificate-setup.md) 2022-02-18 14:40:31 +01:00
Fadi Abbud
d451cc3908 (minor) Fix one option value 2022-02-18 13:57:45 +01:00
Fadi Abbud
d9e326f84a Fix link in development-ca.md 2022-02-17 10:05:08 +01:00
Bernhard Reiter
196e123415
Improve docs/development-ca.md
* Add some considerations and references. So readers can follow some
   of the engineering thoughts.
2022-02-16 09:55:16 +01:00
Bernhard Reiter
72a0f1f4ed
Improve docs/install-server-certificate.md
* Be more explizit about not using a development ca in production
   for the server.
2022-02-16 09:31:16 +01:00
Bernhard Reiter
f20a9e2da6
Merge branch 'client-certificate' of github.com:csaf-poc/csaf_distribution into client-certificate 2022-02-15 18:21:41 +01:00
Bernhard Reiter
2905a30cc0
Improve tls client cert handling
* Improve nginx setup to transfer auth information to the fcgiwrap
 backend.
 * Add instructions for creating client certs for testing.
 * Add debug output to see if and which client cert has been used when
   calling the csaf_provider.go .
2022-02-15 18:20:24 +01:00
Bernhard Reiter
a71f490999
Merge branch 'main' into client-certificate 2022-02-15 10:01:18 +01:00
Bernhard Reiter
ae776306e2
Fix typo 2022-02-14 16:38:40 +01:00
Bernhard Reiter
ef402259a1
Improve client cert setup
* remove cert creation, as it will be described in a different
   file.
2022-02-14 13:24:22 +01:00
Bernhard Reiter
ed82234305
Add docs to run a development ca with gnuls 2022-02-14 13:04:10 +01:00
Fadi Abbud
6a106640c6
Improve docs: add instructions to install TLS cert for nginx
* Add instructions for installing a TLS server certificate on nginx 
 * Fix link to nginx in README.md
 * List all three ways to get a webserver TLS certificate. With some
   hints on which to chose for which purpose.
 * Do not add CSR instructions, because they can change over time and each CA may
   have slightly different requirements.
 * Add a hint about setting protocol selection.
 * Fix typo in provider-setup.md
2022-02-14 12:39:40 +01:00
Bernhard Reiter
122cfb4757
Improve install-server-certificate.md
* Add technical hint about ERR_SSL_KEY_USAGE_INCOMPATIBLE.
 * Improve format and spelling.
 * Remove OSCP hint as this is related to client certificates.
2022-02-14 10:45:02 +01:00
Bernhard Reiter
d3f99189b5
Rework docs/install-server-certificate.md
* List all three ways to get a webserver TLS certificate. With some
   hints on which to chose for which purpose.
 * Refer to the official nginx documentation and remove some of the
   instructions, because they can change over time and each CA may
   have slightly different requirements.
 * Add a hint about setting protocol selection.
2022-02-11 17:42:24 +01:00
Bernhard Reiter
a39c8669d9
Fix typo in provider-setup.md 2022-02-11 15:36:08 +01:00
Fadi Abbud
078ccdbd69 Fix Typo 2022-02-09 16:30:32 +01:00
Fadi Abbud
05f35a76af Instruction for installing TLS server certificate on nginx 2022-02-02 15:19:25 +01:00