Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add google_kms_key_ring_iam_policy resource and improve iam docs #814

Merged
merged 2 commits into from
Dec 6, 2017
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions google/provider.go
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,7 @@ func Provider() terraform.ResourceProvider {
"google_kms_key_ring": resourceKmsKeyRing(),
"google_kms_key_ring_iam_binding": ResourceIamBinding(IamKmsKeyRingSchema, NewKmsKeyRingIamUpdater),
"google_kms_key_ring_iam_member": ResourceIamMember(IamKmsKeyRingSchema, NewKmsKeyRingIamUpdater),
"google_kms_key_ring_iam_policy": ResourceIamPolicy(IamKmsKeyRingSchema, NewKmsKeyRingIamUpdater),
"google_kms_crypto_key": resourceKmsCryptoKey(),
"google_kms_crypto_key_iam_binding": ResourceIamBinding(IamKmsCryptoKeySchema, NewKmsCryptoKeyIamUpdater),
"google_kms_crypto_key_iam_member": ResourceIamMember(IamKmsCryptoKeySchema, NewKmsCryptoKeyIamUpdater),
Expand Down
155 changes: 99 additions & 56 deletions google/resource_google_kms_key_ring_iam_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,8 @@ import (
"testing"
)

const DEFAULT_KMS_TEST_LOCATION = "us-central1"

func TestAccGoogleKmsKeyRingIamBinding(t *testing.T) {
t.Parallel()

Expand All @@ -20,21 +22,27 @@ func TestAccGoogleKmsKeyRingIamBinding(t *testing.T) {
roleId := "roles/cloudkms.cryptoKeyDecrypter"
keyRingName := fmt.Sprintf("tf-test-%s", acctest.RandString(10))

keyRingId := &kmsKeyRingId{
Project: projectId,
Location: DEFAULT_KMS_TEST_LOCATION,
Name: keyRingName,
}

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
// Test Iam Binding creation
Config: testAccGoogleKmsKeyRingIamBinding_basic(projectId, orgId, billingAccount, account, keyRingName, roleId),
Check: testAccCheckGoogleKmsKeyRingIamBindingExists("foo", roleId, []string{
Check: testAccCheckGoogleKmsKeyRingIam(keyRingId.keyRingId(), roleId, []string{
fmt.Sprintf("serviceAccount:%s@%s.iam.gserviceaccount.com", account, projectId),
}),
},
{
// Test Iam Binding update
Config: testAccGoogleKmsKeyRingIamBinding_update(projectId, orgId, billingAccount, account, keyRingName, roleId),
Check: testAccCheckGoogleKmsKeyRingIamBindingExists("foo", roleId, []string{
Check: testAccCheckGoogleKmsKeyRingIam(keyRingId.keyRingId(), roleId, []string{
fmt.Sprintf("serviceAccount:%s@%s.iam.gserviceaccount.com", account, projectId),
fmt.Sprintf("serviceAccount:%s-2@%s.iam.gserviceaccount.com", account, projectId),
}),
Expand All @@ -53,42 +61,67 @@ func TestAccGoogleKmsKeyRingIamMember(t *testing.T) {
roleId := "roles/cloudkms.cryptoKeyEncrypter"
keyRingName := fmt.Sprintf("tf-test-%s", acctest.RandString(10))

keyRingId := &kmsKeyRingId{
Project: projectId,
Location: DEFAULT_KMS_TEST_LOCATION,
Name: keyRingName,
}

resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
// Test Iam Member creation (no update for member, no need to test)
Config: testAccGoogleKmsKeyRingIamMember_basic(projectId, orgId, billingAccount, account, keyRingName, roleId),
Check: testAccCheckGoogleKmsKeyRingIamMemberExists("foo", roleId,
Check: testAccCheckGoogleKmsKeyRingIam(keyRingId.keyRingId(), roleId, []string{
fmt.Sprintf("serviceAccount:%s@%s.iam.gserviceaccount.com", account, projectId),
),
}),
},
},
})
}

func testAccCheckGoogleKmsKeyRingIamBindingExists(bindingResourceName, roleId string, members []string) resource.TestCheckFunc {
return func(s *terraform.State) error {
bindingRs, ok := s.RootModule().Resources[fmt.Sprintf("google_kms_key_ring_iam_binding.%s", bindingResourceName)]
if !ok {
return fmt.Errorf("Not found: %s", bindingResourceName)
}
func TestAccGoogleKmsKeyRingIamPolicy(t *testing.T) {
t.Parallel()

config := testAccProvider.Meta().(*Config)
keyRingId, err := parseKmsKeyRingId(bindingRs.Primary.Attributes["key_ring_id"], config)
orgId := getTestOrgFromEnv(t)
projectId := acctest.RandomWithPrefix("tf-test")
billingAccount := getTestBillingAccountFromEnv(t)
account := acctest.RandomWithPrefix("tf-test")
roleId := "roles/cloudkms.cryptoKeyEncrypter"
keyRingName := fmt.Sprintf("tf-test-%s", acctest.RandString(10))

if err != nil {
return err
}
keyRingId := &kmsKeyRingId{
Project: projectId,
Location: DEFAULT_KMS_TEST_LOCATION,
Name: keyRingName,
}

p, err := config.clientKms.Projects.Locations.KeyRings.GetIamPolicy(keyRingId.keyRingId()).Do()
resource.Test(t, resource.TestCase{
PreCheck: func() { testAccPreCheck(t) },
Providers: testAccProviders,
Steps: []resource.TestStep{
{
Config: testAccGoogleKmsKeyRingIamPolicy_basic(projectId, orgId, billingAccount, account, keyRingName, roleId),
Check: testAccCheckGoogleKmsKeyRingIam(keyRingId.keyRingId(), roleId, []string{
fmt.Sprintf("serviceAccount:%s@%s.iam.gserviceaccount.com", account, projectId),
}),
},
},
})
}

func testAccCheckGoogleKmsKeyRingIam(keyRingId, role string, members []string) resource.TestCheckFunc {
return func(s *terraform.State) error {
config := testAccProvider.Meta().(*Config)
p, err := config.clientKms.Projects.Locations.KeyRings.GetIamPolicy(keyRingId).Do()
if err != nil {
return err
}

for _, binding := range p.Bindings {
if binding.Role == roleId {
if binding.Role == role {
sort.Strings(members)
sort.Strings(binding.Members)

Expand All @@ -100,41 +133,6 @@ func testAccCheckGoogleKmsKeyRingIamBindingExists(bindingResourceName, roleId st
}
}

return fmt.Errorf("No binding for role %q", roleId)
}
}

func testAccCheckGoogleKmsKeyRingIamMemberExists(n, role, member string) resource.TestCheckFunc {
return func(s *terraform.State) error {
rs, ok := s.RootModule().Resources["google_kms_key_ring_iam_member."+n]
if !ok {
return fmt.Errorf("Not found: %s", n)
}

config := testAccProvider.Meta().(*Config)
keyRingId, err := parseKmsKeyRingId(rs.Primary.Attributes["key_ring_id"], config)

if err != nil {
return err
}

p, err := config.clientKms.Projects.Locations.KeyRings.GetIamPolicy(keyRingId.keyRingId()).Do()
if err != nil {
return err
}

for _, binding := range p.Bindings {
if binding.Role == role {
for _, m := range binding.Members {
if m == member {
return nil
}
}

return fmt.Errorf("Missing member %q, got %v", member, binding.Members)
}
}

return fmt.Errorf("No binding for role %q", role)
}
}
Expand Down Expand Up @@ -211,7 +209,7 @@ resource "google_service_account" "test_account_2" {

resource "google_kms_key_ring" "key_ring" {
project = "${google_project_services.test_project.project}"
location = "us-central1"
location = "%s"
name = "%s"
}

Expand All @@ -223,7 +221,7 @@ resource "google_kms_key_ring_iam_binding" "foo" {
"serviceAccount:${google_service_account.test_account_2.email}"
]
}
`, projectId, orgId, billingAccount, account, account, keyRingName, roleId)
`, projectId, orgId, billingAccount, account, account, DEFAULT_KMS_TEST_LOCATION, keyRingName, roleId)
}

func testAccGoogleKmsKeyRingIamMember_basic(projectId, orgId, billingAccount, account, keyRingName, roleId string) string {
Expand Down Expand Up @@ -252,7 +250,7 @@ resource "google_service_account" "test_account" {

resource "google_kms_key_ring" "key_ring" {
project = "${google_project_services.test_project.project}"
location = "us-central1"
location = "%s"
name = "%s"
}

Expand All @@ -261,5 +259,50 @@ resource "google_kms_key_ring_iam_member" "foo" {
role = "%s"
member = "serviceAccount:${google_service_account.test_account.email}"
}
`, projectId, orgId, billingAccount, account, keyRingName, roleId)
`, projectId, orgId, billingAccount, account, DEFAULT_KMS_TEST_LOCATION, keyRingName, roleId)
}

func testAccGoogleKmsKeyRingIamPolicy_basic(projectId, orgId, billingAccount, account, keyRingName, roleId string) string {
return fmt.Sprintf(`
resource "google_project" "test_project" {
name = "Test project"
project_id = "%s"
org_id = "%s"
billing_account = "%s"
}

resource "google_project_services" "test_project" {
project = "${google_project.test_project.project_id}"

services = [
"cloudkms.googleapis.com",
"iam.googleapis.com",
]
}

resource "google_service_account" "test_account" {
project = "${google_project_services.test_project.project}"
account_id = "%s"
display_name = "Iam Testing Account"
}

resource "google_kms_key_ring" "key_ring" {
project = "${google_project_services.test_project.project}"
location = "%s"
name = "%s"
}

data "google_iam_policy" "foo" {
binding {
role = "%s"

members = ["serviceAccount:${google_service_account.test_account.email}"]
}
}

resource "google_kms_key_ring_iam_policy" "foo" {
key_ring_id = "${google_kms_key_ring.key_ring.id}"
policy_data = "${data.google_iam_policy.foo.policy_data}"
}
`, projectId, orgId, billingAccount, account, DEFAULT_KMS_TEST_LOCATION, keyRingName, roleId)
}
2 changes: 1 addition & 1 deletion website/docs/r/google_kms_crypto_key.html.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: "google"
page_title: "Google: google_kms_crypto_key"
sidebar_current: "docs-google-kms-crypto-key"
sidebar_current: "docs-google-kms-crypto-key-x"
description: |-
Allows creation of a Google Cloud Platform KMS CryptoKey.
---
Expand Down
2 changes: 1 addition & 1 deletion website/docs/r/google_kms_key_ring.html.markdown
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
---
layout: "google"
page_title: "Google: google_kms_key_ring"
sidebar_current: "docs-google-kms-key-ring"
sidebar_current: "docs-google-kms-key-ring-x"
description: |-
Allows creation of a Google Cloud Platform KMS KeyRing.
---
Expand Down
92 changes: 92 additions & 0 deletions website/docs/r/google_kms_key_ring_iam.html.markdown
Original file line number Diff line number Diff line change
@@ -0,0 +1,92 @@
---
layout: "google"
page_title: "Google: google_kms_key_ring_iam"
sidebar_current: "docs-google-kms-key-ring-iam"
description: |-
Collection of resources to manage IAM policy for a Google Cloud KMS key ring.
---

# IAM policy for Google Cloud KMS key ring

Three different resources help you manage your IAM policy for KMS key ring. Each of these resources serves a different use case:

* `google_kms_key_ring_iam_policy`: Authoritative. Sets the IAM policy for the key ring and replaces any existing policy already attached.
* `google_kms_key_ring_iam_binding`: Authoritative for a given role. Updates the IAM policy to grant a role to a list of members. Other roles within the IAM policy for the key ring are preserved.
* `google_kms_key_ring_iam_member`: Non-authoritative. Updates the IAM policy to grant a role to a new member. Other members for the role for the key ring are preserved.

~> **Note:** `google_kms_key_ring_iam_policy` **cannot** be used in conjunction with `google_kms_key_ring_iam_binding` and `google_kms_key_ring_iam_member` or they will fight over what your policy should be.

~> **Note:** `google_kms_key_ring_iam_binding` resources **can be** used in conjunction with `google_kms_key_ring_iam_member` resources **only if** they do not grant privilege to the same role.

## google\_kms\_key\_ring\_iam\_policy

```hcl
data "google_iam_policy" "admin" {
binding {
role = "roles/editor"

members = [
"user:[email protected]",
]
}
}

resource "google_kms_key_ring_iam_policy" "key_ring" {
key_ring_id = "your-key-ring-id"
policy_data = "${data.google_iam_policy.admin.policy_data}"
}
```

## google\_kms\_key\_ring\_iam\_binding

```hcl
resource "google_kms_key_ring_binding" "key_ring" {
key_ring_id = "your-key-ring-id"
role = "roles/editor"

members = [
"user:[email protected]",
]
}
```

## google\_kms\_key\_ring\_iam\_member

```hcl
resource "google_kms_key_ring_iam_member" "key_ring" {
key_ring_id = "your-key-ring-id"
role = "roles/editor"
member = "user:[email protected]"
}
```

## Argument Reference

The following arguments are supported:

* `key_ring_id` - (Required) The key ring ID, in the form
`{project_id}/{location_name}/{key_ring_name}` or
`{location_name}/{key_ring_name}`. In the second form, the provider's
project setting will be used as a fallback.

* `member/members` - (Required) Identities that will be granted the privilege in `role`.
Each entry can have one of the following values:
* **allUsers**: A special identifier that represents anyone who is on the internet; with or without a Google account.
* **allAuthenticatedUsers**: A special identifier that represents anyone who is authenticated with a Google account or a service account.
* **user:{emailid}**: An email address that represents a specific Google account. For example, [email protected] or [email protected].
* **serviceAccount:{emailid}**: An email address that represents a service account. For example, [email protected].
* **group:{emailid}**: An email address that represents a Google group. For example, [email protected].
* **domain:{domain}**: A Google Apps domain name that represents all the users of that domain. For example, google.com or example.com.

* `role` - (Required) The role that should be applied. Only one
`google_kms_key_ring_iam_binding` can be used per role.

* `policy_data` - (Required only by `google_kms_key_ring_iam_policy`) The policy data generated by
a `google_iam_policy` data source.

## Attributes Reference

In addition to the arguments listed above, the following computed attributes are
exported:

* `etag` - (Computed) The etag of the key ring's IAM policy.
Loading