Skip to content

Commit bfb259b

Browse files
thc202thc202
authored
Merge pull request #525 from psiinon/sbom
Add SBOM help page
2 parents be9d42f + d5da84e commit bfb259b

File tree

7 files changed

+54
-2
lines changed

7 files changed

+54
-2
lines changed

‎addOns/help/CHANGELOG.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,9 @@ All notable changes to this add-on will be documented in this file.
44
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
55

66
## Unreleased
7+
### Added
8+
- SBOM help page.
9+
710
### Changed
811
- Updated for 2.14.0.
912

‎addOns/help/src/main/javahelp/contents/cmdline.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ <H2>Options</H2>
4949
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>-addonlist</td><td>List all of the installed add-ons</td></tr>
5050
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>-script &lt;script&gt;</td><td>Run the specified script (file system path) if command line/daemon, or just load it if GUI</td></tr>
5151
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>-suppinfo</td><td>Outputs details relevant for support and troubleshooting (to the console/standard out). Such as: ZAP version, java version, installed add-ons and version, locale info, operating system, etc.</td></tr>
52+
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>-sbomzip &lt;path&gt;</td><td>Creates a zip file containing all of the available <a href="start/features/sbom.html">SBOMs</a></td></tr>
5253

5354
</table>
5455
<br>

‎addOns/help/src/main/javahelp/contents/start/features/features.html

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@ <H1>Features</H1>
2727
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="modes.html">Modes</a></td><td></td></tr>
2828
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="notes.html">Notes</a></td><td></td></tr>
2929
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="pscan.html">Passive Scan</a></td><td></td></tr>
30+
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="sbom.html">Software Bill of Materials</a></td><td></td></tr>
3031
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="scanpolicy.html">Scan Policy</a></td><td></td></tr>
3132
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="scope.html">Scope</a></td><td></td></tr>
3233
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td><a href="scripts.html">Scripts</a></td><td></td></tr>

‎addOns/help/src/main/javahelp/contents/start/features/sbom.html

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 3.2 Final//EN">
2+
<HTML>
3+
<HEAD>
4+
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=utf-8">
5+
<TITLE>
6+
Software Bill of Materials
7+
</TITLE>
8+
</HEAD>
9+
<BODY>
10+
<H1>Software Bill of Materials</H1>
11+
<p>
12+
ZAP includes a runtime Software Bill of Materials (SBOM) generated by <a href="https://cyclonedx.org/">CycloneDX</a>
13+
for both the ZAP core and all of the add-ons maintained by the ZAP team.
14+
Each SBOM will appear as a file called "bom.json" included at the root of the ZAP JARs.
15+
<p>
16+
Note that SBOMs may not be available if you run ZAP from the source code, and some 3rd party add-ons may also not define them.
17+
18+
<H2>SBOM zip</H2>
19+
A zip file containing all of the available SBOM files can be generated via the following options.
20+
The ZAP core SBOM file will be called "zap-core-bom.json" and the add-on SBOM files will be called "&lt;addon-id&gt;-bom.json".
21+
22+
<H3>Desktop</H3>
23+
The <a href="../../ui/tlmenu/help.html">Help menu</a> "Support Info..." dialog "Save SBOM zip..." button.
24+
25+
<H3>Command Line</H3>
26+
27+
The "-sbomzip" <a href="../../cmdline.html">Command Line</a> option.
28+
29+
<H3>API</H3>
30+
31+
The core "createSbomZip" <a href="api.html">API</a> action.
32+
33+
<H2>See also</H2>
34+
<table>
35+
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>
36+
<a href="../../ui/overview.html">UI Overview</a></td><td>for an overview of the user interface</td></tr>
37+
<tr><td>&nbsp;&nbsp;&nbsp;&nbsp;</td><td>
38+
<a href="features.html">Features</a></td><td>provided by ZAP</td></tr>
39+
</table>
40+
41+
</BODY>
42+
</HTML>

‎addOns/help/src/main/javahelp/contents/ui/tlmenu/help.html

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,8 +17,11 @@ <H3>Support Info...</H3>
1717
Displays a dialog that contains information which is useful when troubleshooting or seeking support. Such as:<br>
1818
Version, installed add-ons and versions, operating system, java version, locale info, and ZAP Home Directory path.
1919
This information can be copied and pasted. <br>
20-
The dialog includes an "Open" button, which assuming the OS supports the necessary functionality, will open the ZAP Home Directory
21-
(for logs or configuration files) when clicked.
20+
The dialog includes an "Open ZAP Home" button, which assuming the OS supports the necessary functionality, will open the ZAP Home Directory
21+
(for logs or configuration files) when clicked. <br>
22+
The dialog includes a "Save SBOM zip..." button, which will prompt you for the name of a zip file
23+
which it will generate containing all of the available
24+
<a href="../../start/features/sbom.html">SBOM</a> files.
2225

2326
<H3>Check for Updates...</H3>
2427
This checks to see if you are running the latest version of ZAP.

‎addOns/help/src/main/javahelp/toc.xml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,7 @@
3434
<tocitem text="Modes" target="start.features.modes"/>
3535
<tocitem text="Notes" target="start.features.notes"/>
3636
<tocitem text="Passive Scan" target="start.features.pscan"/>
37+
<tocitem text="Software Bill of Materials" target="start.features.sbom"/>
3738
<tocitem text="Scan Policies" target="start.features.scanpolicy"/>
3839
<tocitem text="Scope" target="start.features.scope"/>
3940
<tocitem text="Scripts" target="start.features.scripts"/>

‎commonFiles/src/main/resources/map.jhm

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
<mapID target="start.features.modes" url="contents/start/features/modes.html" />
3131
<mapID target="start.features.notes" url="contents/start/features/notes.html" />
3232
<mapID target="start.features.pscan" url="contents/start/features/pscan.html" />
33+
<mapID target="start.features.sbom" url="contents/start/features/sbom.html" />
3334
<mapID target="start.features.scanpolicy" url="contents/start/features/scanpolicy.html" />
3435
<mapID target="start.features.scope" url="contents/start/features/scope.html" />
3536
<mapID target="start.features.scripts" url="contents/start/features/scripts.html" />

0 commit comments

Comments
 (0)