summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/crypto/HMAC.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/crypto/HMAC.md')
-rw-r--r--docs/content/en/functions/crypto/HMAC.md36
1 files changed, 36 insertions, 0 deletions
diff --git a/docs/content/en/functions/crypto/HMAC.md b/docs/content/en/functions/crypto/HMAC.md
new file mode 100644
index 000000000..e58619b38
--- /dev/null
+++ b/docs/content/en/functions/crypto/HMAC.md
@@ -0,0 +1,36 @@
+---
+title: crypto.HMAC
+linkTitle: hmac
+description: Returns a cryptographic hash that uses a key to sign a message.
+categories: [functions]
+keywords: []
+menu:
+ docs:
+ parent: functions
+function:
+ aliases: [hmac]
+ returnType: string
+ signatures: ['crypto.HMAC HASH_TYPE KEY MESSAGE [ENCODING]']
+relatedFunctions:
+ - crypto.FNV32a
+ - crypto.HMAC
+ - crypto.MD5
+ - crypto.SHA1
+ - crypto.SHA256
+aliases: [/functions/hmac]
+---
+
+Set the `HASH_TYPE` argument to `md5`, `sha1`, `sha256`, or `sha512`.
+
+Set the optional `ENCODING` argument to either `hex` (default) or `binary`.
+
+```go-html-template
+{{ hmac "sha256" "Secret key" "Secret message" }}
+5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
+
+{{ hmac "sha256" "Secret key" "Secret message" "hex" }}
+5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84
+
+{{ hmac "sha256" "Secret key" "Secret message" "binary" | base64Encode }}
+XM60kfRfixVOIPOwow7Tpv8wJ9Nz+Fx4/+iYMYCwPIQ=
+```