kms

Google KMS Module

This module allows creating and managing KMS crypto keys and IAM bindings at both the keyring and crypto key level. An existing keyring can be used, or a new one can be created and managed by the module if needed.

When using an existing keyring be mindful about applying IAM bindings, as all bindings used by this module are authoritative, and you might inadvertently override bindings managed by the keyring creator.

Protecting against destroy

In this module no lifecycle blocks are set on resources to prevent destroy, in order to allow for experimentation and testing where rapid apply/destroy cycles are needed. If you plan on using this module to manage non-development resources, clone it and uncomment the lifecycle blocks found in main.tf.

Examples

Using an existing keyring

module "kms" {
  source         = "./fabric/modules/kms"
  project_id     = "my-project"
  iam    = {
    "roles/cloudkms.admin" = ["user:user1@example.com"]
  }
  keyring        = { location = "europe-west1", name = "test" }
  keyring_create = false
  keys           = { key-a = null, key-b = null, key-c = null }
}
# tftest skip

Keyring creation and crypto key rotation and IAM roles

module "kms" {
  source     = "./fabric/modules/kms"
  project_id = "my-project"
  iam_additive = {
    "roles/cloudkms.cryptoKeyEncrypterDecrypter" = [
      "user:user1@example.com", "user:user2@example.com"
    ]
  }
  key_iam = {
    key-a = {
      "roles/cloudkms.admin" = ["user:user3@example.com"]
    }
  }
  key_iam_additive = {
    key-b = {
      "roles/cloudkms.cryptoKeyEncrypterDecrypter" = [
        "user:user4@example.com", "user:user5@example.com"
      ]
    }
  }
  keyring = { location = "europe-west1", name = "test" }
  keys = {
    key-a = null
    key-b = { rotation_period = "604800s", labels = null }
    key-c = { rotation_period = null, labels = { env = "test" } }
  }
}
# tftest modules=1 resources=9

Crypto key purpose

module "kms" {
  source      = "./fabric/modules/kms"
  project_id  = "my-project"
  key_purpose = {
    key-c = {
      purpose = "ASYMMETRIC_SIGN"
      version_template = {
        algorithm        = "EC_SIGN_P384_SHA384"
        protection_level = null
      }
    }
  }
  keyring     = { location = "europe-west1", name = "test" }
  keys        = { key-a = null, key-b = null, key-c = null }
}
# tftest modules=1 resources=4

Variables

name	description	type	required	default
keyring	Keyring attributes.	object({…})	✓
project_id	Project id where the keyring will be created.	string	✓
iam	Keyring IAM bindings in {ROLE => [MEMBERS]} format.	map(list(string))		{}
iam_additive	Keyring IAM additive bindings in {ROLE => [MEMBERS]} format.	map(list(string))		{}
key_iam	Key IAM bindings in {KEY => {ROLE => [MEMBERS]}} format.	map(map(list(string)))		{}
key_iam_additive	Key IAM additive bindings in {ROLE => [MEMBERS]} format.	map(map(list(string)))		{}
key_purpose	Per-key purpose, if not set defaults will be used. If purpose is not ENCRYPT_DECRYPT (the default), version_template.algorithm is required.	map(object({…}))		{}
key_purpose_defaults	Defaults used for key purpose when not defined at the key level. If purpose is not ENCRYPT_DECRYPT (the default), version_template.algorithm is required.	object({…})		{…}
keyring_create	Set to false to manage keys and IAM bindings in an existing keyring.	bool		true
keys	Key names and base attributes. Set attributes to null if not needed.	map(object({…}))		{}
tag_bindings	Tag bindings for this keyring, in key => tag value id format.	map(string)		null

Outputs

name	description	sensitive
id	Keyring self link.
key_ids	Key self links.
keyring	Keyring resource.
keys	Key resources.
location	Keyring location.
name	Keyring name.