SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 05:40:11 +01:00
Code Issues Releases Activity Actions
gocsaf/docs/scripts
History
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
..
createCCForITest.sh Improve nginx example config 2022-04-12 16:05:45 +02:00
createRootCAForITest.sh Add scripts for integration test setup and docs generation 2022-04-08 10:04:34 +02:00
createWebserverCertForITest.sh Add dns config example and add it to integration tests 2022-05-16 15:20:37 +02:00
DNSConfigForItest.sh Improve DNS example and itest setup (#285) 2022-08-26 12:23:51 +02:00
downloadExamples.sh Add scripts for integration test setup and docs generation 2022-04-08 10:04:34 +02:00
prepareUbuntuInstanceForITests.sh Fix script scripts/prepareUbuntuInstanceForITests.sh for new go.dev API 2023-08-17 20:17:15 +02:00
Readme.md Improve doc for development test script setup 2022-07-21 12:44:03 +02:00
setupProviderForITest.sh Change default port for secvisogram (#262) 2022-07-26 15:13:02 +02:00
setupValidationService.sh Upgrade jsonschema library to 5.2.0 (#349) 2023-03-10 10:39:23 +01:00
testAggregator.sh Improve integration test scripts 2022-07-21 16:16:16 +02:00
testChecker.sh Convert a lot of command line arguments to snake case (#498) 2023-11-06 14:33:05 +01:00
testDownloader.sh Remove verbose flag from downloader test. (#466) 2023-09-27 13:19:08 +02:00
TLSClientConfigsForITest.sh Add docs for a provider proxy (#255) 2022-07-25 15:23:11 +02:00
TLSConfigsForITest.sh Add dns config example and add it to integration tests 2022-05-16 15:20:37 +02:00
uploadToProvider.sh Convert a lot of command line arguments to snake case (#498) 2023-11-06 14:33:05 +01:00

Readme.md

Scripts for assisting the Integration tests. They are written on Ubuntu 20.04 TLS amd64.

  • prepareUbunutForITest.sh installs the required packages for the csaf_distribution integration tests on a naked ubuntu 20.04 LTS amd64.

  • TLSConfigsForITest.sh generates a root CA and webserver cert by running createRootCAForITest.sh and createWebserverCertForITest.sh and configures nginx for serving TLS connections.

  • TLSClientConfigsForITest.sh generates client certificates by calling createCCForITest.sh which uses the root certificate initialized before with createRootCAForITest.sh. It configures nginx to enable the authentication with client certificate. (This assumes that the same folder name is used to create the root certificate)

  • setupProviderForITest.sh builds the csaf_provider, writes the required nginx configurations and create the initial folders. IT calls uploadToProvider.sh to upload some csaf example files to the provider.

As creating the folders needs to authenticate with the csaf_provider, the configurations of TLS server and Client certificate authentication should be set. So it is recommended to call the scripts in this order: TLSConfigsForITest.sh, TLSClientConfigsForITest.sh, setupProviderForITest.sh

Calling example (as root):

    curl --fail -O https://raw.githubusercontent.com/csaf-poc/csaf_distribution/main/docs/scripts/prepareUbuntuInstanceForITests.sh
    bash prepareUbuntuInstanceForITests.sh

    git clone https://github.com/csaf-poc/csaf_distribution.git # --branch <name>
    pushd csaf_distribution/docs/scripts/

    export FOLDERNAME=devca1 ORGANAME="CSAF Tools Development (internal)"
    source ./TLSConfigsForITest.sh
    set +e  # for an interactive shell, reverse set -e done by previous line
    ./TLSClientConfigsForITest.sh
    ./setupProviderForITest.sh
    ./testAggregator.sh
    ./testDownloader.sh