mirror of
https://github.com/gocsaf/csaf.git
synced 2026-01-20 10:15:41 +01:00
b359fd0a62
* Dense and refactor ROLIE code in aggregator a bit. * Move advisory file processor to csaf package. * Fix minor typo on main readme
71 lines
3.1 KiB
Markdown
71 lines
3.1 KiB
Markdown
# csaf_distribution
|
|
|
|
An implementation of a [CSAF 2.0](https://docs.oasis-open.org/csaf/csaf/v2.0/csd02/csaf-v2.0-csd02.html) trusted provider, checker, aggregator and downloader. Includes an uploader command line tool for the trusted provider.
|
|
|
|
Status: Beta (ready for more testing, but known shortcomings see issues)
|
|
|
|
|
|
## [csaf_provider](docs/csaf_provider.md)
|
|
is an implementation of the role CSAF Trusted Provider, also offering
|
|
a simple HTTPS based management service.
|
|
|
|
## [csaf_uploader](docs/csaf_uploader.md)
|
|
is a command line tool that uploads CSAF documents to the `csaf_provider`.
|
|
|
|
## [csaf_aggregator](docs/csaf_aggregator.md)
|
|
is an implementation of the role CSAF Aggregator.
|
|
|
|
## [csaf_checker](docs/csaf_checker.md)
|
|
is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSAF standard](https://docs.oasis-open.org/csaf/csaf/v2.0/csaf-v2.0.html#7-distributing-csaf-documents).
|
|
|
|
## [csaf_downloader](docs/csaf_downloader.md)
|
|
is a tool for downloading advisories from a provider.
|
|
|
|
## Setup
|
|
Note that the server side is only tested
|
|
and the binaries available for GNU/Linux-Systems, e.g. Ubuntu LTS.
|
|
It is likely to run on similar systems when build from sources.
|
|
|
|
The windows binaries only include `csaf_uploader` and `csaf_checker`.
|
|
|
|
### Prebuild binaries
|
|
|
|
Download the binaries (from the most recent release assets on Github).
|
|
|
|
|
|
### Build from sources
|
|
|
|
- A recent version of **Go** (1.17+) should be installed. [Go installation](https://go.dev/doc/install)
|
|
|
|
- Clone the repository `git clone https://github.com/csaf-poc/csaf_distribution.git `
|
|
|
|
- Build Go components Makefile supplies the following targets:
|
|
- Build For GNU/Linux System: `make build_linux`
|
|
- Build For Windows System (cross build): `make build_win`
|
|
- Build For both linux and windows: `make build`
|
|
- Build from a specific github tag by passing the intended tag to the `BUILDTAG` variable.
|
|
E.g. `make BUILDTAG=v1.0.0 build` or `make BUILDTAG=1 build_linux`.
|
|
The special value `1` means checking out the highest github tag for the build.
|
|
- Remove the generated binaries und their directories: `make mostlyclean`
|
|
|
|
Binaries will be placed in directories named like `bin-linux-amd64/` and `bin-windows-amd64/`.
|
|
|
|
|
|
### Setup (Trusted Provider)
|
|
|
|
- [Install](https://nginx.org/en/docs/install.html) **nginx**
|
|
- To install a TLS server certificate on nginx see [docs/install-server-certificate.md](docs/install-server-certificate.md)
|
|
- To configure nginx see [docs/provider-setup.md](docs/provider-setup.md)
|
|
- To configure nginx for client certificate authentication see [docs/client-certificate-setup.md](docs/client-certificate-setup.md)
|
|
|
|
|
|
## 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/`.
|
|
|
|
- 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.
|