Skip to content

Commit

Permalink
Update README files
Browse files Browse the repository at this point in the history
  • Loading branch information
jjnicola committed Sep 29, 2023
1 parent 61bf723 commit ab5030f
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 0 deletions.
1 change: 1 addition & 0 deletions rust/feed/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ FEED_NAME = "short name of the feed";
## Verify

[Implements](./src/verify/mod.rs) a [HashSumNameLoader](./src/verify/mod.rs#L93) that loads the filenames defined in the sha256sums and verifies the corresponding hashsum.
Also, implements a [signature verifier](./src/verify/mod.rs#L163) for checking the signature of the sha256sums file.

### Example

Expand Down
2 changes: 2 additions & 0 deletions rust/nasl-cli/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,7 @@ Options:


On `feed update` it will first read the `sha256sums` file within the feed directory and verify each file with the corresponding sha256sums. When the hash is correct it will execute each mentioned `*.nasl` script within that dir with `description = 1`.
Optionally, it is possible to perform a signature verification of the sha256sums file before uploading. To enable the signature check, the environment variable `GNUPGHOME` must be set with the gnupg home directory, where the `pubring.kbx` file is stored.

#### transform
Runs nasl scripts in description mode and returns it as a json array into stdout.
Expand All @@ -73,6 +74,7 @@ Options:


On `feed transform` it will first read the `sha256sums` file within the feed directory and verify each file with the corresponding sha256sums. When the hash is correct it will execute each mentioned `*.nasl` script within that dir with `description = 1`.
Optionally, it is possible to perform a signature verification of the sha256sums file before the transformation. To enable the signature check, the environment variable `GNUPGHOME` must be set with the gnupg home directory, where the `pubring.kbx` file is stored.

It will produce a json array in stdout in the format described within [json-storage](../json-storage/README.md).

Expand Down

0 comments on commit ab5030f

Please sign in to comment.