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

Add filters to multiple dashboards #26

Merged
merged 3 commits into from
May 1, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
15 changes: 2 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@ trivy-operator-explorer

## Filters

Some dashboards have filters available. These filters are only set-able from the URL in query parameters for now, as there are no forms on the explorer yet, though it is planned.
Some dashboards have filters that can be set from clicking elements on the page, but the following can only be set manually from the URL query parameters for now. UI elements might be added for these over time.

### Image filter

Expand All @@ -39,18 +39,7 @@ Some dashboards have filters available. These filters are only set-able from the

Example URL: `http://your.explorer.install/image?hasfix=true&severity=Critical`

There are query parameters for image and digest as well, but it's not expected for them to be changed manually. These filters currently do not have a graphical toggle but there's a TODO item below to add some form elements to the page for them.

### ClusterRole/Role/Exposed Secrets filter

| Parameters | Description | Example |
|--------------|-----------------------------------------------------------------------|---------------------------|
| severity | Filter by level of vulnerability severity. | severity=Critical |

Example URL: `http://your.explorer.install/role?severity=Critical`

## TODO

- Make a home page that displays useful graphs for each of the report types.
- Graphical elements for setting filters, currently they're just URL query parameters.
- Testing. Pretty sure by law no new product can have tests.
- Graphical elements for setting the filters on the /image page
40 changes: 37 additions & 3 deletions internal/web/server.go
Original file line number Diff line number Diff line change
Expand Up @@ -51,13 +51,29 @@ func imagesHandler(w http.ResponseWriter, r *http.Request) {
return
}

// Parse URL query params
q := r.URL.Query()

// Check query params
hasFix := q.Get("hasfix")
var hasFixBool bool
if hasFix != "" {
var err error
hasFixBool, err = strconv.ParseBool(hasFix)
if err != nil {
log.Logger.Warn("could not parse hasfix query parameter to bool type, ignoring filter", "raw", hasFix, "error", err.Error())
}
}

// Get vulnerability reports
data, err := kube.GetVulnerabilityReportList()
if err != nil {
log.Logger.Error("error getting VulnerabilityReports", "error", err.Error())
return
}
imageData := imagesview.GetView(data)
imageData := imagesview.GetView(data, imagesview.Filters{
HasFix: hasFixBool,
})

err = tmpl.Execute(w, imageData)
if err != nil {
Expand Down Expand Up @@ -146,13 +162,21 @@ func rolesHandler(w http.ResponseWriter, r *http.Request) {
return
}

// Parse URL query params
q := r.URL.Query()

// Check query params
namespace := q.Get("namespace")

// Get role reports
reports, err := kube.GetRbacAssessmentReportList()
if err != nil {
log.Logger.Error("error getting VulnerabilityReports", "error", err.Error())
return
}
roles := rolesview.GetView(reports)
roles := rolesview.GetView(reports, rolesview.Filters{
Namespace: namespace,
})

err = tmpl.Execute(w, roles)
if err != nil {
Expand Down Expand Up @@ -293,13 +317,23 @@ func configauditsHandler(w http.ResponseWriter, r *http.Request) {
return
}

// Parse URL query params
q := r.URL.Query()

// Check query params
namespace := q.Get("namespace")
kind := q.Get("kind")

// Get reports
reports, err := kube.GetConfigAuditReportList()
if err != nil {
log.Logger.Error("error getting configauditreports", "error", err.Error())
return
}
audits := configauditsview.GetView(reports)
audits := configauditsview.GetView(reports, configauditsview.Filters{
Namespace: namespace,
Kind: kind,
})

err = tmpl.Execute(w, audits)
if err != nil {
Expand Down
25 changes: 22 additions & 3 deletions internal/web/views/configaudits/audit.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,14 @@ import (
"github.com/aquasecurity/trivy-operator/pkg/apis/aquasecurity/v1alpha1"
)

// Filters represents the available optional filters to the config audit view
type Filters struct {
Namespace string
Kind string
}

// GetView converts some report data to the /roles view
func GetView(data *v1alpha1.ConfigAuditReportList) View {
func GetView(data *v1alpha1.ConfigAuditReportList, filters Filters) View {
var view View

for _, item := range data.Items {
Expand All @@ -20,11 +26,24 @@ func GetView(data *v1alpha1.ConfigAuditReportList) View {
} else {
name = item.Name
}
kind := item.ObjectMeta.Labels["trivy-operator.resource.kind"]
namespace := item.ObjectMeta.Labels["trivy-operator.resource.namespace"]

if filters.Kind != "" {
if kind != filters.Kind {
continue
}
}
if filters.Namespace != "" {
if namespace != filters.Namespace {
continue
}
}

audit := Data{
Kind: item.ObjectMeta.Labels["trivy-operator.resource.kind"],
Kind: kind,
Name: name,
Namespace: item.ObjectMeta.Labels["trivy-operator.resource.namespace"],
Namespace: namespace,
}

index, unique := view.isUnique(audit.Name, audit.Namespace, audit.Kind)
Expand Down
14 changes: 13 additions & 1 deletion internal/web/views/images/images.go
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,13 @@ import (
"github.com/aquasecurity/trivy-operator/pkg/apis/aquasecurity/v1alpha1"
)

// Filters represents the available optional filters to the images view
type Filters struct {
HasFix bool
}

// GetView converts some report data to the /images view
func GetView(data *v1alpha1.VulnerabilityReportList) View {
func GetView(data *v1alpha1.VulnerabilityReportList, filters Filters) View {
var i View

for _, item := range data.Items {
Expand Down Expand Up @@ -62,6 +67,13 @@ func GetView(data *v1alpha1.VulnerabilityReportList) View {
FixedVersion: v.FixedVersion,
}

// Filter by hasfix
if filters.HasFix {
if strings.TrimSpace(vuln.FixedVersion) == "" {
continue
}
}

// If the image is not unique, we need to check if the vulnerability is unique too
// Seems rare, but Trivy Operator sometimes gives duplicate CVE data for an image
uniqueVuln := i[imageIndex].isUniqueImageVulnerability(vuln.ID, vuln.Severity)
Expand Down
16 changes: 14 additions & 2 deletions internal/web/views/roles/roles.go
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,13 @@ import (
"github.com/aquasecurity/trivy-operator/pkg/apis/aquasecurity/v1alpha1"
)

// Filters represents the available optional filters to the roles audit view
type Filters struct {
Namespace string
}

// GetView converts some report data to the /roles view
func GetView(data *v1alpha1.RbacAssessmentReportList) View {
func GetView(data *v1alpha1.RbacAssessmentReportList, filters Filters) View {
var r View

for _, item := range data.Items {
Expand All @@ -21,10 +26,17 @@ func GetView(data *v1alpha1.RbacAssessmentReportList) View {
name = item.Name
}

namespace := item.ObjectMeta.Labels["trivy-operator.resource.namespace"]
if filters.Namespace != "" {
if namespace != filters.Namespace {
continue
}
}

role := Data{
Kind: item.ObjectMeta.Labels["trivy-operator.resource.kind"],
Name: name,
Namespace: item.ObjectMeta.Labels["trivy-operator.resource.namespace"],
Namespace: namespace,
}

index, unique := r.isUniqueRole(role.Name, role.Namespace, role.Kind)
Expand Down
6 changes: 3 additions & 3 deletions static/configaudits.html
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<!DOCTYPE html>
<html lang="en">
<title>Explorer: configaudits</title>
<title>Explorer: Config Audits</title>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<link href="/static/css/output.css" rel="stylesheet">
Expand Down Expand Up @@ -38,7 +38,7 @@
<tr class="bg-white border-b dark:bg-gray-800 dark:border-gray-700 hover:bg-gray-100 dark:hover:bg-gray-600">
<!-- Roles column -->
<td scope="row" class="px-6 py-4 font-medium text-gray-900 whitespace-nowrap dark:text-white">
<a href="/configaudit?name={{ $data.Name }}&namespace={{ $data.Namespace }}&kind={{ $data.Kind }}">
<a href="/configaudits?namespace={{ $data.Namespace }}">
{{ $data.Namespace }}
</a>
</td>
Expand All @@ -48,7 +48,7 @@
</a>
</td>
<td scope="row" class="px-6 py-4 font-medium text-gray-900 whitespace-nowrap dark:text-white">
<a href="/configaudit?name={{ $data.Name }}&namespace={{ $data.Namespace }}&kind={{ $data.Kind }}">
<a href="/configaudits?kind={{ $data.Kind }}">
{{ $data.Kind }}
</a>
</td>
Expand Down
24 changes: 24 additions & 0 deletions static/css/output.css
Original file line number Diff line number Diff line change
Expand Up @@ -767,6 +767,11 @@ video {
background-color: rgb(249 250 251 / var(--tw-bg-opacity));
}

.bg-green-100 {
--tw-bg-opacity: 1;
background-color: rgb(220 252 231 / var(--tw-bg-opacity));
}

.bg-orange-200 {
--tw-bg-opacity: 1;
background-color: rgb(254 215 170 / var(--tw-bg-opacity));
Expand Down Expand Up @@ -905,6 +910,10 @@ video {
font-weight: 500;
}

.font-normal {
font-weight: 400;
}

.font-semibold {
font-weight: 600;
}
Expand Down Expand Up @@ -938,6 +947,11 @@ video {
color: rgb(17 24 39 / var(--tw-text-opacity));
}

.text-green-800 {
--tw-text-opacity: 1;
color: rgb(22 101 52 / var(--tw-text-opacity));
}

.text-orange-800 {
--tw-text-opacity: 1;
color: rgb(154 52 18 / var(--tw-text-opacity));
Expand Down Expand Up @@ -1107,6 +1121,11 @@ video {
background-color: rgb(17 24 39 / var(--tw-bg-opacity));
}

.dark\:bg-green-900 {
--tw-bg-opacity: 1;
background-color: rgb(20 83 45 / var(--tw-bg-opacity));
}

.dark\:bg-indigo-800 {
--tw-bg-opacity: 1;
background-color: rgb(55 48 163 / var(--tw-bg-opacity));
Expand Down Expand Up @@ -1152,6 +1171,11 @@ video {
color: rgb(156 163 175 / var(--tw-text-opacity));
}

.dark\:text-green-300 {
--tw-text-opacity: 1;
color: rgb(134 239 172 / var(--tw-text-opacity));
}

.dark\:text-orange-100 {
--tw-text-opacity: 1;
color: rgb(255 237 213 / var(--tw-text-opacity));
Expand Down
3 changes: 3 additions & 0 deletions static/images.html
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,9 @@
</th>
<th scope="col" class="px-6 py-3">
Vulnerabilities
<a href="/images?hasfix=true">
<span class="bg-green-100 text-green-800 text-xs font-normal me-2 px-2.5 py-0.5 rounded-full dark:bg-green-900 dark:text-green-300">Has fix?</span>
</a>
</th>
</tr>
</thead>
Expand Down
2 changes: 1 addition & 1 deletion static/roles.html
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,7 @@
<tr class="bg-white border-b dark:bg-gray-800 dark:border-gray-700 hover:bg-gray-100 dark:hover:bg-gray-600">
<!-- Roles column -->
<td scope="row" class="px-6 py-4 font-medium text-gray-900 whitespace-nowrap dark:text-white">
<a href="/role?name={{ $data.Name }}&namespace={{ $data.Namespace }}">
<a href="/roles?namespace={{ $data.Namespace }}">
{{ $data.Namespace }}
</a>
</td>
Expand Down