-
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #34 from FizzBuzz791/feat/s3-support-2
Feat/s3 support 2
- Loading branch information
Showing
5 changed files
with
235 additions
and
3 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,89 @@ | ||
| import { CfnBucket, CfnBucketPolicy } from "@aws-cdk/aws-s3"; | ||
| import { isResolvableObject, Annotations } from "@aws-cdk/core"; | ||
| import { BaseComplianceChecker } from "./compliance-checker"; | ||
|
|
||
| export interface S3Config { | ||
| serverSideEncryption?: boolean; | ||
| ssl?: boolean; | ||
| } | ||
|
|
||
| export class S3ComplianceChecker extends BaseComplianceChecker< | ||
| CfnBucket | CfnBucketPolicy | ||
| > { | ||
| constructor(config: S3Config) { | ||
| super({ s3: config }); | ||
| } | ||
|
|
||
| checkCompliance(node: CfnBucket | CfnBucketPolicy): void { | ||
| if (this.config.s3?.serverSideEncryption) { | ||
| this.checkServerSideEncryption(node); | ||
| } else if (this.config.s3?.ssl) { | ||
| this.checkSSL(node); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * [S3.4] S3 buckets should have server-side encryption enabled | ||
| * Ref: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-fsbp-controls.html#fsbp-s3-4 | ||
| */ | ||
| private checkServerSideEncryption(node: CfnBucket | CfnBucketPolicy) { | ||
| if (node instanceof CfnBucket) { | ||
| if ( | ||
| !node.hasOwnProperty("bucketEncryption") || | ||
| node.bucketEncryption === undefined || | ||
| isResolvableObject(node.bucketEncryption) | ||
| ) { | ||
| Annotations.of(node).addError( | ||
| "[S3.4] S3 buckets should have server-side encryption enabled" | ||
| ); | ||
| } else if ( | ||
| node.bucketEncryption.serverSideEncryptionConfiguration === undefined || | ||
| isResolvableObject( | ||
| node.bucketEncryption.serverSideEncryptionConfiguration | ||
| ) || | ||
| node.bucketEncryption.serverSideEncryptionConfiguration.length === 0 || | ||
| isResolvableObject( | ||
| node.bucketEncryption.serverSideEncryptionConfiguration[0] | ||
| ) | ||
| ) { | ||
| Annotations.of(node).addError( | ||
| "[S3.4] S3 buckets should have server-side encryption enabled.2" | ||
| ); | ||
| } else { | ||
| const ssec = node.bucketEncryption.serverSideEncryptionConfiguration[0]; | ||
| if ( | ||
| isResolvableObject(ssec.bucketKeyEnabled) || | ||
| ssec.bucketKeyEnabled === false | ||
| ) { | ||
| Annotations.of(node).addError( | ||
| "[S3.4] S3 buckets should have server-side encryption enabled.3" | ||
| ); | ||
| } else if ( | ||
| ssec.serverSideEncryptionByDefault === undefined || | ||
| isResolvableObject(ssec.serverSideEncryptionByDefault) || | ||
| !["AES-256", "aws:kms"].includes( | ||
| ssec.serverSideEncryptionByDefault.sseAlgorithm | ||
| ) | ||
| ) { | ||
| Annotations.of(node).addError( | ||
| "[S3.4] S3 buckets should have server-side encryption enabled.4" | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * [S3.5] S3 buckets should require requests to use Secure Socket Layer | ||
| * Ref: https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-standards-fsbp-controls.html#fsbp-s3-5 | ||
| */ | ||
| private checkSSL(node: CfnBucket | CfnBucketPolicy) { | ||
| if (node instanceof CfnBucketPolicy) { | ||
| if (node.policyDocument?.Statement?.length === 0) { | ||
| Annotations.of(node).addError( | ||
| "[S3.5] S3 buckets should require requests to use Secure Socket Layer" | ||
| ); | ||
| } | ||
| } | ||
| } | ||
| } |
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,36 @@ | ||
| import { AnyPrincipal, Effect, PolicyStatement } from "@aws-cdk/aws-iam"; | ||
| import { Bucket, BucketEncryption } from "@aws-cdk/aws-s3"; | ||
| import { Stack } from "@aws-cdk/core"; | ||
| import { IBuilder } from "../IBuilder"; | ||
|
|
||
| export class S3Builder implements IBuilder<Bucket> { | ||
| private readonly _stack: Stack; | ||
|
|
||
| private _encryption: BucketEncryption = BucketEncryption.KMS_MANAGED; | ||
|
|
||
| constructor(stack: Stack) { | ||
| this._stack = stack; | ||
| } | ||
|
|
||
| withEncryption(encryption: BucketEncryption): S3Builder { | ||
| this._encryption = encryption; | ||
| return this; | ||
| } | ||
|
|
||
| build(): Bucket { | ||
| const bucket = new Bucket(this._stack, "Bucket", { | ||
| encryption: this._encryption, | ||
| }); | ||
| bucket.addToResourcePolicy( | ||
| new PolicyStatement({ | ||
| actions: ["s3:*"], | ||
| effect: Effect.DENY, | ||
| conditions: { | ||
| Bool: { "aws:SecureTransport": false }, | ||
| }, | ||
| principals: [new AnyPrincipal()], | ||
| }) | ||
| ); | ||
| return bucket; | ||
| } | ||
| } |
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,90 @@ | ||
| import { BucketEncryption } from "@aws-cdk/aws-s3"; | ||
| import { App, Stack, Aspects } from "@aws-cdk/core"; | ||
| import { AWSFoundationalSecurityBestPracticesChecker } from "../../src/aws-foundational-security-best-practices"; | ||
| import { S3Builder } from "./S3Builder"; | ||
|
|
||
| describe("S3", () => { | ||
| let app: App; | ||
|
|
||
| beforeEach(() => { | ||
| app = new App(); | ||
| }); | ||
|
|
||
| describe("[S3.4] S3 buckets should have server-side encryption enabled", () => { | ||
| test("Given an S3 Bucket with server-side encryption disabled, When synth is run, Then synth should fail", () => { | ||
| // Arrange | ||
| const stack = new Stack(app, "test-s3-4-stack-fail", {}); | ||
| new S3Builder(stack).withEncryption(BucketEncryption.UNENCRYPTED).build(); | ||
| Aspects.of(app).add(new AWSFoundationalSecurityBestPracticesChecker()); | ||
|
|
||
| // Act | ||
| const synthMessages = app | ||
| .synth({ validateOnSynthesis: true, force: true }) | ||
| .getStackByName("test-s3-4-stack-fail").messages; | ||
|
|
||
| // Assert | ||
| expect(synthMessages.length).toBe(1); | ||
| expect(synthMessages[0].level).toBe("error"); | ||
| expect(synthMessages[0].entry.data).toBe( | ||
| "[S3.4] S3 buckets should have server-side encryption enabled" | ||
| ); | ||
| }); | ||
|
|
||
| test("Given an S3 Bucket with server-side encryption enabled, When synth is run, Then synth should pass", () => { | ||
| // Arrange | ||
| const stack = new Stack(app, "test-s3-4-stack-pass", {}); | ||
| new S3Builder(stack).withEncryption(BucketEncryption.KMS_MANAGED).build(); | ||
| Aspects.of(app).add(new AWSFoundationalSecurityBestPracticesChecker()); | ||
|
|
||
| // Act | ||
| const synthMessages = app | ||
| .synth({ validateOnSynthesis: true, force: true }) | ||
| .getStackByName("test-s3-4-stack-pass").messages; | ||
|
|
||
| // Assert | ||
| expect(synthMessages.length).toBe(0); | ||
| }); | ||
|
|
||
| test("Given an S3 Bucket with server-side encryption disabled and S3.4 is ignored, When synth is run, Then synth should pass", () => { | ||
| // Arrange | ||
| const stack = new Stack(app, "test-s3-4-stack-ignore-pass", {}); | ||
| new S3Builder(stack).withEncryption(BucketEncryption.UNENCRYPTED).build(); | ||
| Aspects.of(app).add( | ||
| new AWSFoundationalSecurityBestPracticesChecker({ | ||
| s3: { serverSideEncryption: false }, | ||
| }) | ||
| ); | ||
|
|
||
| // Act | ||
| const synthMessages = app | ||
| .synth({ validateOnSynthesis: true, force: true }) | ||
| .getStackByName("test-s3-4-stack-ignore-pass").messages; | ||
|
|
||
| // Assert | ||
| expect(synthMessages.length).toBe(0); | ||
| }); | ||
| }); | ||
|
|
||
| // describe("[S3.5] S3 buckets should require requests to use Secure Socket Layer", () => { | ||
| // test("Given an S3 Bucket that doesn't require SSL, When synth is run, Then synth should fail", () => { | ||
| // // Arrange | ||
| // const stack = new Stack(app, "test-s3-5-stack-fail", {}); | ||
| // new S3Builder(stack).build(); | ||
| // Aspects.of(app).add(new AWSFoundationalSecurityBestPracticesChecker()); | ||
|
|
||
| // // Act | ||
| // const synthApp = app | ||
| // .synth({ validateOnSynthesis: true, force: true }) | ||
| // .getStackByName("test-s3-5-stack-fail"); | ||
| // console.log(JSON.stringify(synthApp.template)); | ||
| // const synthMessages = synthApp.messages; | ||
|
|
||
| // // Assert | ||
| // expect(synthMessages.length).toBe(1); | ||
| // expect(synthMessages[0].level).toBe("error"); | ||
| // expect(synthMessages[0].entry.data).toBe( | ||
| // "[S3.5] S3 buckets should require requests to use Secure Socket Layer" | ||
| // ); | ||
| // }); | ||
| // }); | ||
| }); |