mirror of
https://github.com/opentffoundation/opentf.git
synced 2025-12-21 10:47:34 -05:00
a15a6c9657
Signed-off-by: Janos <86970079+janosdebugs@users.noreply.github.com> Signed-off-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Signed-off-by: Roman Grinovski <roman.grinovski@gmail.com> Co-authored-by: Damian Stasik <920747+damianstasik@users.noreply.github.com> Co-authored-by: Roman Grinovski <roman.grinovski@gmail.com>
32 lines
1.1 KiB
Plaintext
32 lines
1.1 KiB
Plaintext
---
|
|
sidebar_label: base64sha256
|
|
description: |-
|
|
The base64sha256 function computes the SHA256 hash of a given string and
|
|
encodes it with Base64.
|
|
---
|
|
|
|
# `base64sha256` Function
|
|
|
|
`base64sha256` computes the SHA256 hash of a given string and encodes it with
|
|
Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()`
|
|
returns hexadecimal representation.
|
|
|
|
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. OpenTofu 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
|
|
|
|
* [`filebase64sha256`](../../language/functions/filebase64sha256.mdx) calculates the same hash from
|
|
the contents of a file rather than from a string value.
|
|
* [`sha256`](../../language/functions/sha256.mdx) calculates the same hash but returns the result
|
|
in a more-verbose hexadecimal encoding.
|