mirror of
https://github.com/kyverno/kyverno.git
synced 2025-03-06 07:57:07 +00:00
* feat: generate backgroundscan reports for validating admission policies Signed-off-by: Mariam Fahmy <mariam.fahmy@nirmata.com> * fix: skip validate check images if errors are encourted when validating the resource Signed-off-by: Mariam Fahmy <mariam.fahmy@nirmata.com> --------- Signed-off-by: Mariam Fahmy <mariam.fahmy@nirmata.com>
119 lines
3.9 KiB
Go
119 lines
3.9 KiB
Go
package utils
|
|
|
|
import (
|
|
"context"
|
|
|
|
"github.com/go-logr/logr"
|
|
"github.com/kyverno/kyverno/api/kyverno"
|
|
kyvernov1 "github.com/kyverno/kyverno/api/kyverno/v1"
|
|
"github.com/kyverno/kyverno/pkg/config"
|
|
"github.com/kyverno/kyverno/pkg/engine"
|
|
engineapi "github.com/kyverno/kyverno/pkg/engine/api"
|
|
"github.com/kyverno/kyverno/pkg/engine/jmespath"
|
|
"github.com/kyverno/kyverno/pkg/validatingadmissionpolicy"
|
|
"go.uber.org/multierr"
|
|
admissionregistrationv1alpha1 "k8s.io/api/admissionregistration/v1alpha1"
|
|
"k8s.io/apimachinery/pkg/apis/meta/v1/unstructured"
|
|
)
|
|
|
|
type scanner struct {
|
|
logger logr.Logger
|
|
engine engineapi.Engine
|
|
config config.Configuration
|
|
jp jmespath.Interface
|
|
}
|
|
|
|
type ScanResult struct {
|
|
EngineResponse *engineapi.EngineResponse
|
|
Error error
|
|
}
|
|
|
|
type Scanner interface {
|
|
ScanResource(context.Context, unstructured.Unstructured, map[string]string, ...engineapi.GenericPolicy) map[*engineapi.GenericPolicy]ScanResult
|
|
}
|
|
|
|
func NewScanner(
|
|
logger logr.Logger,
|
|
engine engineapi.Engine,
|
|
config config.Configuration,
|
|
jp jmespath.Interface,
|
|
) Scanner {
|
|
return &scanner{
|
|
logger: logger,
|
|
engine: engine,
|
|
config: config,
|
|
jp: jp,
|
|
}
|
|
}
|
|
|
|
func (s *scanner) ScanResource(ctx context.Context, resource unstructured.Unstructured, nsLabels map[string]string, policies ...engineapi.GenericPolicy) map[*engineapi.GenericPolicy]ScanResult {
|
|
results := map[*engineapi.GenericPolicy]ScanResult{}
|
|
for i, policy := range policies {
|
|
var errors []error
|
|
logger := s.logger.WithValues("kind", resource.GetKind(), "namespace", resource.GetNamespace(), "name", resource.GetName())
|
|
var response *engineapi.EngineResponse
|
|
if policy.GetType() == engineapi.KyvernoPolicyType {
|
|
var err error
|
|
pol := policy.GetPolicy().(kyvernov1.PolicyInterface)
|
|
response, err = s.validateResource(ctx, resource, nsLabels, pol)
|
|
if err != nil {
|
|
logger.Error(err, "failed to scan resource")
|
|
errors = append(errors, err)
|
|
}
|
|
spec := pol.GetSpec()
|
|
if spec.HasVerifyImages() && len(errors) == 0 {
|
|
ivResponse, err := s.validateImages(ctx, resource, nsLabels, pol)
|
|
if err != nil {
|
|
logger.Error(err, "failed to scan images")
|
|
errors = append(errors, err)
|
|
}
|
|
if response == nil {
|
|
response = ivResponse
|
|
} else if ivResponse != nil {
|
|
response.PolicyResponse.Rules = append(response.PolicyResponse.Rules, ivResponse.PolicyResponse.Rules...)
|
|
}
|
|
}
|
|
} else {
|
|
pol := policy.GetPolicy().(admissionregistrationv1alpha1.ValidatingAdmissionPolicy)
|
|
res := validatingadmissionpolicy.Validate(pol, resource)
|
|
response = &res
|
|
}
|
|
results[&policies[i]] = ScanResult{response, multierr.Combine(errors...)}
|
|
}
|
|
return results
|
|
}
|
|
|
|
func (s *scanner) validateResource(ctx context.Context, resource unstructured.Unstructured, nsLabels map[string]string, policy kyvernov1.PolicyInterface) (*engineapi.EngineResponse, error) {
|
|
policyCtx, err := engine.NewPolicyContext(s.jp, resource, kyvernov1.Create, nil, s.config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
policyCtx = policyCtx.
|
|
WithNewResource(resource).
|
|
WithPolicy(policy).
|
|
WithNamespaceLabels(nsLabels)
|
|
response := s.engine.Validate(ctx, policyCtx)
|
|
return &response, nil
|
|
}
|
|
|
|
func (s *scanner) validateImages(ctx context.Context, resource unstructured.Unstructured, nsLabels map[string]string, policy kyvernov1.PolicyInterface) (*engineapi.EngineResponse, error) {
|
|
annotations := resource.GetAnnotations()
|
|
if annotations != nil {
|
|
resource = *resource.DeepCopy()
|
|
delete(annotations, kyverno.AnnotationImageVerify)
|
|
resource.SetAnnotations(annotations)
|
|
}
|
|
policyCtx, err := engine.NewPolicyContext(s.jp, resource, kyvernov1.Create, nil, s.config)
|
|
if err != nil {
|
|
return nil, err
|
|
}
|
|
policyCtx = policyCtx.
|
|
WithNewResource(resource).
|
|
WithPolicy(policy).
|
|
WithNamespaceLabels(nsLabels)
|
|
response, _ := s.engine.VerifyAndPatchImages(ctx, policyCtx)
|
|
if len(response.PolicyResponse.Rules) > 0 {
|
|
s.logger.Info("validateImages", "policy", policy, "response", response)
|
|
}
|
|
return &response, nil
|
|
}
|