-
Notifications
You must be signed in to change notification settings - Fork 14.6k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Anshuman Tripathi <[email protected]> Update based on feedback Signed-off-by: Anshuman Tripathi <[email protected]> Update based on feedback Signed-off-by: Anshuman Tripathi <[email protected]> Update checklist reading guide Signed-off-by: Anshuman Tripathi <[email protected]> Update checklist structure based on feedback Signed-off-by: Anshuman Tripathi <[email protected]> Apply suggestions from code review Adding the suggestions from the last review. Co-authored-by: Tim Bannister <[email protected]> Fix style Signed-off-by: Anshuman Tripathi <[email protected]>
- Loading branch information
1 parent
c01e382
commit 86c48ee
Showing
1 changed file
with
101 additions
and
0 deletions.
There are no files selected for viewing
101 changes: 101 additions & 0 deletions
101
content/en/docs/concepts/security/application-security-checklist.md
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,101 @@ | ||
--- | ||
title: Application Security Checklist | ||
description: > | ||
Baseline guidelines around ensuring application security on Kubernetes, aimed at application developers | ||
content_type: concept | ||
weight: 110 | ||
--- | ||
|
||
<!-- overview --> | ||
|
||
This checklist aims on providing basic guidelines on securing applications running in Kubernetes from a developer perspective. | ||
This list is not meant to be exhaustive and is meant to evolve over time. | ||
|
||
<!-- The following is taken from the existing checklist created for Kubernetes admins. https://kubernetes.io/docs/concepts/security/security-checklist/ --> | ||
|
||
On how to read and use this document: | ||
|
||
- The order of topics does not reflect an order of priority. | ||
- Some checklist items are detailed in the paragraph below the list of each section. | ||
- This checklist assumes a `developer` is a Kubernetes cluster user that interacts with namespaced scope objects. | ||
|
||
|
||
{{< caution >}} | ||
Checklists are **not** sufficient for attaining a good security posture on their own. A good security posture requires constant attention and improvement, but a checklist can be the first step on the never-ending journey towards security preparedness. Some of the recommendations in this checklist may be too restrictive or too lax for your specific security needs. Since Kubernetes security is not "one size fits all", each category of checklist items should be evaluated on its merits. | ||
{{< /caution >}} | ||
|
||
|
||
<!-- body --> | ||
## Base security hardening | ||
The following checklist provide a base security hardening recommendations that would apply to most applications deploying to Kubernetes. | ||
|
||
### Application design | ||
|
||
- [ ] Following the right [security principles](https://www.cncf.io/wp-content/uploads/2022/06/CNCF_cloud-native-security-whitepaper-May2022-v2.pdf) when designing applicaitons. | ||
- [ ] Application configured with appropriate {{< glossary_tooltip text="QoS class" term_id="QoS-class" >}} through resource request and limits | ||
- [ ] Memory limit is set for the workloads with a limit equal or inferior to the request. | ||
- [ ] CPU limit might be set on sensitive workloads. | ||
|
||
### Service account | ||
|
||
- [ ] Avoid using the `default` ServiceAccount. Create ServiceAccounts for each workload or microservice. | ||
- [ ] `automountServiceAccountToken` should be set to `false` unless the pod specifically requires access to the Kubernetes API to operate. | ||
|
||
### Pod-level `securityContext` recommendations {#security-context-pod} | ||
|
||
- [ ] Set `runAsNonRoot: true`. | ||
- [ ] Configure the container to execute as a less privileged user (for example, using `runAsUser` and `runAsGroup`), and configure appropriate permissions on files or directories inside the container image. | ||
- [ ] Optionally add a supplementary group with `fsGroup` to access persistent volumes. | ||
- [ ] The application deploys into a namespace that enforces an appropriate [Pod security standard](/docs/concepts/security/pod-security-standards/). If you cannot control this enforcement for the cluster(s) where the application is deployed, take this into account either through documentation or additional defense in depth. | ||
|
||
### Container-level `securityContext` recommendations {#security-context-container} | ||
|
||
- [ ] Disable privilege escalations using `allowPrivilegeEscalation: false`. | ||
- [ ] Configure the root filesystem to be read-only with `readOnlyRootFilesystem: true`. | ||
- [ ] Avoid running privileged containers (set `privileged: false`). | ||
- [ ] Drop all capabilities from the containers, and add back only specific ones that are needed for operation of the container. | ||
|
||
### Role Based Access Control (RBAC) {#rbac} | ||
|
||
- [ ] Permissions such as **create**, **patch**, **update** and **delete** should be only granted if necessary. | ||
- [ ] Avoid creating RBAC permissions to create or update roles which can lead to [privilege escalation](/docs/reference/access-authn-authz/rbac/#privilege-escalation-prevention-and-bootstrapping). | ||
- [ ] Review bindings for the `system:unauthenticated` group and remove them where possible, as this gives access to anyone who can contact the API server at a network level. | ||
|
||
The **create**, **update** and **delete** verbs should be permitted judiciously. The **patch** verb if allowed on a Namespace can | ||
[allow users to update labels on the namespace or deployments](/docs/concepts/security/rbac-good-practices/#namespace-modification) which can increase the attack surface. | ||
|
||
For sensitive workloads, consider providing a recommended ValidatingAdmissionPolicy that further restricts the permitted write actions. | ||
|
||
### Image security | ||
|
||
- [ ] Using a image scanning tool the scan an image before deploying containers in the Kubernetes cluster. | ||
- [ ] Use container signing to validate the container image signature before deploying to the Kubernetes cluster. | ||
|
||
### Network Policies | ||
|
||
- [ ] Configure [NetworkPolicies](/docs/concepts/services-networking/network-policies/) to only allow expected ingress and egress traffic from the pods. | ||
|
||
Make sure that your cluster provides and enforces NetworkPolicy. If you are writing an application that people will deploy to different clusters, consider whether you can assume that NetworkPolicy is available and enforced. | ||
|
||
## Advanced security hardening {#advanced} | ||
|
||
This section of this guide covers some advanced security hardening points which might be valuable based on different Kubernetes environment setup | ||
|
||
### Linux container security | ||
|
||
Configure {{< glossary_tooltip text="Security Context" term_id="Security-Context" >}} for the pod-container. | ||
- [ ] [Set appropriate Seccomp profiles](/docs/tasks/configure-pod-container/security-context/#set-the-seccomp-profile-for-a-container). | ||
- [ ] [Configure appropriate AppArmor policies](/docs/tutorials/security/apparmor/). | ||
- [ ] [Assign appropriate SELinux labels to the contianers](/docs/tasks/configure-pod-container/security-context/#assign-selinux-labels-to-a-container). | ||
|
||
### Runtime Classes | ||
|
||
- [ ] Configure appropriate runtime classes for containers. | ||
|
||
{{% thirdparty-content %}} | ||
|
||
Some containers may require a different isolation level from what is provided by the default runtime of the cluster. `runtimeClassname` can be used in a podspec to define a differnt runtime class. | ||
|
||
For sensitive workloads consider using kernel emulation tools like [gVisor](https://gvisor.dev/docs/), or virtualized isolation using a mechanism such as [kata-containers](https://katacontainers.io/). | ||
|
||
In high trust environments, consider using [confidential virtual machines](/blog/2023/07/06/confidential-kubernetes/) to improve cluster security even further. |