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

fix(misconf): fix incorrect k8s locations due to JSON to YAML conversion #8073

Merged
merged 3 commits into from
Feb 27, 2025

Conversation

nikpivkin
Copy link
Contributor

@nikpivkin nikpivkin commented Dec 9, 2024

Description

This PR uses github.com/go-json-experiment/json to parsing JSON manifests, which produces correct node positions, unlike the current approach where JSON is first converted to YAML and then parsed.

Before

AVD-KSV-0021 (LOW): Container 'hello' of Pod 'hello-cpu-limit' should set 'securityContext.runAsGroup' > 10000
════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
Force the container to run with group ID > 10000 to avoid conflicts with the host’s user table.

See https://avd.aquasec.com/misconfig/ksv021
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
 test.json:7-12
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   7 ┌     "spec": {
   8 │         "containers": [
   9 │             {
  10 │                 "command": ["sh", "-c", "echo 'Hello' && sleep 1h"],
  11 │                 "image": "busybox",
  12 └                 "name": "hello"
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

After

AVD-KSV-0021 (LOW): Container 'hello' of Pod 'hello-cpu-limit' should set 'securityContext.runAsGroup' > 10000
════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════════
Force the container to run with group ID > 10000 to avoid conflicts with the host’s user table.

See https://avd.aquasec.com/misconfig/ksv021
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
 test.json:8-13
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
   8 ┌         "containers": [
   9 │             {
  10 │                 "command": ["sh", "-c", "echo 'Hello' && sleep 1h"],
  11 │                 "image": "busybox",
  12 │                 "name": "hello"
  13 └             }
────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────

Related issues

Checklist

  • I've read the guidelines for contributing to this repository.
  • I've followed the conventions in the PR title.
  • I've added tests that prove my fix is effective or that my feature works.
  • I've updated the documentation with the relevant information (if needed).
  • I've added usage information (if the PR introduces new options)
  • I've included a "before" and "after" example to the description (if the PR is a user interface change).

Copy link

github-actions bot commented Feb 8, 2025

This PR is stale because it has been labeled with inactivity.

@github-actions github-actions bot added the lifecycle/stale Denotes an issue or PR has remained open with no activity and will be auto-closed. label Feb 8, 2025
@nikpivkin nikpivkin force-pushed the k8s-json-loc branch 2 times, most recently from be3824f to 89dd527 Compare February 19, 2025 19:03
@nikpivkin
Copy link
Contributor Author

@simar7 Although this is an experimental package, it is already used in a lot of projects. Also recently opened a proposal to include this package in Go as encoding/json/v2. What do you think about using it?

@nikpivkin nikpivkin marked this pull request as ready for review February 19, 2025 19:32
@github-actions github-actions bot removed the lifecycle/stale Denotes an issue or PR has remained open with no activity and will be auto-closed. label Feb 20, 2025
@simar7
Copy link
Member

simar7 commented Feb 25, 2025

@simar7 Although this is an experimental package, it is already used in a lot of projects. Also recently opened a proposal to include this package in Go as encoding/json/v2. What do you think about using it?

Interesting, I'm not opposed to it but I am curious if we can solve it with what's already there in stdlib or not.

@nikpivkin
Copy link
Contributor Author

Currently, the encoding/json package does not provide a way to retrieve node positions.

Copy link
Member

@simar7 simar7 left a comment

Choose a reason for hiding this comment

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

lgtm just left one comment, @knqyf263 do you have any thoughts on this?

go.mod Outdated
@@ -48,6 +48,7 @@ require (
github.com/docker/go-units v0.5.0
github.com/fatih/color v1.18.0
github.com/go-git/go-git/v5 v5.13.2
github.com/go-json-experiment/json v0.0.0-20250211171154-1ae217ad3535
Copy link
Member

Choose a reason for hiding this comment

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

nit: Could we add a link to the Golang proposal here that would adopt this package? That way we can remove it once it gets upstreamed.

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Done 59db14e

@simar7 simar7 added this pull request to the merge queue Feb 27, 2025
Merged via the queue into aquasecurity:main with commit a994453 Feb 27, 2025
12 checks passed
dstrelbytskyi pushed a commit to datarobot/trivy that referenced this pull request Mar 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

bug(misconf): Incorrect location of findings in k8s JSON scan
2 participants