Skip to content

Commit 6685227

Browse files
authored
Merge pull request #480 from swaroopar/feature/addHmacConfig
add HMAC configuration documentation
2 parents e8a03d0 + e8b36bf commit 6685227

File tree

1 file changed

+17
-0
lines changed

1 file changed

+17
-0
lines changed

docs/webhooks.mdx

+17
Original file line numberDiff line numberDiff line change
@@ -47,3 +47,20 @@ other applications which will send data to xpanse via webhook APIs.
4747
On receiving the request, xpanse again tries to generate signature data from received data and
4848
generate the signature again. If this signature value matches to the signature value sent in the request header,
4949
then the request is accepted. Otherwise, rejected with HTTP 401.
50+
51+
## Configuration for HMAC Key
52+
53+
xpanse must configure the secret key for HMAC signature signing using the property **xpanse.webhook.hmac.request.signing.key**.
54+
55+
A random value can be generated using the below command on command line.
56+
This will give a 32 byte (256 bit) secret key.
57+
58+
```shell
59+
openssl rand -hex 32
60+
```
61+
62+
Once the key is generated and finalized, it must be used on the client applications as described in their documentation.
63+
64+
:::tip Sample key for non-production environments
65+
To provide better developer experience, the **dev** spring profile provides a sample key which can be used in non-production environments.
66+
:::

0 commit comments

Comments
 (0)