aws-cdk: core: permissions boundary not being applied to custom resource role

Describe the bug

I’m deploying a stack through CDK pipelines and have a permissions boundary configured within cdk.json. Every role is being configured app wide with the permissions boundary apart from one which seems to be created by CDK itself for my AwsCustomResource.

Expected Behavior

I expect the permissions boundary to be applied the CDK application app wide and not miss any roles deployed by the CDK application

Current Behavior

The CDK created role is failing to add the permissions boundary to the application.

Reproduction Steps

CDK pipelines is being deployed using bootstrapped roles with a custom qualifier and where the permission boundary is required.

synth_object = cdk.DefaultStackSynthesizer(
    qualifier=config["cdk_synth_qualifier"],
)

AwsCustomResource

response = AwsCustomResource(
    self,
    "describe-enis",
    on_update={
        "service": "EC2",
        "action": "describeNetworkInterfaces",
        "output_paths": output_paths,
        "parameters": {"NetworkInterfaceIds": eni_ids},
        "physical_resource_id": PhysicalResourceId.of(str(random.random())),
    },
    policy=AwsCustomResourcePolicy.from_statements(
        statements=[
            iam.PolicyStatement(
                effect=iam.Effect.ALLOW,
                actions=["ec2:DescribeNetworkInterfaces"],
                resources=["*"],
            ),
        ],
    ),
)

The role in question not being provided the permission boundary AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867

"AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867": {
   "Type": "AWS::IAM::Role",
   "Properties": {
    "AssumeRolePolicyDocument": {
     "Version": "2012-10-17",
     "Statement": [
      {
       "Action": "sts:AssumeRole",
       "Effect": "Allow",
       "Principal": {
        "Service": "lambda.amazonaws.com"
       }
      }
     ]
    },
    "ManagedPolicyArns": [
     {
      "Fn::Sub": "arn:${AWS::Partition}:iam::aws:policy/service-role/AWSLambdaBasicExecutionRole"
     }
    ]
   },

The cdk.json config

"@aws-cdk/core:permissionsBoundary": {
      "name": "cdk-permissions-boundary-policy"
    }

Possible Solution

No response

Additional Information/Context

I have tried adding the permission boundary to the stack itself, as well as the custom resource itself following the documentation here: https://docs.aws.amazon.com/cdk/api/v1/python/aws_cdk.aws_iam/README.html#permissions-boundaries

I have also tried creating a custom aspect to add the stack and the stage but none of these worked either: https://github.com/aws/aws-cdk/issues/3242#issuecomment-561064190

CDK CLI Version

2.141.0

Framework Version

No response

Node.js Version

v22.1.0

OS

Sonoma 14.2.1

Language

Python

Language Version

3.12.3

Other information

No response

About this issue

  • Original URL
  • State: open
  • Created 3 years ago
  • Reactions: 6
  • Comments: 21 (4 by maintainers)

Most upvoted comments

AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867

Hi @dliu864 , apologies for the delay in getting back. The code is in java and I am not that much familiar with it. Although I have been trying to repro it using typescript in my account.

I have marked the issue as P1 for the appropriate traction by the team as it has been reported by many customers.

I found some Typescript CDK code which reproduces the same bug if that helps:

          Same issue found here: my organisation doesn't allow role creation without a boundary attached.

Or this ghost-role (AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867) is not amendable…

Error:

9:36:27 AM | CREATE_FAILED        | AWS::IAM::Role                 | AWSCDKCfnUtilsProv...oviderRoleFE0EE867
Resource handler returned message: "Encountered a permissions error performing a tagging operation, please add required tag permissions. See https://re
post.aws/knowledge-center/cloudformation-tagging-permission-error for how to resolve. Resource handler returned message: "User: arn:aws:sts::2997035557
57:assumed-role/cf-app-noc-deployer-role/AWSCloudFormation is not authorized to perform: iam:CreateRole on resource: arn:aws:iam::299703555757:role/noc
-dmo-appsync-vpce-dev--AWSCDKCfnUtilsProviderCus-5WrO4F59gAcl because no identity-based policy allows the iam:CreateRole action (Service: Iam, Status C
ode: 403, Request ID: 51f6419b-9d7a-4611-b0be-912935de5f0d)"" (RequestToken: 348afcbd-35f2-ecef-c439-617cf13f7225, HandlerErrorCode: UnauthorizedTaggin
gOperation)

Stack:

export class VpceStack extends BaseStack {

    constructor(scope: Construct, id: string, props: BaseStackProps) {
        super(scope, id, props);

        const policies = new LambdaPolicies(this.locals);

        const defaultRole = new Role(this, this.id('lambda-basic-role'), {
            roleName: this.name('basic-role'),
            assumedBy: new ServicePrincipal('lambda.amazonaws.com'),
            managedPolicies: policies.managedPolicies(this),
            permissionsBoundary: this.project.defaultLambdaBoundary(),
            inlinePolicies: policies.inlinePolicies(this.project.cmk().keyArn),
        });

        // Retrieve VPC Restricted
        const vpcRestricted = Vpc.fromLookup(this, this.id("vpc-restricted"), {
            isDefault: false,
            vpcId: "vpc-02de2f0d152316a2b"
        });

        // Security groups
        const vpceAppsyncSG = new ec2.SecurityGroup(
            this, this.id("vpce-appsync-sg"),
            {
                vpc: vpcRestricted,
                securityGroupName: this.name("vpce-appsync-sg"),
                description: "Allow Access to AppSync",
                allowAllOutbound: true,
            },
        );

        // Create VPC Endpoint for AppSync with SG previously created
        const vpceAppSync = vpcRestricted.addInterfaceEndpoint(this.id("vpc-endpoint-appsync"),
            {
                service: ec2.InterfaceVpcEndpointAwsService.APP_SYNC,
                privateDnsEnabled: true,
                subnets: { subnetType: ec2.SubnetType.PRIVATE_ISOLATED },
                securityGroups: [vpceAppsyncSG],
            },
        );

        // find IpAddresses of VPCEndpoint attach to a subnet
        const getEndpointPrivateIpAddress = (index: number) => {
            const privateIpAddressField = `NetworkInterfaces.${index}.PrivateIpAddress`;
            const resource = new AwsCustomResource(this, `GetEndpointIp${index}`, {
                role: defaultRole,
                onUpdate: {
                    service: "EC2",
                    action: "describeNetworkInterfaces",
                    outputPaths: [privateIpAddressField],
                    parameters: {
                        NetworkInterfaceIds: vpceAppSync.vpcEndpointNetworkInterfaceIds,
                    },
                    physicalResourceId: PhysicalResourceId.of(privateIpAddressField),
                },
                policy: AwsCustomResourcePolicy.fromSdkCalls({
                    resources: AwsCustomResourcePolicy.ANY_RESOURCE,
                }),
            });
            return resource.getResponseField(privateIpAddressField);
        };

        this.output(this.id('EndpointPrivateIpAddress'), getEndpointPrivateIpAddress(0));
    }
}

_Originally posted by @nocquidant in https://github.com/aws/aws-cdk/issues/22972#issuecomment-2066024383_

Had a back and forth with AWS premium support and was recommended the following solution, which worked for us (thanks Greg!).

The solution for us was to use iam.Role.customize_roles (https://docs.aws.amazon.com/cdk/api/v2/python/aws_cdk.aws_iam/Role.html#aws_cdk.aws_iam.Role.customize_roles) which allowed us to specify custom roles for the roles created by CDK. The only drawback here is that all roles in the stack itself will be replaced by whatever is specified in customize_roles. Any role not specified in customize_roles will not be found in your CloudFormation template on synth and will display an error.

First thing to do is synth your application as normal and take a note of the path of all the roles in the stack. You can find the path under "Metadata": { "aws:cdk:path": "CdkPipelines/ToolingDeployment/tooling-ApiGateway/AWSCDKCfnUtilsProviderCustomResourceProvider/Role" }.

Then at the top of the stack place your customize_roles with the specified paths and your own custom created role. Your own roles have to be created outside of said stack.

iam.Role.customize_roles(
    self,
    prevent_synthesis=True,
    use_precreated_roles={
        "CdkPipelines/ToolingDeployment/tooling-ApiGateway/AWSCDKCfnUtilsProviderCustomResourceProvider/Role": "custom_resource_role_name"
        ],
        "CdkPipelines/ToolingDeployment/tooling-ApiGateway/AWS679f53fac002430cb0da5b7982bd2287/ServiceRole": "custom_resource_role_name"
        ],
    },
)

It’s important to set prevent_synthesis as True or else the CloudFormation template will contain the CDK created roles. It will however error out if a certain role is no addressed in customize_roles.

Hope this helps!

I’ve managed to isolate where exactly the role is being created.

AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867 and it’s corresponding Lambda AWSCDKCfnUtilsProviderCustomResourceProviderHandlerCF82AA57 are created when you reference a certain construct value within AwsCustomResource.

From my example this is when I reference vpc_endpoint_network_interface_ids in the below example.

AwsCustomResource(
    self,
    "describe-enis",
    on_update={
        "service": "EC2",
        "action": "describeNetworkInterfaces",
        "output_paths": output_paths,
        "parameters": {"NetworkInterfaceIds": vpc_endpoint.vpc_endpoint_network_interface_ids },
        "physical_resource_id": PhysicalResourceId.of(str(random.random())),
    },
    policy=AwsCustomResourcePolicy.from_statements(
        statements=[
            iam.PolicyStatement(
                effect=iam.Effect.ALLOW,
                actions=["ec2:DescribeNetworkInterfaces"],
                resources=["*"],
            ),
        ],
    ),
)

If I replace the parameters module in the AwsSdkCall with a random list of strings and synth the role AWSCDKCfnUtilsProviderCustomResourceProviderRoleFE0EE867 and Lambda AWSCDKCfnUtilsProviderCustomResourceProviderHandlerCF82AA57 disappear.

AwsCustomResource(
    self,
    "describe-enis",
    on_update={
        "service": "EC2",
        "action": "describeNetworkInterfaces",
        "output_paths": output_paths,
        "parameters": {"NetworkInterfaceIds": ["w/e"]},
        "physical_resource_id": PhysicalResourceId.of(str(random.random())),
    },
    policy=AwsCustomResourcePolicy.from_statements(
        statements=[
            iam.PolicyStatement(
                effect=iam.Effect.ALLOW,
                actions=["ec2:DescribeNetworkInterfaces"],
                resources=["*"],
            ),
        ],
    ),
)

I tried looking around for what this Lambda does but I can’t find anything. It’s completely without context of the CDK app hence why adding a permission boundary with an custom aspect or an escape hatch won’t work.

I’m not sure of a work around since the only way to make the custom resource work is to add interface ID’s manually which is not really the point of my use case.

Hi Khurana,

I have added you to my repo so you can reproduce the bug. Please let me know how it goes.

Cheers,

David

On Wed, May 29, 2024 at 4:39 AM Shailja Khurana @.***> wrote:

@adamtimmins https://github.com/adamtimmins , Could you please share the the complete repro code.

I also see there is a closed issue similar to the custom role mentioned above - #22972 https://github.com/aws/aws-cdk/issues/22972 and previous attempts have been made for such similar issues like this PR - #14754 https://github.com/aws/aws-cdk/pull/14754. However this still seems like an issue so I am marking this as P1 for the appropriate traction.

— Reply to this email directly, view it on GitHub https://github.com/aws/aws-cdk/issues/30179#issuecomment-2135888177, or unsubscribe https://github.com/notifications/unsubscribe-auth/AI2L3GKCI2FASVSH5J4S2CDZETFNBAVCNFSM6AAAAABHUCKCV2VHI2DSMVQWIX3LMV43OSLTON2WKQ3PNVWWK3TUHMZDCMZVHA4DQMJXG4 . You are receiving this because you commented.Message ID: @.***>