From 89224a52b9739081100c5e11851da7d5cf64c509 Mon Sep 17 00:00:00 2001 From: Fadi Abbud Date: Thu, 16 Dec 2021 15:18:11 +0100 Subject: [PATCH 1/5] Add Third party licenses info --- LICENSES/3rdpartylicenses.md | 20 ++++++++++++++++++++ README.md | 9 ++++++--- 2 files changed, 26 insertions(+), 3 deletions(-) create mode 100644 LICENSES/3rdpartylicenses.md diff --git a/LICENSES/3rdpartylicenses.md b/LICENSES/3rdpartylicenses.md new file mode 100644 index 0000000..7dfbfde --- /dev/null +++ b/LICENSES/3rdpartylicenses.md @@ -0,0 +1,20 @@ +## The used third party dependencies and their licenses + +| Dependency | License | +| -------------------------------------------------- | -------------------- | +| github.com/BurntSushi/toml | MIT License | +| github.com/PaesslerAG/jsonpath | BSD-3-Clause License | +| github.com/PaesslerAG/gval | BSD-3-Clause License | +| github.com/ProtonMail/gopenpgp/v2 | MIT License | +| github.com/jessevdk/go-flags | BSD-3-Clause License | +| github.com/mitchellh/go-homedir | MIT License | +| github.com/santhosh-tekuri/jsonschema | Apache-2.0 License | +| golang.org/x/crypto | BSD-3-Clause license | +| github.com/ProtonMail/go-crypto | BSD-3-Clause License | +| github.com/ProtonMail/go-mime | MIT License | +| github.com/konsorten/go-windows-terminal-sequences | MIT License | +| github.com/pkg/errors | BSD-2-Clause License | +| github.com/sirupsen/logrus | MIT License | +| golang.org/x/sys | BSD-3-Clause | +| golang.org/x/term | BSD-3-Clause | +| golang.org/x/text | BSD-3-Clause | diff --git a/README.md b/README.md index e7b2417..0481ee9 100644 --- a/README.md +++ b/README.md @@ -36,7 +36,7 @@ Follwoing options are supported: | -c, --config=INI-FILE | Path to config ini file | | -h, --help | Show help | -E.g. of Creating the initial directiories and files. +E.g. of Creating the initial directiories and files ``` ./csaf_uploader -a create -u http://localhost/cgi-bin/csaf_provider.go @@ -63,10 +63,13 @@ action=create u=http://localhost/cgi-bin/csaf_provider.go ``` - ## License - csaf_distribution is licensed as Free Software under MIT License. - See the specific source files -for details, the license itself can be found in the directory `LICENSES`. \ No newline at end of file + for details, the license itself can be found in the directory `LICENSES`. + +- csaf_distrubution contains third party Free Software components under compatible licenses, please check [LICENSES/3rdpartylicenses.md](LICENSES/3rdpartylicenses.md) for more info. + +- Check the source file of each schema under `/csaf/schema/` to see the source and license of each one. \ No newline at end of file From a75d46bc9e94af7ec79be51da05fb31953ee6ca0 Mon Sep 17 00:00:00 2001 From: Fadi Abbud Date: Thu, 16 Dec 2021 15:23:45 +0100 Subject: [PATCH 2/5] Remove unnecessary "license" word --- LICENSES/3rdpartylicenses.md | 36 ++++++++++++++++++------------------ 1 file changed, 18 insertions(+), 18 deletions(-) diff --git a/LICENSES/3rdpartylicenses.md b/LICENSES/3rdpartylicenses.md index 7dfbfde..7a15017 100644 --- a/LICENSES/3rdpartylicenses.md +++ b/LICENSES/3rdpartylicenses.md @@ -1,20 +1,20 @@ ## The used third party dependencies and their licenses -| Dependency | License | -| -------------------------------------------------- | -------------------- | -| github.com/BurntSushi/toml | MIT License | -| github.com/PaesslerAG/jsonpath | BSD-3-Clause License | -| github.com/PaesslerAG/gval | BSD-3-Clause License | -| github.com/ProtonMail/gopenpgp/v2 | MIT License | -| github.com/jessevdk/go-flags | BSD-3-Clause License | -| github.com/mitchellh/go-homedir | MIT License | -| github.com/santhosh-tekuri/jsonschema | Apache-2.0 License | -| golang.org/x/crypto | BSD-3-Clause license | -| github.com/ProtonMail/go-crypto | BSD-3-Clause License | -| github.com/ProtonMail/go-mime | MIT License | -| github.com/konsorten/go-windows-terminal-sequences | MIT License | -| github.com/pkg/errors | BSD-2-Clause License | -| github.com/sirupsen/logrus | MIT License | -| golang.org/x/sys | BSD-3-Clause | -| golang.org/x/term | BSD-3-Clause | -| golang.org/x/text | BSD-3-Clause | +| Dependency | License | +| -------------------------------------------------- | ------------ | +| github.com/BurntSushi/toml | MIT | +| github.com/PaesslerAG/jsonpath | BSD-3-Clause | +| github.com/PaesslerAG/gval | BSD-3-Clause | +| github.com/ProtonMail/gopenpgp/v2 | MIT | +| github.com/jessevdk/go-flags | BSD-3-Clause | +| github.com/mitchellh/go-homedir | MIT | +| github.com/santhosh-tekuri/jsonschema | Apache-2.0 | +| golang.org/x/crypto | BSD-3-Clause | +| github.com/ProtonMail/go-crypto | BSD-3-Clause | +| github.com/ProtonMail/go-mime | MIT | +| github.com/konsorten/go-windows-terminal-sequences | MIT | +| github.com/pkg/errors | BSD-2-Clause | +| github.com/sirupsen/logrus | MIT | +| golang.org/x/sys | BSD-3-Clause | +| golang.org/x/term | BSD-3-Clause | +| golang.org/x/text | BSD-3-Clause | From c3475c4440aec28489b7b98303ea45cbdd616cde Mon Sep 17 00:00:00 2001 From: Fadi Abbud Date: Thu, 16 Dec 2021 16:26:08 +0100 Subject: [PATCH 3/5] Improve Phrasing and move 3rdpartylicenses one up. --- LICENSES/3rdpartylicenses.md => 3rdpartylicenses.md | 0 README.md | 2 +- 2 files changed, 1 insertion(+), 1 deletion(-) rename LICENSES/3rdpartylicenses.md => 3rdpartylicenses.md (100%) diff --git a/LICENSES/3rdpartylicenses.md b/3rdpartylicenses.md similarity index 100% rename from LICENSES/3rdpartylicenses.md rename to 3rdpartylicenses.md diff --git a/README.md b/README.md index 0481ee9..c52fa2a 100644 --- a/README.md +++ b/README.md @@ -70,6 +70,6 @@ u=http://localhost/cgi-bin/csaf_provider.go - See the specific source files for details, the license itself can be found in the directory `LICENSES`. -- csaf_distrubution contains third party Free Software components under compatible licenses, please check [LICENSES/3rdpartylicenses.md](LICENSES/3rdpartylicenses.md) for more info. +- csaf_distrubution contains third party Free Software components under licenses that to our best knowledge are compatible at time of adding the depenceny, please check [3rdpartylicenses.md](3rdpartylicenses.md) for more info. - Check the source file of each schema under `/csaf/schema/` to see the source and license of each one. \ No newline at end of file From d599b11c5622be5edeec7d930eea881658677e33 Mon Sep 17 00:00:00 2001 From: "Bernhard E. Reiter" Date: Mon, 10 Jan 2022 15:12:53 +0100 Subject: [PATCH 4/5] Improve writing of License section in README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index c52fa2a..2aba3b8 100644 --- a/README.md +++ b/README.md @@ -68,8 +68,8 @@ u=http://localhost/cgi-bin/csaf_provider.go - csaf_distribution is licensed as Free Software under MIT License. - See the specific source files - for details, the license itself can be found in the directory `LICENSES`. + for details, the license itself can be found in the directory `LICENSES/`. -- csaf_distrubution contains third party Free Software components under licenses that to our best knowledge are compatible at time of adding the depenceny, please check [3rdpartylicenses.md](3rdpartylicenses.md) for more info. +- Contains third party Free Software components under licenses that to our best knowledge are compatible at time of adding the dependency, [3rdpartylicenses.md](3rdpartylicenses.md) has the details. -- Check the source file of each schema under `/csaf/schema/` to see the source and license of each one. \ No newline at end of file +- Check the source file of each schema under `/csaf/schema/` to see the source and license of each one. From 6bd0e3da205c1a520a93de166fafb4df9a34ed2c Mon Sep 17 00:00:00 2001 From: "Bernhard E. Reiter" Date: Mon, 10 Jan 2022 15:14:20 +0100 Subject: [PATCH 5/5] fix typos in README.md --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 2aba3b8..f058e58 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # csaf_distribution -**WIP**: A prove of concept for a CSAF trusted provider, checker and aggregator. +**WIP**: A proof of concept for a CSAF trusted provider, checker and aggregator. ## Setup @@ -19,8 +19,8 @@ - To configure nginx see [docs/provider-setup.md](docs/provider-setup.md) ## csaf_uploader -csaf_uploader is a command line tool that upload CSAF-Documents to the trusted provider (CSAF_Provider). -Follwoing options are supported: +csaf_uploader is a command line tool that uploads CSAF documents to the trusted provider (CSAF_Provider). +Following options are supported: | Options | Description | | ------------------------------------------ | ------------------------------------------------------------------------------------------ | @@ -36,13 +36,13 @@ Follwoing options are supported: | -c, --config=INI-FILE | Path to config ini file | | -h, --help | Show help | -E.g. of Creating the initial directiories and files +E.g. creating the initial directiories and files ``` ./csaf_uploader -a create -u http://localhost/cgi-bin/csaf_provider.go ``` -E.g. of Uploading a csaf-document +E.g. uploading a csaf-document ``` ./csaf_uploader -a upload -I -t white -u http://localhost/cgi-bin/csaf_provider.go CSAF-document-1.json