Skip to content

Commit 7ecab7e

Browse files
authored
docs: add supported technologies page (#422)
--------- Signed-off-by: Nathan Nguyen <nathan.nguyen@oracle.com>
1 parent c3a9a08 commit 7ecab7e

File tree

4 files changed

+101
-2
lines changed

4 files changed

+101
-2
lines changed

docs/source/index.rst

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,9 @@
77
:description: macaron - A CI/CD security analysis tool for supply-chain attacks
88
:keywords: CI/CD, SLSA, supply-chain security
99

10+
.. References/links
11+
.. _Witness: https://github.com/testifysec/witness
12+
1013
=====================
1114
Macaron documentation
1215
=====================
@@ -29,6 +32,14 @@ Macaron is an analysis tool which focuses on the build process for an artifact a
2932
are at a high-level, Macaron first defines these requirements as specific
3033
concrete rules that can be checked automatically. Macaron has a customizable checker platform that makes it easy to define checks that depend on each other.
3134

35+
---------------
36+
Getting started
37+
---------------
38+
39+
To start with Macaron, see our :doc:`Installation </pages/installation>` and :doc:`Using </pages/using>` pages.
40+
41+
For all services and technologies that Macaron supports, see our :doc:`Supported Technologies </pages/supported_technologies/index>` page.
42+
3243
-------------------------
3344
Current checks in Macaron
3445
-------------------------
@@ -49,8 +60,11 @@ the requirements that are currently supported by Macaron.
4960
- **Scripted build** - All build steps were fully defined in a “build script”.
5061
- Identify and validate build script(s).
5162
* - 1
52-
- **Provenance available** - The provenance is available.
53-
- Check for existence of SLSA provenance. If there are no SLSA provenance, the repo can still be compliant to level 1 given the build script is available.
63+
- **Provenance available** - Provenances are available.
64+
- Check for existence of provenances, which can be SLSA or `Witness`_ provenances. If there is no provenance, the repo can still be compliant to level 1 given the build script is available.
65+
* - 1
66+
- **Witness provenance** - One or more `Witness`_ provenances are discovered.
67+
- Check for existence of `Witness`_ provenances, and whether artifact digests match those in the provenances.
5468
* - 2
5569
- **Build service** - All build steps are run using some build service (e.g. GitHub Actions)
5670
- Identify and validate the CI service(s) used for the build process.
@@ -91,4 +105,5 @@ intermediate representations as abstractions. Using such abstractions, Macaron i
91105
pages/using
92106
pages/output_files
93107
pages/cli_usage/index
108+
pages/supported_technologies/index
94109
pages/apidoc/index
Lines changed: 72 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,72 @@
1+
.. Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
2+
.. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
======================
5+
Supported Technologies
6+
======================
7+
8+
------------
9+
Git Services
10+
------------
11+
12+
.. list-table::
13+
:header-rows: 1
14+
15+
* - Git Service
16+
* - `GitHub <https://github.com>`_
17+
* - `GitLab <https://gitlab.com>`_
18+
19+
------------
20+
CI Services
21+
------------
22+
23+
.. list-table::
24+
:header-rows: 1
25+
26+
* - CI Service
27+
* - `GitHub Actions <https://github.com/features/actions>`_
28+
29+
30+
------------------
31+
Package Registries
32+
------------------
33+
34+
.. list-table::
35+
:widths: 25 50 25
36+
:header-rows: 1
37+
38+
* - Package Registry
39+
- Support
40+
- Documentation
41+
* - `JFrog Artifactory <https://jfrog.com/artifactory>`_
42+
- Only projects built with Gradle and publishing to a JFrog Artifactory repo following `Maven layout <https://maven.apache.org/repository/layout.html>`_
43+
- :doc:`page </pages/supported_technologies/jfrog>`
44+
45+
-----------
46+
Provenances
47+
-----------
48+
49+
.. list-table::
50+
:widths: 25 50 25
51+
:header-rows: 1
52+
53+
* - Provenance
54+
- Support
55+
- Documentation
56+
* - `SLSA <https://slsa.dev>`_
57+
- Only provenances under `SLSA version 0.2 <https://slsa.dev/spec/v0.2/provenance>`_.
58+
- :doc:`page </pages/supported_technologies/jfrog>`
59+
* - `Witness <https://github.com/testifysec/witness>`_
60+
- * Only provenances under Witness version 0.1
61+
* Only projects built with Gradle on GitLab CI provenances and publishing provenances to JFrog Artifactory
62+
- :doc:`page </pages/supported_technologies/jfrog>`
63+
64+
--------
65+
See also
66+
--------
67+
68+
.. toctree::
69+
:maxdepth: 1
70+
71+
jfrog
72+
witness
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
2+
.. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
=================
5+
JFrog Artifactory
6+
=================
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
.. Copyright (c) 2023 - 2023, Oracle and/or its affiliates. All rights reserved.
2+
.. Licensed under the Universal Permissive License v 1.0 as shown at https://oss.oracle.com/licenses/upl/.
3+
4+
=======
5+
Witness
6+
=======

0 commit comments

Comments
 (0)