-
Notifications
You must be signed in to change notification settings - Fork 197
/
plugin.go
543 lines (506 loc) · 14 KB
/
plugin.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
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
package polaris
import (
"encoding/json"
"fmt"
"io"
"strings"
"github.com/aquasecurity/starboard/pkg/apis/aquasecurity/v1alpha1"
"github.com/aquasecurity/starboard/pkg/configauditreport"
"github.com/aquasecurity/starboard/pkg/ext"
"github.com/aquasecurity/starboard/pkg/kube"
"github.com/aquasecurity/starboard/pkg/starboard"
corev1 "k8s.io/api/core/v1"
"k8s.io/apimachinery/pkg/api/resource"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/utils/pointer"
"sigs.k8s.io/controller-runtime/pkg/client"
)
const (
// Plugin the name of this plugin.
Plugin = "Polaris"
)
const (
polarisContainerName = "polaris"
configVolume = "config"
)
const (
keyImageRef = "polaris.imageRef"
keyConfigYaml = "polaris.config.yaml"
keyResourcesRequestsCPU = "polaris.resources.requests.cpu"
keyResourcesRequestsMemory = "polaris.resources.requests.memory"
keyResourcesLimitsCPU = "polaris.resources.limits.cpu"
keyResourcesLimitsMemory = "polaris.resources.limits.memory"
)
const (
// DefaultConfigYAML the default Polaris config YAML as string literal.
DefaultConfigYAML = `checks:
# reliability
multipleReplicasForDeployment: ignore
priorityClassNotSet: ignore
# resources
cpuRequestsMissing: warning
cpuLimitsMissing: warning
memoryRequestsMissing: warning
memoryLimitsMissing: warning
# images
tagNotSpecified: danger
pullPolicyNotAlways: ignore
# healthChecks
readinessProbeMissing: warning
livenessProbeMissing: warning
# networking
hostNetworkSet: warning
hostPortSet: warning
# security
hostIPCSet: danger
hostPIDSet: danger
notReadOnlyRootFilesystem: warning
privilegeEscalationAllowed: danger
runAsRootAllowed: warning
runAsPrivileged: danger
dangerousCapabilities: danger
insecureCapabilities: warning
exemptions:
- controllerNames:
- kube-apiserver
- kube-proxy
- kube-scheduler
- etcd-manager-events
- kube-controller-manager
- kube-dns
- etcd-manager-main
rules:
- hostPortSet
- hostNetworkSet
- readinessProbeMissing
- livenessProbeMissing
- cpuRequestsMissing
- cpuLimitsMissing
- memoryRequestsMissing
- memoryLimitsMissing
- runAsRootAllowed
- runAsPrivileged
- notReadOnlyRootFilesystem
- hostPIDSet
- controllerNames:
- kube-flannel-ds
rules:
- notReadOnlyRootFilesystem
- runAsRootAllowed
- notReadOnlyRootFilesystem
- readinessProbeMissing
- livenessProbeMissing
- cpuLimitsMissing
- controllerNames:
- cert-manager
rules:
- notReadOnlyRootFilesystem
- runAsRootAllowed
- readinessProbeMissing
- livenessProbeMissing
- controllerNames:
- cluster-autoscaler
rules:
- notReadOnlyRootFilesystem
- runAsRootAllowed
- readinessProbeMissing
- controllerNames:
- vpa
rules:
- runAsRootAllowed
- readinessProbeMissing
- livenessProbeMissing
- notReadOnlyRootFilesystem
- controllerNames:
- datadog
rules:
- runAsRootAllowed
- readinessProbeMissing
- livenessProbeMissing
- notReadOnlyRootFilesystem
- controllerNames:
- nginx-ingress-controller
rules:
- privilegeEscalationAllowed
- insecureCapabilities
- runAsRootAllowed
- controllerNames:
- dns-controller
- datadog-datadog
- kube-flannel-ds
- kube2iam
- aws-iam-authenticator
- datadog
- kube2iam
rules:
- hostNetworkSet
- controllerNames:
- aws-iam-authenticator
- aws-cluster-autoscaler
- kube-state-metrics
- dns-controller
- external-dns
- dnsmasq
- autoscaler
- kubernetes-dashboard
- install-cni
- kube2iam
rules:
- readinessProbeMissing
- livenessProbeMissing
- controllerNames:
- aws-iam-authenticator
- nginx-ingress-default-backend
- aws-cluster-autoscaler
- kube-state-metrics
- dns-controller
- external-dns
- kubedns
- dnsmasq
- autoscaler
- tiller
- kube2iam
rules:
- runAsRootAllowed
- controllerNames:
- aws-iam-authenticator
- nginx-ingress-controller
- nginx-ingress-default-backend
- aws-cluster-autoscaler
- kube-state-metrics
- dns-controller
- external-dns
- kubedns
- dnsmasq
- autoscaler
- tiller
- kube2iam
rules:
- notReadOnlyRootFilesystem
- controllerNames:
- cert-manager
- dns-controller
- kubedns
- dnsmasq
- autoscaler
- insights-agent-goldilocks-vpa-install
- datadog
rules:
- cpuRequestsMissing
- cpuLimitsMissing
- memoryRequestsMissing
- memoryLimitsMissing
- controllerNames:
- kube2iam
- kube-flannel-ds
rules:
- runAsPrivileged
- controllerNames:
- kube-hunter
rules:
- hostPIDSet
- controllerNames:
- polaris
- kube-hunter
- goldilocks
- insights-agent-goldilocks-vpa-install
rules:
- notReadOnlyRootFilesystem
- controllerNames:
- insights-agent-goldilocks-controller
rules:
- livenessProbeMissing
- readinessProbeMissing
- controllerNames:
- insights-agent-goldilocks-vpa-install
- kube-hunter
rules:
- runAsRootAllowed
`
)
// Config defines configuration params for this plugin.
type Config struct {
starboard.PluginConfig
}
// GetImageRef returns upstream Polaris container image reference.
func (c Config) GetImageRef() (string, error) {
return c.GetRequiredData(keyImageRef)
}
// GetResourceRequirements constructs ResourceRequirements from the Config.
func (c Config) GetResourceRequirements() (corev1.ResourceRequirements, error) {
requirements := corev1.ResourceRequirements{
Requests: corev1.ResourceList{},
Limits: corev1.ResourceList{},
}
err := c.setResourceLimit(keyResourcesRequestsCPU, &requirements.Requests, corev1.ResourceCPU)
if err != nil {
return requirements, err
}
err = c.setResourceLimit(keyResourcesRequestsMemory, &requirements.Requests, corev1.ResourceMemory)
if err != nil {
return requirements, err
}
err = c.setResourceLimit(keyResourcesLimitsCPU, &requirements.Limits, corev1.ResourceCPU)
if err != nil {
return requirements, err
}
err = c.setResourceLimit(keyResourcesLimitsMemory, &requirements.Limits, corev1.ResourceMemory)
if err != nil {
return requirements, err
}
return requirements, nil
}
func (c Config) setResourceLimit(configKey string, k8sResourceList *corev1.ResourceList, k8sResourceName corev1.ResourceName) error {
if value, found := c.Data[configKey]; found {
quantity, err := resource.ParseQuantity(value)
if err != nil {
return fmt.Errorf("parsing resource definition %s: %s %w", configKey, value, err)
}
(*k8sResourceList)[k8sResourceName] = quantity
}
return nil
}
type plugin struct {
clock ext.Clock
}
// NewPlugin constructs a new configauditreport.Plugin, which is using an
// upstream Polaris container image to audit configuration of Kubernetes workloads.
func NewPlugin(clock ext.Clock) configauditreport.Plugin {
return &plugin{
clock: clock,
}
}
var (
supportedKinds = []kube.Kind{
kube.KindPod,
kube.KindDeployment,
kube.KindReplicaSet,
kube.KindReplicationController,
kube.KindStatefulSet,
kube.KindDaemonSet,
kube.KindCronJob,
kube.KindJob,
}
)
func (p *plugin) SupportedKinds() []kube.Kind {
return supportedKinds
}
func (p *plugin) IsApplicable(_ starboard.PluginContext, _ client.Object) (bool, string, error) {
return true, "", nil
}
// Init ensures the default Config required by this plugin.
func (p *plugin) Init(ctx starboard.PluginContext) error {
return ctx.EnsureConfig(starboard.PluginConfig{
Data: map[string]string{
keyImageRef: "quay.io/fairwinds/polaris:4.2",
keyConfigYaml: DefaultConfigYAML,
keyResourcesRequestsCPU: "50m",
keyResourcesRequestsMemory: "50M",
keyResourcesLimitsCPU: "300m",
keyResourcesLimitsMemory: "300M",
},
})
}
func (p *plugin) ConfigHash(ctx starboard.PluginContext, _ kube.Kind) (string, error) {
cm, err := ctx.GetConfig()
if err != nil {
return "", err
}
data := make(map[string]string)
for key, value := range cm.Data {
if strings.HasPrefix(key, "polaris.resources.") {
continue
}
data[key] = value
}
return kube.ComputeHash(data), nil
}
func (p *plugin) newConfigFrom(ctx starboard.PluginContext) (Config, error) {
pluginConfig, err := ctx.GetConfig()
if err != nil {
return Config{}, fmt.Errorf("getting config: %w", err)
}
return Config{PluginConfig: pluginConfig}, nil
}
func (p *plugin) GetScanJobSpec(ctx starboard.PluginContext, obj client.Object) (corev1.PodSpec, []*corev1.Secret, error) {
config, err := p.newConfigFrom(ctx)
if err != nil {
return corev1.PodSpec{}, nil, fmt.Errorf("constructing config from plugin context: %w", err)
}
imageRef, err := config.GetImageRef()
if err != nil {
return corev1.PodSpec{}, nil, fmt.Errorf("getting image ref: %w", err)
}
requirements, err := config.GetResourceRequirements()
if err != nil {
return corev1.PodSpec{}, nil, fmt.Errorf("getting resource requirements: %w", err)
}
sourceName := p.sourceNameFrom(obj)
return corev1.PodSpec{
ServiceAccountName: ctx.GetServiceAccountName(),
AutomountServiceAccountToken: pointer.BoolPtr(true),
RestartPolicy: corev1.RestartPolicyNever,
Affinity: starboard.LinuxNodeAffinity(),
Volumes: []corev1.Volume{
{
Name: configVolume,
VolumeSource: corev1.VolumeSource{
ConfigMap: &corev1.ConfigMapVolumeSource{
LocalObjectReference: corev1.LocalObjectReference{
Name: starboard.GetPluginConfigMapName(ctx.GetName()),
},
},
},
},
},
Containers: []corev1.Container{
{
Name: polarisContainerName,
Image: imageRef,
ImagePullPolicy: corev1.PullIfNotPresent,
TerminationMessagePolicy: corev1.TerminationMessageFallbackToLogsOnError,
Resources: requirements,
VolumeMounts: []corev1.VolumeMount{
{
Name: configVolume,
MountPath: "/etc/starboard",
},
},
Command: []string{"sh"},
Args: []string{
"-c",
"polaris audit --log-level error --config /etc/starboard/polaris.config.yaml --resource " + sourceName + " 2> /dev/null",
},
SecurityContext: &corev1.SecurityContext{
Privileged: pointer.BoolPtr(false),
AllowPrivilegeEscalation: pointer.BoolPtr(false),
Capabilities: &corev1.Capabilities{
Drop: []corev1.Capability{"all"},
},
ReadOnlyRootFilesystem: pointer.BoolPtr(true),
},
},
},
SecurityContext: &corev1.PodSecurityContext{},
}, nil, nil
}
func (p *plugin) GetContainerName() string {
return polarisContainerName
}
func (p *plugin) ParseConfigAuditReportData(ctx starboard.PluginContext, logsReader io.ReadCloser) (v1alpha1.ConfigAuditReportData, error) {
config, err := p.newConfigFrom(ctx)
if err != nil {
return v1alpha1.ConfigAuditReportData{}, fmt.Errorf("constructing config from plugin context: %w", err)
}
var report Report
err = json.NewDecoder(logsReader).Decode(&report)
if err != nil {
return v1alpha1.ConfigAuditReportData{}, err
}
var checks []v1alpha1.Check
var podChecks []v1alpha1.Check
containerNameToChecks := make(map[string][]v1alpha1.Check)
if len(report.Results) != 1 {
return v1alpha1.ConfigAuditReportData{}, fmt.Errorf("unexpected report results count, got: %d, want: %d", len(report.Results), 1)
}
for _, pr := range report.Results[0].PodResult.Results {
severity, err := v1alpha1.StringToSeverity(pr.Severity)
if err != nil {
return v1alpha1.ConfigAuditReportData{}, err
}
check := v1alpha1.Check{
ID: pr.ID,
Messages: []string{pr.Message},
Success: pr.Success,
Severity: severity,
Category: pr.Category,
}
checks = append(checks, check)
podChecks = append(podChecks, check)
}
for _, cr := range report.Results[0].PodResult.ContainerResults {
var containerChecks []v1alpha1.Check
for _, crr := range cr.Results {
severity, err := v1alpha1.StringToSeverity(crr.Severity)
if err != nil {
return v1alpha1.ConfigAuditReportData{}, err
}
containerChecks = append(containerChecks, v1alpha1.Check{
ID: crr.ID,
Messages: []string{crr.Message},
Success: crr.Success,
Severity: severity,
Category: crr.Category,
Scope: &v1alpha1.CheckScope{
Type: "Container",
Value: cr.Name,
},
})
}
checks = append(checks, containerChecks...)
containerNameToChecks[cr.Name] = containerChecks
}
imageRef, err := config.GetImageRef()
if err != nil {
return v1alpha1.ConfigAuditReportData{}, fmt.Errorf("getting image ref: %w", err)
}
version, err := starboard.GetVersionFromImageRef(imageRef)
if err != nil {
return v1alpha1.ConfigAuditReportData{}, fmt.Errorf("getting version from image ref: %w", err)
}
return v1alpha1.ConfigAuditReportData{
Scanner: v1alpha1.Scanner{
Name: "Polaris",
Vendor: "Fairwinds Ops",
Version: version,
},
Summary: p.configAuditSummaryFrom(podChecks, containerNameToChecks),
UpdateTimestamp: metav1.NewTime(p.clock.Now()),
Checks: checks,
// TODO Deprecate PodChecks and ContainerChecks in 0.12+
PodChecks: podChecks,
ContainerChecks: containerNameToChecks,
}, nil
}
func (p *plugin) sourceNameFrom(obj client.Object) string {
gvk := obj.GetObjectKind().GroupVersionKind()
group := gvk.Group
if len(group) > 0 {
group = "." + group
}
return fmt.Sprintf("%s/%s%s/%s/%s",
obj.GetNamespace(),
gvk.Kind,
group,
gvk.Version,
obj.GetName(),
)
}
func (p *plugin) configAuditSummaryFrom(podChecks []v1alpha1.Check, containerChecks map[string][]v1alpha1.Check) v1alpha1.ConfigAuditSummary {
var summary v1alpha1.ConfigAuditSummary
for _, c := range podChecks {
if c.Success {
continue
}
switch c.Severity {
case v1alpha1.SeverityCritical:
summary.CriticalCount++
case v1alpha1.SeverityLow:
summary.LowCount++
}
}
for _, checks := range containerChecks {
for _, c := range checks {
if c.Success {
continue
}
switch c.Severity {
case v1alpha1.SeverityCritical:
summary.CriticalCount++
case v1alpha1.SeverityLow:
summary.LowCount++
}
}
}
return summary
}