vulnly 1.0.0__tar.gz

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.
vulnly-1.0.0/LICENSE ADDED
@@ -0,0 +1,201 @@
1
+ Apache License
2
+ Version 2.0, January 2004
3
+ http://www.apache.org/licenses/
4
+
5
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
6
+
7
+ 1. Definitions.
8
+
9
+ "License" shall mean the terms and conditions for use, reproduction,
10
+ and distribution as defined by Sections 1 through 9 of this document.
11
+
12
+ "Licensor" shall mean the copyright owner or entity authorized by
13
+ the copyright owner that is granting the License.
14
+
15
+ "Legal Entity" shall mean the union of the acting entity and all
16
+ other entities that control, are controlled by, or are under common
17
+ control with that entity. For the purposes of this definition,
18
+ "control" means (i) the power, direct or indirect, to cause the
19
+ direction or management of such entity, whether by contract or
20
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
21
+ outstanding shares, or (iii) beneficial ownership of such entity.
22
+
23
+ "You" (or "Your") shall mean an individual or Legal Entity
24
+ exercising permissions granted by this License.
25
+
26
+ "Source" form shall mean the preferred form for making modifications,
27
+ including but not limited to software source code, documentation
28
+ source, and configuration files.
29
+
30
+ "Object" form shall mean any form resulting from mechanical
31
+ transformation or translation of a Source form, including but
32
+ not limited to compiled object code, generated documentation,
33
+ and conversions to other media types.
34
+
35
+ "Work" shall mean the work of authorship, whether in Source or
36
+ Object form, made available under the License, as indicated by a
37
+ copyright notice that is included in or attached to the work
38
+ (an example is provided in the Appendix below).
39
+
40
+ "Derivative Works" shall mean any work, whether in Source or Object
41
+ form, that is based on (or derived from) the Work and for which the
42
+ editorial revisions, annotations, elaborations, or other modifications
43
+ represent, as a whole, an original work of authorship. For the purposes
44
+ of this License, Derivative Works shall not include works that remain
45
+ separable from, or merely link (or bind by name) to the interfaces of,
46
+ the Work and Derivative Works thereof.
47
+
48
+ "Contribution" shall mean any work of authorship, including
49
+ the original version of the Work and any modifications or additions
50
+ to that Work or Derivative Works thereof, that is intentionally
51
+ submitted to Licensor for inclusion in the Work by the copyright owner
52
+ or by an individual or Legal Entity authorized to submit on behalf of
53
+ the copyright owner. For the purposes of this definition, "submitted"
54
+ means any form of electronic, verbal, or written communication sent
55
+ to the Licensor or its representatives, including but not limited to
56
+ communication on electronic mailing lists, source code control systems,
57
+ and issue tracking systems that are managed by, or on behalf of, the
58
+ Licensor for the purpose of discussing and improving the Work, but
59
+ excluding communication that is conspicuously marked or otherwise
60
+ designated in writing by the copyright owner as "Not a Contribution."
61
+
62
+ "Contributor" shall mean Licensor and any individual or Legal Entity
63
+ on behalf of whom a Contribution has been received by Licensor and
64
+ subsequently incorporated within the Work.
65
+
66
+ 2. Grant of Copyright License. Subject to the terms and conditions of
67
+ this License, each Contributor hereby grants to You a perpetual,
68
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
69
+ copyright license to reproduce, prepare Derivative Works of,
70
+ publicly display, publicly perform, sublicense, and distribute the
71
+ Work and such Derivative Works in Source or Object form.
72
+
73
+ 3. Grant of Patent License. Subject to the terms and conditions of
74
+ this License, each Contributor hereby grants to You a perpetual,
75
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
76
+ (except as stated in this section) patent license to make, have made,
77
+ use, offer to sell, sell, import, and otherwise transfer the Work,
78
+ where such license applies only to those patent claims licensable
79
+ by such Contributor that are necessarily infringed by their
80
+ Contribution(s) alone or by combination of their Contribution(s)
81
+ with the Work to which such Contribution(s) was submitted. If You
82
+ institute patent litigation against any entity (including a
83
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
84
+ or a Contribution incorporated within the Work constitutes direct
85
+ or contributory patent infringement, then any patent licenses
86
+ granted to You under this License for that Work shall terminate
87
+ as of the date such litigation is filed.
88
+
89
+ 4. Redistribution. You may reproduce and distribute copies of the
90
+ Work or Derivative Works thereof in any medium, with or without
91
+ modifications, and in Source or Object form, provided that You
92
+ meet the following conditions:
93
+
94
+ (a) You must give any other recipients of the Work or
95
+ Derivative Works a copy of this License; and
96
+
97
+ (b) You must cause any modified files to carry prominent notices
98
+ stating that You changed the files; and
99
+
100
+ (c) You must retain, in the Source form of any Derivative Works
101
+ that You distribute, all copyright, patent, trademark, and
102
+ attribution notices from the Source form of the Work,
103
+ excluding those notices that do not pertain to any part of
104
+ the Derivative Works; and
105
+
106
+ (d) If the Work includes a "NOTICE" text file as part of its
107
+ distribution, then any Derivative Works that You distribute must
108
+ include a readable copy of the attribution notices contained
109
+ within such NOTICE file, excluding those notices that do not
110
+ pertain to any part of the Derivative Works, in at least one
111
+ of the following places: within a NOTICE text file distributed
112
+ as part of the Derivative Works; within the Source form or
113
+ documentation, if provided along with the Derivative Works; or,
114
+ within a display generated by the Derivative Works, if and
115
+ wherever such third-party notices normally appear. The contents
116
+ of the NOTICE file are for informational purposes only and
117
+ do not modify the License. You may add Your own attribution
118
+ notices within Derivative Works that You distribute, alongside
119
+ or as an addendum to the NOTICE text from the Work, provided
120
+ that such additional attribution notices cannot be construed
121
+ as modifying the License.
122
+
123
+ You may add Your own copyright statement to Your modifications and
124
+ may provide additional or different license terms and conditions
125
+ for use, reproduction, or distribution of Your modifications, or
126
+ for any such Derivative Works as a whole, provided Your use,
127
+ reproduction, and distribution of the Work otherwise complies with
128
+ the conditions stated in this License.
129
+
130
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
131
+ any Contribution intentionally submitted for inclusion in the Work
132
+ by You to the Licensor shall be under the terms and conditions of
133
+ this License, without any additional terms or conditions.
134
+ Notwithstanding the above, nothing herein shall supersede or modify
135
+ the terms of any separate license agreement you may have executed
136
+ with Licensor regarding such Contributions.
137
+
138
+ 6. Trademarks. This License does not grant permission to use the trade
139
+ names, trademarks, service marks, or product names of the Licensor,
140
+ except as required for reasonable and customary use in describing the
141
+ origin of the Work and reproducing the content of the NOTICE file.
142
+
143
+ 7. Disclaimer of Warranty. Unless required by applicable law or
144
+ agreed to in writing, Licensor provides the Work (and each
145
+ Contributor provides its Contributions) on an "AS IS" BASIS,
146
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
147
+ implied, including, without limitation, any warranties or conditions
148
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
149
+ PARTICULAR PURPOSE. You are solely responsible for determining the
150
+ appropriateness of using or redistributing the Work and assume any
151
+ risks associated with Your exercise of permissions under this License.
152
+
153
+ 8. Limitation of Liability. In no event and under no legal theory,
154
+ whether in tort (including negligence), contract, or otherwise,
155
+ unless required by applicable law (such as deliberate and grossly
156
+ negligent acts) or agreed to in writing, shall any Contributor be
157
+ liable to You for damages, including any direct, indirect, special,
158
+ incidental, or consequential damages of any character arising as a
159
+ result of this License or out of the use or inability to use the
160
+ Work (including but not limited to damages for loss of goodwill,
161
+ work stoppage, computer failure or malfunction, or any and all
162
+ other commercial damages or losses), even if such Contributor
163
+ has been advised of the possibility of such damages.
164
+
165
+ 9. Accepting Warranty or Additional Liability. While redistributing
166
+ the Work or Derivative Works thereof, You may choose to offer,
167
+ and charge a fee for, acceptance of support, warranty, indemnity,
168
+ or other liability obligations and/or rights consistent with this
169
+ License. However, in accepting such obligations, You may act only
170
+ on Your own behalf and on Your sole responsibility, not on behalf
171
+ of any other Contributor, and only if You agree to indemnify,
172
+ defend, and hold each Contributor harmless for any liability
173
+ incurred by, or claims asserted against, such Contributor by reason
174
+ of your accepting any such warranty or additional liability.
175
+
176
+ END OF TERMS AND CONDITIONS
177
+
178
+ APPENDIX: How to apply the Apache License to your work.
179
+
180
+ To apply the Apache License to your work, attach the following
181
+ boilerplate notice, with the fields enclosed by brackets "[]"
182
+ replaced with your own identifying information. (Don't include
183
+ the brackets!) The text should be enclosed in the appropriate
184
+ comment syntax for the file format. We also recommend that a
185
+ file or class name and description of purpose be included on the
186
+ same "printed page" as the copyright notice for easier
187
+ identification within third-party archives.
188
+
189
+ Copyright [yyyy] [name of copyright owner]
190
+
191
+ Licensed under the Apache License, Version 2.0 (the "License");
192
+ you may not use this file except in compliance with the License.
193
+ You may obtain a copy of the License at
194
+
195
+ http://www.apache.org/licenses/LICENSE-2.0
196
+
197
+ Unless required by applicable law or agreed to in writing, software
198
+ distributed under the License is distributed on an "AS IS" BASIS,
199
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
200
+ See the License for the specific language governing permissions and
201
+ limitations under the License.
vulnly-1.0.0/PKG-INFO ADDED
@@ -0,0 +1,441 @@
1
+ Metadata-Version: 2.4
2
+ Name: vulnly
3
+ Version: 1.0.0
4
+ Summary: Generate offline, self-contained HTML vulnerability reports from Cloudsmith, Trivy, Grype and Snyk scan output
5
+ Author-email: Colin Moynes <colinmoynes@gmail.com>
6
+ License-Expression: Apache-2.0
7
+ Project-URL: Homepage, https://github.com/colinmoynes/Vulnly
8
+ Project-URL: Issues, https://github.com/colinmoynes/Vulnly/issues
9
+ Keywords: vulnerability,security,scanner,report,trivy,grype,cloudsmith,html
10
+ Classifier: Development Status :: 5 - Production/Stable
11
+ Classifier: Environment :: Console
12
+ Classifier: Intended Audience :: Developers
13
+ Classifier: Intended Audience :: System Administrators
14
+ Classifier: Intended Audience :: Information Technology
15
+ Classifier: Operating System :: OS Independent
16
+ Classifier: Programming Language :: Python :: 3
17
+ Classifier: Programming Language :: Python :: 3.10
18
+ Classifier: Programming Language :: Python :: 3.11
19
+ Classifier: Programming Language :: Python :: 3.12
20
+ Classifier: Programming Language :: Python :: 3.13
21
+ Classifier: Topic :: Security
22
+ Classifier: Topic :: Software Development :: Quality Assurance
23
+ Classifier: Typing :: Typed
24
+ Requires-Python: >=3.10
25
+ Description-Content-Type: text/markdown
26
+ License-File: LICENSE
27
+ Provides-Extra: dev
28
+ Requires-Dist: pytest>=7.0; extra == "dev"
29
+ Dynamic: license-file
30
+
31
+ <img src="https://raw.githubusercontent.com/colinmoynes/vulnly/main/assets/icons/vulnly-readme-banner.png" alt="Vulnly" width="800">
32
+
33
+ Generate self-contained HTML vulnerability reports from Cloudsmith, Trivy, Grype and Snyk.
34
+ Every report is a single file that opens with no network access.
35
+
36
+ ![License](https://img.shields.io/badge/license-Apache%202.0-blue.svg)
37
+ ![Python](https://img.shields.io/badge/python-3.10%2B-blue.svg)
38
+
39
+ ## Installation
40
+
41
+ Install from PyPI (Currently in beta):
42
+
43
+ ```bash
44
+ pip install vulnly
45
+ ```
46
+
47
+ ## Features
48
+
49
+ - **Fully offline reports** — a single HTML file with fonts, charting library and logo embedded. No CDN, no web fonts, no outbound requests when opened, so reports work on airgapped hosts and keep working once archived
50
+ - Supports multiple scanner sources: **Cloudsmith**, **Trivy**, **Grype**, and **Snyk** (auto-detected or via `--source` flag)
51
+ - **Repository summary reports** — automatically detects Cloudsmith repo-level summaries and generates a dedicated overview report with package status breakdown, aggregate vulnerability counts, and per-package detail table
52
+ - Dark and light colour themes via `--theme` flag, plus an in-report toggle so readers can switch without regenerating
53
+ - Interactive doughnut charts showing severity or status distribution (Chart.js, bundled)
54
+ - Severity stat cards (Total, Critical, High, Medium, Low, Unknown) and a count of findings that have a fix available
55
+ - **Top affected packages** — a ranked breakdown showing where findings are concentrated, since one bad dependency usually dominates a scan
56
+ - Auto-generated executive summary, with an alert that distinguishes urgent findings from routine ones and from a clean scan
57
+ - Client-side search, severity filters and a fixable-only toggle, with sortable columns and pagination so large reports stay usable
58
+ - **CSV export** of the current filtered view, safe to open in a spreadsheet
59
+ - Automatic linking for CVE IDs (NVD) and GHSA IDs (GitHub Advisories)
60
+ - Customisable logo — supply via `--logo`, embedded in the report as a data URI
61
+ - Accepts input from a file or stdin (`-`), making it easy to pipe from other tools
62
+ - Input validation with helpful warnings for malformed data
63
+ - Zero external dependencies — uses only the Python standard library
64
+
65
+ ## Quick Start
66
+
67
+ ```bash
68
+ vulnly sample_data.json
69
+ ```
70
+
71
+ This reads `sample_data.json` and writes the report to `reports/` (the default output directory).
72
+
73
+ ### Specify the scanner source
74
+
75
+ The tool auto-detects the input format, but you can be explicit:
76
+
77
+ ```bash
78
+ vulnly scan.json --source trivy
79
+ vulnly scan.json --source grype
80
+ vulnly scan.json --source snyk
81
+ vulnly scan.json --source cloudsmith
82
+ ```
83
+
84
+ If `--source` is specified and the input doesn't match the expected format, the tool exits with a clear error message.
85
+
86
+ ### Repository summary reports
87
+
88
+ Cloudsmith repo-level summary JSON is automatically detected and generates a dedicated repository overview report:
89
+
90
+ ```bash
91
+ vulnly repo_summary.json
92
+ ```
93
+
94
+ The output includes package status cards (vulnerable / no issues / not scanned), aggregate vulnerability severity breakdown, a status distribution chart, and a searchable/filterable package table.
95
+
96
+ ### Specify a custom output path
97
+
98
+ ```bash
99
+ vulnly sample_data.json -o my_report.html
100
+ ```
101
+
102
+ ### Custom logo
103
+
104
+ Use the `--logo` flag to supply a custom logo image. It will be embedded directly in the HTML report header as a base64 data URI:
105
+
106
+ ```bash
107
+ vulnly sample_data.json --logo my-company-logo.png
108
+ ```
109
+
110
+ **Logo requirements:**
111
+
112
+ | Constraint | Limit |
113
+ |---|---|
114
+ | Max file size | 2 MB |
115
+ | Max dimensions | 512 × 512 px |
116
+ | Recommended size | 128 × 128 px to 256 × 256 px |
117
+ | Supported formats | `.png`, `.jpg`, `.jpeg`, `.gif`, `.svg`, `.webp`, `.ico` |
118
+
119
+ If a custom logo exceeds the file size or dimension limits, a warning is printed and the default Vulnly logo is used instead.
120
+
121
+ If no `--logo` is provided, the built-in Vulnly logo is used.
122
+
123
+ ### Theme
124
+
125
+ Choose the theme the report opens in — dark is the default:
126
+
127
+ ```bash
128
+ vulnly sample_data.json --theme light
129
+ vulnly sample_data.json --theme dark
130
+ ```
131
+
132
+ Every report also carries both palettes, so readers can switch with the
133
+ toggle in the report header regardless of which theme it was generated in.
134
+ Their choice is remembered per browser.
135
+
136
+ ### Read from stdin
137
+
138
+ Pipe JSON directly from another command:
139
+
140
+ ```bash
141
+ cat scan_output.json | vulnly -
142
+ ```
143
+
144
+ #### Cloudsmith CLI
145
+
146
+ Pipe vulnerability scan results directly from the Cloudsmith CLI:
147
+
148
+ ```bash
149
+ cloudsmith vulnerabilities WORKSPACE/REPO/PACKAGE_IDENTIFIER --output-format json | vulnly -
150
+ ```
151
+
152
+ #### Trivy
153
+
154
+ Scan an image with Trivy and pipe directly to Vulnly:
155
+
156
+ ```bash
157
+ trivy image -f json nginx:latest | vulnly --source trivy -
158
+ ```
159
+
160
+ #### Grype
161
+
162
+ Scan an image with Grype and pipe directly to Vulnly:
163
+
164
+ ```bash
165
+ grype nginx:latest -o json | vulnly --source grype -
166
+ ```
167
+
168
+ #### Snyk
169
+
170
+ Test a container image with Snyk and pipe directly to Vulnly:
171
+
172
+ ```bash
173
+ snyk container test nginx:latest --json | vulnly --source snyk -
174
+ ```
175
+
176
+ ## Example report
177
+
178
+ The scan summary — severity and fixable counts, the distribution chart, and an
179
+ executive summary whose alert reflects whether anything is actually urgent:
180
+
181
+ <img src="https://raw.githubusercontent.com/colinmoynes/vulnly/main/assets/readme/example.jpg" alt="Vulnly report summary: stat cards, severity distribution chart and executive summary">
182
+
183
+ Further down, the findings themselves — where they are concentrated, then a
184
+ sortable table with search, severity and fixable filters, and CSV export:
185
+
186
+ <img src="https://raw.githubusercontent.com/colinmoynes/vulnly/main/assets/readme/example2.jpg" alt="Vulnly findings: top affected packages breakdown and the filterable vulnerability table">
187
+
188
+ ## Usage
189
+
190
+ ```
191
+ usage: vulnly [-h] [-v] [-o OUTPUT] [--logo LOGO]
192
+ [--theme {dark,light}] [--source SOURCE]
193
+ input
194
+
195
+ Generate an HTML vulnerability report from a JSON input file.
196
+
197
+ positional arguments:
198
+ input Path to the JSON file containing vulnerability
199
+ data (use '-' for stdin)
200
+
201
+ options:
202
+ -h, --help show this help message and exit
203
+ -v, --version show program's version number and exit
204
+ -o, --output OUTPUT Output HTML file path (default: auto-generated
205
+ from package metadata)
206
+ --logo LOGO Path to a custom logo image (embedded in the
207
+ report as a data URI)
208
+ --theme {dark,light} Report colour theme (default: dark)
209
+ --source SOURCE Scanner source format: cloudsmith, grype, snyk,
210
+ trivy (auto-detected if omitted)
211
+ ```
212
+
213
+ ### Environment variables
214
+
215
+ | Variable | Effect |
216
+ | --- | --- |
217
+ | `VULNLY_NO_UPDATE_CHECK` | Set to any value to skip the PyPI version check. |
218
+
219
+ The version check is skipped automatically when stderr is not a terminal, so
220
+ it makes no network request in CI or when output is piped.
221
+
222
+ ## Offline reports
223
+
224
+ A generated report is a single HTML file that makes **no network requests when
225
+ opened**. Everything it needs is embedded:
226
+
227
+ | Asset | Source | Licence |
228
+ | --- | --- | --- |
229
+ | Charting | Chart.js 4.4.0, bundled and inlined | MIT |
230
+ | Typography | Inter, variable font covering weights 400–800 | SIL OFL 1.1 |
231
+ | Logo | Embedded as a data URI | — |
232
+
233
+ This means reports render identically on airgapped hosts and in restricted
234
+ browser environments, and keep rendering years later when a CDN URL would have
235
+ moved. It also means opening a report tells no third party that you did.
236
+
237
+ CVE and GHSA identifiers still link out to NVD and GitHub Advisories, but those
238
+ are ordinary links — nothing is fetched unless the reader clicks one.
239
+
240
+ The generator itself contacts the network only for its PyPI version check,
241
+ which can be disabled with `VULNLY_NO_UPDATE_CHECK` as described above.
242
+
243
+ ## Input JSON Format
244
+
245
+ The generator accepts **multiple input formats** — it auto-detects which one you provide, or you can specify explicitly with `--source`.
246
+
247
+ ### 1. Cloudsmith package format
248
+
249
+ Pass raw JSON output from the Cloudsmith CLI. The tool extracts namespace, repository, package metadata, scan target, and all vulnerabilities automatically.
250
+
251
+ The expected structure has a top-level `data` object containing `package`, `scans`, etc.:
252
+
253
+ ```json
254
+ {
255
+ "data": {
256
+ "created_at": "2025-06-09T08:39:20.441354Z",
257
+ "identifier": "TZR5N4HaO7nTclhz",
258
+ "package": {
259
+ "name": "log4j",
260
+ "url": "https://example.com/packages/my-org/java/wAoMy00juV6N/",
261
+ "version": "28a05d8e..."
262
+ },
263
+ "scans": [
264
+ {
265
+ "target": "Java",
266
+ "type": "jar",
267
+ "results": [
268
+ {
269
+ "vulnerability_id": "CVE-2021-45046",
270
+ "severity": "Critical",
271
+ "title": "DoS in log4j 2.x...",
272
+ "package_name": "org.apache.logging.log4j:log4j-core",
273
+ "affected_version": { "version": "2.8.1" },
274
+ "fixed_version": { "version": "2.16.0, 2.12.2" },
275
+ "cvss_scores": null
276
+ }
277
+ ]
278
+ }
279
+ ]
280
+ }
281
+ }
282
+ ```
283
+
284
+ ### 2. Cloudsmith repository summary format
285
+
286
+ Pass the repo-level summary JSON from Cloudsmith. This is auto-detected and produces a repository overview report instead of a per-package vulnerability report:
287
+
288
+ ```json
289
+ {
290
+ "data": {
291
+ "owner": "my-org",
292
+ "packages": [
293
+ {
294
+ "package": "cloudsmith.io/jdk:9ea72e62...",
295
+ "slug_perm": "XXVmdsZn7OEh",
296
+ "status": "vulnerable",
297
+ "vulnerabilities": {
298
+ "critical": 0,
299
+ "high": 0,
300
+ "low": 1,
301
+ "medium": 2,
302
+ "unknown": 0
303
+ }
304
+ },
305
+ {
306
+ "package": "cloudsmith.io/jdk:5659dd01...",
307
+ "slug_perm": "Ft30zuSymLol",
308
+ "status": "no_issues_found",
309
+ "vulnerabilities": {
310
+ "critical": 0,
311
+ "high": 0,
312
+ "low": 0,
313
+ "medium": 0,
314
+ "unknown": 0
315
+ }
316
+ }
317
+ ],
318
+ "repository": "chainguard"
319
+ }
320
+ }
321
+ ```
322
+
323
+ The report includes status cards (vulnerable, no issues, not scanned), aggregate severity totals, a doughnut chart of package status, and a filterable package table.
324
+
325
+ Package status values: `vulnerable`, `no_issues_found`, `no_scan`.
326
+
327
+ ### 3. Trivy format
328
+
329
+ Pass Trivy's JSON output (`trivy image -f json`). The tool maps `ArtifactName`, `Results[].Vulnerabilities[]`, CVSS scores, and fix versions:
330
+
331
+ ```bash
332
+ trivy image -f json nginx:latest > trivy-output.json
333
+ vulnly trivy-output.json
334
+ ```
335
+
336
+ ### 4. Grype format
337
+
338
+ Pass Grype's JSON output (`grype -o json`). The tool maps `matches[]`, artifact metadata, CVSS scores, and fix versions:
339
+
340
+ ```bash
341
+ grype nginx:latest -o json > grype-output.json
342
+ vulnly grype-output.json
343
+ ```
344
+
345
+ ### 5. Snyk format
346
+
347
+ Pass Snyk's JSON output (`snyk container test --json`). The tool maps `vulnerabilities[]`, CVSS scores, CVE identifiers, and fix versions. Duplicate vulnerability paths are automatically deduplicated:
348
+
349
+ ```bash
350
+ snyk container test nginx:latest --json > snyk-output.json
351
+ vulnly snyk-output.json
352
+ ```
353
+
354
+ ### 6. Simplified format
355
+
356
+ A flat JSON structure is also supported for custom integrations:
357
+
358
+ ```json
359
+ {
360
+ "scan_date": "2026-03-13",
361
+ "repository": "my-org/production-repo",
362
+ "package_name": "my-application",
363
+ "package_version": "1.4.2",
364
+ "package_format": "Docker",
365
+ "scan_target": "debian 9.4",
366
+ "package_size": "~77.4 MB",
367
+ "scan_id": "TZR5N4HaO7nTclhz",
368
+ "vulnerabilities": [
369
+ {
370
+ "severity": "critical",
371
+ "identifier": "CVE-2026-1234",
372
+ "package": "openssl",
373
+ "affected_version": "1.1.1t",
374
+ "fixed_version": "1.1.1u",
375
+ "title": "Heap buffer overflow in OpenSSL",
376
+ "cvss": 9.8
377
+ }
378
+ ]
379
+ }
380
+ ```
381
+
382
+ #### Top-level fields
383
+
384
+ | Field | Required | Description |
385
+ |---|---|---|
386
+ | `scan_date` | Yes | Date the scan was performed (`YYYY-MM-DD`) |
387
+ | `repository` | Yes | Namespace/repository path (e.g. `my-org/production-repo`) |
388
+ | `package_name` | Yes | Name of the scanned package |
389
+ | `package_version` | Yes | Version of the scanned package |
390
+ | `package_format` | No | Package format (e.g. `Docker`, `Maven`). Defaults to `Unknown` |
391
+ | `scan_target` | No | Scan target OS/platform (e.g. `debian 9.4`). Defaults to `Unknown` |
392
+ | `package_size` | No | Human-readable package size (e.g. `~77.4 MB`). Defaults to `Unknown` |
393
+ | `scan_id` | No | Unique scan identifier. Defaults to `N/A` |
394
+ | `vulnerabilities` | Yes | Array of vulnerability objects |
395
+
396
+ #### Vulnerability object fields
397
+
398
+ | Field | Required | Description |
399
+ |---|---|---|
400
+ | `severity` | Yes | One of `critical`, `high`, `medium`, `low` (case-insensitive) |
401
+ | `identifier` | Yes | CVE ID or other identifier (e.g. `GHSA-...`). CVE IDs are auto-linked to NVD; GHSA IDs are linked to GitHub Advisories |
402
+ | `package` | Yes | Name of the affected dependency |
403
+ | `affected_version` | No | The vulnerable version |
404
+ | `fixed_version` | No | The version containing the fix, or `"N/A"` / omit if no fix is available |
405
+ | `title` | No | Short description of the vulnerability. Auto-generated if omitted |
406
+ | `cvss` | No | CVSS v3 score as a number (e.g. `9.8`). Displayed as `N/A` if omitted |
407
+
408
+ ## Requirements
409
+
410
+ - Python 3.10+
411
+
412
+ ## Terminal Output
413
+
414
+ The script prints a severity breakdown after generating the report:
415
+
416
+ ```
417
+ Report generated: reports/nginx_latest_nginx_latest_a72860cb95fd_grype_vulnerability_report.html (3 vulnerabilities)
418
+ CRITICAL: 1 MEDIUM: 1 LOW: 1
419
+ ```
420
+
421
+ A clean scan says so explicitly:
422
+
423
+ ```
424
+ Report generated: reports/chainguard_nginx_latest_..._trivy_vulnerability_report.html (0 vulnerabilities)
425
+ No vulnerabilities found.
426
+ ```
427
+
428
+ When no `-o` is specified, reports are saved to the `reports/` subfolder. This directory is git-ignored by default.
429
+
430
+ ## Security
431
+
432
+ Vulnly treats scanner output as untrusted: advisory titles and package names
433
+ come from vulnerability feeds, and reports are shared and archived. Generated
434
+ reports load nothing from the network, scanner text is never rendered as
435
+ markup, and CSV exports are inert in a spreadsheet.
436
+
437
+ To report a vulnerability in Vulnly itself, see [SECURITY.md](SECURITY.md).
438
+
439
+ ## License
440
+
441
+ This project is licensed under the Apache License 2.0 — see the [LICENSE](LICENSE) file for details.