Skip to content

Commit 2bfd140

Browse files
committed
docs: update PROVENANCE.md and README.md for GitHub artifact attestations
1 parent 3e77b7b commit 2bfd140

File tree

2 files changed

+15
-23
lines changed

2 files changed

+15
-23
lines changed

PROVENANCE.md

Lines changed: 13 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
1-
## Verifying SDK build provenance with the SLSA framework
1+
## Verifying SDK build provenance with GitHub artifact attestations
22

3-
LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages.
3+
LaunchDarkly uses [GitHub artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages.
44

5-
As part of [SLSA requirements for level 3 compliance](https://slsa.dev/spec/v1.0/requirements), LaunchDarkly publishes provenance about our SDK package builds using [GitHub's generic SLSA3 provenance generator](https://github.com/slsa-framework/slsa-github-generator/blob/main/internal/builders/generic/README.md#generation-of-slsa3-provenance-for-arbitrary-projects) for distribution alongside our packages. These attestations are available for download from the GitHub release page for the release version under Assets > `multiple.intoto.jsonl`.
5+
LaunchDarkly publishes provenance about our SDK package builds using [GitHub's `actions/attest` action](https://github.com/actions/attest). These attestations are stored in GitHub's attestation API and can be verified using the [GitHub CLI](https://cli.github.com/).
66

7-
To verify SLSA provenance attestations, we recommend using [slsa-verifier](https://github.com/slsa-framework/slsa-verifier). Example usage for verifying SDK packages is included below:
7+
To verify build provenance attestations, we recommend using the [GitHub CLI `attestation verify` command](https://cli.github.com/manual/gh_attestation_verify). Example usage for verifying SDK packages is included below:
88

99
<!-- x-release-please-start-version -->
1010
```
@@ -13,32 +13,24 @@ SDK_VERSION=9.15.0
1313
```
1414
<!-- x-release-please-end -->
1515

16-
1716
```
18-
# Download package from PyPi
17+
# Download package from PyPI
1918
$ pip download --only-binary=:all: launchdarkly-server-sdk==${SDK_VERSION}
2019
21-
# Download provenance from Github release into same directory
22-
$ curl --location -O \
23-
https://github.com/launchdarkly/python-server-sdk/releases/download/${SDK_VERSION}/multiple.intoto.jsonl
24-
25-
# Run slsa-verifier to verify provenance against package artifacts
26-
$ slsa-verifier verify-artifact \
27-
--provenance-path multiple.intoto.jsonl \
28-
--source-uri github.com/launchdarkly/python-server-sdk \
29-
launchdarkly_server_sdk-${SDK_VERSION}-py3-none-any.whl
20+
# Verify provenance using the GitHub CLI
21+
$ gh attestation verify launchdarkly_server_sdk-${SDK_VERSION}-py3-none-any.whl -R launchdarkly/python-server-sdk
3022
```
3123

3224
Below is a sample of expected output.
3325

3426
```
35-
Verified signature against tlog entry index 76390194 at URL: https://rekor.sigstore.dev/api/v1/log/entries/24296fb24b8ad77ac42700bfad5eb5597ea8bda92acb470aade248c01ccfc44047c0cd5b4433021a
36-
Verified build using builder "https://github.com/slsa-framework/slsa-github-generator/.github/workflows/generator_generic_slsa3.yml@refs/tags/v1.7.0" at commit c7b42a2e7486904978d77cf05a07280e7e1bbec2
37-
Verifying artifact launchdarkly_server_sdk-9.2.2-py3-none-any.whl: PASSED
27+
Loaded digest sha256:... for file://launchdarkly_server_sdk-9.15.0-py3-none-any.whl
28+
Loaded 1 attestation from GitHub API
29+
✓ Verification succeeded!
3830
39-
PASSED: Verified SLSA provenance
31+
launchdarkly_server_sdk-9.15.0-py3-none-any.whl was attested by a trusted GitHub Actions workflow
4032
```
4133

42-
Alternatively, to verify the provenance manually, the SLSA framework specifies [recommendations for verifying build artifacts](https://slsa.dev/spec/v1.0/verifying-artifacts) in their documentation.
34+
For more information, see [GitHub's documentation on verifying artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds#verifying-artifact-attestations-with-the-github-cli).
4335

44-
**Note:** These instructions do not apply when building our SDKs from source.
36+
**Note:** These instructions do not apply when building our SDKs from source.

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,9 +34,9 @@ We run integration tests for all our SDKs using a centralized test harness. This
3434

3535
We encourage pull requests and other contributions from the community. Check out our [contributing guidelines](CONTRIBUTING.md) for instructions on how to contribute to this SDK.
3636

37-
## Verifying SDK build provenance with the SLSA framework
37+
## Verifying SDK build provenance with GitHub artifact attestations
3838

39-
LaunchDarkly uses the [SLSA framework](https://slsa.dev/spec/v1.0/about) (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).
39+
LaunchDarkly uses [GitHub artifact attestations](https://docs.github.com/en/actions/security-for-github-actions/using-artifact-attestations/using-artifact-attestations-to-establish-provenance-for-builds) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the [provenance guide](PROVENANCE.md).
4040

4141
## About LaunchDarkly
4242

0 commit comments

Comments
 (0)