-
Notifications
You must be signed in to change notification settings - Fork 4k
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
feat(iam): Permissions Boundaries #12777
Merged
+354
−4
Merged
Changes from all commits
Commits
Show all changes
5 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
94 changes: 94 additions & 0 deletions
94
packages/@aws-cdk/aws-codebuild/lib/untrusted-code-boundary-policy.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,94 @@ | ||
import * as iam from '@aws-cdk/aws-iam'; | ||
import { Construct } from 'constructs'; | ||
|
||
/** | ||
* Construction properties for UntrustedCodeBoundaryPolicy | ||
*/ | ||
export interface UntrustedCodeBoundaryPolicyProps { | ||
/** | ||
* The name of the managed policy. | ||
* | ||
* @default - A name is automatically generated. | ||
*/ | ||
readonly managedPolicyName?: string; | ||
|
||
/** | ||
* Additional statements to add to the default set of statements | ||
* | ||
* @default - No additional statements | ||
*/ | ||
readonly additionalStatements?: iam.PolicyStatement[]; | ||
} | ||
|
||
/** | ||
* Permissions Boundary for a CodeBuild Project running untrusted code | ||
* | ||
* This class is a Policy, intended to be used as a Permissions Boundary | ||
* for a CodeBuild project. It allows most of the actions necessary to run | ||
* the CodeBuild project, but disallows reading from Parameter Store | ||
* and Secrets Manager. | ||
* | ||
* Use this when your CodeBuild project is running untrusted code (for | ||
* example, if you are using one to automatically build Pull Requests | ||
* that anyone can submit), and you want to prevent your future self | ||
* from accidentally exposing Secrets to this build. | ||
* | ||
* (The reason you might want to do this is because otherwise anyone | ||
* who can submit a Pull Request to your project can write a script | ||
* to email those secrets to themselves). | ||
* | ||
* @example | ||
* | ||
* iam.PermissionsBoundary.of(project).apply(new UntrustedCodeBoundaryPolicy(this, 'Boundary')); | ||
*/ | ||
export class UntrustedCodeBoundaryPolicy extends iam.ManagedPolicy { | ||
constructor(scope: Construct, id: string, props: UntrustedCodeBoundaryPolicyProps = {}) { | ||
super(scope, id, { | ||
managedPolicyName: props.managedPolicyName, | ||
description: 'Permissions Boundary Policy for CodeBuild Projects running untrusted code', | ||
statements: [ | ||
new iam.PolicyStatement({ | ||
actions: [ | ||
// For logging | ||
'logs:CreateLogGroup', | ||
'logs:CreateLogStream', | ||
'logs:PutLogEvents', | ||
|
||
// For test reports | ||
'codebuild:CreateReportGroup', | ||
'codebuild:CreateReport', | ||
'codebuild:UpdateReport', | ||
'codebuild:BatchPutTestCases', | ||
'codebuild:BatchPutCodeCoverages', | ||
|
||
// For batch builds | ||
'codebuild:StartBuild', | ||
'codebuild:StopBuild', | ||
'codebuild:RetryBuild', | ||
|
||
// For pulling ECR images | ||
'ecr:GetDownloadUrlForLayer', | ||
'ecr:BatchGetImage', | ||
'ecr:BatchCheckLayerAvailability', | ||
|
||
// For running in a VPC | ||
'ec2:CreateNetworkInterfacePermission', | ||
'ec2:CreateNetworkInterface', | ||
'ec2:DescribeNetworkInterfaces', | ||
'ec2:DeleteNetworkInterface', | ||
'ec2:DescribeSubnets', | ||
'ec2:DescribeSecurityGroups', | ||
'ec2:DescribeDhcpOptions', | ||
'ec2:DescribeVpcs', | ||
|
||
// NOTABLY MISSING: | ||
// - Reading secrets | ||
// - Reading parameterstore | ||
], | ||
resources: ['*'], | ||
}), | ||
...props.additionalStatements ?? [], | ||
], | ||
}); | ||
} | ||
} |
56 changes: 56 additions & 0 deletions
56
packages/@aws-cdk/aws-codebuild/test/test.untrusted-code-boundary.ts
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
import { expect, haveResourceLike, arrayWith } from '@aws-cdk/assert'; | ||
import * as iam from '@aws-cdk/aws-iam'; | ||
import * as cdk from '@aws-cdk/core'; | ||
import { Test } from 'nodeunit'; | ||
import * as codebuild from '../lib'; | ||
|
||
export = { | ||
'can attach permissions boundary to Project'(test: Test) { | ||
// GIVEN | ||
const stack = new cdk.Stack(); | ||
|
||
// WHEN | ||
const project = new codebuild.Project(stack, 'Project', { | ||
source: codebuild.Source.gitHub({ owner: 'a', repo: 'b' }), | ||
}); | ||
iam.PermissionsBoundary.of(project).apply(new codebuild.UntrustedCodeBoundaryPolicy(stack, 'Boundary')); | ||
|
||
// THEN | ||
expect(stack).to(haveResourceLike('AWS::IAM::Role', { | ||
PermissionsBoundary: { Ref: 'BoundaryEA298153' }, | ||
})); | ||
|
||
test.done(); | ||
}, | ||
|
||
'can add additional statements Boundary'(test: Test) { | ||
// GIVEN | ||
const stack = new cdk.Stack(); | ||
|
||
// WHEN | ||
const project = new codebuild.Project(stack, 'Project', { | ||
source: codebuild.Source.gitHub({ owner: 'a', repo: 'b' }), | ||
}); | ||
iam.PermissionsBoundary.of(project).apply(new codebuild.UntrustedCodeBoundaryPolicy(stack, 'Boundary', { | ||
additionalStatements: [ | ||
new iam.PolicyStatement({ | ||
actions: ['a:a'], | ||
resources: ['b'], | ||
}), | ||
], | ||
})); | ||
|
||
// THEN | ||
expect(stack).to(haveResourceLike('AWS::IAM::ManagedPolicy', { | ||
PolicyDocument: { | ||
Statement: arrayWith({ | ||
Effect: 'Allow', | ||
Action: 'a:a', | ||
Resource: 'b', | ||
}), | ||
}, | ||
})); | ||
|
||
test.done(); | ||
}, | ||
}; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,53 @@ | ||
import { Node, IConstruct } from 'constructs'; | ||
import { CfnRole, CfnUser } from './iam.generated'; | ||
import { IManagedPolicy } from './managed-policy'; | ||
|
||
/** | ||
* Modify the Permissions Boundaries of Users and Roles in a construct tree | ||
* | ||
* @example | ||
* | ||
* const policy = ManagedPolicy.fromAwsManagedPolicyName('ReadOnlyAccess'); | ||
* PermissionsBoundary.of(stack).apply(policy); | ||
*/ | ||
export class PermissionsBoundary { | ||
/** | ||
* Access the Permissions Boundaries of a construct tree | ||
*/ | ||
public static of(scope: IConstruct): PermissionsBoundary { | ||
return new PermissionsBoundary(scope); | ||
} | ||
|
||
private constructor(private readonly scope: IConstruct) { | ||
} | ||
|
||
/** | ||
* Apply the given policy as Permissions Boundary to all Roles in the scope | ||
* | ||
* Will override any Permissions Boundaries configured previously; in case | ||
* a Permission Boundary is applied in multiple scopes, the Boundary applied | ||
* closest to the Role wins. | ||
*/ | ||
public apply(boundaryPolicy: IManagedPolicy) { | ||
Node.of(this.scope).applyAspect({ | ||
visit(node: IConstruct) { | ||
if (node instanceof CfnRole || node instanceof CfnUser) { | ||
node.permissionsBoundary = boundaryPolicy.managedPolicyArn; | ||
} | ||
}, | ||
}); | ||
} | ||
|
||
/** | ||
* Remove previously applied Permissions Boundaries | ||
*/ | ||
public clear() { | ||
Node.of(this.scope).applyAspect({ | ||
visit(node: IConstruct) { | ||
if (node instanceof CfnRole || node instanceof CfnUser) { | ||
node.permissionsBoundary = undefined; | ||
} | ||
}, | ||
}); | ||
} | ||
} |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Would it make sense to add a "forbid" statements for these?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Not really. It does the same thing.