Skip to content
This repository was archived by the owner on Jun 19, 2026. It is now read-only.

Commit acf2dae

Browse files
author
Benjamin A. Stockwell
committed
Add a doc explaining how to use the generate_request_signature tool
1 parent c3c9bfb commit acf2dae

1 file changed

Lines changed: 11 additions & 0 deletions

File tree

docs/generate_request_signature.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
## sso_proxy/generate-request-signature
2+
`sso-generate-request-signature` is a command-line tool that is provided alongside `sso_proxy` to facilitate upstream testing of SSO's proxied request signatures, or of libraries that attempt to validate signatures. Note that running `sso-generate-request-signature` requires some of the same configuration to be in place as running `sso-proxy` would, i.e. a `REQUESTSIGNER_KEY` environment variable. Assuming that exists, the tool can be run with three optional flags, followed by as many request headers as desired in `<name>:<value>` format:
3+
4+
- `-url`: the path of the URL of the request to calculate the signature on (default: "")
5+
- `-method`: the method of the request (default: "GET") (note: the method is not used in the signature calculation)
6+
- `-body`: for PUT or POST requests, a string representing the body of the request to calculate a signature on (default: "")
7+
8+
### examples
9+
`sso-generate-request-signature -url "/foo" -method "POST" -body "{}" x-header-1:bar x-header-2:baz`
10+
11+
`sso-generate-request-signature -url "/bar"`

0 commit comments

Comments
 (0)