Add doc comment on HMAC

Signed-off-by: Jacob Weinstock <[email protected]>
bmc-toolbox · Sep 11, 2023 · 4d9b3c7 · 4d9b3c7
1 parent 55d4044
commit 4d9b3c7
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/providers/rpc/doc.go b/providers/rpc/doc.go
@@ -4,5 +4,9 @@ It allows users a simple way to interoperate with an existing/bespoke out-of-ban
 
 The rpc provider request/response payloads are modeled after JSON-RPC 2.0, but are not JSON-RPC 2.0
 compliant so as to allow for more flexibility and interoperability with existing systems.
+
+The rpc provider has options that can be set to include an HMAC signature in the request header.
+It follows the features found at https://webhooks.fyi/security/hmac, this includes hash algorithms sha256
+and sha512, replay prevention, versioning, and key rotation.
 */
 package rpc