Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
skeet70 committed Jun 15, 2023
1 parent 044627b commit 9bf1572
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
2 changes: 1 addition & 1 deletion Cargo.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[package]
name = "search-edeks"
version = "1.0.0"
version = "1.1.0"
authors = ["IronCore Labs <[email protected]>"]
categories = ["utilities"]
description = "Tool to search EDEK's protobuf. Can be used to find EDEKs that need to be rekeyed from an old KMS config ID."
Expand Down
6 changes: 4 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Check out this repo and run `cargo b --release`. The binary will be at `target/r

```console
search-edeks --help
search-edeks 1.0.0
search-edeks 1.1.0
IronCore Labs <[email protected]>
Tool to search EDEK's protobuf. Can be used to find EDEKs that need to be rekeyed from an old KMS
config ID.
Expand All @@ -31,10 +31,12 @@ OPTIONS:
-h, --hex Consume and output hex formatted EDEKs
--help Print help information
-i, --id <VALUE> Sets the KMS config ID we're searching for
-v, --verbose Output identifier and original EDEK (and error message if applicable). If
not enabled, only identifiers will be output
-V, --version Print version information
```

For example `search-edeks -f edeks.txt -i 1201 -h` would search `edeks.txt` for any EDEKs that were created using KMS config ID `1201`.
For example `search-edeks --file edeks.txt --id 1201 --hex` would search `edeks.txt` for any EDEKs that were created using KMS config ID `1201`. It would output `matching-edeks.txt` with the one identifier per line for each EDEK that matched. It would output `broken-edeks.txt` with one identifier per line for each EDEK that wasn't parsable as an EDEK. If `--verbose` was enabled, the output would be tuples of the required input form (with the broken EDEKs additonally containing an error message).

## Releasing

Expand Down

0 comments on commit 9bf1572

Please sign in to comment.