diff options
| author | Joe Mooring <joe.mooring@veriphor.com> | 2022-03-23 19:48:34 +0300 |
|---|---|---|
| committer | Bjørn Erik Pedersen <bjorn.erik.pedersen@gmail.com> | 2022-03-23 21:42:56 +0300 |
| commit | 94e8a907694406da67e29ab376db393e199fe1cc (patch) | |
| tree | d9ec17d69db3cc1c46a95109931295ece54d5b19 /docs/content/en | |
| parent | a461e9d01a95089eca571d3a49642b01d9173c18 (diff) | |
tpl/crypto: Add optional encoding arg to hmac function
Closes #9709
Diffstat (limited to 'docs/content/en')
| -rw-r--r-- | docs/content/en/functions/hmac.md | 27 |
1 files changed, 14 insertions, 13 deletions
diff --git a/docs/content/en/functions/hmac.md b/docs/content/en/functions/hmac.md index 9df36d300..b906e5abb 100644 --- a/docs/content/en/functions/hmac.md +++ b/docs/content/en/functions/hmac.md @@ -1,7 +1,7 @@ --- title: hmac linktitle: hmac -description: Compute the cryptographic checksum of a message. +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 @@ -10,24 +10,25 @@ menu: docs: parent: "functions" keywords: [hmac,checksum] -signature: ["hmac HASH_TYPE KEY MESSAGE"] +signature: ["crypto.HMAC HASH_TYPE KEY MESSAGE [ENCODING]","hmac HASH_TYPE KEY MESSAGE [ENCODING]" ] workson: [] hugoversion: relatedfuncs: [hmac] deprecated: false -aliases: [hmac] +aliases: [] --- -`hmac` returns a cryptographic hash that uses a key to sign a message. +Set the `HASH_TYPE` argument to `md5`, `sha1`, `sha256`, or `sha512`. -``` -{{ hmac "sha256" "Secret key" "Hello world, gophers!"}}, -<!-- returns the string "b6d11b6c53830b9d87036272ca9fe9d19306b8f9d8aa07b15da27d89e6e34f40" -``` +Set the optional `ENCODING` argument to either `hex` (default) or `binary`. -Supported hash functions: +```go-html-template +{{ hmac "sha256" "Secret key" "Secret message" }} +5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84 -* md5 -* sha1 -* sha256 -* sha512 +{{ hmac "sha256" "Secret key" "Secret message" "hex" }} +5cceb491f45f8b154e20f3b0a30ed3a6ff3027d373f85c78ffe8983180b03c84 + +{{ hmac "sha256" "Secret key" "Secret message" "binary" | base64Encode }} +XM60kfRfixVOIPOwow7Tpv8wJ9Nz+Fx4/+iYMYCwPIQ= +``` |