lnd icon indicating copy to clipboard operation
lnd copied to clipboard
verified publisher icon lightningnetwork

build: Add integrity pinning to Docker build images

Open dstadulis opened this issue 1 year ago • 1 comments

Change Description

This PR adds integrity pinning to Docker build images. Referencing the Docker environment by a specified SHA hash reduces the need to trust, the on-going integrity of Dockerhub resources, or data-transport.

Before this change, build Dockerfiles referenced docker images by notional content which could be malicously swapped without alerting.

Docker-Image digests exist under a cohesive index digest which account for the fact that different architectures will obtain different image files. See additional commentary: https://github.com/docker/hub-feedback/issues/1925#issuecomment-565646445

Producing Integrity Pinning Digests

Local:

docker inspect $image_name
#JSON output results

HTTP: https://hub.docker.com/layers/library/golang/1.22.6-bookworm/images/sha256-8ae92b0f1598356df80f4e9bd682c4cdbae8f1a3fc9cee1f05ce88a00462f05f

JSON API: https://registry.hub.docker.com/v2/repositories/library/golang/tags/1.22

Steps to Test

# Fetch
gh pr checkout 9115

git checkout docker-build-image-integrity
SKIP_VERSION_CHECK=1 make docker-release tag=docker-build-image-integrity

Pull Request Checklist

Testing

  • [ ] Your PR passes all CI checks.
  • [ ] Tests covering the positive and negative (error paths) are included.
  • [ ] Bug fixes contain tests triggering the bug to prevent regressions.

Code Style and Documentation

dstadulis avatar Sep 18 '24 03:09 dstadulis

[!IMPORTANT]

Review skipped

Auto reviews are limited to specific labels.

Labels to auto review (1)
  • llm-review

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share
Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example: -- I pushed a fix in commit <commit_id>, please review it. -- Generate unit testing code for this file.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples: -- @coderabbitai generate unit testing code for this file. -- @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: -- @coderabbitai generate interesting stats about this repository and render them as a table. -- @coderabbitai read src/utils.ts and generate unit testing code. -- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format. -- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

coderabbitai[bot] avatar Sep 18 '24 03:09 coderabbitai[bot]

Build system improvements are being opened in litd: https://github.com/lightninglabs/lightning-terminal/pull/881

If this PR is merged the benefits can be duplicated into other repos.

dstadulis avatar Oct 23 '24 10:10 dstadulis

lmk if the the section "Producing Integrity Pinning Digests" should be added to development guides: The section's purpose is to aid future developers when producing the digest when updating the docker version

dstadulis avatar Oct 23 '24 11:10 dstadulis

lmk if the the section "Producing Integrity Pinning Digests" should be added to development guides: The section's purpose is to aid future developers when producing the digest when updating the docker version

I think that would be helpful, yes. And perhaps a comment above each version in the Dockerfiles where to find the commands for how to extract the hash.

guggero avatar Oct 23 '24 11:10 guggero