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.

Sign up for GitHub

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

Jump to bottom

Add datapolicy tags to staging/src/k8s.io/client-go/ #96001

Merged
merged 1 commit into from Nov 12, 2020
Merged

Add datapolicy tags to staging/src/k8s.io/client-go/ #96001

merged 1 commit into from Nov 12, 2020

Conversation

serathius
Copy link
Contributor

@serathius serathius commented Oct 29, 2020 •
edited

/kind feature

What this PR does / why we need it:
This PR adds "datapolicy" tags to golang structures as described in Kubernetes system components logs sanitization KEP. Those tags will be used by for ensuring this data will not be written to logs by Kubernetes system components.

List of datapolicy tags available:

  • security-key - for TLS certificate keys. Keywords: key, cert, pem
  • token - for HTTP authorization tokens. Keywords: token, secret, header, auth
  • password - anything passwordlike. Keywords: password

Special notes for your reviewer:

Due to size of Kubernetes codebase first iteration of tagging was done based on greping for particular keyword. Please ensure that tagged fields do contain type of sensitive data that matches their tag. Feel free to suggest any additional places that you think should be tagged.

Does this PR introduce a user-facing change?:
No

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

- [KEP]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1753-logs-sanitization

/cc @PurelyApplied
/sig instrumentation security
/priority important-soon
/milestone v1.20

@k8s-ci-robot k8s-ci-robot added the release-note-none Denotes a PR that doesn't merit a release note. label Oct 29, 2020
@k8s-ci-robot
Copy link
Contributor

@serathius: GitHub didn't allow me to request PR reviews from the following users: PurelyApplied.

Note that only kubernetes members and repo collaborators can review this PR, and authors cannot review their own PRs.

In response to this:

/kind feature

What this PR does / why we need it:
This PR adds "datapolicy" tags to golang structures as described in Kubernetes system components logs sanitization KEP. Those tags will be used by for ensuring this data will not be written to logs written by Kubernetes system components.

List of datapolicy tags available:

  • security-key - for TLS certificate keys. Keywords: key, cert, pem
  • token - for HTTP authorization tokens. Keywords: token, secret, header, auth
  • password - anything passwordlike. Keywords: password

Special notes for your reviewer:

Due to size of Kubernetes codebase first iteration of tagging was done based on greping for particular keyword. Please ensure that tagged fields do contain type of sensitive data that matches their tag. Feel free to suggest any additional places that you think should be tagged.

Does this PR introduce a user-facing change?:
No

NONE

Additional documentation e.g., KEPs (Kubernetes Enhancement Proposals), usage docs, etc.:

- [KEP]: https://github.com/kubernetes/enhancements/tree/master/keps/sig-instrumentation/1753-logs-sanitization

/cc @PurelyApplied
/sig instrumentation security
/priority important-soon
/milestone v1.20

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 k8s-ci-robot added kind/feature Categorizes issue or PR as related to a new feature. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. labels Oct 29, 2020
@k8s-ci-robot k8s-ci-robot added this to the v1.20 milestone Oct 29, 2020
@k8s-ci-robot k8s-ci-robot added sig/security Categorizes an issue or PR as relevant to SIG Security. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/auth Categorizes an issue or PR as relevant to SIG Auth. labels Oct 29, 2020
@serathius
Copy link
Contributor Author

/assign @sttts

@serathius serathius mentioned this pull request Oct 29, 2020
Closed
@serathius
Copy link
Contributor Author

/retest

@roycaihw
Copy link
Member

/cc @roycaihw @deads2k
/triage accepted

@k8s-ci-robot k8s-ci-robot added triage/accepted Indicates an issue or PR is ready to be actively worked on. and removed needs-triage Indicates an issue or PR lacks a `triage/foo` label and requires one. labels Oct 29, 2020
@roycaihw
Copy link
Member

/assign @deads2k
David, could you share opinion from security point of view? Thanks

sttts
sttts reviewed Nov 2, 2020
View reviewed changes
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/types.go Outdated
}

// Response defines metadata about a failed request, including HTTP status code and
// response headers.
type Response struct {
// Headers holds HTTP headers returned by the server.
Header map[string][]string
Header map[string][]string `datapolicy:"token"`
Copy link
Contributor

Choose a reason for hiding this comment

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

by the server, not the client.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Is there possibility of those headers having any sensitive information?

Copy link
Contributor

Choose a reason for hiding this comment

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

am not aware of any such case.

Copy link
Contributor

Choose a reason for hiding this comment

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

This is still marked as token

@sttts
Copy link
Contributor

sttts commented Nov 2, 2020

These annotations won't harm. Of course most structs in this PR are not exposed anywhere, but they could in the future by accident. So this looks fine.

Left some comments.

@serathius
Copy link
Contributor Author

There were some comments about sensitivity of client certificate, don't see them now. Maybe they were deleted or GitHub lost tem
Still I would want confirmation from @PurelyApplied. Should we classify client certificate as sensitive?

@serathius
Copy link
Contributor Author

/retest

@serathius serathius force-pushed the datapolicy-client-go branch 2 times, most recently from ad60272 to 8798c32 Compare November 12, 2020 11:27
@k8s-ci-robot k8s-ci-robot added size/L Denotes a PR that changes 100-499 lines, ignoring generated files. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API and removed size/M Denotes a PR that changes 30-99 lines, ignoring generated files. labels Nov 12, 2020
@k8s-ci-robot k8s-ci-robot added size/M Denotes a PR that changes 30-99 lines, ignoring generated files. and removed size/L Denotes a PR that changes 100-499 lines, ignoring generated files. labels Nov 12, 2020
@serathius
Copy link
Contributor Author

Sorry for test failure spam, looks like my local repository was corrupted resulting in prow failing to merge:

$git merge --no-ff -m 'Merge +refs/pull/96372/head:refs/pr/96372' f36893d68352e7f3e9d4a627052784beab7bb13f
merge: f36893d68352e7f3e9d4a627052784beab7bb13f - not something we can merge
$git log f36893d68352e7f3e9d4a627052784beab7bb13f
fatal: bad object f36893d68352e7f3e9d4a627052784beab7bb13f

@serathius
Copy link
Contributor Author

PTAL @sttts

@sttts
Copy link
Contributor

sttts commented Nov 12, 2020 •
edited

/lgtm
~~/assign @liggitt ~~

for API review.

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2020
@sttts
Copy link
Contributor

sttts commented Nov 12, 2020

/approve

@k8s-ci-robot k8s-ci-robot added the approved Indicates a PR has been approved by an approver from all required OWNERS files. label Nov 12, 2020
@k8s-ci-robot k8s-ci-robot removed the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2020
@fejta-bot
Copy link

This PR may require API review.

If so, when the changes are ready, complete the pre-review checklist and request an API review.

Status of requested reviews is tracked in the API Review project.

@serathius
Copy link
Contributor Author

Fixed gofmt.

@serathius
Copy link
Contributor Author

As this PR covers field that was responsible for CVE-2020-8565 and is approved let's include it in 1.20
/milestone v1.20

@k8s-ci-robot k8s-ci-robot added this to the v1.20 milestone Nov 12, 2020
liggitt
liggitt reviewed Nov 12, 2020
View reviewed changes
staging/src/k8s.io/client-go/pkg/apis/clientauthentication/types.go
// PEM-encoded client TLS certificate.
// +optional
ClientCertificateData string
// PEM-encoded client TLS private key.
// +optional
ClientKeyData string
ClientKeyData string `datapolicy:"secret-key"`
Copy link
Member

Choose a reason for hiding this comment

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

is there anything that will catch a typo in these values? how does data policy handle unknown datapolicy values?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Values of data policy are informational only. Datapolicy library will report list of all values.

Copy link
Contributor

Choose a reason for hiding this comment

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

Two weeks late to the party here, but KEP-1933 is going to use these field tags for its static analysis. It would be relatively easy to add an analysis step that examines what values correspond to datapolicy keys in field tags.

It would be a little messier to check for typos is the datapolicy key itself, but we could bark up that tree if we're concerned about it.

liggitt
liggitt reviewed Nov 12, 2020
View reviewed changes
Copy link
Member

@liggitt liggitt left a comment

Choose a reason for hiding this comment

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

/lgtm
/approve

@k8s-ci-robot k8s-ci-robot added the lgtm "Looks good to me", indicates that a PR is ready to be merged. label Nov 12, 2020
@k8s-ci-robot
Copy link
Contributor

[APPROVALNOTIFIER] This PR is APPROVED

This pull-request has been approved by: liggitt, serathius, sttts

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

@k8s-ci-robot k8s-ci-robot merged commit f4a156e into kubernetes:master Nov 12, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sttts sttts sttts left review comments

@liggitt liggitt liggitt left review comments

@PurelyApplied PurelyApplied PurelyApplied left review comments

@deads2k deads2k Awaiting requested review from deads2k

@roycaihw roycaihw Awaiting requested review from roycaihw

Assignees

@sttts sttts

@liggitt liggitt

@deads2k deads2k

Labels
approved Indicates a PR has been approved by an approver from all required OWNERS files. cncf-cla: yes Indicates the PR's author has signed the CNCF CLA. kind/api-change Categorizes issue or PR as related to adding, removing, or otherwise changing an API kind/feature Categorizes issue or PR as related to a new feature. lgtm "Looks good to me", indicates that a PR is ready to be merged. priority/important-soon Must be staffed and worked on either currently, or very soon, ideally in time for the next release. release-note-none Denotes a PR that doesn't merit a release note. sig/api-machinery Categorizes an issue or PR as relevant to SIG API Machinery. sig/auth Categorizes an issue or PR as relevant to SIG Auth. sig/instrumentation Categorizes an issue or PR as relevant to SIG Instrumentation. sig/security Categorizes an issue or PR as relevant to SIG Security. size/M Denotes a PR that changes 30-99 lines, ignoring generated files. triage/accepted Indicates an issue or PR is ready to be actively worked on.
Projects
None yet
Milestone
v1.20
Development

Successfully merging this pull request may close these issues.

None yet
8 participants
@serathius @k8s-ci-robot @roycaihw @sttts @PurelyApplied @fejta-bot @liggitt @deads2k