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.

Sign up for GitHub

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): avoid duplicate statements in policy documents #2254

Merged
merged 9 commits into from
Apr 16, 2019
Merged

feat(iam): avoid duplicate statements in policy documents #2254

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
4c24fb3
feat(iam): remove duplicate statements from policy documents
jogold Apr 11, 2019
dec38e4
remove duplicate check in log retention
jogold Apr 11, 2019
fb71270
fix codepipeline-actions integ test
jogold Apr 11, 2019
0baa26a
prevent adding duplicate statement
jogold Apr 12, 2019
8a0c36c
implement IResolvedValuePostProcessor
jogold Apr 12, 2019
185edd0
jsdoc
jogold Apr 12, 2019
2afd5d3
add unit test with base document
jogold Apr 12, 2019
94028c1
use a set for jsonStatements
jogold Apr 15, 2019
c421907
add note
jogold Apr 15, 2019
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
47 changes: 0 additions & 47 deletions ...codepipeline-actions/test/integ.pipeline-code-build-multiple-inputs-outputs.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -191,20 +191,6 @@
}
]
},
{
"Action": [
"codebuild:BatchGetBuilds",
"codebuild:StartBuild",
"codebuild:StopBuild"
],
"Effect": "Allow",
"Resource": {
"Fn::GetAtt": [
"MyBuildProject30DB9D6E",
"Arn"
]
}
},
{
"Action": [
"codebuild:BatchGetBuilds",
Expand Down Expand Up @@ -531,39 +517,6 @@
}
]
},
{
"Action": [
"s3:GetObject*",
"s3:GetBucket*",
"s3:List*",
"s3:DeleteObject*",
"s3:PutObject*",
"s3:Abort*"
],
"Effect": "Allow",
"Resource": [
{
"Fn::GetAtt": [
"MyBucketF68F3FF0",
"Arn"
]
},
{
"Fn::Join": [
"",
[
{
"Fn::GetAtt": [
"MyBucketF68F3FF0",
"Arn"
]
},
"/*"
]
]
}
]
},
{
"Action": [
"s3:GetObject*",
Expand Down
14 changes: 0 additions & 14 deletions ...ges/@aws-cdk/aws-codepipeline-actions/test/integ.pipeline-code-commit-build.expected.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -278,20 +278,6 @@
]
}
},
{
"Action": [
"codebuild:BatchGetBuilds",
"codebuild:StartBuild",
"codebuild:StopBuild"
],
"Effect": "Allow",
"Resource": {
"Fn::GetAtt": [
"MyBuildProject30DB9D6E",
"Arn"
]
}
},
{
"Action": [
"codebuild:BatchGetBuilds",
Expand Down
44 changes: 38 additions & 6 deletions packages/@aws-cdk/aws-iam/lib/policy-document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,15 @@ import { Default, RegionInfo } from '@aws-cdk/region-info';
import { IPrincipal } from './principals';
import { mergePrincipal } from './util';

export class PolicyDocument extends cdk.Token {
export class PolicyDocument extends cdk.Token implements cdk.IResolvedValuePostProcessor {
private statements = new Array<PolicyStatement>();

/**
* Creates a new IAM policy document.
* @param defaultDocument An IAM policy document to use as an initial
* policy. All statements of this document will be copied in.
*/
constructor(private readonly baseDocument?: any) {
constructor(private readonly baseDocument: any = {}) {
super();
}

Expand All @@ -20,13 +20,40 @@ export class PolicyDocument extends cdk.Token {
return undefined;
}

const doc = this.baseDocument || { };
doc.Statement = doc.Statement || [ ];
doc.Version = doc.Version || '2012-10-17';
doc.Statement = doc.Statement.concat(this.statements);
const doc = {
...this.baseDocument,
Statement: (this.baseDocument.Statement || []).concat(this.statements),
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This concatenation happens at construction time - when this.statements is guaranteed to be empty. You need to wrap this in a Token so it is done at synthesis time.

Copy link
Contributor Author

@jogold jogold Apr 15, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It happens in resolve() not constructor(), it was like that before.

https://github.com/awslabs/aws-cdk/blob/b61707896582373c4526129945ddaac20055f313/packages/%40aws-cdk/aws-iam/lib/policy-document.ts#L23-L27

Version: this.baseDocument.Version || '2012-10-17'
};

return doc;
}

/**
* Removes duplicate statements
*/
public postProcess(input: any, _context: cdk.ResolveContext): any {
if (!input || !input.Statement) {
return input;
}

const jsonStatements = new Set<string>();
const uniqueStatements: PolicyStatement[] = [];

for (const statement of input.Statement) {
const jsonStatement = JSON.stringify(statement);
if (!jsonStatements.has(jsonStatement)) {
uniqueStatements.push(statement);
jsonStatements.add(jsonStatement);
}
}

return {
...input,
Statement: uniqueStatements
};
}

get isEmpty(): boolean {
return this.statements.length === 0;
}
Expand All @@ -39,6 +66,11 @@ export class PolicyDocument extends cdk.Token {
return this.statements.length;
}

/**
* Adds a statement to the policy document.
*
* @param statement the statement to add.
*/
public addStatement(statement: PolicyStatement): PolicyDocument {
this.statements.push(statement);
return this;
Expand Down
143 changes: 126 additions & 17 deletions packages/@aws-cdk/aws-iam/test/test.policy-document.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,30 +212,58 @@ export = {
'statementCount returns the number of statement in the policy document'(test: Test) {
const p = new PolicyDocument();
test.equal(p.statementCount, 0);
p.addStatement(new PolicyStatement());
p.addStatement(new PolicyStatement().addAction('action1'));
test.equal(p.statementCount, 1);
p.addStatement(new PolicyStatement());
p.addStatement(new PolicyStatement().addAction('action2'));
test.equal(p.statementCount, 2);
test.done();
},

'the { AWS: "*" } principal is represented as `Anyone` or `AnyPrincipal`'(test: Test) {
const stack = new Stack();
const p = new PolicyDocument();
'{ AWS: "*" } principal': {
'is represented as `Anyone`'(test: Test) {
const stack = new Stack();
const p = new PolicyDocument();

p.addStatement(new PolicyStatement().addPrincipal(new Anyone()));
p.addStatement(new PolicyStatement().addPrincipal(new AnyPrincipal()));
p.addStatement(new PolicyStatement().addAnyPrincipal());
p.addStatement(new PolicyStatement().addPrincipal(new Anyone()));

test.deepEqual(stack.node.resolve(p), {
Statement: [
{ Effect: 'Allow', Principal: '*' },
{ Effect: 'Allow', Principal: '*' },
{ Effect: 'Allow', Principal: '*' }
],
Version: '2012-10-17'
});
test.done();
test.deepEqual(stack.node.resolve(p), {
Statement: [
{ Effect: 'Allow', Principal: '*' }
],
Version: '2012-10-17'
});
test.done();
},

'is represented as `AnyPrincipal`'(test: Test) {
const stack = new Stack();
const p = new PolicyDocument();

p.addStatement(new PolicyStatement().addPrincipal(new AnyPrincipal()));

test.deepEqual(stack.node.resolve(p), {
Statement: [
{ Effect: 'Allow', Principal: '*' }
],
Version: '2012-10-17'
});
test.done();
},

'is represented as `addAnyPrincipal`'(test: Test) {
const stack = new Stack();
const p = new PolicyDocument();

p.addStatement(new PolicyStatement().addAnyPrincipal());

test.deepEqual(stack.node.resolve(p), {
Statement: [
{ Effect: 'Allow', Principal: '*' }
],
Version: '2012-10-17'
});
test.done();
}
},

'addAwsPrincipal/addArnPrincipal are the aliases'(test: Test) {
Expand Down Expand Up @@ -425,4 +453,85 @@ export = {
test.done();
}
},

'duplicate statements': {

'without tokens'(test: Test) {
// GIVEN
const stack = new Stack();
const p = new PolicyDocument();

const statement = new PolicyStatement()
.addResources('resource1', 'resource2')
.addActions('action1', 'action2')
.addServicePrincipal('service')
.addConditions({
a: {
b: 'c'
},
d: {
e: 'f'
}
});

// WHEN
p.addStatement(statement);
p.addStatement(statement);
p.addStatement(statement);

// THEN
test.equal(stack.node.resolve(p).Statement.length, 1);
test.done();
},

'with tokens'(test: Test) {
// GIVEN
const stack = new Stack();
const p = new PolicyDocument();

const statement1 = new PolicyStatement()
.addResource(new Token(() => 'resource').toString())
.addAction(new Token(() => 'action').toString());
const statement2 = new PolicyStatement()
.addResource(new Token(() => 'resource').toString())
.addAction(new Token(() => 'action').toString());

// WHEN
p.addStatement(statement1);
p.addStatement(statement2);

// THEN
test.equal(stack.node.resolve(p).Statement.length, 1);
test.done();
},

'with base document'(test: Test) {
// GIVEN
const stack = new Stack();

// WHEN
const p = new PolicyDocument({
Statement: [
{
Action: 'action',
Effect: 'Allow',
Resource: 'resource'
},
{
Action: 'action',
Effect: 'Allow',
Resource: 'resource'
}
]
});

p.addStatement(new PolicyStatement()
.addAction('action')
.addResource('resource'));

// THEN
test.equal(stack.node.resolve(p).Statement.length, 1);
test.done();
}
}
};
18 changes: 8 additions & 10 deletions packages/@aws-cdk/aws-lambda/lib/log-retention.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,16 +39,14 @@ export class LogRetention extends cdk.Construct {
lambdaPurpose: 'LogRetention',
});

if (provider.role && !provider.role.node.tryFindChild('DefaultPolicy')) { // Avoid duplicate statements
provider.role.addToPolicy(
new iam.PolicyStatement()
.addActions('logs:PutRetentionPolicy', 'logs:DeleteRetentionPolicy')
// We need '*' here because we will also put a retention policy on
// the log group of the provider function. Referencing it's name
// creates a CF circular dependency.
.addAllResources()
);
}
provider.addToRolePolicy( // Duplicate statements will be deduplicated by `PolicyDocument`
new iam.PolicyStatement()
.addActions('logs:PutRetentionPolicy', 'logs:DeleteRetentionPolicy')
// We need '*' here because we will also put a retention policy on
// the log group of the provider function. Referencing it's name
// creates a CF circular dependency.
.addAllResources()
);

// Need to use a CfnResource here to prevent lerna dependency cycles
// @aws-cdk/aws-cloudformation -> @aws-cdk/aws-lambda -> @aws-cdk/aws-cloudformation
Expand Down