Clear the secrets from request for klog print in `logGRPC()` #1462

mpatlasov · 2023-10-20T02:43:19Z

Malicious user can put a secret in request as explained here: #1372.

What type of PR is this?

/kind bug

What this PR does / why we need it:

Malicious user can put a secret in request as explained here: #1372.

This PR simply clears the secrets from request.

Which issue(s) this PR fixes:

Fixes #1372

Does this PR introduce a user-facing change?:

NONE

k8s-ci-robot · 2023-10-20T02:43:28Z

Welcome @mpatlasov!

It looks like this is your first PR to kubernetes-sigs/gcp-compute-persistent-disk-csi-driver 🎉. Please refer to our pull request process documentation to help your PR have a smooth ride to approval.

You will be prompted by a bot to use commands during the review process. Do not be afraid to follow the prompts! It is okay to experiment. Here is the bot commands documentation.

You can also check if kubernetes-sigs/gcp-compute-persistent-disk-csi-driver has its own contribution guidelines.

You may want to refer to our testing guide if you run into trouble with your tests not passing.

If you are having difficulty getting your pull request seen, please follow the recommended escalation practices. Also, for tips and tricks in the contribution process you may want to read the Kubernetes contributor cheat sheet. We want to make sure your contribution gets all the attention it needs!

Thank you, and welcome to Kubernetes. 😃

k8s-ci-robot · 2023-10-20T02:43:29Z

Hi @mpatlasov. Thanks for your PR.

I'm waiting for a kubernetes-sigs member to verify that this patch is reasonable to test. If it is, they should reply with /ok-to-test on its own line. Until that is done, I will not automatically test new commits in this PR, but the usual testing commands by org members will still work. Regular contributors should join the org to skip this step.

Once the patch is verified, the new status will be reflected by the ok-to-test label.

I understand the commands that are listed here.

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.

k8s-ci-robot · 2023-10-20T02:43:32Z

[APPROVALNOTIFIER] This PR is NOT APPROVED

This pull-request has been approved by: mpatlasov
Once this PR has been reviewed and has the lgtm label, please assign saikat-royc for approval. For more information see the Kubernetes Code Review Process.

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

Needs approval from an approver in each of these files:

OWNERS

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

msau42 · 2023-10-20T04:57:49Z

pkg/gce-pd-csi-driver/utils.go

- klog.V(4).Infof("%s called with request: %s", info.FullMethod, req)
+ // However malicious user still can put a secret in request as explained here:
+ // https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/issues/1372
+ if klog.V(4).Enabled() {


We regularly use log level 4 in production. Since this driver doesn't actually require any secret, can we just clear the secrets from the request?

@msau42 , the request may be of different types, i.e. NodeExpandVolumeRequest is not the only type with Secrets (e.g. CreateVolumeRequest, DeleteVolumeRequest, etc.). I didn't find any straightforward way to clear the secrets from a request of arbitrary type, can you tell me how you suggest to do it?

Do you think we can leverage the reflect package? https://pkg.go.dev/reflect#example-Value.FieldByName potentially looks promising. Or could we even use https://pkg.go.dev/reflect#StructTag to create a more efficient protosanitizer?

mpatlasov · 2023-10-30T06:36:05Z

Last push reworks PR: instead of calling protosanitizer.StripSecrets(req), now it simply clears the secrets from request.

pkg/gce-pd-csi-driver/utils.go

Malicious user can put a secret in request as explained here: kubernetes-sigs#1372.

mpatlasov · 2023-11-03T22:38:05Z

Last push addressed Jan's comment:

Reflection magic went to a separate function
Comment fixed
Unit-test added

jsafrane · 2023-11-29T13:58:35Z

/ok-to-test

jsafrane · 2023-11-29T16:53:32Z

/lgtm

mpatlasov · 2023-11-29T16:54:01Z

@msau42 , can you approve please?

k8s-ci-robot · 2023-12-08T05:40:25Z

PR needs rebase.

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.

msau42 · 2023-12-28T21:18:12Z

pkg/gce-pd-csi-driver/utils.go

@@ -56,14 +57,30 @@ func NewNodeServiceCapability(cap csi.NodeServiceCapability_RPC_Type) *csi.NodeS
 }
 }

+// Reflect magic below simply clears Secrets map from request.
+func clearSecrets(req interface{}) interface{} {


@jsafrane how do you feel about putting this into csi-lib-utils as an alternative to protosanitizer so that it is not specific to a csi driver?

Sounds good to me, but with a huge warning that only field explicitly named Secrets is cleared.

msau42 · 2023-12-28T21:18:43Z

pkg/gce-pd-csi-driver/utils.go

@@ -56,14 +57,30 @@ func NewNodeServiceCapability(cap csi.NodeServiceCapability_RPC_Type) *csi.NodeS
 }
 }

+// Reflect magic below simply clears Secrets map from request.


It would be good to document all the assumptions about how secret fields are named in the csi spec.

msau42 · 2023-12-28T21:20:50Z

pkg/gce-pd-csi-driver/utils.go

- // Note that secrets are not included in any RPC message. In the past protosanitizer and other log
+ // Note that secrets may be included in some RPC messages
+ // (https://github.com/kubernetes-sigs/gcp-compute-persistent-disk-csi-driver/issues/1372),
+ // but the driver ignores them. In the past protosanitizer and other log


Are you able to do a benchmark test to show that the reflect method does not signficantly increase CPU usage?

k8s-triage-robot · 2024-04-04T14:16:23Z

The Kubernetes project currently lacks enough contributors to adequately respond to all PRs.

This bot triages PRs according to the following rules:

After 90d of inactivity, lifecycle/stale is applied
After 30d of inactivity since lifecycle/stale was applied, lifecycle/rotten is applied
After 30d of inactivity since lifecycle/rotten was applied, the PR is closed

You can:

Mark this PR as fresh with /remove-lifecycle stale
Close this PR with /close
Offer to help out with Issue Triage

Please send feedback to sig-contributor-experience at kubernetes/community.

/lifecycle stale

mpatlasov · 2024-04-04T14:42:33Z

/remove-lifecycle stale

k8s-ci-robot added release-note-none Denotes a PR that doesn't merit a release note. kind/bug Categorizes issue or PR as related to a bug. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. labels Oct 20, 2023

k8s-ci-robot added the needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. label Oct 20, 2023

k8s-ci-robot requested review from leiyiz and saikat-royc October 20, 2023 02:43

k8s-ci-robot added the size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. label Oct 20, 2023

msau42 reviewed Oct 20, 2023

View reviewed changes

mpatlasov force-pushed the sanitize-req-in-klog-print branch from 4eb6516 to a618653 Compare October 30, 2023 06:31

k8s-ci-robot added size/S Denotes a PR that changes 10-29 lines, ignoring generated files. and removed size/XS Denotes a PR that changes 0-9 lines, ignoring generated files. labels Oct 30, 2023

mpatlasov changed the title ~~Sanitize request for klog print in logGRPC()~~ Clear secrets from request for klog print in logGRPC() Oct 30, 2023

mpatlasov changed the title ~~Clear secrets from request for klog print in logGRPC()~~ Clear the secrets from request for klog print in logGRPC() Oct 30, 2023

jsafrane reviewed Nov 2, 2023

View reviewed changes

pkg/gce-pd-csi-driver/utils.go Outdated Show resolved Hide resolved

pkg/gce-pd-csi-driver/utils.go Show resolved Hide resolved

Clear secrets from request for klog print in logGRPC()

afd457a

Malicious user can put a secret in request as explained here: kubernetes-sigs#1372.

mpatlasov force-pushed the sanitize-req-in-klog-print branch from a618653 to afd457a Compare November 3, 2023 22:34

k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/S Denotes a PR that changes 10-29 lines, ignoring generated files. labels Nov 3, 2023

k8s-ci-robot added ok-to-test Indicates a non-member PR verified by an org member that is safe to test. and removed needs-ok-to-test Indicates a PR that requires an org member to verify it is safe to test. labels Nov 29, 2023

k8s-ci-robot assigned jsafrane Nov 29, 2023

k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 29, 2023

k8s-ci-robot added the needs-rebase Indicates a PR cannot be merged because it has merge conflicts with HEAD. label Dec 8, 2023

mpatlasov mentioned this pull request Dec 22, 2023

REQUEST: New membership for mpatlasov kubernetes/org#4636

Closed

9 tasks

msau42 reviewed Dec 28, 2023

View reviewed changes

k8s-ci-robot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 4, 2024

k8s-ci-robot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and has become stale. label Apr 4, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Clear the secrets from request for klog print in `logGRPC()` #1462

Clear the secrets from request for klog print in `logGRPC()` #1462

mpatlasov commented Oct 20, 2023 •

edited

k8s-ci-robot commented Oct 20, 2023

k8s-ci-robot commented Oct 20, 2023

k8s-ci-robot commented Oct 20, 2023

msau42 Oct 20, 2023

mpatlasov Oct 23, 2023

msau42 Oct 25, 2023

mpatlasov commented Oct 30, 2023

mpatlasov commented Nov 3, 2023

jsafrane commented Nov 29, 2023

jsafrane commented Nov 29, 2023

mpatlasov commented Nov 29, 2023

k8s-ci-robot commented Dec 8, 2023

msau42 Dec 28, 2023

jsafrane Jan 5, 2024

msau42 Dec 28, 2023

msau42 Dec 28, 2023

k8s-triage-robot commented Apr 4, 2024

mpatlasov commented Apr 4, 2024

Clear the secrets from request for klog print in logGRPC() #1462

Are you sure you want to change the base?

Clear the secrets from request for klog print in logGRPC() #1462

Conversation

mpatlasov commented Oct 20, 2023 • edited

k8s-ci-robot commented Oct 20, 2023

k8s-ci-robot commented Oct 20, 2023

k8s-ci-robot commented Oct 20, 2023

msau42 Oct 20, 2023

Choose a reason for hiding this comment

mpatlasov Oct 23, 2023

Choose a reason for hiding this comment

msau42 Oct 25, 2023

Choose a reason for hiding this comment

mpatlasov commented Oct 30, 2023

mpatlasov commented Nov 3, 2023

jsafrane commented Nov 29, 2023

jsafrane commented Nov 29, 2023

mpatlasov commented Nov 29, 2023

k8s-ci-robot commented Dec 8, 2023

msau42 Dec 28, 2023

Choose a reason for hiding this comment

jsafrane Jan 5, 2024

Choose a reason for hiding this comment

msau42 Dec 28, 2023

Choose a reason for hiding this comment

msau42 Dec 28, 2023

Choose a reason for hiding this comment

k8s-triage-robot commented Apr 4, 2024

mpatlasov commented Apr 4, 2024

Clear the secrets from request for klog print in `logGRPC()` #1462

Clear the secrets from request for klog print in `logGRPC()` #1462

mpatlasov commented Oct 20, 2023 •

edited