You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: app/controlplane/plugins/core/guac/v1/README.md
+38-13Lines changed: 38 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,28 +2,37 @@
2
2
3
3
Graph for Understanding Artifact Composition ([GUAC](https://github.com/guacsec/guac)) aggregates software security metadata into a high fidelity graph database—normalizing entity identities and mapping standard relationships between them. Querying this graph can drive higher-level organizational outcomes such as audit, policy, risk management, and even developer assistance.
4
4
5
-
This integration allows Chainloop users to automatically send attestation (DSSE envelopes / in-toto statements) and CycloneDX/SPDX Software Bill Of Materials (SBOMs) to a cloud storage bucket staging area. From there, GUAC can be configured to continuously monitor and inject that data. Compatible with Guac v0.1.0 beta or newer.
5
+
Chainloop users can **automatically send signed [in-toto](https://in-toto.io/) attestations and both [CycloneDX](https://cyclonedx.org/) and [SPDX](https://spdx.dev/) Software Bill Of Materials (SBOMs)** to a cloud storage bucket. From there, GUAC can be configured to continuously monitor and inject that data.
6
6
7
7

8
8
9
+
## Demo
9
10
10
-
## How to use it
11
+
You can see a demo of this integration in action in the following video:
11
12
12
-
Currently, this integration only supports [Google Cloud Storage](https://cloud.google.com/storage) (GCS) as a storage provider with more to come in the future. If you are interested in a specific provider, please [let us know](https://github.com/chainloop-dev/chainloop/issues/new)
<imgsrc="http://img.youtube.com/vi/XEeMeyC9ZJs/0.jpg"alt="Use Guac with Chainloop"width="100%"height="500"border="10" />
15
+
</a>
13
16
17
+
## Configure Integration in Chainloop
14
18
15
-
### Chainloop setup
16
-
#### Using Google Cloud Platform
19
+
There are two steps involved to enable this integration:
20
+
21
+
1. Register a Guac integration in your Chainloop account
22
+
2. Attach this integration to your workflow
23
+
24
+
### Registration
25
+
26
+
Currently, this integration only supports [Google Cloud Storage](https://cloud.google.com/storage) (GCS) as a storage provider, with more to come in the future. If you are interested in a specific provider, please [let us know](https://github.com/chainloop-dev/chainloop/issues/new)
27
+
28
+
#### Using Google Cloud Storage (GCS)
17
29
18
30
**Prerequisites**
19
31
20
32
- A Google Cloud Platform (GCP) account
21
33
- A GCP project with a GCS bucket
22
34
- A GCP service account with write access to the bucket. See [Creating and managing service accounts](https://cloud.google.com/iam/docs/creating-managing-service-accounts) for more information.
23
-
- Once create, download the service account [JSON credentials file](https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account)
24
-
25
-
26
-
**Registration**
35
+
- Once created, download the service account [JSON credentials file](https://developers.google.com/workspace/guides/create-credentials#create_credentials_for_a_service_account)
27
36
28
37
To get started, you need to register the plugin in your Chainloop organization.
That's all on the Chainloop side. Now all new attestation and SBOM metadata files will get uploaded to Google Cloud Storage.
54
+
That's all on the Chainloop side. Now all new attestation and SBOM metadata files will get uploaded to your Google Cloud Storage bucket.
55
+
## Configure Guac
46
56
57
+
Next, we need to configure Guac to pick up the files from the bucket and inject them into the graph. Please refer to [guacsec/guac](https://docs.guac.sh) documentation to learn more.
47
58
48
-
### GUAC setup
59
+
But in a nutshell, you need to:
49
60
50
-
Refer to https://github.com/guacsec/guac documentation to learn how to setup GUAC to import from a GCS-based collector.
61
+
-[Have a Guac instance up and running](https://docs.guac.sh/setup)
62
+
- Ingest the data from the bucket into the graph
63
+
64
+
> NOTE: Currently, importing GCS data into Guac requires manually running a `collect` command. The community [is discussing](https://github.com/guacsec/guac/issues/1005) how to run this process periodically and automatically.
0 commit comments