2020-09-23 12:15:21 -07:00
---
layout: docs
2024-12-04 13:28:17 -05:00
page_title: AEAD KMS configuration
description: >-
Learn about using the Authenticated Encryption with Associated Data (AEAD) KMS for key management. AEAD is typically used for development workflows or testing.
2020-09-23 12:15:21 -07:00
---
2022-09-13 16:48:06 -07:00
# `aead` KMS
2022-07-12 12:29:35 -07:00
~> **Note:** This is mostly used for `dev` workflows or testing. The key will be exposed
2020-10-13 15:21:09 -04:00
to anyone that can view the configuration file. If using this KMS, consider
using `boundary config encrypt` to encrypt all but the `config` KMS and using an
external KMS for `config` purposes.
2020-09-23 12:15:21 -07:00
```hcl
kms "aead" {
purpose = "worker-auth"
aead_type = "aes-gcm"
key = "8fZBjCUfN0TzjEGLQldGY4+iE9AkOvCfjh7+p0GtRBQ="
key_id = "global_worker-auth"
}
```
2022-11-24 19:07:37 -06:00
- `purpose` - Purpose of this KMS, acceptable values are: `worker-auth`, `worker-auth-storage`,
2024-04-12 15:37:52 -04:00
`root`, `previous-root`, `recovery`, `bsr`, or `config`.
2020-09-23 12:15:21 -07:00
2020-10-13 15:21:09 -04:00
- `aead_type` - The type of encryption this KMS uses. Currently only `aes-gcm` is implemented.
2020-09-23 12:15:21 -07:00
2020-10-13 15:21:09 -04:00
- `key` - The base64-encoded 256-bit encryption key.
2020-09-23 12:15:21 -07:00
- `key_id` - The unique name of this key.
