diff --git a/3rdpartylicenses.md b/3rdpartylicenses.md new file mode 100644 index 0000000..7a15017 --- /dev/null +++ b/3rdpartylicenses.md @@ -0,0 +1,20 @@ +## The used third party dependencies and their licenses + +| 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 | diff --git a/README.md b/README.md index e7b2417..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 @@ -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/`. + +- 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.