Skip to content

Commit

Permalink
Merge pull request #2200 from psiinon/sbom-list
Browse files Browse the repository at this point in the history
Add SBOM list page
  • Loading branch information
kingthorin authored Oct 18, 2023
2 parents 826d2f6 + 9dcb3af commit 0e9d238
Show file tree
Hide file tree
Showing 4 changed files with 48 additions and 1 deletion.
4 changes: 4 additions & 0 deletions site/content/docs/_index.md
Original file line number Diff line number Diff line change
Expand Up @@ -51,6 +51,10 @@ groups:
link: /docs/statistics/
desc: public ZAP usage statistics

- name: 'Software Bill of Materials'
link: /docs/sbom/
desc: ZAP add-on SBOMs

- header: 'Internal Details'
links:

Expand Down
13 changes: 13 additions & 0 deletions site/content/docs/sbom/_index.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
---
title: "Software Bill of Materials"
type: sbom
---
ZAP includes a runtime Software Bill of Materials (SBOM) generated by [CycloneDX](https://cyclonedx.org/) for both the ZAP core and all of the add-ons maintained by the ZAP team. Each SBOM will appear as a file called “bom.json” included at the root of the ZAP JARs.

Runtime SBOMs for the ZAP core and the add-ons you have installed can be accessed in ZAP as per the [Software Bill of Materials](/docs/desktop/start/features/sbom/)
help page.

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.

The full set of available build time add-on SBOMs are:

30 changes: 30 additions & 0 deletions site/layouts/sbom/list.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
{{ define "main" }}
<section class="bolt-header">
<div class="wrapper py-20">
<h1 class="text--white">{{ .Title }}</h1>
</div>
</section>
<div class="wrapper py-70">
{{- .Content -}}

<table class="table">
<thead align="left">
<tr>
<th style="width: 80%">Name</th>
<th style="width: 20%">Components</th>
</tr>
</thead>

{{ range .Pages }}
<tr>
<td>
<a href="{{ .Permalink }}">{{ .Title }}</a>
</td>
<td>
{{ len .Params.sbom.components }}
</td>
</tr>
{{ end }}

</table>
{{ end }}
2 changes: 1 addition & 1 deletion site/layouts/sbom/single.html
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ <h1 class="text--white">{{ .Title }}</h1>
<div class="wrapper py-20" data-kind="{{ .Kind }}">
<header class="breadcrumbs">
<a href="/docs/">Docs</a> &gt;
SBOM &gt;
<a href="/docs/sbom/">SBOM</a> &gt;
<a href="/docs/sbom/{{ $addOn.id }}">{{ $addOn.name }}</a>
</header>
<br>
Expand Down

0 comments on commit 0e9d238

Please sign in to comment.