-
Notifications
You must be signed in to change notification settings - Fork 4.4k
feat(aws-autoscaling): add flag and aspect to require imdsv2 #16052
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
Merged
Merged
Changes from all commits
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
f12fe19
feat(aws-autoscaling): add aspect to enable/disable imdsv1
jericht fd32844
use aspects api in unit test and use isResolvableObject in core
jericht ca7cc7b
add option to disable imdsv1
jericht b2ed9d7
remove suppressWarnings option
jericht 336da33
remove base class and rename variable to requireImdsv2
jericht a26b1d6
Merge branch 'master' into jericht/autoscaling_imds_aspect
mergify[bot] 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 hidden or 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 hidden or 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 @@ | ||
| export * from './require-imdsv2-aspect'; |
38 changes: 38 additions & 0 deletions
38
packages/@aws-cdk/aws-autoscaling/lib/aspects/require-imdsv2-aspect.ts
This file contains hidden or 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,38 @@ | ||
| import * as cdk from '@aws-cdk/core'; | ||
| import { AutoScalingGroup } from '../auto-scaling-group'; | ||
| import { CfnLaunchConfiguration } from '../autoscaling.generated'; | ||
|
|
||
| /** | ||
| * Aspect that makes IMDSv2 required on instances deployed by AutoScalingGroups. | ||
| */ | ||
| export class AutoScalingGroupRequireImdsv2Aspect implements cdk.IAspect { | ||
| constructor() { | ||
| } | ||
|
|
||
| public visit(node: cdk.IConstruct): void { | ||
| if (!(node instanceof AutoScalingGroup)) { | ||
| return; | ||
| } | ||
|
|
||
| const launchConfig = node.node.tryFindChild('LaunchConfig') as CfnLaunchConfiguration; | ||
| if (cdk.isResolvableObject(launchConfig.metadataOptions)) { | ||
| this.warn(node, 'CfnLaunchConfiguration.MetadataOptions field is a CDK token.'); | ||
| return; | ||
| } | ||
|
|
||
| launchConfig.metadataOptions = { | ||
| ...launchConfig.metadataOptions, | ||
| httpTokens: 'required', | ||
| }; | ||
| } | ||
|
|
||
| /** | ||
| * Adds a warning annotation to a node. | ||
| * | ||
| * @param node The scope to add the warning to. | ||
| * @param message The warning message. | ||
| */ | ||
| protected warn(node: cdk.IConstruct, message: string) { | ||
| cdk.Annotations.of(node).addWarning(`${AutoScalingGroupRequireImdsv2Aspect.name} failed on node ${node.node.id}: ${message}`); | ||
| } | ||
| } |
This file contains hidden or 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 hidden or 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
79 changes: 79 additions & 0 deletions
79
packages/@aws-cdk/aws-autoscaling/test/aspects/require-imdsv2-aspect.test.ts
This file contains hidden or 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,79 @@ | ||
| import { | ||
| expect as expectCDK, | ||
| haveResourceLike, | ||
| } from '@aws-cdk/assert-internal'; | ||
| import '@aws-cdk/assert-internal/jest'; | ||
| import * as ec2 from '@aws-cdk/aws-ec2'; | ||
| import * as cdk from '@aws-cdk/core'; | ||
| import { | ||
| AutoScalingGroup, | ||
| AutoScalingGroupRequireImdsv2Aspect, | ||
| CfnLaunchConfiguration, | ||
| } from '../../lib'; | ||
|
|
||
| describe('AutoScalingGroupRequireImdsv2Aspect', () => { | ||
| let app: cdk.App; | ||
| let stack: cdk.Stack; | ||
| let vpc: ec2.Vpc; | ||
|
|
||
| beforeEach(() => { | ||
| app = new cdk.App(); | ||
| stack = new cdk.Stack(app, 'Stack'); | ||
| vpc = new ec2.Vpc(stack, 'Vpc'); | ||
| }); | ||
|
|
||
| test('warns when metadataOptions is a token', () => { | ||
| // GIVEN | ||
| const asg = new AutoScalingGroup(stack, 'AutoScalingGroup', { | ||
| vpc, | ||
| instanceType: new ec2.InstanceType('t2.micro'), | ||
| machineImage: ec2.MachineImage.latestAmazonLinux(), | ||
| }); | ||
| const launchConfig = asg.node.tryFindChild('LaunchConfig') as CfnLaunchConfiguration; | ||
| launchConfig.metadataOptions = fakeToken(); | ||
| const aspect = new AutoScalingGroupRequireImdsv2Aspect(); | ||
|
|
||
| // WHEN | ||
| cdk.Aspects.of(stack).add(aspect); | ||
|
|
||
| // THEN | ||
| expectCDK(stack).notTo(haveResourceLike('AWS::AutoScaling::LaunchConfiguration', { | ||
| MetadataOptions: { | ||
| HttpTokens: 'required', | ||
| }, | ||
| })); | ||
| expect(asg.node.metadataEntry).toContainEqual({ | ||
| data: expect.stringContaining('CfnLaunchConfiguration.MetadataOptions field is a CDK token.'), | ||
| type: 'aws:cdk:warning', | ||
| trace: undefined, | ||
| }); | ||
| }); | ||
|
|
||
| test('requires IMDSv2', () => { | ||
| // GIVEN | ||
| new AutoScalingGroup(stack, 'AutoScalingGroup', { | ||
| vpc, | ||
| instanceType: new ec2.InstanceType('t2.micro'), | ||
| machineImage: ec2.MachineImage.latestAmazonLinux(), | ||
| }); | ||
| const aspect = new AutoScalingGroupRequireImdsv2Aspect(); | ||
|
|
||
| // WHEN | ||
| cdk.Aspects.of(stack).add(aspect); | ||
|
|
||
| // THEN | ||
| expectCDK(stack).to(haveResourceLike('AWS::AutoScaling::LaunchConfiguration', { | ||
| MetadataOptions: { | ||
| HttpTokens: 'required', | ||
| }, | ||
| })); | ||
| }); | ||
| }); | ||
|
|
||
| function fakeToken(): cdk.IResolvable { | ||
| return { | ||
| creationStack: [], | ||
| resolve: (_c) => {}, | ||
| toString: () => '', | ||
| }; | ||
| } |
This file contains hidden or 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
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.
Uh oh!
There was an error while loading. Please reload this page.