SystemSh0cker/gocsaf
1
0
Fork 0
mirror of https://github.com/gocsaf/csaf.git synced 2025-12-22 11:55:40 +01:00
Code Issues Releases Activity Actions

Merge pull request #16 from csaf-poc/readme-for-uploader

Browse source 
Adjust README for csaf_uploader
This commit is contained in:
Sascha L. Teichmann 2021-12-13 16:00:05 +01:00 • committed by GitHub
commit 8623728a9a
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
1 changed files with 46 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

46
README.md
View file

@ -18,6 +18,52 @@
- [Install](http://nginx.org/en/docs/install.html) **nginx**
- 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:
| Options | Description |
| ------------------------------------------ | ------------------------------------------------------------------------------------------ |
| -a, --action=[upload\|create] | Action to perform (default: upload) |
| -u, --url=URL | URL of the CSAF provider (default:https:<span></span>//localhost/cgi-bin/csaf_provider.go) |
| -t, --tlp=[csaf\|white\|green\|amber\|red] | TLP of the feed (default: csaf) |
| -x, --external-signed | CASF files are signed externally. |
| -k, --key=KEY-FILE | OpenPGP key to sign the CSAF files |
| -p, --password=PASSWORD | Authentication password for accessing the CSAF provider |
| -P, --passphrase=PASSPHRASE | Passphrase to unlock the OpenPGP key |
| -i, --password-interactive | Enter password interactively |
| -I, --passphrase-interacive | Enter passphrase interactively |
| -c, --config=INI-FILE | Path to config ini file |
| -h, --help | Show help |
E.g. of 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
```
./csaf_uploader -a upload -I -t white -u http://localhost/cgi-bin/csaf_provider.go CSAF-document-1.json
```
which asks to enter password interactively.
csaf_uploader can be started with a config file like following:
```
./csaf_provider -c conf.ini
```
config.ini :
```
action=create
u=http://localhost/cgi-bin/csaf_provider.go
```
## License
- csaf_distribution is licensed as Free Software under MIT License.