Skip to content

Commit 1ae6996

Browse files
committed
Tweak the README and SPEC a bit.
Move the "Ahout VEX" section to the readme Add info on governance Add high level roadmap Signed-off-by: Dan Lorenc <[email protected]>
1 parent f795473 commit 1ae6996

File tree

2 files changed

+37
-16
lines changed

2 files changed

+37
-16
lines changed

OPENVEX-SPEC.md

Lines changed: 0 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -9,22 +9,6 @@ Exploitability eXchange (VEX)](http://example.com) document published on XXX
99
by the VEX working group coordinated by the [Cybersecurity & Infrastructure
1010
Security Agency](https://www.cisa.gov/) (CISA).
1111

12-
## About VEX
13-
14-
Vulnerability Exploitability eXchange is a vulnerability document designed to
15-
complement a Software Bill of Materials (SBOM) that informs users of a software
16-
product about the applicability of one or more vulnerability findings.
17-
18-
Security scanners will detect and flag components in software that have
19-
been identified as being vulnerable. Often, software is not necessarily affected
20-
as signaled by security scanners for many reasons such as: the vulnerable component may
21-
have been already patched, may not be present, or may not be able to be executed. To turn off
22-
false alerts like these, a scanner may consume VEX data from the software supplier.
23-
24-
The extreme transparency brought by SBOMs into how software is composed will
25-
most likely increase the number of these kind of false positives, requiring an
26-
automated solution to avoid an explosion in the false positive rate of security
27-
scans. Hence VEX.
2812

2913
## The VEX Statement
3014

README.md

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,30 @@ OpenVEX is an implementation of the
44
[Vulnerability Exploitability Exchange](https://www.ntia.gov/files/ntia/publications/vex_one-page_summary.pdf)
55
(VEX for short) that is designed to be minimal, compliant, interoperable, and
66
embeddable.
7+
The specification is available in the [OPENVEX-SPEC.md](OPENVEX-SPEC.md) file of this repository.
8+
9+
OpenVEX is designed to meet the minimum requirements defined by the [CISA SBOM and VEX Efforts](https://www.cisa.gov/sbom).
10+
We believe OpenVEX meets these requirements now, and will do our best to ensure it continues to meet them as requirements
11+
change.
12+
13+
**Note**: The OpenVEX specification is currently a draft. We don't anticipate large changes, but are open to them.
14+
15+
## About VEX
16+
17+
Vulnerability Exploitability eXchange is a vulnerability document designed to
18+
complement a Software Bill of Materials (SBOM) that informs users of a software
19+
product about the applicability of one or more vulnerability findings.
20+
21+
Security scanners will detect and flag components in software that have
22+
been identified as being vulnerable. Often, software is not necessarily affected
23+
as signaled by security scanners for many reasons such as: the vulnerable component may
24+
have been already patched, may not be present, or may not be able to be executed. To turn off
25+
false alerts like these, a scanner may consume VEX data from the software supplier.
26+
27+
The extreme transparency brought by SBOMs into how software is composed will
28+
most likely increase the number of these kind of false positives, requiring an
29+
automated solution to avoid an explosion in the false positive rate of security
30+
scans. Hence VEX.
731

832
## OpenVEX is...
933

@@ -61,6 +85,14 @@ Check out
6185
and our [examples repository](https://github.com/openvex/examples) for more
6286
information and use cases.
6387

88+
## OpenVEX Roadmap
89+
90+
The OpenVEX specification is currently a draft.
91+
We believe the specification is usable today, but will focus on implementation and adoption in the short term.
92+
We can't be fully confident the specification works until it has been implemented by a wide range of users, tools
93+
and systems.
94+
95+
We're hoping for a 1.0 release in 2023.
6496

6597
## Frequently Asked Questions
6698

@@ -96,3 +128,8 @@ are missing a few pieces of the minimum elements of VEX. Nevertheless, OpenVEX
96128
can be used along with CSAF and CycloneDX documents. The OpenVEX tooling can
97129
generate a complete VEX impact history from files expressed in the other
98130
implementations
131+
132+
#### Who is behind this project?
133+
134+
This project uses a community governance model defined in the [community repository](https://github.com/openvex/community).
135+
Contributions are welcome!

0 commit comments

Comments
 (0)