Merge pull request #465 from csaf-poc/downloader-document-forward

Downloader: Document the implementes forward API
gocsaf · Sep 27, 2023 · 2e5038f · 2e5038f
2 parents 37f770e + 0ec5f22
commit 2e5038f
Showing 1 changed file with 8 additions and 0 deletions.
diff --git a/docs/csaf_downloader.md b/docs/csaf_downloader.md
@@ -123,6 +123,14 @@ In the config file this has to be noted as:
 ignorepattern = [".*white.*", ".*red.*"]
 ```
 
+#### Forwarding
+The downloader is able to forward downloaded advisories and their checksums,
+OpenPGP signatures and validation results to an HTTP endpoint.  
+The details of the implemented API are described [here](https://github.com/mfd2007/csaf_upload_interface).  
+**Attention** This is a work in progress. There is
+no production ready server which implements this protocol.
+The server in the linked repository is currently for development and testing only.
+
 #### beware of client cert passphrase
 
 The `client-passphrase` option implements a legacy private