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

Allow usage of service principals for KMS grants #32595

Merged
merged 1 commit into from
Jul 21, 2023
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
3 changes: 3 additions & 0 deletions .changelog/32595.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
```release-note:feature
resource/aws_kms_grant: Allow usage of service principal as grantee and revoker.
```
26 changes: 16 additions & 10 deletions internal/service/kms/grant.go
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,13 @@ func ResourceGrant() *schema.Resource {
Computed: true,
},
"grantee_principal": {
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: verify.ValidARN,
Type: schema.TypeString,
Required: true,
ForceNew: true,
ValidateFunc: validation.Any(
verify.ValidARN,
verify.ValidServicePrincipal,
),
},
"key_id": {
Type: schema.TypeString,
Expand Down Expand Up @@ -122,10 +125,13 @@ func ResourceGrant() *schema.Resource {
ForceNew: true,
},
"retiring_principal": {
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: verify.ValidARN,
Type: schema.TypeString,
Optional: true,
ForceNew: true,
ValidateFunc: validation.Any(
verify.ValidARN,
verify.ValidServicePrincipal,
),
},
},
}
Expand Down Expand Up @@ -331,13 +337,13 @@ func findGrantByTwoPartKeyWithRetry(ctx context.Context, conn *kms.KMS, keyID, g
}

if principal := aws.StringValue(grant.GranteePrincipal); principal != "" {
if !arn.IsARN(principal) {
if !arn.IsARN(principal) && !verify.IsServicePrincipal(principal) {
return retry.RetryableError(fmt.Errorf("grantee principal (%s) is invalid. Perhaps the principal has been deleted or recreated", principal))
}
}

if principal := aws.StringValue(grant.RetiringPrincipal); principal != "" {
if !arn.IsARN(principal) {
if !arn.IsARN(principal) && !verify.IsServicePrincipal(principal) {
return retry.RetryableError(fmt.Errorf("retiring principal (%s) is invalid. Perhaps the principal has been deleted or recreated", principal))
}
}
Expand Down
47 changes: 47 additions & 0 deletions internal/service/kms/grant_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -277,6 +277,41 @@ func TestAccKMSGrant_crossAccountARN(t *testing.T) {
})
}

func TestAccKMSGrant_service(t *testing.T) {
ctx := acctest.Context(t)
resourceName := "aws_kms_grant.test"
rName := sdkacctest.RandomWithPrefix(acctest.ResourcePrefix)
servicePrincipal := "dynamodb.us-west-1.amazonaws.com" //lintignore:AWSAT003

resource.ParallelTest(t, resource.TestCase{
PreCheck: func() { acctest.PreCheck(ctx, t) },
ErrorCheck: acctest.ErrorCheck(t, kms.EndpointsID),
ProtoV5ProviderFactories: acctest.ProtoV5ProviderFactories,
CheckDestroy: testAccCheckGrantDestroy(ctx),
Steps: []resource.TestStep{
{
Config: testAccGrantConfig_service(rName, "\"Encrypt\", \"Decrypt\"", servicePrincipal),
Check: resource.ComposeTestCheckFunc(
testAccCheckGrantExists(ctx, resourceName),
resource.TestCheckResourceAttr(resourceName, "name", rName),
resource.TestCheckResourceAttr(resourceName, "grantee_principal", servicePrincipal),
resource.TestCheckResourceAttr(resourceName, "retiring_principal", servicePrincipal),
resource.TestCheckResourceAttr(resourceName, "operations.#", "2"),
resource.TestCheckTypeSetElemAttr(resourceName, "operations.*", "Encrypt"),
resource.TestCheckTypeSetElemAttr(resourceName, "operations.*", "Decrypt"),
resource.TestCheckResourceAttrPair(resourceName, "key_id", "aws_kms_key.test", "key_id"),
),
},
{
ResourceName: resourceName,
ImportState: true,
ImportStateVerify: true,
ImportStateVerifyIgnore: []string{"grant_token", "retire_on_delete"},
},
},
})
}

func testAccCheckGrantDestroy(ctx context.Context) resource.TestCheckFunc {
return func(s *terraform.State) error {
conn := acctest.Provider.Meta().(*conns.AWSClient).KMSConn(ctx)
Expand Down Expand Up @@ -496,3 +531,15 @@ resource "aws_kms_grant" "test" {
}
`, rName, operations))
}

func testAccGrantConfig_service(rName string, operations string, servicePrincipal string) string {
return acctest.ConfigCompose(testAccGrantConfig_base(rName), fmt.Sprintf(`
resource "aws_kms_grant" "test" {
name = %[1]q
key_id = aws_kms_key.test.key_id
operations = [%[2]s]
grantee_principal = %[3]q
retiring_principal = %[3]q
}
`, rName, operations, servicePrincipal))
}
21 changes: 21 additions & 0 deletions internal/verify/validate.go
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,9 @@ var accountIDRegexp = regexp.MustCompile(`^(aws|aws-managed|third-party|\d{12}|c
var partitionRegexp = regexp.MustCompile(`^aws(-[a-z]+)*$`)
var regionRegexp = regexp.MustCompile(`^[a-z]{2}(-[a-z]+)+-\d$`)

// validates all listed in https://gist.github.com/shortjared/4c1e3fe52bdfa47522cfe5b41e5d6f22
var servicePrincipalRegexp = regexp.MustCompile(`^([a-z0-9-]+\.){1,4}(amazonaws|amazon)\.com$`)

func Valid4ByteASN(v interface{}, k string) (ws []string, errors []error) {
value := v.(string)

Expand Down Expand Up @@ -479,3 +482,21 @@ func ValidAnyDiag(validators ...schema.SchemaValidateDiagFunc) schema.SchemaVali
return results
}
}

func ValidServicePrincipal(v interface{}, k string) (ws []string, errors []error) {
value := v.(string)

if value == "" {
return ws, errors
}

if !IsServicePrincipal(value) {
errors = append(errors, fmt.Errorf("%q (%s) is an invalid Service Principal: invalid prefix value (expecting to match regular expression: %s)", k, value, servicePrincipalRegexp))
}

return ws, errors
}

func IsServicePrincipal(value string) (valid bool) {
return servicePrincipalRegexp.MatchString(value)
}
38 changes: 38 additions & 0 deletions internal/verify/validate_test.go
Original file line number Diff line number Diff line change
Expand Up @@ -737,3 +737,41 @@ func TestFloatGreaterThan(t *testing.T) {
}
}
}

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

v := ""
_, errors := ValidServicePrincipal(v, "test.google.com")
if len(errors) != 0 {
t.Fatalf("%q should not be validated as an Service Principal name: %q", v, errors)
}

validNames := []string{
"a4b.amazonaws.com",
"appstream.application-autoscaling.amazonaws.com",
"alexa-appkit.amazon.com",
"member.org.stacksets.cloudformation.amazonaws.com",
"vpc-flow-logs.amazonaws.com",
"logs.eu-central-1.amazonaws.com",
}
for _, v := range validNames {
_, errors := ValidServicePrincipal(v, "arn")
if len(errors) != 0 {
t.Fatalf("%q should be a valid Service Principal: %q", v, errors)
}
}

invalidNames := []string{
"test.google.com",
"transfer.amz.com",
"test",
"testwithwildcard*",
}
for _, v := range invalidNames {
_, errors := ValidServicePrincipal(v, "arn")
if len(errors) == 0 {
t.Fatalf("%q should be an invalid Service Principal", v)
}
}
}