-
Notifications
You must be signed in to change notification settings - Fork 8
Initial verifiable builds docs #239
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
MadelineAu
wants to merge
3
commits into
main
Choose a base branch
from
verifiableBuilds
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,49 @@ | ||
| --- | ||
| title: Verifiable Builds | ||
| sidebar_position: 5 | ||
| --- | ||
|
|
||
| Verifiable builds provide cryptographic proof linking the source code and build process for EigenCompute applications. EigenCompute verifiable builds | ||
| enable users to cryptographically verify that a running container was built from a specific GitHub commit. | ||
|
|
||
| EigenCompute uses the [Google Cloud Build SLSA provenance system](https://cloud.google.com/build/docs/securing-builds/generate-validate-build-provenance/) | ||
| to provide the build digest that is cryptographically signed by Google Cloud Build and includes: | ||
|
|
||
| * Git repository URL | ||
| * Exact commit SHA | ||
| * Dockerfile path and build context | ||
| * All dependency image digests | ||
| * Build timestamp. | ||
|
|
||
| Verifiably built containers are stored publicly in [Docker Hub](https://hub.docker.com/r/eigenlayer/eigencloud-containers). | ||
|
|
||
| The [Verifiability Dashboard](https://verify.eigencloud.xyz/) displays the status of source code verification for applications. | ||
|
|
||
| For information on how to build verifiably, see [Build from verfiable source](../howto/build/verifiable-builds/build-from-verifiable-source.md). | ||
|
|
||
| ## Dependencies | ||
|
|
||
| For an application to be verifiably built, every layer of the application stack must be verifiably built. You cannot include | ||
| unverified code in a verifiable build. | ||
|
|
||
| When you submit a build with dependencies, each dependency: | ||
|
|
||
| 1. Must be a previously verifiably built image. | ||
| 2. Must have valid SLSA provenance. | ||
| 3. Must have it's digest recorded in your build's provenance. | ||
|
|
||
| When submitting a build with dependencies, provenance is validated and dependency digests are recorded in the build's SLSA provenance. | ||
|
|
||
| The [EigenCompute TLS and KMS clients are prebuilt](https://github.com/Layr-Labs/eigencompute-containers) and the digests included in all EigenCompute applications. | ||
|
|
||
| EigenCompute applications with dependencies other than the TLS and KMS clients must submit those verifiable builds and include | ||
| the dependency's image digest when verifiably building the application. | ||
|
|
||
| ## Guarantees | ||
|
|
||
| | Property | Guarantee | | ||
| |-----------------------|---------------------------------------------------------| | ||
| | Source Verification | Every line of code traces back to a specific git commit | | ||
| | Build Reproducibility | Same inputs always produce same provenance | | ||
| | Dependency Integrity | No unverified code can be injected | | ||
| | Tamper Evidence | Any modification breaks the cryptographic chain | | ||
6 changes: 6 additions & 0 deletions
6
docs/eigencompute/howto/build/verifiable-builds/_category_.json
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,6 @@ | ||
| { | ||
| "position": 4, | ||
| "label": "Verifiable Builds", | ||
| "collapsible": true, | ||
| "collapsed": false, | ||
| } |
53 changes: 53 additions & 0 deletions
53
docs/eigencompute/howto/build/verifiable-builds/build-from-verifiable-source.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,53 @@ | ||
| --- | ||
| title: Build from verifiable source | ||
| sidebar_position: 1 | ||
| --- | ||
|
|
||
| To build from a verifiable source, options are: | ||
|
|
||
| 1. Use the `ecloud compute build submit` command to submit a verifiable build from a GitHub source. | ||
| 2. Specify the `--verifiable` option or select `Yes` when prompted when deploying or upgrading using the `ecloud compute deploy` or `upgrade` commands.. | ||
|
|
||
| ## Submit from GitHub source | ||
|
|
||
| To submit a verifiable build from a GitHub source, specify the required options or supply when prompted: | ||
|
|
||
| * `--repo` (`ECLOUD_BUILD_REPO`) | ||
| * `--commit` (`ECLOUD_BUILD_COMMIT`) | ||
| * `--dockerfile` (`ECLOUD_BUILD_DOCKERFILE`, default is `Dockerfile`) | ||
| * `--context` (`ECLOUD_BUILD_CONTEXT`, default is `.`) | ||
| * `--dependencies sha256:...` (repeatable; prompt supports comma-separated) | ||
| * `--build-caddyfile` (`ECLOUD_BUILD_CADDYFILE`) (optional) | ||
| * `--no-follow` | ||
| * `--json` | ||
|
|
||
| For example: | ||
| ``` | ||
| ecloud compute build submit --repo https://github.com/myorg/myapp --commit abc123... | ||
|
|
||
| ecloud compute build submit --repo https://github.com/myorg/myapp --commit abc123... --dependencies sha256:def456... | ||
|
|
||
| ecloud compute build submit --repo https://github.com/myorg/myapp --commit abc123... --build-caddyfile Caddyfile | ||
|
|
||
| ecloud compute build submit --repo https://github.com/myorg/myapp --commit abc123... --no-follow | ||
| ``` | ||
|
|
||
| Once built and verified, the image can be specified as a prebuilt image when deploying or upgrading. | ||
|
|
||
| ## Submit when deploying or upgrading | ||
|
|
||
| To submit when deploying or upgrading, specify the `--verifiable` option for the `ecloud compute app` command, or select | ||
| `Yes` when prompted. | ||
|
|
||
| When deploying or upgrading, specify a GitHub source using the `--build-context`, `--build-dependencies`, and `--build-dockerfile` options, | ||
| or specify a prebuilt verifiable image using the `--image-ref` option. | ||
|
|
||
| ## Submitting builds with dependencies | ||
|
|
||
| To specify prebuilt dependencies to include in a verifiable build, use the `--dependencies` option for `ecloud compute build`, | ||
| `ecloud compute app deploy` or `ecloud compute app upgrade`. | ||
|
|
||
| The EigenCompute TLS and KMS clients do not need to be specified as dependencies because they are [prebuilt](https://github.com/Layr-Labs/eigencompute-containers) | ||
| and the digests included in all EigenCompute applications. | ||
|
|
||
| For more information on dependencies in verifiable builds, refer to [Verifiable Builds](../../../concepts/verifiable-builds.md). |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think we should include the Google SLSA Providence public key that we use to verify everything? And possibly link out to Google's documentation on SLSA provenance.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yep - I need to add another topic for 'how to verify' and include those.