image-scanner-with-trivy 0.0.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/.gitattributes +26 -0
- package/.jsii +3950 -0
- package/.prettierignore +1 -0
- package/.prettierrc.json +8 -0
- package/.projenrc.ts +80 -0
- package/API.md +521 -0
- package/LICENSE +202 -0
- package/README.md +49 -0
- package/assets/lambda/Dockerfile +32 -0
- package/assets/lambda/dist/index.js +7 -0
- package/assets/lambda/index.ts +73 -0
- package/lib/index.d.ts +186 -0
- package/lib/index.js +92 -0
- package/lib/integ.d.ts +1 -0
- package/lib/integ.js +25 -0
- package/package.json +103 -0
package/LICENSE
ADDED
|
@@ -0,0 +1,202 @@
|
|
|
1
|
+
|
|
2
|
+
Apache License
|
|
3
|
+
Version 2.0, January 2004
|
|
4
|
+
http://www.apache.org/licenses/
|
|
5
|
+
|
|
6
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
7
|
+
|
|
8
|
+
1. Definitions.
|
|
9
|
+
|
|
10
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
11
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
12
|
+
|
|
13
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
14
|
+
the copyright owner that is granting the License.
|
|
15
|
+
|
|
16
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
17
|
+
other entities that control, are controlled by, or are under common
|
|
18
|
+
control with that entity. For the purposes of this definition,
|
|
19
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
20
|
+
direction or management of such entity, whether by contract or
|
|
21
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
22
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
23
|
+
|
|
24
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
25
|
+
exercising permissions granted by this License.
|
|
26
|
+
|
|
27
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
28
|
+
including but not limited to software source code, documentation
|
|
29
|
+
source, and configuration files.
|
|
30
|
+
|
|
31
|
+
"Object" form shall mean any form resulting from mechanical
|
|
32
|
+
transformation or translation of a Source form, including but
|
|
33
|
+
not limited to compiled object code, generated documentation,
|
|
34
|
+
and conversions to other media types.
|
|
35
|
+
|
|
36
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
37
|
+
Object form, made available under the License, as indicated by a
|
|
38
|
+
copyright notice that is included in or attached to the work
|
|
39
|
+
(an example is provided in the Appendix below).
|
|
40
|
+
|
|
41
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
42
|
+
form, that is based on (or derived from) the Work and for which the
|
|
43
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
44
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
45
|
+
of this License, Derivative Works shall not include works that remain
|
|
46
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
47
|
+
the Work and Derivative Works thereof.
|
|
48
|
+
|
|
49
|
+
"Contribution" shall mean any work of authorship, including
|
|
50
|
+
the original version of the Work and any modifications or additions
|
|
51
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
52
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
53
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
54
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
55
|
+
means any form of electronic, verbal, or written communication sent
|
|
56
|
+
to the Licensor or its representatives, including but not limited to
|
|
57
|
+
communication on electronic mailing lists, source code control systems,
|
|
58
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
59
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
60
|
+
excluding communication that is conspicuously marked or otherwise
|
|
61
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
62
|
+
|
|
63
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
64
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
65
|
+
subsequently incorporated within the Work.
|
|
66
|
+
|
|
67
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
68
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
69
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
70
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
71
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
72
|
+
Work and such Derivative Works in Source or Object form.
|
|
73
|
+
|
|
74
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
75
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
76
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
77
|
+
(except as stated in this section) patent license to make, have made,
|
|
78
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
79
|
+
where such license applies only to those patent claims licensable
|
|
80
|
+
by such Contributor that are necessarily infringed by their
|
|
81
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
82
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
83
|
+
institute patent litigation against any entity (including a
|
|
84
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
85
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
86
|
+
or contributory patent infringement, then any patent licenses
|
|
87
|
+
granted to You under this License for that Work shall terminate
|
|
88
|
+
as of the date such litigation is filed.
|
|
89
|
+
|
|
90
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
91
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
92
|
+
modifications, and in Source or Object form, provided that You
|
|
93
|
+
meet the following conditions:
|
|
94
|
+
|
|
95
|
+
(a) You must give any other recipients of the Work or
|
|
96
|
+
Derivative Works a copy of this License; and
|
|
97
|
+
|
|
98
|
+
(b) You must cause any modified files to carry prominent notices
|
|
99
|
+
stating that You changed the files; and
|
|
100
|
+
|
|
101
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
102
|
+
that You distribute, all copyright, patent, trademark, and
|
|
103
|
+
attribution notices from the Source form of the Work,
|
|
104
|
+
excluding those notices that do not pertain to any part of
|
|
105
|
+
the Derivative Works; and
|
|
106
|
+
|
|
107
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
108
|
+
distribution, then any Derivative Works that You distribute must
|
|
109
|
+
include a readable copy of the attribution notices contained
|
|
110
|
+
within such NOTICE file, excluding those notices that do not
|
|
111
|
+
pertain to any part of the Derivative Works, in at least one
|
|
112
|
+
of the following places: within a NOTICE text file distributed
|
|
113
|
+
as part of the Derivative Works; within the Source form or
|
|
114
|
+
documentation, if provided along with the Derivative Works; or,
|
|
115
|
+
within a display generated by the Derivative Works, if and
|
|
116
|
+
wherever such third-party notices normally appear. The contents
|
|
117
|
+
of the NOTICE file are for informational purposes only and
|
|
118
|
+
do not modify the License. You may add Your own attribution
|
|
119
|
+
notices within Derivative Works that You distribute, alongside
|
|
120
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
121
|
+
that such additional attribution notices cannot be construed
|
|
122
|
+
as modifying the License.
|
|
123
|
+
|
|
124
|
+
You may add Your own copyright statement to Your modifications and
|
|
125
|
+
may provide additional or different license terms and conditions
|
|
126
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
127
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
128
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
129
|
+
the conditions stated in this License.
|
|
130
|
+
|
|
131
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
132
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
133
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
134
|
+
this License, without any additional terms or conditions.
|
|
135
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
136
|
+
the terms of any separate license agreement you may have executed
|
|
137
|
+
with Licensor regarding such Contributions.
|
|
138
|
+
|
|
139
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
140
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
141
|
+
except as required for reasonable and customary use in describing the
|
|
142
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
143
|
+
|
|
144
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
145
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
146
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
147
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
148
|
+
implied, including, without limitation, any warranties or conditions
|
|
149
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
150
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
151
|
+
appropriateness of using or redistributing the Work and assume any
|
|
152
|
+
risks associated with Your exercise of permissions under this License.
|
|
153
|
+
|
|
154
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
155
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
156
|
+
unless required by applicable law (such as deliberate and grossly
|
|
157
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
158
|
+
liable to You for damages, including any direct, indirect, special,
|
|
159
|
+
incidental, or consequential damages of any character arising as a
|
|
160
|
+
result of this License or out of the use or inability to use the
|
|
161
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
162
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
163
|
+
other commercial damages or losses), even if such Contributor
|
|
164
|
+
has been advised of the possibility of such damages.
|
|
165
|
+
|
|
166
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
167
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
168
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
169
|
+
or other liability obligations and/or rights consistent with this
|
|
170
|
+
License. However, in accepting such obligations, You may act only
|
|
171
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
172
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
173
|
+
defend, and hold each Contributor harmless for any liability
|
|
174
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
175
|
+
of your accepting any such warranty or additional liability.
|
|
176
|
+
|
|
177
|
+
END OF TERMS AND CONDITIONS
|
|
178
|
+
|
|
179
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
180
|
+
|
|
181
|
+
To apply the Apache License to your work, attach the following
|
|
182
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
183
|
+
replaced with your own identifying information. (Don't include
|
|
184
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
185
|
+
comment syntax for the file format. We also recommend that a
|
|
186
|
+
file or class name and description of purpose be included on the
|
|
187
|
+
same "printed page" as the copyright notice for easier
|
|
188
|
+
identification within third-party archives.
|
|
189
|
+
|
|
190
|
+
Copyright [yyyy] [name of copyright owner]
|
|
191
|
+
|
|
192
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
193
|
+
you may not use this file except in compliance with the License.
|
|
194
|
+
You may obtain a copy of the License at
|
|
195
|
+
|
|
196
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
197
|
+
|
|
198
|
+
Unless required by applicable law or agreed to in writing, software
|
|
199
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
200
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
201
|
+
See the License for the specific language governing permissions and
|
|
202
|
+
limitations under the License.
|
package/README.md
ADDED
|
@@ -0,0 +1,49 @@
|
|
|
1
|
+
# image-scanner-with-trivy
|
|
2
|
+
|
|
3
|
+
## What is
|
|
4
|
+
|
|
5
|
+
This is an AWS CDK Construct that allows you to **scan a container image in CDK deployment layer with trivy**.
|
|
6
|
+
|
|
7
|
+
If it detects vulnerabilities, it can **prevent the image from being pushed to the ECR for the application**.
|
|
8
|
+
|
|
9
|
+
Since it takes an `imageUri` for ECR as an argument, it can also be used to **simply scan an existing image in the repository**.
|
|
10
|
+
|
|
11
|
+
## Trivy
|
|
12
|
+
|
|
13
|
+
[Trivy](https://github.com/aquasecurity/trivy) is a comprehensive and versatile security scanner.
|
|
14
|
+
|
|
15
|
+
## Usage
|
|
16
|
+
|
|
17
|
+
- Install
|
|
18
|
+
|
|
19
|
+
```sh
|
|
20
|
+
npm install image-scanner-with-trivy
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
- CDK Code
|
|
24
|
+
|
|
25
|
+
```ts
|
|
26
|
+
import { ImageScannerWithTrivy } from 'image-scanner-with-trivy';
|
|
27
|
+
|
|
28
|
+
const repository = new Repository(this, 'ImageRepository', {
|
|
29
|
+
removalPolicy: RemovalPolicy.DESTROY,
|
|
30
|
+
autoDeleteImages: true,
|
|
31
|
+
});
|
|
32
|
+
|
|
33
|
+
const image = new DockerImageAsset(this, 'DockerImage', {
|
|
34
|
+
directory: resolve(__dirname, './'),
|
|
35
|
+
});
|
|
36
|
+
|
|
37
|
+
// Please grant the necessary options on a case-by-case basis.
|
|
38
|
+
const imageScanner = new ImageScannerWithTrivy(this, 'ImageScannerWithTrivy', {
|
|
39
|
+
imageUri: image.imageUri,
|
|
40
|
+
repository: image.repository,
|
|
41
|
+
});
|
|
42
|
+
|
|
43
|
+
// By adding `addDependency`, if the vulnerabilities are detected by `ImageScannerWithTrivy`, the following `ECRDeployment` will not be executed, deployment will fail.
|
|
44
|
+
const ecrDeployment = new ECRDeployment(this, 'DeployImage', {
|
|
45
|
+
src: new DockerImageName(image.imageUri),
|
|
46
|
+
dest: new DockerImageName(`${repository.repositoryUri}:latest`),
|
|
47
|
+
});
|
|
48
|
+
ecrDeployment.node.addDependency(imageScanner);
|
|
49
|
+
```
|
|
@@ -0,0 +1,32 @@
|
|
|
1
|
+
# ------------------------------------------------------------#
|
|
2
|
+
# trivy Install Layer
|
|
3
|
+
# ------------------------------------------------------------#
|
|
4
|
+
FROM arm64v8/alpine:3.18 AS trivy
|
|
5
|
+
|
|
6
|
+
WORKDIR /
|
|
7
|
+
|
|
8
|
+
RUN mkdir -p /trivy
|
|
9
|
+
|
|
10
|
+
RUN apk --update add --no-cache curl
|
|
11
|
+
|
|
12
|
+
RUN \
|
|
13
|
+
VERSION=$( \
|
|
14
|
+
curl --silent "https://api.github.com/repos/aquasecurity/trivy/releases/latest" | \
|
|
15
|
+
grep '"tag_name":' | \
|
|
16
|
+
sed -E 's/.*"v([^"]+)".*/\1/' \
|
|
17
|
+
) && curl -L -o trivy_${VERSION}_Linux-ARM64.tar.gz https://github.com/aquasecurity/trivy/releases/download/v${VERSION}/trivy_${VERSION}_Linux-ARM64.tar.gz \
|
|
18
|
+
&& tar zxf trivy_${VERSION}_Linux-ARM64.tar.gz -C /trivy \
|
|
19
|
+
&& rm trivy_${VERSION}_Linux-ARM64.tar.gz
|
|
20
|
+
|
|
21
|
+
# ------------------------------------------------------------#
|
|
22
|
+
# Run Layer
|
|
23
|
+
# ------------------------------------------------------------#
|
|
24
|
+
FROM public.ecr.aws/lambda/nodejs:18-arm64
|
|
25
|
+
|
|
26
|
+
WORKDIR /
|
|
27
|
+
|
|
28
|
+
COPY dist/index.js /var/task/index.js
|
|
29
|
+
|
|
30
|
+
COPY --from=trivy /trivy/trivy /opt
|
|
31
|
+
|
|
32
|
+
CMD ["index.handler"]
|
|
@@ -0,0 +1,7 @@
|
|
|
1
|
+
"use strict";var S=Object.create;var c=Object.defineProperty;var $=Object.getOwnPropertyDescriptor;var x=Object.getOwnPropertyNames;var I=Object.getPrototypeOf,U=Object.prototype.hasOwnProperty;var k=(r,e)=>{for(var s in e)c(r,s,{get:e[s],enumerable:!0})},h=(r,e,s,n)=>{if(e&&typeof e=="object"||typeof e=="function")for(let t of x(e))!U.call(r,t)&&t!==s&&c(r,t,{get:()=>e[t],enumerable:!(n=$(e,t))||n.enumerable});return r};var w=(r,e,s)=>(s=r!=null?S(I(r)):{},h(e||!r||!r.__esModule?c(s,"default",{value:r,enumerable:!0}):s,r)),E=r=>h(c({},"__esModule",{value:!0}),r);var b={};k(b,{handler:()=>j});module.exports=E(b);var y=require("child_process"),R=require("fs"),C=w(require("path"),1),j=async function(r){let e=r.RequestType,s=r.ResourceProperties.addr,n=r.ResourceProperties.imageUri,t=r.ResourceProperties.ignoreUnfixed,g=r.ResourceProperties.severity,u=r.ResourceProperties.scanners,p=r.ResourceProperties.imageConfigScanners,l=r.ResourceProperties.exitCode,m=r.ResourceProperties.exitOnEol,a=r.ResourceProperties.trivyIgnore,d=r.ResourceProperties.platform;if(!s||!n)throw new Error("addr and imageUri are required.");let P={PhysicalResourceId:s,Data:{}};if(e==="Create"||e==="Update"){let o=[];t==="true"&&o.push("--ignore-unfixed"),g.length&&o.push(`--severity ${g.join(",")}`),u.length&&o.push(`--scanners ${u.join(",")}`),p.length&&o.push(`--image-config-scanners ${p.join(",")}`),l&&o.push(`--exit-code ${l}`),m&&o.push(`--exit-on-eol ${m}`),a.length&&o.push("--ignorefile /tmp/.trivyignore"),d&&o.push(`--platform ${d}`),a.length&&(console.log("trivyignore: "+JSON.stringify(a)),v(a));let f=`/opt/trivy image --no-progress ${o.join(" ")} ${n}`;console.log("command: "+f),console.log("imageUri: "+n);let i=(0,y.spawnSync)(f,{shell:!0});if(console.log(`stderr:
|
|
2
|
+
`+i.stderr?.toString()),console.log(`stdout:
|
|
3
|
+
`+i.stdout?.toString()),i.status!==0)throw new Error(`Error: ${i.error}
|
|
4
|
+
Signal: ${i.signal}
|
|
5
|
+
Status: ${i.status}
|
|
6
|
+
Image Scanner returned fatal errors. You may have vulnerabilities. See logs.`)}return P},v=r=>{let e=C.default.join("/tmp",".trivyignore"),s=(0,R.createWriteStream)(e);r.forEach(n=>{s.write(n+`
|
|
7
|
+
`)}),s.end()};0&&(module.exports={handler});
|
|
@@ -0,0 +1,73 @@
|
|
|
1
|
+
import { spawnSync } from 'child_process';
|
|
2
|
+
import { createWriteStream } from 'fs';
|
|
3
|
+
import path from 'path';
|
|
4
|
+
import { CdkCustomResourceHandler, CdkCustomResourceResponse } from 'aws-lambda';
|
|
5
|
+
|
|
6
|
+
export const handler: CdkCustomResourceHandler = async function (event) {
|
|
7
|
+
const requestType = event.RequestType;
|
|
8
|
+
|
|
9
|
+
const addr = event.ResourceProperties.addr as string;
|
|
10
|
+
const imageUri = event.ResourceProperties.imageUri as string;
|
|
11
|
+
const ignoreUnfixed = event.ResourceProperties.ignoreUnfixed as string;
|
|
12
|
+
const severity = event.ResourceProperties.severity as string[];
|
|
13
|
+
const scanners = event.ResourceProperties.scanners as string[];
|
|
14
|
+
const imageConfigScanners = event.ResourceProperties.imageConfigScanners as string[];
|
|
15
|
+
const exitCode = event.ResourceProperties.exitCode as number;
|
|
16
|
+
const exitOnEol = event.ResourceProperties.exitOnEol as number;
|
|
17
|
+
const trivyIgnore = event.ResourceProperties.trivyIgnore as string[];
|
|
18
|
+
const platform = event.ResourceProperties.platform as string;
|
|
19
|
+
|
|
20
|
+
if (!addr || !imageUri) throw new Error('addr and imageUri are required.');
|
|
21
|
+
|
|
22
|
+
const funcResponse: CdkCustomResourceResponse = {
|
|
23
|
+
PhysicalResourceId: addr,
|
|
24
|
+
Data: {} as { [key: string]: string },
|
|
25
|
+
};
|
|
26
|
+
|
|
27
|
+
if (requestType === 'Create' || requestType === 'Update') {
|
|
28
|
+
const options: string[] = [];
|
|
29
|
+
if (ignoreUnfixed === 'true') options.push('--ignore-unfixed');
|
|
30
|
+
if (severity.length) options.push(`--severity ${severity.join(',')}`);
|
|
31
|
+
if (scanners.length) options.push(`--scanners ${scanners.join(',')}`);
|
|
32
|
+
if (imageConfigScanners.length)
|
|
33
|
+
options.push(`--image-config-scanners ${imageConfigScanners.join(',')}`);
|
|
34
|
+
if (exitCode) options.push(`--exit-code ${exitCode}`);
|
|
35
|
+
if (exitOnEol) options.push(`--exit-on-eol ${exitOnEol}`);
|
|
36
|
+
if (trivyIgnore.length) options.push('--ignorefile /tmp/.trivyignore');
|
|
37
|
+
if (platform) options.push(`--platform ${platform}`);
|
|
38
|
+
|
|
39
|
+
if (trivyIgnore.length) {
|
|
40
|
+
console.log('trivyignore: ' + JSON.stringify(trivyIgnore));
|
|
41
|
+
makeTrivyIgnoreFile(trivyIgnore);
|
|
42
|
+
}
|
|
43
|
+
|
|
44
|
+
const cmd = `/opt/trivy image --no-progress ${options.join(' ')} ${imageUri}`;
|
|
45
|
+
console.log('command: ' + cmd);
|
|
46
|
+
console.log('imageUri: ' + imageUri);
|
|
47
|
+
|
|
48
|
+
const response = spawnSync(cmd, {
|
|
49
|
+
shell: true,
|
|
50
|
+
});
|
|
51
|
+
|
|
52
|
+
console.log('stderr:\n' + response.stderr?.toString());
|
|
53
|
+
console.log('stdout:\n' + response.stdout?.toString());
|
|
54
|
+
|
|
55
|
+
if (response.status !== 0)
|
|
56
|
+
throw new Error(
|
|
57
|
+
`Error: ${response.error}\nSignal: ${response.signal}\nStatus: ${response.status}\nImage Scanner returned fatal errors. You may have vulnerabilities. See logs.`,
|
|
58
|
+
);
|
|
59
|
+
}
|
|
60
|
+
|
|
61
|
+
return funcResponse;
|
|
62
|
+
};
|
|
63
|
+
|
|
64
|
+
const makeTrivyIgnoreFile = (trivyIgnore: string[]) => {
|
|
65
|
+
const trivyIgnoreFilePath = path.join('/tmp', '.trivyignore');
|
|
66
|
+
const trivyIgnoreFile = createWriteStream(trivyIgnoreFilePath);
|
|
67
|
+
|
|
68
|
+
trivyIgnore.forEach((line) => {
|
|
69
|
+
trivyIgnoreFile.write(line + '\n');
|
|
70
|
+
});
|
|
71
|
+
|
|
72
|
+
trivyIgnoreFile.end();
|
|
73
|
+
};
|
package/lib/index.d.ts
ADDED
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
import { IRepository } from 'aws-cdk-lib/aws-ecr';
|
|
2
|
+
import { Construct } from 'constructs';
|
|
3
|
+
/**
|
|
4
|
+
* Enum for Severity Selection
|
|
5
|
+
*
|
|
6
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/scanner/vulnerability/#severity-selection
|
|
7
|
+
*/
|
|
8
|
+
export declare enum Severity {
|
|
9
|
+
UNKNOWN = "UNKNOWN",
|
|
10
|
+
LOW = "LOW",
|
|
11
|
+
MEDIUM = "MEDIUM",
|
|
12
|
+
HIGH = "HIGH",
|
|
13
|
+
CRITICAL = "CRITICAL"
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Enum for Scanners
|
|
17
|
+
*
|
|
18
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/configuration/others/#enabledisable-scanners
|
|
19
|
+
*/
|
|
20
|
+
export declare enum Scanners {
|
|
21
|
+
VULN = "vuln",
|
|
22
|
+
CONFIG = "config",
|
|
23
|
+
SECRET = "secret",
|
|
24
|
+
LICENSE = "license"
|
|
25
|
+
}
|
|
26
|
+
/**
|
|
27
|
+
* Enum for ImageConfigScanners
|
|
28
|
+
*
|
|
29
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/target/container_image/#container-image-metadata
|
|
30
|
+
*/
|
|
31
|
+
export declare enum ImageConfigScanners {
|
|
32
|
+
CONFIG = "config",
|
|
33
|
+
SECRET = "secret"
|
|
34
|
+
}
|
|
35
|
+
export interface ImageScannerWithTrivyProps {
|
|
36
|
+
/**
|
|
37
|
+
* Image URI for scan target.
|
|
38
|
+
*/
|
|
39
|
+
readonly imageUri: string;
|
|
40
|
+
/**
|
|
41
|
+
* Repository including the image URI for scan target.
|
|
42
|
+
*
|
|
43
|
+
* Because of grantPull to CustomResourceLambda.
|
|
44
|
+
*/
|
|
45
|
+
readonly repository: IRepository;
|
|
46
|
+
/**
|
|
47
|
+
* The unfixed/unfixable vulnerabilities mean that the patch has not yet been provided on their distribution.
|
|
48
|
+
*
|
|
49
|
+
* To hide unfixed/unfixable vulnerabilities, you can use the `--ignore-unfixed` flag.
|
|
50
|
+
*
|
|
51
|
+
* @default false
|
|
52
|
+
*
|
|
53
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/scanner/vulnerability/#unfixed-vulnerabilities
|
|
54
|
+
*/
|
|
55
|
+
readonly ignoreUnfixed?: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* Severity Selection
|
|
58
|
+
*
|
|
59
|
+
* The severity is taken from the selected data source since the severity from vendors is more accurate.
|
|
60
|
+
* Using CVE-2023-0464 as an example, while it is rated as "HIGH" in NVD, Red Hat has marked its 'Impact' as "Low". As a result, Trivy will display it as "Low".
|
|
61
|
+
*
|
|
62
|
+
* The severity depends on the compile option, the default configuration, etc. NVD doesn't know how the vendor distributes the software.
|
|
63
|
+
* Red Hat evaluates the severity more accurately. That's why Trivy prefers vendor scores over NVD.
|
|
64
|
+
*
|
|
65
|
+
* It defaults to `CRITICAL` IN THIS CONSTRUCT for safety in CI/CD, but the default configuration of Trivy is "CRITICAL,HIGH,MEDIUM,LOW,UNKNOWN".
|
|
66
|
+
*
|
|
67
|
+
* @default [Severity.CRITICAL]
|
|
68
|
+
*
|
|
69
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/scanner/vulnerability/#severity-selection
|
|
70
|
+
*/
|
|
71
|
+
readonly severity?: Severity[];
|
|
72
|
+
/**
|
|
73
|
+
* Enable/Disable Scanners
|
|
74
|
+
*
|
|
75
|
+
* You can enable/disable scanners with the `scanners`.
|
|
76
|
+
*
|
|
77
|
+
* For example, container image scanning enables vulnerability (VULN) and secret scanners (SECRET) by default.
|
|
78
|
+
* If you don't need secret scanning, it can be disabled by specifying Scanners.VULN only.
|
|
79
|
+
*
|
|
80
|
+
* @default [Security.VULN,Scanners.SECRET]
|
|
81
|
+
*
|
|
82
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/configuration/others/#enabledisable-scanners
|
|
83
|
+
*/
|
|
84
|
+
readonly scanners?: Scanners[];
|
|
85
|
+
/**
|
|
86
|
+
* Enum for ImageConfigScanners
|
|
87
|
+
*
|
|
88
|
+
* Container images have configuration. docker inspect and `docker history` show the information according to the configuration.
|
|
89
|
+
* Trivy scans the configuration of container images for
|
|
90
|
+
*
|
|
91
|
+
* - Misconfigurations
|
|
92
|
+
* - Secrets
|
|
93
|
+
*
|
|
94
|
+
* They are disabled by default. You can enable them with `imageConfigScanners`.
|
|
95
|
+
*
|
|
96
|
+
* @default []
|
|
97
|
+
*
|
|
98
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/target/container_image/#container-image-metadata
|
|
99
|
+
*/
|
|
100
|
+
readonly imageConfigScanners?: ImageConfigScanners[];
|
|
101
|
+
/**
|
|
102
|
+
* Exit Code
|
|
103
|
+
*
|
|
104
|
+
* Use the `exitCode` option if you want to exit with a non-zero exit code.
|
|
105
|
+
*
|
|
106
|
+
* You can specify 0 if you do not want to exit even when vulnerabilities are detected.
|
|
107
|
+
*
|
|
108
|
+
* It defaults to 1 IN THIS CONSTRUCT for safety in CI/CD. In the original trivy, it is 0.
|
|
109
|
+
*
|
|
110
|
+
* @default 1
|
|
111
|
+
*
|
|
112
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/configuration/others/#exit-code
|
|
113
|
+
*/
|
|
114
|
+
readonly exitCode?: number;
|
|
115
|
+
/**
|
|
116
|
+
* Exit on EOL
|
|
117
|
+
*
|
|
118
|
+
* Sometimes you may surprisingly get 0 vulnerabilities in an old image:
|
|
119
|
+
* - Enabling --ignore-unfixed option while all packages have no fixed versions.
|
|
120
|
+
* - Scanning a rather outdated OS (e.g. Ubuntu 10.04).
|
|
121
|
+
*
|
|
122
|
+
* An OS at the end of service/life (EOL) usually gets into this situation, which is definitely full of vulnerabilities.
|
|
123
|
+
* `exitOnEol` can fail scanning on EOL OS with a non-zero code.
|
|
124
|
+
*
|
|
125
|
+
* It defaults to 1 IN THIS CONSTRUCT for safety in CI/CD. In the original trivy, it is 0.
|
|
126
|
+
*
|
|
127
|
+
* @default 1
|
|
128
|
+
*
|
|
129
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/configuration/others/#exit-on-eol
|
|
130
|
+
*/
|
|
131
|
+
readonly exitOnEol?: number;
|
|
132
|
+
/**
|
|
133
|
+
* By Finding IDs
|
|
134
|
+
*
|
|
135
|
+
* The ignore rules written to the .trivyignore in trivy.
|
|
136
|
+
* Put each line you write in the file into one element of the array.
|
|
137
|
+
*
|
|
138
|
+
* @example
|
|
139
|
+
* $ cat .trivyignore
|
|
140
|
+
* # Accept the risk
|
|
141
|
+
* CVE-2018-14618
|
|
142
|
+
*
|
|
143
|
+
* # Accept the risk until 2023-01-01
|
|
144
|
+
* CVE-2019-14697 exp:2023-01-01
|
|
145
|
+
*
|
|
146
|
+
* # No impact in our settings
|
|
147
|
+
* CVE-2019-1543
|
|
148
|
+
*
|
|
149
|
+
* # Ignore misconfigurations
|
|
150
|
+
* AVD-DS-0002
|
|
151
|
+
*
|
|
152
|
+
* # Ignore secrets
|
|
153
|
+
* generic-unwanted-rule
|
|
154
|
+
* aws-account-id
|
|
155
|
+
*
|
|
156
|
+
* @default []
|
|
157
|
+
*
|
|
158
|
+
* @see https://aquasecurity.github.io/trivy/latest/docs/configuration/filtering/#trivyignore
|
|
159
|
+
*/
|
|
160
|
+
readonly trivyIgnore?: string[];
|
|
161
|
+
/**
|
|
162
|
+
* Custom Resource Memory Size (MB)
|
|
163
|
+
*
|
|
164
|
+
* You can specify between `3008` and `10240`.
|
|
165
|
+
*
|
|
166
|
+
* If this Construct execution terminates abnormally due to SIGKILL, try a larger size.
|
|
167
|
+
*
|
|
168
|
+
* Default value (`3008` MB) is Maximum memory size for default AWS account without quota limit increase.
|
|
169
|
+
*
|
|
170
|
+
* @default 3008
|
|
171
|
+
*/
|
|
172
|
+
readonly memorySize?: number;
|
|
173
|
+
/**
|
|
174
|
+
* Scan Image on a specific Architecture and OS
|
|
175
|
+
*
|
|
176
|
+
* By default, Trivy loads an image on a `linux/amd64` machine.
|
|
177
|
+
*
|
|
178
|
+
* To customize this, pass a `platform` argument in the format OS/Architecture for the image, such as `linux/arm64`
|
|
179
|
+
*
|
|
180
|
+
* @default -
|
|
181
|
+
*/
|
|
182
|
+
readonly platform?: string;
|
|
183
|
+
}
|
|
184
|
+
export declare class ImageScannerWithTrivy extends Construct {
|
|
185
|
+
constructor(scope: Construct, id: string, props: ImageScannerWithTrivyProps);
|
|
186
|
+
}
|