Skip to content

Commit f3a51f8

Browse files
committed
Make our lists, lists
1 parent e093716 commit f3a51f8

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

readme.md

Lines changed: 11 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -43,13 +43,14 @@ SIGNED_REQUEST_TOLERANCE_SECONDS=
4343
```
4444

4545
Each of the settings above allows for a different level of configuration.
46-
- `SIGNED_REQUEST_ALGORITHM` is the algorithm that will be used to generate / verify the signature. This is defaulted to use `sha256` feel free to change this to anything that `hash_hmac` accepts.
47-
- `SIGNED_REQUEST_CACHE_PREFIX` is the prefix to use for all the cache keys that will be generated. Here you can use the default if you're not planning on sharing a cache between multiple applications.
48-
- `SIGNED_REQUEST_SIGNATURE_HEADER` should be the request header that the signature will be included on, `X-Signature` will be used by default.
49-
- `SIGNED_REQUEST_ALGORITHM_HEADER` should be the request header that the includes the algorithm used to sign the request.
50-
- `SIGNED_REQUEST_KEY` is the shared secret key between the application generating the requests, and the application consuming them. This value should not be publically available.
51-
- `SIGNED_REQUEST_ALLOW_REPLAYS` allows you to enable or disable replay attacks. By default replays are disabled.
52-
- `SIGNED_REQUEST_TOLERANCE_SECONDS` is the number of seconds that a request will be considered for. This setting allows for some time drift between servers and is only used when replays are disabled.
46+
47+
- `SIGNED_REQUEST_ALGORITHM` is the algorithm that will be used to generate / verify the signature. This is defaulted to use `sha256` feel free to change this to anything that `hash_hmac` accepts.
48+
- `SIGNED_REQUEST_CACHE_PREFIX` is the prefix to use for all the cache keys that will be generated. Here you can use the default if you're not planning on sharing a cache between multiple applications.
49+
- `SIGNED_REQUEST_SIGNATURE_HEADER` should be the request header that the signature will be included on, `X-Signature` will be used by default.
50+
- `SIGNED_REQUEST_ALGORITHM_HEADER` should be the request header that the includes the algorithm used to sign the request.
51+
- `SIGNED_REQUEST_KEY` is the shared secret key between the application generating the requests, and the application consuming them. This value should not be publically available.
52+
- `SIGNED_REQUEST_ALLOW_REPLAYS` allows you to enable or disable replay attacks. By default replays are disabled.
53+
- `SIGNED_REQUEST_TOLERANCE_SECONDS` is the number of seconds that a request will be considered for. This setting allows for some time drift between servers and is only used when replays are disabled.
5354

5455
### Setup the Middleware
5556

@@ -103,7 +104,8 @@ postman.setEnvironmentVariable("x-signature", signature);
103104
```
104105

105106
Note for this to work you'll have to setup your environment to have the following variables:
106-
- `{{url}}` this is the base url to the api you'll be hitting.
107-
- `{{key}}` this is the shared secret key you'll be using in your environment.
107+
108+
- `{{url}}` this is the base url to the api you'll be hitting.
109+
- `{{key}}` this is the shared secret key you'll be using in your environment.
108110

109111
All other environment variables that will be needed will be automatically generated by the above script.

0 commit comments

Comments
 (0)