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

feat(misconf): Show misconfig ID in output #7762

Merged
merged 3 commits into from
Oct 23, 2024
Merged

feat(misconf): Show misconfig ID in output #7762

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
edf33d5
feat(misconf): Show misconfig ID in output
simar7 Oct 18, 2024
0513137
update format
simar7 Oct 21, 2024
36a5573
use AVDID
simar7 Oct 23, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions pkg/report/table/misconfig.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -124,18 +124,18 @@ func (r *misconfigRenderer) renderSummary(misconf types.DetectedMisconfiguration
}
}

// severity
// ID & severity
switch misconf.Severity {
case severityCritical:
r.printf("<red><bold>%s: ", misconf.Severity)
r.printf("%s <red><bold>(%s): ", misconf.AVDID, misconf.Severity)
case severityHigh:
r.printf("<red>%s: ", misconf.Severity)
r.printf("%s <red>(%s): ", misconf.AVDID, misconf.Severity)
case severityMedium:
r.printf("<yellow>%s: ", misconf.Severity)
r.printf("%s <yellow>(%s): ", misconf.AVDID, misconf.Severity)
case severityLow:
r.printf("%s: ", misconf.Severity)
r.printf("%s (%s): ", misconf.AVDID, misconf.Severity)
default:
r.printf("<blue>%s: ", misconf.Severity)
r.printf("%s <blue>(%s): ", misconf.AVDID, misconf.Severity)
}

// heading
Expand Down
21 changes: 11 additions & 10 deletions pkg/report/table/misconfig_test.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ func TestMisconfigRenderer(t *testing.T) {
MisconfSummary: &types.MisconfSummary{Successes: 0, Failures: 1, Exceptions: 0},
Misconfigurations: []types.DetectedMisconfiguration{
{
ID: "AVD-XYZ-0123",
ID: "some-alias-for-a-check",
AVDID: "AVD-XYZ-0123",
Title: "Config file is bad",
Description: "Your config file is not good.",
Message: "Oh no, a bad config.",
Expand All @@ -44,7 +45,7 @@ my-file ()
Tests: 1 (SUCCESSES: 0, FAILURES: 1, EXCEPTIONS: 0)
Failures: 1 (LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)

HIGH: Oh no, a bad config.
AVD-XYZ-0123 (HIGH): Oh no, a bad config.
════════════════════════════════════════
Your config file is not good.

Expand All @@ -61,7 +62,7 @@ See https://google.com/search?q=bad%20config
MisconfSummary: &types.MisconfSummary{Successes: 0, Failures: 1, Exceptions: 0},
Misconfigurations: []types.DetectedMisconfiguration{
{
ID: "AVD-XYZ-0123",
AVDID: "AVD-XYZ-0123",
Title: "Config file is bad",
Description: "Your config file is not good.",
Message: "Oh no, a bad config.",
Expand Down Expand Up @@ -103,7 +104,7 @@ my-file ()
Tests: 1 (SUCCESSES: 0, FAILURES: 1, EXCEPTIONS: 0)
Failures: 1 (LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)

HIGH: Oh no, a bad config.
AVD-XYZ-0123 (HIGH): Oh no, a bad config.
════════════════════════════════════════
Your config file is not good.

Expand All @@ -126,7 +127,7 @@ See https://google.com/search?q=bad%20config
MisconfSummary: &types.MisconfSummary{Successes: 1, Failures: 1, Exceptions: 0},
Misconfigurations: []types.DetectedMisconfiguration{
{
ID: "AVD-XYZ-0123",
AVDID: "AVD-XYZ-0123",
Title: "Config file is bad",
Description: "Your config file is not good.",
Message: "Oh no, a bad config.",
Expand Down Expand Up @@ -157,7 +158,7 @@ See https://google.com/search?q=bad%20config
},
},
{
ID: "AVD-XYZ-0456",
AVDID: "AVD-XYZ-0456",
Title: "Config file is bad again",
Description: "Your config file is still not good.",
Message: "Oh no, a bad config AGAIN.",
Expand All @@ -174,7 +175,7 @@ my-file ()
Tests: 2 (SUCCESSES: 1, FAILURES: 1, EXCEPTIONS: 0)
Failures: 1 (LOW: 0, MEDIUM: 0, HIGH: 1, CRITICAL: 0)

FAIL: HIGH: Oh no, a bad config.
FAIL: AVD-XYZ-0123 (HIGH): Oh no, a bad config.
════════════════════════════════════════
Your config file is not good.

Expand All @@ -188,7 +189,7 @@ See https://google.com/search?q=bad%20config
────────────────────────────────────────


PASS: MEDIUM: Oh no, a bad config AGAIN.
PASS: AVD-XYZ-0456 (MEDIUM): Oh no, a bad config AGAIN.
════════════════════════════════════════
Your config file is still not good.

Expand All @@ -213,7 +214,7 @@ See https://google.com/search?q=bad%20config
{
Type: "Terraform Security Check",
ID: "AVD-AWS-0107",
AVDID: "AVS-AWS-0107",
AVDID: "AVD-AWS-0107",
Title: "An ingress security group rule allows traffic from /0",
Description: "Opening up ports to the public internet is generally to be avoided. You should restrict access to IP addresses or ranges that explicitly require it where possible.",
Message: "Security group rule allows ingress from public internet.",
Expand Down Expand Up @@ -312,7 +313,7 @@ terraform-aws-modules/security-group/aws/main.tf (terraform)
Tests: 6 (SUCCESSES: 5, FAILURES: 1, EXCEPTIONS: 0)
Failures: 1 (LOW: 0, MEDIUM: 0, HIGH: 0, CRITICAL: 1)

CRITICAL: Security group rule allows ingress from public internet.
AVD-AWS-0107 (CRITICAL): Security group rule allows ingress from public internet.
════════════════════════════════════════
Opening up ports to the public internet is generally to be avoided. You should restrict access to IP addresses or ranges that explicitly require it where possible.

Expand Down