Skip to content

Commit 43cf5bf

Browse files
authored
docs: adding example output for PROVENANCE.md (#268)
**Requirements** - [ ] I have added test coverage for new or changed functionality - [ ] I have followed the repository's [pull request submission guidelines](../blob/main/CONTRIBUTING.md#submitting-pull-requests) - [ ] I have validated my changes against all supported platform versions **Describe the solution you've provided** Using provenance generated for previous release to flesh out PROVENANCE.md **Describe alternatives you've considered** Provide a clear and concise description of any alternative solutions or features you've considered. **Additional context** Add any other context about the pull request here.
2 parents 5e81826 + 5eee8f2 commit 43cf5bf

File tree

2 files changed

+14
-7
lines changed

2 files changed

+14
-7
lines changed

PROVENANCE.md

Lines changed: 13 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,24 +2,31 @@
22

33
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.
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-provenance.intoto.jsonl`.
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`.
66

77
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:
88

9+
<!-- x-release-please-start-version -->
910
```
10-
# Download packages from PyPi
11+
# Download package from PyPi
1112
$ pip download --only-binary=:all: launchdarkly-server-sdk
1213
13-
# Download provenance from Github release
14+
# Download provenance from Github release into same directory
1415
$ curl --location -O \
15-
https://github.com/launchdarkly/python-server-sdk/releases/download/VERSION/multiple.intoto.jsonl
16+
https://github.com/launchdarkly/python-server-sdk/releases/download/9.2.0/multiple.intoto.jsonl
1617
1718
# Run slsa-verifier to verify provenance against package artifacts
1819
$ slsa-verifier verify-artifact \
19-
--provenance-path multiple-provenance.intoto.jsonl \
20+
--provenance-path multiple.intoto.jsonl \
2021
--source-uri github.com/launchdarkly/python-server-sdk \
21-
launchdarkly_server_sdk-VERSION-py3-none-any.whl
22+
launchdarkly_server_sdk-9.2.0-py3-none-any.whl
23+
Verified signature against tlog entry index 71399397 at URL: https://rekor.sigstore.dev/api/v1/log/entries/24296fb24b8ad77a95c53f2cb33fe2e8c8fbc04591ebf26e4d2796fb2975c3ba377f1dc14507f421
24+
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 5e818265c9f85ae9a111290bd6a4fad1a08786e9
25+
Verifying artifact launchdarkly_server_sdk-9.2.0-py3-none-any.whl: PASSED
26+
27+
PASSED: Verified SLSA provenance
2228
```
29+
<!-- x-release-please-end -->
2330

2431
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.
2532

release-please-config.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
"release-type": "python",
55
"versioning": "default",
66
"include-v-in-tag": false,
7-
"extra-files": ["ldclient/version.py"],
7+
"extra-files": ["ldclient/version.py", "PROVENANCE.md"],
88
"include-component-in-tag": false
99
}
1010
}

0 commit comments

Comments
 (0)