1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 18:15:42 +01:00

Improve provider documentation

* Add description about the api endpoints offered by the provider
   and why create should only be called once.

improves #168
This commit is contained in:
Bernhard Reiter 2022-08-23 14:50:39 +02:00
parent 2656312ab1
commit 26a8fb0b55
No known key found for this signature in database
GPG key ID: 2B7BA3BF9BC3A554
2 changed files with 23 additions and 1 deletions

View file

@ -1,8 +1,27 @@
`csaf_provider` implements the CGI interface for webservers `csaf_provider` implements a CGI interface for webservers
and reads its configuration from a [TOML](https://toml.io/en/) file. and reads its configuration from a [TOML](https://toml.io/en/) file.
The [setup docs](../README.md#setup-trusted-provider) The [setup docs](../README.md#setup-trusted-provider)
explain how to wire this up with nginx and where the config file lives. explain how to wire this up with nginx and where the config file lives.
When installed, two entpoints are offered,
and you should use the [csaf_uploader](../docs/csaf_uploader)
to access them:
### /api/create
Must be called once after all configuration values are set.
It will write the `provider-metadata.json` and may write
or update the`security.txt`.
Once the files exist, they will **not** be overwriten
by additional `create` calls, even if the config values have been changed.
Changes should happen rarely and can be done manually.
### /api/upload
Called for each upload of a document and will update
the CSAF structure in the file system accordingly.
## Provider options ## Provider options

View file

@ -28,6 +28,9 @@ Help Options:
-h, --help Show this help message -h, --help Show this help message
``` ```
E.g. creating the initial directories and files. E.g. creating the initial directories and files.
This must only be done once, as subsequent `create` calls to the
[csaf_provider](../docs/csaf_provider.md)
may not lead to the desired result.
```bash ```bash
./csaf_uploader -a create -u https://localhost/cgi-bin/csaf_provider.go ./csaf_uploader -a create -u https://localhost/cgi-bin/csaf_provider.go