Skip to content

Commit

Permalink
Add example fix review suggestions
Browse files Browse the repository at this point in the history
Signed-off-by: Sina Taghizadeh <[email protected]>
  • Loading branch information
sinat101 authored Aug 11, 2023
1 parent 031aaca commit ef91f19
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,17 @@ Examples of inbound traffic include:
The broker requires a Wireguard keypair in order to establish a secure connection.

- `semgrep-network-broker genkey` generates a random private key in base64 and prints it to stdout
- `echo "<PRIVATE KEY>" | semgrep-network-broker pubkey` reads a base64 private key from stdin and prints the corresponding base64 public key to stdout
- `semgrep-network-broker pubkey` reads a base64 private key from stdin and prints the corresponding base64 public key to stdout

#### Example

```bash
> semgrep-network-broker genkey
some_private_key

> echo "some_private_key" | semgrep-network-broker pubkey
some_public_key
```

Your public key is safe to share. _Do not_ share your private key with anyone (including Semgrep).

Expand Down Expand Up @@ -167,7 +177,7 @@ Requirements:

### pubkey

`echo "<PRIVATE KEY>" | semgrep-network-broker pubkey` generates a base64 public key for a given private key (via stdin)
`semgrep-network-broker pubkey` generates a base64 public key for a given private key (via stdin)

### relay
`semgrep-network-broker relay` launches an HTTP server that relays request that match a certain rule.
Expand Down

0 comments on commit ef91f19

Please sign in to comment.