vexpath 0.1.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.
- vexpath-0.1.0/.gitignore +46 -0
- vexpath-0.1.0/LICENSE +201 -0
- vexpath-0.1.0/PKG-INFO +160 -0
- vexpath-0.1.0/README.md +128 -0
- vexpath-0.1.0/pyproject.toml +68 -0
- vexpath-0.1.0/src/vexpath/__init__.py +12 -0
- vexpath-0.1.0/src/vexpath/commands/__init__.py +3 -0
- vexpath-0.1.0/src/vexpath/commands/advisory.py +305 -0
- vexpath-0.1.0/src/vexpath/commands/attest.py +348 -0
- vexpath-0.1.0/src/vexpath/commands/auth.py +235 -0
- vexpath-0.1.0/src/vexpath/commands/policy.py +179 -0
- vexpath-0.1.0/src/vexpath/commands/reach.py +235 -0
- vexpath-0.1.0/src/vexpath/commands/report.py +189 -0
- vexpath-0.1.0/src/vexpath/commands/sbom.py +173 -0
- vexpath-0.1.0/src/vexpath/commands/scan.py +309 -0
- vexpath-0.1.0/src/vexpath/commands/upload.py +104 -0
- vexpath-0.1.0/src/vexpath/commands/vex.py +249 -0
- vexpath-0.1.0/src/vexpath/credentials.py +213 -0
- vexpath-0.1.0/src/vexpath/exit_codes.py +28 -0
- vexpath-0.1.0/src/vexpath/main.py +120 -0
- vexpath-0.1.0/src/vexpath/output.py +96 -0
- vexpath-0.1.0/src/vexpath/py.typed +0 -0
- vexpath-0.1.0/src/vexpath/sources.py +88 -0
- vexpath-0.1.0/tests/test_auth_and_upload.py +499 -0
- vexpath-0.1.0/tests/test_cli.py +1029 -0
- vexpath-0.1.0/tests/test_report_command.py +153 -0
vexpath-0.1.0/.gitignore
ADDED
|
@@ -0,0 +1,46 @@
|
|
|
1
|
+
# Python
|
|
2
|
+
__pycache__/
|
|
3
|
+
*.py[cod]
|
|
4
|
+
*.egg-info/
|
|
5
|
+
.eggs/
|
|
6
|
+
build/
|
|
7
|
+
dist/
|
|
8
|
+
.venv/
|
|
9
|
+
venv/
|
|
10
|
+
|
|
11
|
+
# Tooling caches
|
|
12
|
+
.pytest_cache/
|
|
13
|
+
.mypy_cache/
|
|
14
|
+
.ruff_cache/
|
|
15
|
+
.coverage
|
|
16
|
+
.coverage.*
|
|
17
|
+
htmlcov/
|
|
18
|
+
coverage.xml
|
|
19
|
+
|
|
20
|
+
# Local environment
|
|
21
|
+
.env
|
|
22
|
+
.env.local
|
|
23
|
+
*.local.yml
|
|
24
|
+
|
|
25
|
+
# Scan artefacts produced while dogfooding
|
|
26
|
+
/sbom.cdx.json
|
|
27
|
+
/openvex.json
|
|
28
|
+
/cdx-vex.json
|
|
29
|
+
/attestation.intoto.jsonl
|
|
30
|
+
/results.json
|
|
31
|
+
.vexpath-cache/
|
|
32
|
+
|
|
33
|
+
# Advisory snapshots downloaded at runtime (the frozen test snapshot IS committed)
|
|
34
|
+
/var/
|
|
35
|
+
/data/
|
|
36
|
+
|
|
37
|
+
# Editors and OS
|
|
38
|
+
.vscode/
|
|
39
|
+
.idea/
|
|
40
|
+
*.swp
|
|
41
|
+
.DS_Store
|
|
42
|
+
Thumbs.db
|
|
43
|
+
|
|
44
|
+
# Tailwind standalone binary (downloaded by `make tailwind-install`, not committed)
|
|
45
|
+
/bin/tailwindcss
|
|
46
|
+
/bin/tailwindcss.exe
|
vexpath-0.1.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 2026 Akmal Khan
|
|
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.
|
vexpath-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,160 @@
|
|
|
1
|
+
Metadata-Version: 2.5
|
|
2
|
+
Name: vexpath
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Command-line tool: generate SBOMs, match advisories, analyse reachability and emit signed VEX.
|
|
5
|
+
Project-URL: Homepage, https://github.com/Unknown122-coder/vexpath
|
|
6
|
+
Project-URL: Documentation, https://github.com/Unknown122-coder/vexpath/tree/main/docs
|
|
7
|
+
Project-URL: Repository, https://github.com/Unknown122-coder/vexpath
|
|
8
|
+
Project-URL: Issues, https://github.com/Unknown122-coder/vexpath/issues
|
|
9
|
+
Project-URL: Changelog, https://github.com/Unknown122-coder/vexpath/releases
|
|
10
|
+
Author: Akmal Khan
|
|
11
|
+
License-Expression: Apache-2.0
|
|
12
|
+
License-File: LICENSE
|
|
13
|
+
Keywords: cyclonedx,openvex,reachability,sbom,sca,security,spdx,supply-chain,vex,vulnerability
|
|
14
|
+
Classifier: Development Status :: 4 - Beta
|
|
15
|
+
Classifier: Environment :: Console
|
|
16
|
+
Classifier: Intended Audience :: Developers
|
|
17
|
+
Classifier: Intended Audience :: System Administrators
|
|
18
|
+
Classifier: License :: OSI Approved :: Apache Software License
|
|
19
|
+
Classifier: Operating System :: OS Independent
|
|
20
|
+
Classifier: Programming Language :: Python :: 3
|
|
21
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
22
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
23
|
+
Classifier: Topic :: Security
|
|
24
|
+
Classifier: Topic :: Software Development :: Quality Assurance
|
|
25
|
+
Classifier: Topic :: System :: Software Distribution
|
|
26
|
+
Classifier: Typing :: Typed
|
|
27
|
+
Requires-Python: >=3.12
|
|
28
|
+
Requires-Dist: rich>=13.9
|
|
29
|
+
Requires-Dist: typer>=0.15
|
|
30
|
+
Requires-Dist: vexpath-core==0.1.0
|
|
31
|
+
Description-Content-Type: text/markdown
|
|
32
|
+
|
|
33
|
+
# vexpath
|
|
34
|
+
|
|
35
|
+
**Most of your vulnerability findings cannot run.** vexpath works out which
|
|
36
|
+
ones can, and shows you the call path that proves it.
|
|
37
|
+
|
|
38
|
+
```bash
|
|
39
|
+
uv tool install vexpath # or: pipx install vexpath
|
|
40
|
+
vexpath scan .
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
A scanner tells you that `jinja2` has a critical advisory. vexpath reads the
|
|
44
|
+
commit that fixed it, extracts the functions it changed, builds a call graph
|
|
45
|
+
from your code through your dependencies, and tells you whether anything you
|
|
46
|
+
run can reach them. On five real repositories it cleared 68 of 146 findings as
|
|
47
|
+
unreachable, with the evidence for each.
|
|
48
|
+
|
|
49
|
+
```
|
|
50
|
+
SEVERITY VERDICT ADVISORY COMPONENT REACHABILITY
|
|
51
|
+
--------------------------------------------------------------------------------
|
|
52
|
+
HIGH affected CVE-2026-1234 jinja2 3.1.0 reachable_confirmed
|
|
53
|
+
MEDIUM not_affected CVE-2026-5678 urllib3 2.2.1 unreachable
|
|
54
|
+
|
|
55
|
+
38 findings | 10 reachable | 28 not affected | 0 under investigation
|
|
56
|
+
```
|
|
57
|
+
|
|
58
|
+
## What makes a finding clearable
|
|
59
|
+
|
|
60
|
+
A finding is cleared only when the vulnerable code **provably** cannot run.
|
|
61
|
+
That requires the dependency's own source, so:
|
|
62
|
+
|
|
63
|
+
```bash
|
|
64
|
+
pip install -e . # or uv sync, or poetry install
|
|
65
|
+
vexpath scan .
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
With nothing installed, vexpath still matches advisories but clears nothing —
|
|
69
|
+
an absence of paths through code it never read proves nothing, and it says so
|
|
70
|
+
rather than implying a clean bill of health. `--download-missing` fetches each
|
|
71
|
+
dependency's source from the package index instead (nothing is executed,
|
|
72
|
+
ever).
|
|
73
|
+
|
|
74
|
+
## The gate
|
|
75
|
+
|
|
76
|
+
```bash
|
|
77
|
+
vexpath scan . --policy balanced
|
|
78
|
+
```
|
|
79
|
+
|
|
80
|
+
Exits 1 when a critical or high finding's vulnerable code is provably
|
|
81
|
+
reachable, or when anything in your tree is in CISA's Known Exploited
|
|
82
|
+
Vulnerabilities catalogue. Five presets, or write your own in CEL:
|
|
83
|
+
|
|
84
|
+
```bash
|
|
85
|
+
vexpath policy list
|
|
86
|
+
vexpath scan . --policy 'findings.exists(f, f.kev && f.verdict != "not_affected")'
|
|
87
|
+
```
|
|
88
|
+
|
|
89
|
+
## Exit codes
|
|
90
|
+
|
|
91
|
+
The contract with CI, and fixed:
|
|
92
|
+
|
|
93
|
+
| Code | Meaning |
|
|
94
|
+
|---|---|
|
|
95
|
+
| 0 | Analysis completed and the policy passed |
|
|
96
|
+
| 1 | Analysis completed and the policy **failed** — your dependencies need attention |
|
|
97
|
+
| 2 | Analysis could not complete: a broken lockfile, an unreachable index |
|
|
98
|
+
| 3 | Configuration error: a policy that does not compile, a bad flag |
|
|
99
|
+
|
|
100
|
+
1 and 2 are separate on purpose. A build failing because the code is
|
|
101
|
+
vulnerable must never look like a build failing because the tool broke.
|
|
102
|
+
|
|
103
|
+
## What else it does
|
|
104
|
+
|
|
105
|
+
| Command | What for |
|
|
106
|
+
|---|---|
|
|
107
|
+
| `vexpath scan` | The whole pipeline: SBOM → match → reachability → VEX → gate |
|
|
108
|
+
| `vexpath reach --advisory CVE-…` | Why one verdict is what it is: symbols searched for, which entry points reach them, by what path, and the graph it rests on |
|
|
109
|
+
| `vexpath report results.json --format sarif` | Re-render a scan. Nothing is re-analysed, so the SARIF matches the table |
|
|
110
|
+
| `vexpath sbom generate` | CycloneDX 1.6 or SPDX 2.3 from seven lockfile formats |
|
|
111
|
+
| `vexpath vex export` | OpenVEX 0.2.0 or CycloneDX VEX, with the evidence attached |
|
|
112
|
+
| `vexpath attest sign` | A signed in-toto statement in a DSSE envelope, keyless or with a key |
|
|
113
|
+
| `vexpath advisory sync` | Download a local advisory snapshot for offline and air-gapped use |
|
|
114
|
+
| `vexpath policy test` | Try a gate against a scan that already ran |
|
|
115
|
+
|
|
116
|
+
## Offline and reproducible
|
|
117
|
+
|
|
118
|
+
```bash
|
|
119
|
+
vexpath advisory sync --ecosystem PyPI --dir ./advisories
|
|
120
|
+
vexpath scan . --snapshot ./advisories
|
|
121
|
+
```
|
|
122
|
+
|
|
123
|
+
A scan against a pinned snapshot can be re-derived. One against the live API
|
|
124
|
+
cannot, and every report says which it was — a clearance nobody can reproduce
|
|
125
|
+
is a claim, not a finding.
|
|
126
|
+
|
|
127
|
+
## It never runs your dependencies
|
|
128
|
+
|
|
129
|
+
Source is parsed with `ast`, never imported. `setup.py` is read, never
|
|
130
|
+
executed. Archives are unpacked, never installed. A tool that executed what it
|
|
131
|
+
analysed would be a worse supply-chain risk than the one it was looking for.
|
|
132
|
+
|
|
133
|
+
## What it covers
|
|
134
|
+
|
|
135
|
+
Advisory matching works for every ecosystem OSV publishes. **Reachability is
|
|
136
|
+
Python only** — it is a real static analysis, not a heuristic, and one done
|
|
137
|
+
properly for one language is worth more than four done badly. Lockfiles read:
|
|
138
|
+
`uv.lock`, `poetry.lock`, `pdm.lock`, `Pipfile.lock`, `package-lock.json`,
|
|
139
|
+
`pnpm-lock.yaml`, `requirements.txt` (pinned).
|
|
140
|
+
|
|
141
|
+
`vexpath version` prints exactly what the build you have can do, because a
|
|
142
|
+
cleared finding means nothing unless you know whether reachability ran.
|
|
143
|
+
|
|
144
|
+
## In CI
|
|
145
|
+
|
|
146
|
+
```yaml
|
|
147
|
+
- uses: Unknown122-coder/vexpath@v1
|
|
148
|
+
with:
|
|
149
|
+
policy: balanced
|
|
150
|
+
```
|
|
151
|
+
|
|
152
|
+
The Action caches call graphs, writes SARIF for code scanning, and can comment
|
|
153
|
+
on the pull request. A cold scan takes minutes; a warm one takes seconds.
|
|
154
|
+
|
|
155
|
+
## Standards
|
|
156
|
+
|
|
157
|
+
purl, OSV, CycloneDX 1.4–1.6, SPDX 2.2–2.3, OpenVEX 0.2.0, in-toto Statement
|
|
158
|
+
v1, DSSE, Sigstore, SARIF 2.1.0, CVSS 3.x, PEP 440, semver, CEL.
|
|
159
|
+
|
|
160
|
+
Apache 2.0.
|
vexpath-0.1.0/README.md
ADDED
|
@@ -0,0 +1,128 @@
|
|
|
1
|
+
# vexpath
|
|
2
|
+
|
|
3
|
+
**Most of your vulnerability findings cannot run.** vexpath works out which
|
|
4
|
+
ones can, and shows you the call path that proves it.
|
|
5
|
+
|
|
6
|
+
```bash
|
|
7
|
+
uv tool install vexpath # or: pipx install vexpath
|
|
8
|
+
vexpath scan .
|
|
9
|
+
```
|
|
10
|
+
|
|
11
|
+
A scanner tells you that `jinja2` has a critical advisory. vexpath reads the
|
|
12
|
+
commit that fixed it, extracts the functions it changed, builds a call graph
|
|
13
|
+
from your code through your dependencies, and tells you whether anything you
|
|
14
|
+
run can reach them. On five real repositories it cleared 68 of 146 findings as
|
|
15
|
+
unreachable, with the evidence for each.
|
|
16
|
+
|
|
17
|
+
```
|
|
18
|
+
SEVERITY VERDICT ADVISORY COMPONENT REACHABILITY
|
|
19
|
+
--------------------------------------------------------------------------------
|
|
20
|
+
HIGH affected CVE-2026-1234 jinja2 3.1.0 reachable_confirmed
|
|
21
|
+
MEDIUM not_affected CVE-2026-5678 urllib3 2.2.1 unreachable
|
|
22
|
+
|
|
23
|
+
38 findings | 10 reachable | 28 not affected | 0 under investigation
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
## What makes a finding clearable
|
|
27
|
+
|
|
28
|
+
A finding is cleared only when the vulnerable code **provably** cannot run.
|
|
29
|
+
That requires the dependency's own source, so:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
pip install -e . # or uv sync, or poetry install
|
|
33
|
+
vexpath scan .
|
|
34
|
+
```
|
|
35
|
+
|
|
36
|
+
With nothing installed, vexpath still matches advisories but clears nothing —
|
|
37
|
+
an absence of paths through code it never read proves nothing, and it says so
|
|
38
|
+
rather than implying a clean bill of health. `--download-missing` fetches each
|
|
39
|
+
dependency's source from the package index instead (nothing is executed,
|
|
40
|
+
ever).
|
|
41
|
+
|
|
42
|
+
## The gate
|
|
43
|
+
|
|
44
|
+
```bash
|
|
45
|
+
vexpath scan . --policy balanced
|
|
46
|
+
```
|
|
47
|
+
|
|
48
|
+
Exits 1 when a critical or high finding's vulnerable code is provably
|
|
49
|
+
reachable, or when anything in your tree is in CISA's Known Exploited
|
|
50
|
+
Vulnerabilities catalogue. Five presets, or write your own in CEL:
|
|
51
|
+
|
|
52
|
+
```bash
|
|
53
|
+
vexpath policy list
|
|
54
|
+
vexpath scan . --policy 'findings.exists(f, f.kev && f.verdict != "not_affected")'
|
|
55
|
+
```
|
|
56
|
+
|
|
57
|
+
## Exit codes
|
|
58
|
+
|
|
59
|
+
The contract with CI, and fixed:
|
|
60
|
+
|
|
61
|
+
| Code | Meaning |
|
|
62
|
+
|---|---|
|
|
63
|
+
| 0 | Analysis completed and the policy passed |
|
|
64
|
+
| 1 | Analysis completed and the policy **failed** — your dependencies need attention |
|
|
65
|
+
| 2 | Analysis could not complete: a broken lockfile, an unreachable index |
|
|
66
|
+
| 3 | Configuration error: a policy that does not compile, a bad flag |
|
|
67
|
+
|
|
68
|
+
1 and 2 are separate on purpose. A build failing because the code is
|
|
69
|
+
vulnerable must never look like a build failing because the tool broke.
|
|
70
|
+
|
|
71
|
+
## What else it does
|
|
72
|
+
|
|
73
|
+
| Command | What for |
|
|
74
|
+
|---|---|
|
|
75
|
+
| `vexpath scan` | The whole pipeline: SBOM → match → reachability → VEX → gate |
|
|
76
|
+
| `vexpath reach --advisory CVE-…` | Why one verdict is what it is: symbols searched for, which entry points reach them, by what path, and the graph it rests on |
|
|
77
|
+
| `vexpath report results.json --format sarif` | Re-render a scan. Nothing is re-analysed, so the SARIF matches the table |
|
|
78
|
+
| `vexpath sbom generate` | CycloneDX 1.6 or SPDX 2.3 from seven lockfile formats |
|
|
79
|
+
| `vexpath vex export` | OpenVEX 0.2.0 or CycloneDX VEX, with the evidence attached |
|
|
80
|
+
| `vexpath attest sign` | A signed in-toto statement in a DSSE envelope, keyless or with a key |
|
|
81
|
+
| `vexpath advisory sync` | Download a local advisory snapshot for offline and air-gapped use |
|
|
82
|
+
| `vexpath policy test` | Try a gate against a scan that already ran |
|
|
83
|
+
|
|
84
|
+
## Offline and reproducible
|
|
85
|
+
|
|
86
|
+
```bash
|
|
87
|
+
vexpath advisory sync --ecosystem PyPI --dir ./advisories
|
|
88
|
+
vexpath scan . --snapshot ./advisories
|
|
89
|
+
```
|
|
90
|
+
|
|
91
|
+
A scan against a pinned snapshot can be re-derived. One against the live API
|
|
92
|
+
cannot, and every report says which it was — a clearance nobody can reproduce
|
|
93
|
+
is a claim, not a finding.
|
|
94
|
+
|
|
95
|
+
## It never runs your dependencies
|
|
96
|
+
|
|
97
|
+
Source is parsed with `ast`, never imported. `setup.py` is read, never
|
|
98
|
+
executed. Archives are unpacked, never installed. A tool that executed what it
|
|
99
|
+
analysed would be a worse supply-chain risk than the one it was looking for.
|
|
100
|
+
|
|
101
|
+
## What it covers
|
|
102
|
+
|
|
103
|
+
Advisory matching works for every ecosystem OSV publishes. **Reachability is
|
|
104
|
+
Python only** — it is a real static analysis, not a heuristic, and one done
|
|
105
|
+
properly for one language is worth more than four done badly. Lockfiles read:
|
|
106
|
+
`uv.lock`, `poetry.lock`, `pdm.lock`, `Pipfile.lock`, `package-lock.json`,
|
|
107
|
+
`pnpm-lock.yaml`, `requirements.txt` (pinned).
|
|
108
|
+
|
|
109
|
+
`vexpath version` prints exactly what the build you have can do, because a
|
|
110
|
+
cleared finding means nothing unless you know whether reachability ran.
|
|
111
|
+
|
|
112
|
+
## In CI
|
|
113
|
+
|
|
114
|
+
```yaml
|
|
115
|
+
- uses: Unknown122-coder/vexpath@v1
|
|
116
|
+
with:
|
|
117
|
+
policy: balanced
|
|
118
|
+
```
|
|
119
|
+
|
|
120
|
+
The Action caches call graphs, writes SARIF for code scanning, and can comment
|
|
121
|
+
on the pull request. A cold scan takes minutes; a warm one takes seconds.
|
|
122
|
+
|
|
123
|
+
## Standards
|
|
124
|
+
|
|
125
|
+
purl, OSV, CycloneDX 1.4–1.6, SPDX 2.2–2.3, OpenVEX 0.2.0, in-toto Statement
|
|
126
|
+
v1, DSSE, Sigstore, SARIF 2.1.0, CVSS 3.x, PEP 440, semver, CEL.
|
|
127
|
+
|
|
128
|
+
Apache 2.0.
|
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
[project]
|
|
2
|
+
name = "vexpath"
|
|
3
|
+
version = "0.1.0"
|
|
4
|
+
description = "Command-line tool: generate SBOMs, match advisories, analyse reachability and emit signed VEX."
|
|
5
|
+
readme = "README.md"
|
|
6
|
+
requires-python = ">=3.12"
|
|
7
|
+
license = "Apache-2.0"
|
|
8
|
+
# A copy, not a reference to the root. A parent-directory path lands in
|
|
9
|
+
# the source archive as `<name>-<version>/../../LICENSE`, which is a tar
|
|
10
|
+
# member escaping its own root: newer uv refuses to read it outright, and
|
|
11
|
+
# the archive was malformed regardless of which builder tolerated it. A
|
|
12
|
+
# test asserts every copy is byte-identical to the root LICENSE.
|
|
13
|
+
license-files = ["LICENSE"]
|
|
14
|
+
authors = [{ name = "Akmal Khan" }]
|
|
15
|
+
keywords = [
|
|
16
|
+
"security",
|
|
17
|
+
"sbom",
|
|
18
|
+
"vulnerability",
|
|
19
|
+
"reachability",
|
|
20
|
+
"sca",
|
|
21
|
+
"vex",
|
|
22
|
+
"openvex",
|
|
23
|
+
"cyclonedx",
|
|
24
|
+
"spdx",
|
|
25
|
+
"supply-chain",
|
|
26
|
+
]
|
|
27
|
+
# The PyPI page is where somebody decides whether to try this, so the
|
|
28
|
+
# classifiers say what it is rather than only what it needs. "Development
|
|
29
|
+
# Status :: 4 - Beta" is honest: the analysis is measured on real
|
|
30
|
+
# repositories, and the hosted platform is new.
|
|
31
|
+
classifiers = [
|
|
32
|
+
"Development Status :: 4 - Beta",
|
|
33
|
+
"Environment :: Console",
|
|
34
|
+
"Intended Audience :: Developers",
|
|
35
|
+
"Intended Audience :: System Administrators",
|
|
36
|
+
"License :: OSI Approved :: Apache Software License",
|
|
37
|
+
"Operating System :: OS Independent",
|
|
38
|
+
"Programming Language :: Python :: 3",
|
|
39
|
+
"Programming Language :: Python :: 3.12",
|
|
40
|
+
"Programming Language :: Python :: 3.13",
|
|
41
|
+
"Topic :: Security",
|
|
42
|
+
"Topic :: Software Development :: Quality Assurance",
|
|
43
|
+
"Topic :: System :: Software Distribution",
|
|
44
|
+
"Typing :: Typed",
|
|
45
|
+
]
|
|
46
|
+
|
|
47
|
+
dependencies = [
|
|
48
|
+
"vexpath-core==0.1.0",
|
|
49
|
+
"typer>=0.15",
|
|
50
|
+
"rich>=13.9",
|
|
51
|
+
]
|
|
52
|
+
|
|
53
|
+
[project.urls]
|
|
54
|
+
Homepage = "https://github.com/Unknown122-coder/vexpath"
|
|
55
|
+
Documentation = "https://github.com/Unknown122-coder/vexpath/tree/main/docs"
|
|
56
|
+
Repository = "https://github.com/Unknown122-coder/vexpath"
|
|
57
|
+
Issues = "https://github.com/Unknown122-coder/vexpath/issues"
|
|
58
|
+
Changelog = "https://github.com/Unknown122-coder/vexpath/releases"
|
|
59
|
+
|
|
60
|
+
[project.scripts]
|
|
61
|
+
vexpath = "vexpath.main:app"
|
|
62
|
+
|
|
63
|
+
[build-system]
|
|
64
|
+
requires = ["hatchling"]
|
|
65
|
+
build-backend = "hatchling.build"
|
|
66
|
+
|
|
67
|
+
[tool.hatch.build.targets.wheel]
|
|
68
|
+
packages = ["src/vexpath"]
|
|
@@ -0,0 +1,12 @@
|
|
|
1
|
+
"""The ``vexpath`` command-line tool."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from importlib.metadata import PackageNotFoundError, version
|
|
6
|
+
|
|
7
|
+
try: # pragma: no cover - depends on install mode
|
|
8
|
+
__version__ = version("vexpath")
|
|
9
|
+
except PackageNotFoundError: # pragma: no cover - running from a source tree
|
|
10
|
+
__version__ = "0.0.0+unknown"
|
|
11
|
+
|
|
12
|
+
__all__ = ["__version__"]
|