Skip to content

Commit 36c3148

Browse files
authored
docs: remove SLSA 0.1 from docs and fix tables (#829)
Signed-off-by: behnazh-w <[email protected]>
1 parent 3e57ce8 commit 36c3148

File tree

5 files changed

+21
-6
lines changed

5 files changed

+21
-6
lines changed

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
Macaron is a supply chain security analysis tool from [Oracle Labs](https://labs.oracle.com/pls/apex/r/labs/labs/intro), which focuses on the build integrity of an artifact and the artifact dependencies. It is based on the [Supply chain Levels for Software Artifacts (SLSA)](https://slsa.dev/) specification, which aims at preventing some of the software supply chain attacks as the systems get more complex, especially with respect to the use of open-source third-party code in applications. Attacks include stealing credentials, injecting malicious code etc., and it is critical to have security assurance on the third-party code to guarantee that the integrity of the code has not been compromised.
88

9-
Macaron uses [SLSA requirements specifications v0.1](https://slsa.dev/spec/v0.1/requirements) to define concrete rules for protecting software integrity that can be checked for compliance requirements automatically. Macaron provides a customizable checker platform that makes it easy to define checks that depend on each other. This is particularly useful for implementing checks for SLSA levels. In addition, Macaron also checks a user-specified policy for a software component to detect unexpected behavior in the build process. We currently support the following build tools:
9+
Macaron uses [SLSA requirements specifications](https://slsa.dev/spec/v1.0/levels) to define concrete rules for protecting software integrity that can be checked for compliance requirements automatically. Macaron provides a customizable checker platform that makes it easy to define checks that depend on each other. This is particularly useful for implementing checks for SLSA levels. In addition, Macaron also checks a user-specified policy for a software component to detect unexpected behavior in the build process. We currently support the following build tools:
1010

1111
* Maven and Gradle Java build systems
1212
* Pip or Poetry package managers for Python

docs/source/_static/style.css

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
11
/* Copyright (c) 2022 - 2022, Oracle and/or its affiliates. All rights reserved. */
22
/* Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/. */
33

4+
/* !important prevents the common CSS stylesheets from overriding
5+
this as on RTD they are loaded after this stylesheet */
46
.wy-nav-content {
57
max-width: 1200px !important;
68
}
@@ -9,3 +11,18 @@
911
.wy-nav-top {
1012
background: #464545;
1113
}
14+
15+
/* The Read the Docs Sphinx theme contains a bug that causes text in table cells not to wrap.
16+
This results in very wide tables with horizontal scroll bars.
17+
*/
18+
.wy-table-responsive table td {
19+
/* The white-space CSS property sets how white space inside an element is handled. */
20+
white-space: normal !important;
21+
}
22+
23+
.wy-table-responsive {
24+
/* The overflow CSS shorthand property sets the desired behavior when content does not fit in the
25+
element's padding box (overflows) in the horizontal and/or vertical direction.
26+
*/
27+
overflow: visible !important;
28+
}

docs/source/index.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -46,14 +46,12 @@ Current checks in Macaron
4646
The table below shows the current set of actionable checks derived from
4747
the requirements that are currently supported by Macaron.
4848

49-
.. note:: The current checks are designed based on `SLSA v0.1 <https://slsa.dev/spec/v0.1/>`_. Support for `SLSA v1.0 <https://slsa.dev/spec/v1.0/>`_ is currently under development.
50-
5149
.. list-table:: Mapping SLSA requirements to Macaron checks
5250
:widths: 20 40 40
5351
:header-rows: 1
5452

5553
* - SLSA level
56-
- SLSA spec v0.1
54+
- SLSA requirement
5755
- Concrete check
5856
* - 1
5957
- **Scripted build** - All build steps were fully defined in a “build script”.

docs/source/pages/checks/slsa_builds.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ SLSA Build Levels
1010
SLSA Build Levels report on various security aspects of a project, to provide a score that represents its overall trustworthiness and completeness.
1111
See `SLSA Levels <https://slsa.dev/spec/v1.0/levels>`_.
1212

13-
Macaron's ``Provenance verified`` check uses the criteria of SLSA Build Levels to output a result that matches the correct level for a given artifact.
13+
Macaron's :class:`Provenance verified <macaron.slsa_analyzer.checks.provenance_verified_check.ProvenanceVerifiedCheck>` check uses the criteria of SLSA Build Levels to output a result that matches the correct level for a given artifact.
1414

1515
- Build Level 0: There is no provenance for the artifact.
1616
- Build Level 1: There is provenance for the artifact but it cannot be verified.

docs/source/pages/cli_usage/command_analyze.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@ Analyze
1111
Description
1212
-----------
1313

14-
Analyze a public GitHub repository (and optionally the repositories of its dependencies) to determine its SLSA posture. We currently support `SLSA v0.1 <https://slsa.dev/spec/v0.1/>`_. The support for `SLSA v1.0 <https://slsa.dev/spec/v1.0/>`_ will be added in future.
14+
Analyze a public GitHub repository (and optionally the repositories of its dependencies) to determine its :term:`SLSA` posture.
1515

1616
-----
1717
Usage

0 commit comments

Comments
 (0)