1
0
Fork 0
mirror of https://github.com/kyverno/kyverno.git synced 2025-03-06 16:06:56 +00:00
kyverno/pkg/policyreport/policyreport.go
shuting 5e07ecc5f3
Add Policy Report (#1229)
* add report in cli

* policy report crd added

* policy report added

* configmap added

* added jobs

* added jobs

* bug fixed

* added logic for cli

* common function added

* sub command added for policy report

* subcommand added for report

* common package changed

* configmap added

* added logic for kyverno cli

* added logic for jobs

* added logic for jobs

* added logic for jobs

* added logic for cli

* buf fix

* cli changes

* count bug fix

* docs added for command

* go fmt

* refactor codebase

* remove policy controller for policyreport

* policy report removed

* bug fixes

* bug fixes

* added job trigger if needed

* job deletation logic added

* build failed fix

* fixed e2e test

* remove hard coded variables

* packages adde

* improvment added in jobs sheduler

* policy report yaml added

* cronjob added

* small fixes

* remove background sync

* documentation added for report command

* remove extra log

* small improvement

* tested policy report

* revert hardcoded changes

* changes for demo

* demo changes

* resource aggrigation added

* More changes

* More changes

* - resolve PR comments; - refactor jobs controller

* set rbac for jobs

* add clean up in job controller

* add short names

* remove application scope for policyreport

* move job controller to policyreport

* add report logic in command apply

* - update policy report types;  - upgrade k8s library; - update code gen

* temporarily comment out code to pass CI build

* generate / update policyreport to cluster

* add unit test for CLI report

* add test for apply - generate policy report

* fix unit test

* - remove job controller; - remove in-memory configmap; - clean up kustomize manifest

* remove dependency

* add reportRequest / clusterReportRequest

* clean up policy report

* generate report request

* update crd clusterReportRequest

* - update json tag of report summary; - update definition manifests; -  fix dclient creation

* aggregate reportRequest into policy report

* fix unit tests

* - update report summary to optional; - generate clusterPolicyReport; - remove reportRequests after merged to report

* remove

* generate reportRequest in kyverno namespace

* update resource filter in helm chart

* - rename reportRequest to reportChangeRequest; -rename clusterReportRequest to clusterReportChangeRequest

* generate policy report in background scan

* skip generating report change request if there's entry results

* fix results entry removal when policy / rule gets deleted

* rename apiversion from policy.kubernetes.io to policy.k8s.io

* update summary.* to lower case

* move reportChangeRequest to kyverno.io/v1alpha1

* remove policy report flag

* fix report update

* clean up policy violation CRD

* remove violation CRD from manifest

* clean up policy violation code - remove pvGenerator

* change severity fields to lower case

* update import library

* set report category

Co-authored-by: Yuvraj <yuvraj.yad001@gmail.com>
Co-authored-by: Yuvraj <10830562+evalsocket@users.noreply.github.com>
Co-authored-by: Jim Bugwadia <jim@nirmata.com>
2020-11-09 11:26:12 -08:00

184 lines
4.9 KiB
Go

package policyreport
import (
"fmt"
"reflect"
"strings"
"github.com/cornelk/hashmap"
changerequest "github.com/kyverno/kyverno/pkg/api/kyverno/v1alpha1"
report "github.com/kyverno/kyverno/pkg/api/policyreport/v1alpha1"
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
)
type deletedResource struct {
kind, ns, name string
}
func getDeletedResources(aggregatedRequests interface{}) (resources []deletedResource) {
if requests, ok := aggregatedRequests.([]*changerequest.ClusterReportChangeRequest); ok {
for _, request := range requests {
labels := request.GetLabels()
dr := deletedResource{
kind: labels[deletedLabelResourceKind],
name: labels[deletedLabelResource],
ns: labels["namespace"],
}
resources = append(resources, dr)
}
} else if requests, ok := aggregatedRequests.([]*changerequest.ReportChangeRequest); ok {
for _, request := range requests {
labels := request.GetLabels()
dr := deletedResource{
kind: labels[deletedLabelResourceKind],
name: labels[deletedLabelResource],
ns: labels["namespace"],
}
resources = append(resources, dr)
}
}
return
}
func updateResults(oldReport, newReport map[string]interface{}, aggregatedRequests interface{}) (map[string]interface{}, error) {
deleteResources := getDeletedResources(aggregatedRequests)
oldResults := hashResults(oldReport, deleteResources)
if newresults, ok := newReport["results"].([]interface{}); ok {
for _, res := range newresults {
resMap, ok := res.(map[string]interface{})
if !ok {
continue
}
if key, ok := generateHashKey(resMap, deletedResource{}); ok {
oldResults.Set(key, res)
}
}
}
results := getResultsFromHash(oldResults)
if err := unstructured.SetNestedSlice(newReport, results, "results"); err != nil {
return nil, err
}
summary := updateSummary(results)
if err := unstructured.SetNestedMap(newReport, summary, "summary"); err != nil {
return nil, err
}
return newReport, nil
}
func hashResults(policyReport map[string]interface{}, deleteResources []deletedResource) *hashmap.HashMap {
resultsHash := &hashmap.HashMap{}
results, ok := policyReport["results"]
if !ok {
return resultsHash
}
for _, result := range results.([]interface{}) {
if len(deleteResources) != 0 {
for _, dr := range deleteResources {
if key, ok := generateHashKey(result.(map[string]interface{}), dr); ok {
resultsHash.Set(key, result)
}
}
} else {
if key, ok := generateHashKey(result.(map[string]interface{}), deletedResource{}); ok {
resultsHash.Set(key, result)
}
}
}
return resultsHash
}
func getResultsFromHash(resHash *hashmap.HashMap) []interface{} {
results := make([]interface{}, 0)
for result := range resHash.Iter() {
if reflect.DeepEqual(result, hashmap.KeyValue{}) {
continue
}
results = append(results, result.Value.(map[string]interface{}))
}
return results
}
func generateHashKey(result map[string]interface{}, dr deletedResource) (string, bool) {
resources := result["resources"].([]interface{})
if len(resources) < 1 {
return "", false
}
resource := resources[0].(map[string]interface{})
if !reflect.DeepEqual(dr, deletedResource{}) {
if resource["kind"] == dr.kind && resource["name"] == dr.name && resource["namespace"] == dr.ns {
return "", false
}
}
return fmt.Sprintf(
"%s-%s-%s-%s-%s",
result["policy"],
result["rule"],
resource["name"],
resource["namespace"],
resource["name"]), true
}
func updateSummary(results []interface{}) map[string]interface{} {
summary := make(map[string]interface{}, 5)
for _, result := range results {
typedResult, ok := result.(map[string]interface{})
if !ok {
continue
}
switch typedResult["status"].(string) {
case report.StatusPass:
pass, _ := summary[report.StatusPass].(int64)
summary[report.StatusPass] = pass + 1
case report.StatusFail:
fail, _ := summary[report.StatusFail].(int64)
summary[report.StatusFail] = fail + 1
case report.StatusWarn:
warn, _ := summary[report.StatusWarn].(int64)
summary[report.StatusWarn] = warn + 1
case report.StatusError:
e, _ := summary[report.StatusError].(int64)
summary[report.StatusError] = e + 1
case report.StatusSkip:
skip, _ := summary[report.StatusSkip].(int64)
summary[report.StatusSkip] = skip + 1
}
}
status := []string{report.StatusPass, report.StatusFail, report.StatusError, report.StatusSkip, report.StatusWarn}
for i := 0; i < 5; i++ {
if _, ok := summary[status[i]].(int64); !ok {
summary[status[i]] = int64(0)
}
}
return summary
}
func isDeletedPolicyKey(key string) (policyName, ruleName string, isDelete bool) {
policy := strings.Split(key, "/")
if policy[0] == deletedPolicyKey {
// deletedPolicyKey/policyName/ruleName
if len(policy) == 3 {
return policy[1], policy[2], true
}
// deletedPolicyKey/policyName
if len(policy) == 2 {
return policy[1], "", true
}
}
return "", "", false
}