github.com/rstandt/terraform@v0.12.32-0.20230710220336-b1063613405c/website/docs/configuration/functions/base64sha256.html.md (about)

     1  ---
     2  layout: "functions"
     3  page_title: "base64sha256 - Functions - Configuration Language"
     4  sidebar_current: "docs-funcs-crypto-base64sha256"
     5  description: |-
     6    The base64sha256 function computes the SHA256 hash of a given string and
     7    encodes it with Base64.
     8  ---
     9  
    10  # `base64sha256` Function
    11  
    12  -> **Note:** This page is about Terraform 0.12 and later. For Terraform 0.11 and
    13  earlier, see
    14  [0.11 Configuration Language: Interpolation Syntax](../../configuration-0-11/interpolation.html).
    15  
    16  `base64sha256` computes the SHA256 hash of a given string and encodes it with
    17  Base64. This is not equivalent to `base64encode(sha256("test"))` since `sha256()`
    18  returns hexadecimal representation. 
    19  
    20  The given string is first encoded as UTF-8 and then the SHA256 algorithm is applied
    21  as defined in [RFC 4634](https://tools.ietf.org/html/rfc4634). The raw hash is
    22  then encoded with Base64 before returning. Terraform uses the "standard" Base64
    23  alphabet as defined in [RFC 4648 section 4](https://tools.ietf.org/html/rfc4648#section-4).
    24  
    25  ## Examples
    26  
    27  ```
    28  > base64sha256("hello world")
    29  uU0nuZNNPgilLlLX2n2r+sSE7+N6U4DukIj3rOLvzek=
    30  ```
    31  
    32  ## Related Functions
    33  
    34  * [`filebase64sha256`](./filebase64sha256.html) calculates the same hash from
    35    the contents of a file rather than from a string value.
    36  * [`sha256`](./sha256.html) calculates the same hash but returns the result
    37    in a more-verbose hexadecimal encoding.