/
workload.go
401 lines (359 loc) · 14 KB
/
workload.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
package controller
import (
"context"
"errors"
"fmt"
"time"
"github.com/khulnasoft/tunnel-operator/pkg/apis/khulnasoft/v1alpha1"
"github.com/khulnasoft/tunnel-operator/pkg/docker"
"github.com/khulnasoft/tunnel-operator/pkg/exposedsecretreport"
"github.com/khulnasoft/tunnel-operator/pkg/kube"
"github.com/khulnasoft/tunnel-operator/pkg/operator/etc"
"github.com/khulnasoft/tunnel-operator/pkg/operator/jobs"
. "github.com/khulnasoft/tunnel-operator/pkg/operator/predicate"
"github.com/khulnasoft/tunnel-operator/pkg/operator/workload"
"github.com/khulnasoft/tunnel-operator/pkg/plugins/tunnel"
"github.com/khulnasoft/tunnel-operator/pkg/sbomreport"
"github.com/khulnasoft/tunnel-operator/pkg/tunneloperator"
"github.com/khulnasoft/tunnel-operator/pkg/vulnerabilityreport"
"github.com/go-logr/logr"
batchv1 "k8s.io/api/batch/v1"
k8sapierror "k8s.io/apimachinery/pkg/api/errors"
ctrl "sigs.k8s.io/controller-runtime"
"sigs.k8s.io/controller-runtime/pkg/builder"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
"sigs.k8s.io/controller-runtime/pkg/reconcile"
)
const trivyServerUp = "trivy_server_up"
// WorkloadController watches Kubernetes workloads and generates
// v1alpha1.VulnerabilityReport instances using vulnerability scanner that that
// implements the Plugin interface.
type WorkloadController struct {
logr.Logger
etc.Config
kube.ObjectResolver
client.Client
jobs.LimitChecker
vulnerabilityreport.Plugin
tunneloperator.PluginContext
kube.SecretsReader
tunneloperator.ConfigData
ServerHealthChecker ServerHealthChecker
VulnerabilityReadWriter vulnerabilityreport.ReadWriter
ExposedSecretReadWriter exposedsecretreport.ReadWriter
SbomReadWriter sbomreport.ReadWriter
SubmitScanJobChan chan ScanJobRequest
ResultScanJobChan chan ScanJobResult
CacheSyncTimeout time.Duration
}
// ScanJobResult encapsulate processing result and error
type ScanJobResult struct {
Result ctrl.Result
Error error
}
// ScanJobRequest encapsulate workload and context for processing
type ScanJobRequest struct {
Workload client.Object
Context context.Context
ClusterSbomReport map[string]v1alpha1.SbomReportData
}
// +kubebuilder:rbac:groups="",resources=pods,verbs=get;list;watch
// +kubebuilder:rbac:groups=apps,resources=replicasets,verbs=get;list;watch
// +kubebuilder:rbac:groups="",resources=replicationcontrollers,verbs=get;list;watch
// +kubebuilder:rbac:groups=apps,resources=statefulsets,verbs=get;list;watch
// +kubebuilder:rbac:groups=apps,resources=daemonsets,verbs=get;list;watch
// +kubebuilder:rbac:groups=batch,resources=cronjobs,verbs=get;list;watch
// +kubebuilder:rbac:groups=batch,resources=jobs,verbs=get;list;watch
// +kubebuilder:rbac:groups=khulnasoft.github.io,resources=vulnerabilityreports,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=khulnasoft.github.io,resources=exposedsecretreports,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=khulnasoft.github.io,resources=sbomreports,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=khulnasoft.github.io,resources=clustersbomreports,verbs=get;list;watch;create;update;patch;delete
// Manage scan jobs with image pull secrets
// kubebuilder:rbac:groups="",resources=secrets,verbs=create;update
func (r *WorkloadController) SetupWithManager(mgr ctrl.Manager) error {
installModePredicate, err := InstallModePredicate(r.Config)
if err != nil {
return err
}
var resources []kube.Resource
// Determine which Kubernetes workloads the controller will reconcile and add them to resources
targetWorkloads := r.Config.GetTargetWorkloads()
for _, tw := range targetWorkloads {
var resource kube.Resource
err := resource.GetWorkloadResource(tw, nil, r.ObjectResolver)
if err != nil {
return err
}
resources = append(resources, resource)
}
for _, resource := range resources {
err = ctrl.NewControllerManagedBy(mgr).WithOptions(controller.Options{
CacheSyncTimeout: r.CacheSyncTimeout,
}).
For(resource.ForObject, builder.WithPredicates(
Not(ManagedByTunnelOperator),
Not(IsBeingTerminated),
installModePredicate,
)).
Owns(&v1alpha1.VulnerabilityReport{}).
Owns(&v1alpha1.ExposedSecretReport{}).
Owns(&v1alpha1.SbomReport{}).
Complete(r.reconcileWorkload(resource.Kind))
if err != nil {
return err
}
}
// process scan jobs
go r.ProcessScanJob()
return nil
}
func (r *WorkloadController) reconcileWorkload(workloadKind kube.Kind) reconcile.Func {
return func(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
log := r.Logger.WithValues("kind", workloadKind, "name", req.NamespacedName)
workloadRef := kube.ObjectRefFromKindAndObjectKey(workloadKind, req.NamespacedName)
log.V(1).Info("Getting workload from cache")
workloadObj, err := r.ObjectFromObjectRef(ctx, workloadRef)
if err != nil {
if k8sapierror.IsNotFound(err) {
log.V(1).Info("Ignoring cached workload that must have been deleted")
return ctrl.Result{}, nil
}
return ctrl.Result{}, fmt.Errorf("getting %s from cache: %w", workloadKind, err)
}
// Skip processing if it's a Pod controlled by a built-in K8s workload.
if skip, err := workload.SkipProcessing(ctx, workloadObj, r.ObjectResolver,
r.Config.VulnerabilityScannerScanOnlyCurrentRevisions, log, r.ConfigData.GetSkipResourceByLabels()); skip {
return ctrl.Result{}, err
}
podSpec, err := kube.GetPodSpec(workloadObj)
if err != nil {
return ctrl.Result{}, err
}
containerImages := kube.GetContainerImagesFromPodSpec(podSpec, r.GetSkipInitContainers())
hash := kube.ComputeHash(podSpec)
log = log.WithValues("podSpecHash", hash)
hasVulnReports := true
if r.Config.VulnerabilityScannerEnabled {
hasVulnReports, err = hasVulnerabilityReports(ctx, r.VulnerabilityReadWriter, workloadRef, hash, containerImages)
if err != nil {
return ctrl.Result{}, err
}
}
hasExposedSecretReports := true
if r.Config.ExposedSecretScannerEnabled {
hasExposedSecretReports, err = hasSecretReports(ctx, r.ExposedSecretReadWriter, workloadRef, hash, containerImages)
if err != nil {
return ctrl.Result{}, err
}
}
if hasVulnReports && hasExposedSecretReports {
log.V(1).Info("VulnerabilityReports or Secret Reports already exist")
return ctrl.Result{}, nil
}
var reportsData map[string]v1alpha1.SbomReportData
_, job, err := r.hasActiveScanJob(ctx, workloadRef, hash)
if err != nil {
return ctrl.Result{}, fmt.Errorf("checking scan job: %w", err)
}
if job != nil {
log.V(1).Info("Scan job already exists",
"job", fmt.Sprintf("%s/%s", job.Namespace, job.Name))
return ctrl.Result{}, nil
}
if r.BuiltInTrivyServer {
trivyServerAvaliable, err := r.ServerHealthChecker.TrivyServerAvaliable(r.GeTrivyServerURL())
if err != nil {
return ctrl.Result{}, err
}
if !trivyServerAvaliable {
return ctrl.Result{RequeueAfter: r.Config.ScanJobRetryAfter}, nil
}
}
if r.Config.SbomGenerationEnable {
reportsData, err = getGlobalSbomReports(ctx, r.SbomReadWriter, containerImages)
if err != nil {
return ctrl.Result{}, err
}
if len(reportsData) > 0 {
err = r.reuseReport(ctx, workloadObj, reportsData)
if err != nil {
return ctrl.Result{}, err
}
}
}
log.V(1).Info("Submitting a scan for the workload")
// sync all potential workload for scanning
r.SubmitScanJobChan <- ScanJobRequest{Workload: workloadObj, Context: ctx, ClusterSbomReport: reportsData}
// collect scan job processing results
scanJobResult := <-r.ResultScanJobChan
return scanJobResult.Result, scanJobResult.Error
}
}
func (r *WorkloadController) ProcessScanJob() {
for workloadRequest := range r.SubmitScanJobChan {
log := r.Logger.WithValues("pre scan job processing for workload:", workloadRequest.Workload.GetName())
limitExceeded, scanJobsCount, err := r.LimitChecker.Check(workloadRequest.Context)
if err != nil {
r.ResultScanJobChan <- ScanJobResult{Result: ctrl.Result{}, Error: err}
continue
}
log.V(1).Info("Checking scan jobs limit", "count", scanJobsCount, "limit", r.ConcurrentScanJobsLimit)
if limitExceeded {
log.V(1).Info("Pushing back scan job", "count", scanJobsCount, "retryAfter", r.ScanJobRetryAfter)
r.ResultScanJobChan <- ScanJobResult{Result: ctrl.Result{RequeueAfter: r.Config.ScanJobRetryAfter}, Error: nil}
continue
}
err = r.submitScanJob(workloadRequest.Context, workloadRequest.Workload, workloadRequest.ClusterSbomReport)
r.ResultScanJobChan <- ScanJobResult{Result: ctrl.Result{}, Error: err}
}
}
func (r *WorkloadController) hasActiveScanJob(ctx context.Context, owner kube.ObjectRef, hash string) (bool, *batchv1.Job, error) {
jobName := fmt.Sprintf("scan-vulnerabilityreport-%s", kube.ComputeHash(owner))
job := &batchv1.Job{}
err := r.Get(ctx, client.ObjectKey{Namespace: r.Config.Namespace, Name: jobName}, job)
if err != nil {
if k8sapierror.IsNotFound(err) {
return false, nil, nil
}
return false, nil, fmt.Errorf("getting job from cache: %w", err)
}
if job.Labels[tunneloperator.LabelResourceSpecHash] == hash {
return true, job, nil
}
return false, nil, nil
}
func (r *WorkloadController) submitScanJob(ctx context.Context, owner client.Object, reusedReports map[string]v1alpha1.SbomReportData) error {
log := r.Logger.WithValues("kind", owner.GetObjectKind().GroupVersionKind().Kind,
"name", owner.GetName(), "namespace", owner.GetNamespace())
var err error
credentials := make(map[string]docker.Auth, 0)
if r.AccessGlobalSecretsAndServiceAccount {
privateRegistrySecrets, err := r.Config.GetPrivateRegistryScanSecretsNames()
if err != nil {
return err
}
pConfig, err := r.PluginContext.GetConfig()
if err != nil {
return err
}
multiSecretSupport := trivy.MultiSecretSupport(trivy.Config{PluginConfig: pConfig})
credentials, err = r.CredentialsByServer(ctx, owner, privateRegistrySecrets, multiSecretSupport)
if err != nil {
return err
}
}
scanJobTolerations, err := r.GetScanJobTolerations()
if err != nil {
return fmt.Errorf("getting scan job tolerations: %w", err)
}
scanJobAnnotations, err := r.GetScanJobAnnotations()
if err != nil {
return fmt.Errorf("getting scan job annotations: %w", err)
}
scanJobNodeSelector, err := r.GetScanJobNodeSelector()
if err != nil {
return fmt.Errorf("getting scan job nodeSelector: %w", err)
}
scanJobSecurityContext, err := r.GetScanJobPodSecurityContext()
if err != nil {
return fmt.Errorf("getting scan job podSecurityContext: %w", err)
}
scanJobContainerSecurityContext, err := r.GetScanJobContainerSecurityContext()
if err != nil {
return fmt.Errorf("getting scan job [container] securityContext: %w", err)
}
scanJobPodTemplateLabels, err := r.GetScanJobPodTemplateLabels()
if err != nil {
return fmt.Errorf("getting scan job template labels: %w", err)
}
scanJobPodPriorityClassName, err := r.GetScanJobPodPriorityClassName()
if err != nil {
return fmt.Errorf("getting scan job priority class name: %w", err)
}
scanJobBuilder := vulnerabilityreport.NewScanJobBuilder().
WithPlugin(r.Plugin).
WithPluginContext(r.PluginContext).
WithTimeout(r.Config.ScanJobTimeout).
WithTTL(r.Config.ScanJobTTL).
WithObject(owner).
WithTolerations(scanJobTolerations).
WithAnnotations(scanJobAnnotations).
WithNodeSelector(scanJobNodeSelector).
WithPodSecurityContext(scanJobSecurityContext).
WithSecurityContext(scanJobContainerSecurityContext).
WithSkipInitContainers(r.GetSkipInitContainers()).
WithPodTemplateLabels(scanJobPodTemplateLabels).
WithCredentials(credentials).
WithPodPriorityClassName(scanJobPodPriorityClassName)
if len(reusedReports) > 0 {
scanJobBuilder.WithSbomClusterReports(reusedReports)
}
scanJob, secrets, err := scanJobBuilder.Get()
if err != nil {
if errors.Is(err, kube.ErrReplicaSetNotFound) || errors.Is(err, kube.ErrNoRunningPods) ||
errors.Is(err, kube.ErrUnSupportedKind) {
log.V(1).Info("ignoring vulnerability scan", "reason", err)
return nil
}
return fmt.Errorf("constructing scan job: %w", err)
}
for _, secret := range secrets {
err = r.Client.Create(ctx, secret)
if err != nil {
if k8sapierror.IsAlreadyExists(err) {
return nil
}
return fmt.Errorf("creating secret used by scan job failed: %s: %w", secret.Namespace+"/"+secret.Name, err)
}
}
log = log.WithValues("podSpecHash", scanJob.Labels[tunneloperator.LabelResourceSpecHash])
log.V(1).Info("Creating scan job for the workload")
err = r.Client.Create(ctx, scanJob)
if err != nil {
if k8sapierror.IsAlreadyExists(err) {
// TODO Delete secrets that were created in the previous step. Alternatively we can delete them on schedule.
return nil
}
return fmt.Errorf("creating scan job failed: %s: %w", scanJob.Namespace+"/"+scanJob.Name, err)
}
for _, secret := range secrets {
err = controllerutil.SetOwnerReference(scanJob, secret, r.Client.Scheme())
if err != nil {
return fmt.Errorf("setting owner reference: %w", err)
}
err := r.Client.Update(ctx, secret)
if err != nil {
return fmt.Errorf("setting owner reference of secret used by scan job failed: %s: %w", secret.Namespace+"/"+secret.Name, err)
}
}
return nil
}
func (r *WorkloadController) reuseReport(ctx context.Context, owner client.Object, sbomReportDataMap map[string]v1alpha1.SbomReportData) error {
hash, err := kube.ComputeSpecHash(owner)
if err != nil {
return err
}
resourceLabelsToInclude := r.GetReportResourceLabels()
additionalCustomLabels, err := r.GetAdditionalReportLabels()
if err != nil {
return err
}
sbomReports := make([]v1alpha1.SbomReport, 0)
for containerName, sbomReportData := range sbomReportDataMap {
sbomReportBuilder := sbomreport.NewReportBuilder(r.Client.Scheme()).
Controller(owner).
Container(containerName).
Data(sbomReportData).
PodSpecHash(hash).
ResourceLabelsToInclude(resourceLabelsToInclude).
AdditionalReportLabels(additionalCustomLabels)
sbomReport, err := sbomReportBuilder.NamespacedReport()
if err != nil {
return err
}
sbomReports = append(sbomReports, sbomReport)
}
return r.SbomReadWriter.Write(ctx, sbomReports)
}