ResiLien
/
terraform
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
terraform/website/docs/language/functions/base64sha256.mdx

33 lines
1.1 KiB
Plaintext
Raw Normal View History

website: Docs for all of the hash/crypto functions
2018-05-13 22:48:45 +02:00
---
migrate docs to mdx
2021-11-23 00:47:36 +01:00
page_title: base64sha256 - Functions - Configuration Language
website: Docs for all of the hash/crypto functions
2018-05-13 22:48:45 +02:00
description: |-
The base64sha256 function computes the SHA256 hash of a given string and
encodes it with Base64.
migrate docs to mdx
2021-11-23 00:47:36 +01:00
sidebar_title: base64sha256
website: Docs for all of the hash/crypto functions
2018-05-13 22:48:45 +02:00
---
# `base64sha256` Function
`base64sha256` computes the SHA256 hash of a given string and encodes it with
website: Fix typographical errors in the docs for base64sha256/512
2019-11-08 18:43:27 +01:00
Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()`
migrate docs to mdx
2021-11-23 00:47:36 +01:00
returns hexadecimal representation.
website: Docs for all of the hash/crypto functions
2018-05-13 22:48:45 +02:00
The given string is first encoded as UTF-8 and then the SHA256 algorithm is applied
as defined in [RFC 4634](https://tools.ietf.org/html/rfc4634). The raw hash is
then encoded with Base64 before returning. Terraform uses the "standard" Base64
alphabet as defined in [RFC 4648 section 4](https://tools.ietf.org/html/rfc4648#section-4).
## Examples
```
> base64sha256("hello world")
uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek=
```
## Related Functions
migrate docs to mdx
2021-11-23 00:47:36 +01:00
* [`filebase64sha256`](/language/functions/filebase64sha256) calculates the same hash from
lang: New file-hashing functions In prior versions, we recommended using hash functions in conjunction with the file function as an idiom for detecting changes to upstream blobs without fetching and comparing the whole blob. That approach relied on us being able to return raw binary data from file(...). Since Terraform strings pass through intermediate representations that are not binary-safe (e.g. the JSON state), there was a risk of string corruption in prior versions which we have avoided for 0.12 by requiring that file(...) be used only with UTF-8 text files. The specific case of returning a string and immediately passing it into another function was not actually subject to that corruption risk, since the HIL interpreter would just pass the string through verbatim, but this is still now forbidden as a result of the stricter handling of file(...). To avoid breaking these use-cases, here we introduce variants of the hash functions a with "file" prefix that take a filename for a disk file to hash rather than hashing the given string directly. The configuration upgrade tool also now includes a rule to detect the documented idiom and rewrite it into a single function call for one of these new functions. This does cause a bit of function sprawl, but that seems preferable to introducing more complex rules for when file(...) can and cannot read binary files, making the behavior of these various functions easier to understand in isolation.
2019-01-25 18:16:43 +01:00
the contents of a file rather than from a string value.
migrate docs to mdx
2021-11-23 00:47:36 +01:00
* [`sha256`](/language/functions/sha256) calculates the same hash but returns the result
website: Docs for all of the hash/crypto functions
2018-05-13 22:48:45 +02:00
in a more-verbose hexadecimal encoding.