summaryrefslogtreecommitdiffstats
path: root/docs
diff options
context:
space:
mode:
authorEdouard <m@edouard.paris>2020-06-05 20:04:11 +0200
committerGitHub <noreply@github.com>2020-06-05 20:04:11 +0200
commit7eeebe1e5a86a4ad622bc41f88fcb93b619f5a16 (patch)
tree5d36446c4d39b9893c0a50f0ad22f38083d9bcb6 /docs
parent740fa4a91d01fa1c0b151bae0c97a13eea61f5f9 (diff)
tpl/crypto: Add hmac
Diffstat (limited to 'docs')
-rw-r--r--docs/content/en/functions/hmac.md34
-rw-r--r--docs/data/docs.json17
2 files changed, 51 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..02343196b
--- /dev/null
+++ b/docs/content/en/functions/hmac.md
@@ -0,0 +1,34 @@
+---
+title: hmac
+linktitle: hmac
+description: Compute the cryptographic checksum of a message.
+godocref:
+date: 2020-05-29
+publishdate: 2020-05-29
+lastmod: 2020-05-29
+categories: [functions]
+menu:
+ docs:
+ parent: "functions"
+keywords: [hmac,checksum]
+signature: ["hmac HASH_TYPE KEY MESSAGE"]
+workson: []
+hugoversion:
+relatedfuncs: [hmac]
+deprecated: false
+aliases: [hmac]
+---
+
+`hmac` returns a cryptographic hash that uses a key to sign a message.
+
+```
+{{ hmac "sha256" "Secret key" "Hello world, gophers!"}},
+<!-- returns the string "b6d11b6c53830b9d87036272ca9fe9d19306b8f9d8aa07b15da27d89e6e34f40"
+```
+
+Supported hash functions:
+
+* md5
+* sha1
+* sha256
+* sha512
diff --git a/docs/data/docs.json b/docs/data/docs.json
index bf31f45ce..01b8b8d54 100644
--- a/docs/data/docs.json
+++ b/docs/data/docs.json
@@ -3059,6 +3059,23 @@
"6ec43b78da9669f50e4e422575c54bf87536954ccd58280219c393f2ce352b46"
]
]
+ },
+ "HMAC": {
+ "Description": "HMAC hashes the concatenation of a message and a secret key with the given hash function and returns its checksum.",
+ "Args": [
+ "hash function",
+ "message",
+ "key"
+ ],
+ "Aliases": [
+ "hmac"
+ ],
+ "Examples": [
+ [
+ "{{ hmac \"sha256\" \"Hello Gopher!\" \"Hello world, gophers!\" }}",
+ "32aea97d5688891fb35175c5518012323a3079994b909dd6f1bc481e4d0e7ce9"
+ ]
+ ]
}
},
"data": {