https://github.com/gbvanrenswoude/cdk-ecr-asset-scanner

cdk-ecr-asset-scanner
https://github.com/gbvanrenswoude/cdk-ecr-asset-scanner

Last synced: about 10 hours ago
JSON representation

cdk-ecr-asset-scanner

• Host: GitHub
• URL: https://github.com/gbvanrenswoude/cdk-ecr-asset-scanner
• Owner: gbvanrenswoude
• License: apache-2.0
• Created: 2021-08-05T10:08:11.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2022-09-15T20:53:29.000Z (over 2 years ago)
• Last Synced: 2025-01-07T20:03:06.867Z (29 days ago)
• Language: Python
• Size: 473 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Unmaintained, this does not work with the new asset naming convention used in cdkv2. Maybe I'll update it one day. Enhanced ECR scanning kind of replaces this (as released by AWS)

# CDK ECR Asset Scanner

The CDK ECR Asset Scanner is a custom L3 `ScannedDockerImageAsset` construct that builds and uploads your container image assets to ECR. After pushing, it will return the vulnerability report status in a Stack Output. In that way, it gives crucial and important security related information directly back to the engineer working with the stack. It aims to improve security insight while working with AWS CDK.

As stated before, `ScannedDockerImageAsset` is a custom L3 construct in the AWS Construct Library that combines the following L2 Constructs:

- DockerImageAsset

- A Custom Resource backed by a Lambda function

- Stack outputs

Because it just combines existing Constructs, this means the `ScannedDockerImageAsset` is a very stable L3 construct, not deemed experimental.

![Terminal](./docs/assets/terminal_output.png)

## USAGE

Run `npm i cdk-ecr-asset-scanner`.

Just add the `ScannedDockerImageAsset` to your imports, and use it exactly like you would a normal `DockerImageAsset`. It will do all the heavy lifting under the hood by itself. Make sure cdk peer dependencies are correct as usual, but npm will point those out (> 1.118.0 cdk versions)

Example (ts):

```ts

import { ScannedDockerImageAsset } from 'cdk-ecr-asset-scanner';

import * as path from 'path';

...

const env = {

  region: process.env.CDK_DEFAULT_REGION,

  account: process.env.CDK_DEFAULT_ACCOUNT,

};

const app = new cdk.App();

export class TestStack extends cdk.Stack {

  constructor(scope: cdk.Construct, id: string, props?: cdk.StackProps) {

    super(scope, id, props);

    // Image without scan

    // const image3 = new DockerImageAsset(this, "zzz", {

    //   directory: path.join(__dirname, "../src/"),

    // });

    // Image with scan

    const image = new ScannedDockerImageAsset(this, "zzz", {

      directory: path.join(__dirname, "../src/"),

    });

    const image3 = ecs.ContainerImage.fromDockerImageAsset(image);

    const taskDefinition = new ecs.FargateTaskDefinition(

      this,

      "test-task-definition",

      {

        memoryLimitMiB: 2048,

        cpu: 1024,

      }

    );

    taskDefinition.addContainer("container_example_three", {

      image: image3,

      environment: {

        TEST_VAR: "THREE",

      },

      logging: new ecs.AwsLogDriver({

        streamPrefix: "three",

      }),

    });

  }

}

new TestStack(app, "hh-stack", { env });

```

## Availability

- Typescript / JS

- Python