This repository has been archived by the owner on Jan 12, 2023. It is now read-only.
generated from cruise-automation/oss-template
-
Notifications
You must be signed in to change notification settings - Fork 54
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
8 changed files
with
205 additions
and
1 deletion.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,68 @@ | ||
package pod | ||
|
||
import ( | ||
"context" | ||
"fmt" | ||
"github.com/cruise-automation/k-rail/v3/policies" | ||
"github.com/cruise-automation/k-rail/v3/resource" | ||
admissionv1 "k8s.io/api/admission/v1" | ||
corev1 "k8s.io/api/core/v1" | ||
) | ||
|
||
type PolicyNoRootUser struct{} | ||
|
||
func (p PolicyNoRootUser) Name() string { | ||
return "pod_no_root_user" | ||
} | ||
|
||
func (p PolicyNoRootUser) Validate(ctx context.Context, _ policies.Config, ar *admissionv1.AdmissionRequest) ([]policies.ResourceViolation, []policies.PatchOperation) { | ||
resourceViolations := []policies.ResourceViolation{} | ||
podResource := resource.GetPodResource(ctx, ar) | ||
if podResource == nil { | ||
return resourceViolations, nil | ||
} | ||
violationText := "No Root user: Running as the root user is forbidden" | ||
|
||
// check the containers first | ||
validateSecurityContext := func(container corev1.Container) { | ||
if container.SecurityContext != nil && container.SecurityContext.RunAsNonRoot != nil && *container.SecurityContext.RunAsNonRoot { | ||
return | ||
} else if container.SecurityContext != nil && container.SecurityContext.RunAsUser != nil && *container.SecurityContext.RunAsUser > 0 { | ||
return | ||
} | ||
resourceViolations = append(resourceViolations, policies.ResourceViolation{ | ||
Namespace: ar.Namespace, | ||
ResourceName: podResource.ResourceName, | ||
ResourceKind: podResource.ResourceKind, | ||
Violation: fmt.Sprintf("No Root user: Container %s can as the root user which is forbidden", container.Name), | ||
Policy: p.Name(), | ||
}) | ||
} | ||
for _, container := range podResource.PodSpec.Containers { | ||
validateSecurityContext(container) | ||
} | ||
for _, container := range podResource.PodSpec.InitContainers { | ||
validateSecurityContext(container) | ||
} | ||
|
||
// if all the containers have the appropriate securityContext | ||
// and the podSecurityContext is unset, we can skip checking it | ||
if len(resourceViolations) == 0 && podResource.PodSpec.SecurityContext == nil { | ||
return resourceViolations, nil | ||
} | ||
|
||
if podResource.PodSpec.SecurityContext != nil && podResource.PodSpec.SecurityContext.RunAsNonRoot != nil && *podResource.PodSpec.SecurityContext.RunAsNonRoot { | ||
return resourceViolations, nil | ||
} else if podResource.PodSpec.SecurityContext != nil && podResource.PodSpec.SecurityContext.RunAsUser != nil && *podResource.PodSpec.SecurityContext.RunAsUser > 0 { | ||
return resourceViolations, nil | ||
} | ||
|
||
resourceViolations = append(resourceViolations, policies.ResourceViolation{ | ||
Namespace: ar.Namespace, | ||
ResourceName: podResource.ResourceName, | ||
ResourceKind: podResource.ResourceKind, | ||
Violation: violationText, | ||
Policy: p.Name(), | ||
}) | ||
return resourceViolations, nil | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
package pod | ||
|
||
import ( | ||
"context" | ||
"encoding/json" | ||
"github.com/cruise-automation/k-rail/v3/policies" | ||
admissionv1 "k8s.io/api/admission/v1" | ||
corev1 "k8s.io/api/core/v1" | ||
v1 "k8s.io/api/core/v1" | ||
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1" | ||
"k8s.io/apimachinery/pkg/runtime" | ||
"k8s.io/utils/pointer" | ||
"reflect" | ||
"testing" | ||
) | ||
|
||
func TestPolicyNoRoot(t *testing.T) { | ||
ctx := context.Background() | ||
|
||
tests := []struct { | ||
name string | ||
podSpec v1.PodSpec | ||
violations int | ||
}{ | ||
{ | ||
name: "empty securityContext", | ||
violations: 3, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: &v1.PodSecurityContext{}, | ||
Containers: []v1.Container{ | ||
{ | ||
SecurityContext: &v1.SecurityContext{}, | ||
}, | ||
}, | ||
InitContainers: []v1.Container{ | ||
{ | ||
SecurityContext: &v1.SecurityContext{}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "runAsRoot", | ||
violations: 1, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: &v1.PodSecurityContext{ | ||
RunAsUser: pointer.Int64Ptr(0), | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "runAsUser", | ||
violations: 0, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: &v1.PodSecurityContext{ | ||
RunAsUser: pointer.Int64Ptr(1001), | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "runAsNonRoot", | ||
violations: 0, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: &v1.PodSecurityContext{ | ||
RunAsNonRoot: pointer.BoolPtr(true), | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "runAsUser container", | ||
violations: 0, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: &v1.PodSecurityContext{ | ||
RunAsNonRoot: pointer.BoolPtr(true), | ||
}, | ||
Containers: []v1.Container{ | ||
{ | ||
SecurityContext: &v1.SecurityContext{ | ||
RunAsUser: pointer.Int64Ptr(1001), | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
{ | ||
name: "no pod context, but containers are set", | ||
violations: 0, | ||
podSpec: v1.PodSpec{ | ||
SecurityContext: nil, | ||
Containers: []v1.Container{ | ||
{ | ||
SecurityContext: &v1.SecurityContext{ | ||
RunAsNonRoot: pointer.BoolPtr(true), | ||
}, | ||
}, | ||
}, | ||
}, | ||
}, | ||
} | ||
for _, tt := range tests { | ||
t.Run(tt.name, func(t *testing.T) { | ||
raw, _ := json.Marshal(corev1.Pod{Spec: tt.podSpec}) | ||
ar := &admissionv1.AdmissionRequest{ | ||
Namespace: "namespace", | ||
Name: "name", | ||
Object: runtime.RawExtension{Raw: raw}, | ||
Resource: metav1.GroupVersionResource{Group: "", Version: "v1", Resource: "pods"}, | ||
} | ||
v := PolicyNoRootUser{} | ||
if got, _ := v.Validate(ctx, policies.Config{}, ar); !reflect.DeepEqual(len(got), tt.violations) { | ||
t.Errorf("PolicyNoRootUser() %s got %v want %v violations", tt.name, len(got), tt.violations) | ||
} | ||
}) | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters