Skip to content
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

add disable_spire build tag for entrypoint command #8548

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

jkhelil
Copy link
Member

@jkhelil jkhelil commented Feb 3, 2025

We need to make Tekton Pipelines FIPS compliant, and the entrypoint command is a key step in this effort. Since it is statically compiled, we must ensure that cryptographic symbols are removed from the entrypoint binary. To achieve this, we need compile options to disable TLS, SPIRE, and any network-related functionality.

This PR is a partial implementation that introduces a build tag to disable SPIRE (github.com/tektoncd/pipeline/pkg/spire) in cmd/entrypoint/main.go.

Changes

This PR introduces a build tag to conditionally disable SPIRE functionality in the cmd/entrypoint/main.go file. The following changes have been made:

  • Added a build tag disable_spire to conditionally exclude SPIRE-related logic.
  • Split SPIRE logic into two files:
    spire.go for when SPIRE is enabled.
    spire_disabled.go for when SPIRE is disabled using the disable_spire build tag.

partially fixes #8531

Submitter Checklist

As the author of this PR, please check off the items in this checklist:

  • Has Docs if any changes are user facing, including updates to minimum requirements e.g. Kubernetes version bumps
  • Has Tests included if any functionality added or changed
  • pre-commit Passed
  • Follows the commit message standard
  • Meets the Tekton contributor standards (including functionality, content, code)
  • Has a kind label. You can add one by adding a comment on this PR that contains /kind <type>. Valid types are bug, cleanup, design, documentation, feature, flake, misc, question, tep
  • Release notes block below has been updated with any user facing changes (API changes, bug fixes, changes requiring upgrade notices or deprecation warnings). See some examples of good release notes.
  • Release notes contains the string "action required" if the change requires additional action from users switching to the new release

Release Notes

NONE

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Feb 3, 2025
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by:
To complete the pull request process, please assign dibyom after the PR has been reviewed.
You can assign the PR to them by writing /assign @dibyom in a comment when ready.

The full list of commands accepted by this bot can be found here.

Needs approval from an approver in each of these files:

Approvers can indicate their approval by writing /approve in a comment
Approvers can cancel approval by writing /approve cancel in a comment

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@jkhelil jkhelil force-pushed the spire_disable_entrypoint branch from 294dcf8 to e6535ed Compare February 5, 2025 10:05
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@afrittoli
Copy link
Member

fixes #8531

This comment will close the issue once this PR is merged, but it only addresses one part of the issue.
It's better to use "partially-fixes" in this case, or "related to"

Copy link
Member

@afrittoli afrittoli left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for this.
I think it needs some documentation:

  • dev docs explaining how to build with spire disabled
  • end user docs, in the spire section, explaining tha spire needs to be enabled at build time for the config flag to actually work

Would it make sense to log something or fail if the spire flag was enabled when using a build without spire?

@jkhelil jkhelil changed the title add spire_disabled build tag for entrypoint command add disable_spire build tag for entrypoint command Feb 6, 2025
@jkhelil jkhelil force-pushed the spire_disable_entrypoint branch from e6535ed to 2a4dc09 Compare February 6, 2025 07:48
@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@jkhelil jkhelil force-pushed the spire_disable_entrypoint branch from 2a4dc09 to 7d894e1 Compare February 6, 2025 08:09
@jkhelil
Copy link
Member Author

jkhelil commented Feb 6, 2025

@afrittoli @vdemeester I have added docs and check enable_spire flag to exit if the build is not spire enabled

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@tekton-robot
Copy link
Collaborator

The following is the coverage report on the affected files.
Say /test pull-tekton-pipeline-go-coverage-df to re-run this coverage report

File Old Coverage New Coverage Delta
cmd/entrypoint/main.go 11.9% 12.5% 0.6
cmd/entrypoint/spire.go Do not exist 0.0%
pkg/entrypoint/entrypointer.go 88.1% 88.0% -0.0
pkg/entrypoint/spire.go Do not exist 100.0%

@vdemeester
Copy link
Member

/kind cleanup
/retest

@tekton-robot tekton-robot added the kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. label Feb 7, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
kind/cleanup Categorizes issue or PR as related to cleaning up code, process, or technical debt. release-note-none Denotes a PR that doesnt merit a release note. size/L Denotes a PR that changes 100-499 lines, ignoring generated files.
Projects
Status: Todo
Development

Successfully merging this pull request may close these issues.

Making pipeline (and entrypoint) FIPS complitant
4 participants