summaryrefslogtreecommitdiffstats
path: root/docs/content/en/functions/hmac.md
diff options
context:
space:
mode:
Diffstat (limited to 'docs/content/en/functions/hmac.md')
-rw-r--r--docs/content/en/functions/hmac.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/docs/content/en/functions/hmac.md b/docs/content/en/functions/hmac.md
new file mode 100644
index 000000000..b906e5abb
--- /dev/null
+++ b/docs/content/en/functions/hmac.md
@@ -0,0 +1,34 @@
+---
+title: hmac
+linktitle: hmac
+description: Returns a cryptographic hash that uses a key to sign a message.
+date: 2020-05-29
+publishdate: 2020-05-29
+lastmod: 2020-05-29
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+keywords: [hmac,checksum]
+signature: ["crypto.HMAC HASH_TYPE KEY MESSAGE [ENCODING]","hmac HASH_TYPE KEY MESSAGE [ENCODING]" ]
+workson: []
+hugoversion:
+relatedfuncs: [hmac]
+deprecated: false
+aliases: []
+---
+
+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=
+```