summaryrefslogtreecommitdiff
path: root/docs-src/content/functions/crypto.yml
diff options
context:
space:
mode:
authorDave Henderson <dhenderson@gmail.com>2022-02-12 17:27:59 -0500
committerGitHub <noreply@github.com>2022-02-12 17:27:59 -0500
commitf640ec5f846d7e40e619bfba1023de09fe421814 (patch)
treefba56d233e95df6c7096b27e009f8afdf7f19823 /docs-src/content/functions/crypto.yml
parentd31b7c6d47dfdbcf0fbd3a323d41aa1935b558e4 (diff)
New crypto.SHA*Bytes functions (#1306)
Signed-off-by: Dave Henderson <dhenderson@gmail.com>
Diffstat (limited to 'docs-src/content/functions/crypto.yml')
-rw-r--r--docs-src/content/functions/crypto.yml26
1 files changed, 26 insertions, 0 deletions
diff --git a/docs-src/content/functions/crypto.yml b/docs-src/content/functions/crypto.yml
index d1778c67..37c35bdd 100644
--- a/docs-src/content/functions/crypto.yml
+++ b/docs-src/content/functions/crypto.yml
@@ -341,6 +341,32 @@ funcs:
- |
$ gomplate -i '{{ crypto.SHA512 "bar" }}'
cc06808cbbee0510331aa97974132e8dc296aeb795be229d064bae784b0a87a5cf4281d82e8c99271b75db2148f08a026c1a60ed9cabdb8cac6d24242dac4063
+ - rawName: '`crypto.SHA1Bytes`, `crypto.SHA224Bytes`, `crypto.SHA256Bytes`, `crypto.SHA384Bytes`, `crypto.SHA512Bytes`, `crypto.SHA512_224Bytes`, `crypto.SHA512_256Bytes`'
+ description: |
+ Compute a checksum with a SHA-1 or SHA-2 algorithm as defined in [RFC 3174](https://tools.ietf.org/html/rfc3174) (SHA-1) and [FIPS 180-4](http://nvlpubs.nist.gov/nistpubs/FIPS/NIST.FIPS.180-4.pdf) (SHA-2).
+
+ These functions output the raw binary result, suitable for piping to other functions.
+
+ _Warning: SHA-1 is cryptographically broken and should not be used for secure applications._
+ pipeline: false
+ rawUsage: |
+ ```
+ crypto.SHA1Bytes input
+ crypto.SHA224Bytes input
+ crypto.SHA256Bytes input
+ crypto.SHA384Bytes input
+ crypto.SHA512Bytes input
+ crypto.SHA512_224Bytes input
+ crypto.SHA512_256Bytes input
+ ```
+ arguments:
+ - name: input
+ required: true
+ description: the data to hash - can be binary data or text
+ examples:
+ - |
+ $ gomplate -i '{{ crypto.SHA256Bytes "foo" | base64.Encode }}'
+ LCa0a2j/xo/5m0U8HTBBNBNCLXBkg7+g+YpeiGJm564=
- name: crypto.WPAPSK
description: |
This is really an alias to [`crypto.PBKDF2`](#crypto.PBKDF2) with the