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

API examples: move csaf_searcher to a lower prio place (#489)

Browse source 
* move csaf_searcher to a lower prio place

* Adjust wording

* Grammar fix #2 'this is work in progress' -> 'This is a work in progress'...

---------

Co-authored-by: JanHoefelmeyer <hoefelmeyer.jan@gmail.com>
This commit is contained in:
Sascha L. Teichmann 2023-11-02 14:12:41 +01:00 • committed by GitHub
parent 7fbc012e2c
commit 26c630df4a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
3 changed files with 11 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

9
README.md
View file

@ -10,9 +10,6 @@ Can be used for automated forwarding of CSAF documents.
### [csaf_validator](docs/csaf_validator.md) ### [csaf_validator](docs/csaf_validator.md)
is a tool to validate local advisories files against the JSON Schema and an optional remote validator. is a tool to validate local advisories files against the JSON Schema and an optional remote validator.
### [csaf_searcher](docs/csaf_searcher.md)
is a tool to search through local advisories. It finds PURLs based on the product ID of an advisory.
## Tools for advisory providers ## Tools for advisory providers
### [csaf_provider](docs/csaf_provider.md) ### [csaf_provider](docs/csaf_provider.md)
@ -28,6 +25,12 @@ is a tool for testing a CSAF Trusted Provider according to [Section 7 of the CSA
### [csaf_aggregator](docs/csaf_aggregator.md) ### [csaf_aggregator](docs/csaf_aggregator.md)
is a CSAF Aggregator, to list or mirror providers. is a CSAF Aggregator, to list or mirror providers.
## Other stuff
### [examples](./examples/README.md)
are small examples of how to use `github.com/csaf-poc/csaf_distribution` as an API.
Currently this is a work in progress. They may be extended and/or changed in the future.
## Setup ## Setup
Binaries for the server side are only available and tested Binaries for the server side are only available and tested
for GNU/Linux-Systems, e.g. Ubuntu LTS. for GNU/Linux-Systems, e.g. Ubuntu LTS.

5
examples/README.md Normal file
View file

@ -0,0 +1,5 @@
# API examples
A currenty very short list how to use `github.com/csaf-poc/csaf_distribution` as a library:
* (purl_searcher)[./purl_searcher/main.go] is a tool to search through local advisories. It finds PURLs based on the product ID of an advisory.

0
cmd/csaf_searcher/main.go → examples/purls_searcher/main.go
View file