-
Notifications
You must be signed in to change notification settings - Fork 201
/
builder.go
310 lines (265 loc) · 9.22 KB
/
builder.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
package vulnerabilityreport
import (
"fmt"
"strings"
"time"
"github.com/aquasecurity/trivy-operator/pkg/apis/aquasecurity/v1alpha1"
"github.com/aquasecurity/trivy-operator/pkg/docker"
"github.com/aquasecurity/trivy-operator/pkg/kube"
"github.com/aquasecurity/trivy-operator/pkg/trivyoperator"
"github.com/aquasecurity/trivy-operator/pkg/utils"
batchv1 "k8s.io/api/batch/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/util/validation"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
"sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
)
type ScanJobBuilder struct {
plugin Plugin
pluginContext trivyoperator.PluginContext
timeout time.Duration
object client.Object
credentials map[string]docker.Auth
tolerations []corev1.Toleration
nodeSelector map[string]string
annotations map[string]string
podTemplateLabels map[string]string
podSecurityContext *corev1.PodSecurityContext
containerSecurityContext *corev1.SecurityContext
}
func NewScanJobBuilder() *ScanJobBuilder {
return &ScanJobBuilder{}
}
func (s *ScanJobBuilder) WithPlugin(plugin Plugin) *ScanJobBuilder {
s.plugin = plugin
return s
}
func (s *ScanJobBuilder) WithPluginContext(pluginContext trivyoperator.PluginContext) *ScanJobBuilder {
s.pluginContext = pluginContext
return s
}
func (s *ScanJobBuilder) WithTimeout(timeout time.Duration) *ScanJobBuilder {
s.timeout = timeout
return s
}
func (s *ScanJobBuilder) WithObject(object client.Object) *ScanJobBuilder {
s.object = object
return s
}
func (s *ScanJobBuilder) WithTolerations(tolerations []corev1.Toleration) *ScanJobBuilder {
s.tolerations = tolerations
return s
}
func (s *ScanJobBuilder) WithAnnotations(annotations map[string]string) *ScanJobBuilder {
s.annotations = annotations
return s
}
func (s *ScanJobBuilder) WithNodeSelector(nodeSelector map[string]string) *ScanJobBuilder {
s.nodeSelector = nodeSelector
return s
}
func (s *ScanJobBuilder) WithPodSecurityContext(podSecurityContext *corev1.PodSecurityContext) *ScanJobBuilder {
s.podSecurityContext = podSecurityContext
return s
}
func (s *ScanJobBuilder) WithSecurityContext(securityContext *corev1.SecurityContext) *ScanJobBuilder {
s.containerSecurityContext = securityContext
return s
}
func (s *ScanJobBuilder) WithPodTemplateLabels(podTemplateLabels map[string]string) *ScanJobBuilder {
s.podTemplateLabels = podTemplateLabels
return s
}
func (s *ScanJobBuilder) WithCredentials(credentials map[string]docker.Auth) *ScanJobBuilder {
s.credentials = credentials
return s
}
func (s *ScanJobBuilder) Get() (*batchv1.Job, []*corev1.Secret, error) {
spec, err := kube.GetPodSpec(s.object)
if err != nil {
return nil, nil, err
}
templateSpec, secrets, err := s.plugin.GetScanJobSpec(s.pluginContext, s.object, s.credentials, s.containerSecurityContext)
if err != nil {
return nil, nil, err
}
templateSpec.Tolerations = append(templateSpec.Tolerations, s.tolerations...)
if s.podSecurityContext != nil {
templateSpec.SecurityContext = s.podSecurityContext
}
templateSpec.NodeSelector = s.nodeSelector
containerImagesAsJSON, err := kube.GetContainerImagesFromPodSpec(spec).AsJSON()
if err != nil {
return nil, nil, err
}
podSpecHash := kube.ComputeHash(spec)
labels := map[string]string{
trivyoperator.LabelResourceSpecHash: podSpecHash,
trivyoperator.LabelK8SAppManagedBy: trivyoperator.AppTrivyOperator,
trivyoperator.LabelVulnerabilityReportScanner: s.pluginContext.GetName(),
}
podTemplateLabels := make(map[string]string)
for k, v := range labels {
podTemplateLabels[k] = v
}
for k, v := range s.podTemplateLabels {
podTemplateLabels[k] = v
}
job := &batchv1.Job{
ObjectMeta: metav1.ObjectMeta{
Name: GetScanJobName(s.object),
Namespace: s.pluginContext.GetNamespace(),
Labels: labels,
Annotations: map[string]string{
trivyoperator.AnnotationContainerImages: containerImagesAsJSON,
},
},
Spec: batchv1.JobSpec{
BackoffLimit: pointer.Int32(0),
Completions: pointer.Int32(1),
ActiveDeadlineSeconds: utils.DurationSecondsPtr(s.timeout),
Template: corev1.PodTemplateSpec{
ObjectMeta: metav1.ObjectMeta{
Labels: podTemplateLabels,
Annotations: s.annotations,
},
Spec: templateSpec,
},
},
}
// secrets will be created with scan jobs in same namespace where scan job will run
for i := range secrets {
secrets[i].Namespace = s.pluginContext.GetNamespace()
}
s.updateScanJobForWorkloadNamespace(job, spec, secrets)
err = kube.ObjectToObjectMeta(s.object, &job.ObjectMeta)
if err != nil {
return nil, nil, err
}
err = kube.ObjectToObjectMeta(s.object, &job.Spec.Template.ObjectMeta)
if err != nil {
return nil, nil, err
}
return job, secrets, nil
}
// When run scan job in workload namespace is enabled then this method will update scanjob spec with these changes
// - namespace same as workload
// - service account same as workload service account
// - ImagePullSecret same as workload imagePullSecret
func (s *ScanJobBuilder) updateScanJobForWorkloadNamespace(job *batchv1.Job, podspec corev1.PodSpec, secrets []*corev1.Secret) {
operatorConfig := s.pluginContext.GetTrivyOperatorConfig()
if !operatorConfig.VulnerabilityScanJobsInSameNamespace() {
return
}
job.Namespace = s.object.GetNamespace()
job.Spec.Template.Spec.ServiceAccountName = podspec.ServiceAccountName
job.Spec.Template.Spec.ImagePullSecrets = podspec.ImagePullSecrets
for i := range secrets {
secrets[i].Namespace = s.object.GetNamespace()
}
}
func GetScanJobName(obj client.Object) string {
return fmt.Sprintf("scan-vulnerabilityreport-%s", kube.ComputeHash(kube.ObjectRef{
Kind: kube.Kind(obj.GetObjectKind().GroupVersionKind().Kind),
Namespace: obj.GetNamespace(),
Name: obj.GetName(),
}))
}
func RegistryCredentialsSecretName(obj client.Object) string {
return fmt.Sprintf("%s-regcred", GetScanJobName(obj))
}
type ReportBuilder struct {
scheme *runtime.Scheme
controller client.Object
container string
hash string
data v1alpha1.VulnerabilityReportData
reportTTL *time.Duration
resourceLabelsToInclude []string
}
func NewReportBuilder(scheme *runtime.Scheme) *ReportBuilder {
return &ReportBuilder{
scheme: scheme,
}
}
func (b *ReportBuilder) Controller(controller client.Object) *ReportBuilder {
b.controller = controller
return b
}
func (b *ReportBuilder) Container(name string) *ReportBuilder {
b.container = name
return b
}
func (b *ReportBuilder) PodSpecHash(hash string) *ReportBuilder {
b.hash = hash
return b
}
func (b *ReportBuilder) Data(data v1alpha1.VulnerabilityReportData) *ReportBuilder {
b.data = data
return b
}
func (b *ReportBuilder) ReportTTL(ttl *time.Duration) *ReportBuilder {
b.reportTTL = ttl
return b
}
func (b *ReportBuilder) ResourceLabelsToInclude(resourceLabelsToInclude []string) *ReportBuilder {
b.resourceLabelsToInclude = resourceLabelsToInclude
return b
}
func (b *ReportBuilder) reportName() string {
kind := b.controller.GetObjectKind().GroupVersionKind().Kind
name := b.controller.GetName()
reportName := fmt.Sprintf("%s-%s-%s", strings.ToLower(kind), name, b.container)
if len(validation.IsValidLabelValue(reportName)) == 0 {
return reportName
}
return fmt.Sprintf("%s-%s", strings.ToLower(kind), kube.ComputeHash(name+"-"+b.container))
}
func (b *ReportBuilder) Get() (v1alpha1.VulnerabilityReport, error) {
labels := map[string]string{
trivyoperator.LabelContainerName: b.container,
}
if b.hash != "" {
labels[trivyoperator.LabelResourceSpecHash] = b.hash
}
jobLabels := b.controller.GetLabels()
for _, labelToInclude := range b.resourceLabelsToInclude {
if value, ok := jobLabels[labelToInclude]; ok {
labels[labelToInclude] = value
}
}
report := v1alpha1.VulnerabilityReport{
ObjectMeta: metav1.ObjectMeta{
Name: b.reportName(),
Namespace: b.controller.GetNamespace(),
Labels: labels,
},
Report: b.data,
}
if b.reportTTL != nil {
report.Annotations = map[string]string{
v1alpha1.TTLReportAnnotation: b.reportTTL.String(),
}
}
err := kube.ObjectToObjectMeta(b.controller, &report.ObjectMeta)
if err != nil {
return v1alpha1.VulnerabilityReport{}, err
}
err = controllerutil.SetControllerReference(b.controller, &report, b.scheme)
if err != nil {
return v1alpha1.VulnerabilityReport{}, fmt.Errorf("setting controller reference: %w", err)
}
// The OwnerReferencesPermissionsEnforcement admission controller protects the
// access to metadata.ownerReferences[x].blockOwnerDeletion of an object, so
// that only users with "update" permission to the finalizers subresource of the
// referenced owner can change it.
// We set metadata.ownerReferences[x].blockOwnerDeletion to false so that
// additional RBAC permissions are not required when the OwnerReferencesPermissionsEnforcement
// is enabled.
// See https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#ownerreferencespermissionenforcement
report.OwnerReferences[0].BlockOwnerDeletion = pointer.Bool(false)
return report, nil
}