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

[TEP-0145] Add sanity check for CEL expression #7251

Merged

Conversation

Yongxuanzhang
Copy link
Member

@Yongxuanzhang Yongxuanzhang commented Oct 20, 2023

Changes

3rd PR of TEP-0145 tracked by #7244.

This commit adds sanity check for CEL expression by pre-compiling the
CEL expression at admission webhook without evluation. This can help
fail fast if the CEL expression is invalid. And also disallow the usage
of variable references without wrapper with single quotes and prevent
CEL injection from variables.

/kind feature

Signed-off-by: Yongxuan Zhang yongxuanzhang@google.com

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
  • 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
Copy link
Collaborator

Skipping CI for Draft Pull Request.
If you want CI signal for your change, please convert it to an actual PR.
You can still manually trigger a test run with /test all

@tekton-robot tekton-robot added release-note-none Denotes a PR that doesnt merit a release note. do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. kind/feature Categorizes issue or PR as related to a new feature. labels Oct 20, 2023
@tekton-robot tekton-robot added the size/L Denotes a PR that changes 100-499 lines, ignoring generated files. label Oct 20, 2023
@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
pkg/apis/config/feature_flags.go 93.9% 94.0% 0.1
pkg/apis/pipeline/v1/when_validation.go 100.0% 96.8% -3.2
pkg/apis/pipeline/v1beta1/pipeline_conversion.go 95.3% 95.4% 0.0
pkg/apis/pipeline/v1beta1/when_validation.go 100.0% 96.8% -3.2

Comment on lines 62 to 65
env, err := cel.NewEnv()
if err != nil {
return apis.ErrGeneric("err: %s", err.Error())
}
Copy link
Member Author

Choose a reason for hiding this comment

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

Since we don't add env declarations here, we won't get errs. So we cannot test the error. Or can we omit this err? 🤔

@Yongxuanzhang Yongxuanzhang force-pushed the cel-tep-145-2-expression-validate branch from a9e2e3a to 4c2becd Compare October 20, 2023 18:59
@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
pkg/apis/config/feature_flags.go 93.9% 94.0% 0.1
pkg/apis/pipeline/v1/when_validation.go 100.0% 96.8% -3.2
pkg/apis/pipeline/v1beta1/pipeline_conversion.go 95.3% 95.4% 0.0
pkg/apis/pipeline/v1beta1/when_validation.go 100.0% 96.8% -3.2

@tekton-robot tekton-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 21, 2023
@Yongxuanzhang Yongxuanzhang force-pushed the cel-tep-145-2-expression-validate branch from 4c2becd to e144176 Compare October 21, 2023 16:54
@tekton-robot tekton-robot removed the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Oct 21, 2023
@Yongxuanzhang Yongxuanzhang force-pushed the cel-tep-145-2-expression-validate branch 2 times, most recently from 8b81d38 to 19de419 Compare October 21, 2023 17:02
@Yongxuanzhang Yongxuanzhang marked this pull request as ready for review October 21, 2023 17:03
@tekton-robot tekton-robot removed the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Oct 21, 2023
@tekton-robot tekton-robot requested a review from dibyom October 21, 2023 17:03
This commit adds sanity check for CEL expression by pre-compiling the
CEL expression at admission webhook without evluation. This can help
fail fast if the CEL expression is invalid. And also disallow the usage
of variable references without wrapper with single quotes and prevent
CEL injection from variables.

Signed-off-by: Yongxuan Zhang yongxuanzhang@google.com
@Yongxuanzhang Yongxuanzhang force-pushed the cel-tep-145-2-expression-validate branch from 19de419 to 261a7db Compare October 21, 2023 17:04
@tektoncd tektoncd deleted a comment from tekton-robot Oct 21, 2023
@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
pkg/apis/pipeline/v1/when_validation.go 100.0% 96.8% -3.2
pkg/apis/pipeline/v1beta1/when_validation.go 100.0% 96.8% -3.2

@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
pkg/apis/pipeline/v1/when_validation.go 100.0% 96.8% -3.2
pkg/apis/pipeline/v1beta1/when_validation.go 100.0% 96.8% -3.2

@tekton-robot tekton-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Oct 23, 2023
@jerop
Copy link
Member

jerop commented Oct 23, 2023

/test pull-tekton-pipeline-go-coverage

@chmouel
Copy link
Member

chmouel commented Oct 23, 2023

/lgtm

@tekton-robot
Copy link
Collaborator

@chmouel: changing LGTM is restricted to collaborators

In response to this:

/lgtm

Instructions for interacting with me using PR comments are available here. If you have questions or suggestions related to my behavior, please file an issue against the kubernetes/test-infra repository.

@jerop
Copy link
Member

jerop commented Oct 23, 2023

/lgtm

@tekton-robot tekton-robot added the lgtm Indicates that a PR is ready to be merged. label Oct 23, 2023
@tekton-robot
Copy link
Collaborator

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: jerop, vdemeester

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

The pull request process is described 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 tekton-robot merged commit c29e978 into tektoncd:main Oct 23, 2023
2 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. kind/feature Categorizes issue or PR as related to a new feature. lgtm Indicates that a PR is ready to be merged. 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
None yet
Development

Successfully merging this pull request may close these issues.

5 participants