Questo contenuto non è disponibile nella lingua selezionata.
Chapter 7. Security Profiles Operator
7.1. Security Profiles Operator overview Copia collegamentoCollegamento copiato negli appunti!
OpenShift Container Platform Security Profiles Operator (SPO) provides a way to define secure computing (seccomp) profiles and SELinux profiles as custom resources, synchronizing profiles to every node in a given namespace. For the latest updates, see the release notes.
The SPO can distribute custom resources to each node while a reconciliation loop ensures that the profiles stay up-to-date. See Understanding the Security Profiles Operator.
The SPO manages SELinux policies and seccomp profiles for namespaced workloads. For more information, see Enabling the Security Profiles Operator.
You can create seccomp and SELinux profiles, bind policies to pods, record workloads, and synchronize all worker nodes in a namespace.
Use Advanced Security Profile Operator tasks to enable the log enricher, configure webhooks and metrics, or restrict profiles to a single namespace.
Use SPO Advanced Audit Logging to access logs in RHCOS containers for container-level security audit features.
Troubleshoot the Security Profiles Operator as needed, or engage Red Hat support.
You can Uninstall the Security Profiles Operator by removing the profiles before removing the Operator.
7.2. Security Profiles Operator release notes Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator provides a way to define secure computing (seccomp) and SELinux profiles as custom resources, synchronizing profiles to every node in a given namespace.
These release notes track the development of the Security Profiles Operator in OpenShift Container Platform.
For an overview of the Security Profiles Operator, see Security Profiles Operator Overview.
7.2.1. Security Profiles Operator 0.10.0 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.10.0: RHSA-2026:2852 - OpenShift Security Profiles Operator update
7.2.1.1. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
-
In some instances when Security Profiles Operator (SPO) 0.9.0 was used with OpenShift Container Platform version 4.20 and above, SPO would create the
profilerecordingresource but the workload would fail. Failure of the workload prevented the creation of the needed container for running the Operator. With the 0.10.0 release of SPO. theprofilerecordingresource is reliably created, therefore the needed container for running the Operator is reliably created. CMP-3537. -
For version 0.9.0 of Security Profiles Operator (SPO), the
spodpods would fail to run with the error messagefsmount:fscontext:proc/: could not get mount id: operation not permitted. With the release of version 0.10.0, thespodpods run reliably. CMP-4007. -
In releases of SPO 0.9.0 and earlier, there was a bug in syntax of the
selinuxusage. With this release of SPO, the change is from<policyName>_.processto<policyName>.process. The new syntax omits the_. Examples in the documentation now show this updated usage. CMP-4104
7.2.1.2. New features and enhancements Copia collegamentoCollegamento copiato negli appunti!
- With the release of SPO v0.10.0, the Operator now supports Red Hat Enterprise Linux CoreOS (RHCOS) 10 containers. CMP-4033
-
In this release of the Security Profiles Operator, the Advanced Audit Logging Framework is available as a General Availability (GA) feature. The Advanced Audit Logging Framework uses the Audit JSON Log Enricher to capture and log terminal-based command activity in Red Hat Enterprise Linux CoreOS (RHCOS) containers, including
oc rsh,oc exec, andoc debugcommands.
7.2.2. Security Profiles Operator 0.9.0 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.9.0: RHBA-2025:15655 - OpenShift Security Profiles Operator update
This update manages security profiles as cluster-wide resources rather than namespace resources. To update Security Profiles Operator to a version later than 0.8.6 requires manual migration. For migration instructions, see Security Profiles Operator 0.9.0 Update Migration Guide.
7.2.2.1. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
-
Before this update, the spod pods could fail to start and enter into a
CrashLoopBackOffstate due to an error in parsing the semanage configuration file. This issue is caused by a change to the RHEL 9 image naming convention beginning in OpenShift Container Platform 4.19. (OCPBUGS-55829) -
Before this update, the Security Profiles Operator would fail to apply a
RawSelinuxProfileto newly added nodes due to a reconciler type mismatch error. With this update, the operator now correctly handlesRawSelinuxProfileobjects and policies are applied to all nodes as expected. (OCPBUGS-33718)
7.2.3. Security Profiles Operator 0.8.6 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.8.6:
This update includes upgraded dependencies in underlying base images.
7.2.4. Security Profiles Operator 0.8.5 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.8.5:
7.2.4.1. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
- When attempting to install the Security Profile Operator from the web console, the option to enable Operator-recommended cluster monitoring was unavailable for the namespace. With this update, you can now enabled Operator-recommend cluster monitoring in the namespace. (OCPBUGS-37794)
- Previously, the Security Profiles Operator would intermittently be not visible in the OperatorHub, which caused limited access to install the Operator via the web console. With this update, the Security Profiles Operator is present in the OperatorHub.
7.2.5. Security Profiles Operator 0.8.4 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.8.4:
This update addresses CVEs in underlying dependencies.
7.2.5.1. New features and enhancements Copia collegamentoCollegamento copiato negli appunti!
-
You can now specify a default security profile in the
imageattribute of aProfileBindingobject by setting a wildcard. For more information, see Binding workloads to profiles with ProfileBindings (SELinux) and Binding workloads to profiles with ProfileBindings (Seccomp).
7.2.6. Security Profiles Operator 0.8.2 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.8.2:
7.2.6.1. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
-
Previously,
SELinuxProfileobjects did not inherit custom attributes from the same namespace. With this update, the issue has now been resolved andSELinuxProfileobject attributes are inherited from the same namespace as expected. (OCPBUGS-17164) -
Previously, RawSELinuxProfiles would hang during the creation process and would not reach an
Installedstate. With this update, the issue has been resolved and RawSELinuxProfiles are created successfully. (OCPBUGS-19744) -
Previously, patching the
enableLogEnrichertotruewould cause theseccompProfilelog-enricher-tracepods to be stuck in aPendingstate. With this update,log-enricher-tracepods reach anInstalledstate as expected. (OCPBUGS-22182) Previously, the Security Profiles Operator generated high cardinality metrics, causing Prometheus pods using high amounts of memory. With this update, the following metrics will no longer apply in the Security Profiles Operator namespace:
-
rest_client_request_duration_seconds -
rest_client_request_size_bytes rest_client_response_size_bytes
-
7.2.7. Security Profiles Operator 0.8.0 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.8.0:
7.2.7.1. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
- Previously, while trying to install Security Profiles Operator in a disconnected cluster, the secure hashes provided were incorrect due to a SHA relabeling issue. With this update, the SHAs provided work consistently with disconnected environments. (OCPBUGS-14404)
7.2.8. Security Profiles Operator 0.7.1 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.7.1:
7.2.8.1. New features and enhancements Copia collegamentoCollegamento copiato negli appunti!
Security Profiles Operator (SPO) now automatically selects the appropriate
selinuxdimage for RHEL 8- and 9-based Red Hat Enterprise Linux CoreOS (RHCOS) systems.ImportantUsers that mirror images for disconnected environments must mirror both
selinuxdimages provided by the Security Profiles Operator.You can now enable memory optimization inside of an
spoddaemon. For more information, see Enabling memory optimization in the spod daemon.NoteSPO memory optimization is not enabled by default.
- The daemon resource requirements are now configurable. For more information, see Customizing daemon resource requirements.
-
The priority class name is now configurable in the
spodconfiguration. For more information, see Setting a custom priority class name for the spod daemon pod.
7.2.8.2. Deprecated and removed features Copia collegamentoCollegamento copiato negli appunti!
-
The default
nginx-1.19.1seccomp profile is now removed from the Security Profiles Operator deployment.
7.2.8.3. Bug fixes Copia collegamentoCollegamento copiato negli appunti!
- Previously, a Security Profiles Operator (SPO) SELinux policy did not inherit low-level policy definitions from the container template. If you selected another template, such as net_container, the policy would not work because it required low-level policy definitions that only existed in the container template. This issue occurred when the SPO SELinux policy attempted to translate SELinux policies from the SPO custom format to the Common Intermediate Language (CIL) format. With this update, the container template appends to any SELinux policies that require translation from SPO to CIL. Additionally, the SPO SELinux policy can inherit low-level policy definitions from any supported policy template. (OCPBUGS-12879)
7.2.8.4. Known issue Copia collegamentoCollegamento copiato negli appunti!
-
When uninstalling the Security Profiles Operator, the
MutatingWebhookConfigurationobject is not deleted and must be manually removed. As a workaround, delete theMutatingWebhookConfigurationobject after uninstalling the Security Profiles Operator. These steps are defined in Uninstalling the Security Profiles Operator. (OCPBUGS-4687)
7.2.9. Security Profiles Operator 0.5.2 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.5.2:
This update addresses a CVE in an underlying dependency.
7.2.9.1. Known issue Copia collegamentoCollegamento copiato negli appunti!
-
When uninstalling the Security Profiles Operator, the
MutatingWebhookConfigurationobject is not deleted and must be manually removed. As a workaround, delete theMutatingWebhookConfigurationobject after uninstalling the Security Profiles Operator. These steps are defined in Uninstalling the Security Profiles Operator. (OCPBUGS-4687)
7.2.10. Security Profiles Operator 0.5.0 Copia collegamentoCollegamento copiato negli appunti!
The following advisory is available for the Security Profiles Operator 0.5.0:
7.2.10.1. Known issue Copia collegamentoCollegamento copiato negli appunti!
-
When uninstalling the Security Profiles Operator, the
MutatingWebhookConfigurationobject is not deleted and must be manually removed. As a workaround, delete theMutatingWebhookConfigurationobject after uninstalling the Security Profiles Operator. These steps are defined in Uninstalling the Security Profiles Operator. (OCPBUGS-4687)
7.3. Security Profiles Operator support Copia collegamentoCollegamento copiato negli appunti!
7.3.1. Security Profiles Operator lifecycle Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator is a "Rolling Stream" Operator, meaning updates are available asynchronously of OpenShift Container Platform releases. For more information, see OpenShift Operator Life Cycles on the Red Hat Customer Portal.
7.3.2. Getting support Copia collegamentoCollegamento copiato negli appunti!
If you experience difficulty with a procedure described in this documentation, or with OpenShift Container Platform in general, visit the Red Hat Customer Portal.
From the Customer Portal, you can:
- Search or browse through the Red Hat Knowledgebase of articles and solutions relating to Red Hat products.
- Submit a support case to Red Hat Support.
- Access other product documentation.
To identify issues with your cluster, you can use Red Hat Lightspeed in OpenShift Cluster Manager. Red Hat Lightspeed provides details about issues and, if available, information on how to solve a problem.
If you have a suggestion for improving this documentation or have found an error, submit a Jira issue for the most relevant documentation component. Please provide specific details, such as the section name and OpenShift Container Platform version.
7.4. Understanding the Security Profiles Operator Copia collegamentoCollegamento copiato negli appunti!
OpenShift Container Platform administrators can use the Security Profiles Operator to define increased security measures in clusters.
The Security Profiles Operator supports only Red Hat Enterprise Linux CoreOS (RHCOS) worker nodes. Red Hat Enterprise Linux (RHEL) nodes are not supported.
7.4.1. About Security Profiles Copia collegamentoCollegamento copiato negli appunti!
Security profiles can increase security at the container level in your cluster.
Seccomp security profiles list the syscalls a process can make. Permissions are broader than SELinux, enabling users to restrict operations system-wide, such as write.
SELinux security profiles provide a label-based system that restricts the access and usage of processes, applications, or files in a system. All files in an environment have labels that define permissions. SELinux profiles can define access within a given structure, such as directories.
7.5. Enabling the Security Profiles Operator Copia collegamentoCollegamento copiato negli appunti!
Before you can use the Security Profiles Operator, you must ensure the Operator is deployed in the cluster.
All cluster nodes must have the same release version in order for this Operator to function properly. As an example, for nodes running RHCOS, all nodes must have the same RHCOS version.
The Security Profiles Operator supports only Red Hat Enterprise Linux CoreOS (RHCOS) worker nodes. Red Hat Enterprise Linux (RHEL) nodes are not supported.
The Security Profiles Operator supports x86_64 and ppc64le architecture.
7.5.1. Installing the Security Profiles Operator Copia collegamentoCollegamento copiato negli appunti!
Prerequisites
-
You must have access to the web console as a user with
cluster-adminprivileges.
Procedure
-
In the OpenShift Container Platform web console, navigate to Ecosystem
Software Catalog. - Search for the Security Profiles Operator, then click Install.
-
Keep the default selection of Installation mode and namespace to ensure that the Operator will be installed to the
openshift-security-profilesnamespace. - Click Install.
Verification
To confirm that the installation is successful:
-
Navigate to the Ecosystem
Installed Operators page. -
Check that the Security Profiles Operator is installed in the
openshift-security-profilesnamespace and its status isSucceeded.
If the Operator is not installed successfully:
-
Navigate to the Ecosystem
Installed Operators page and inspect the Statuscolumn for any errors or failures. -
Navigate to the Workloads
Pods page and check the logs in any pods in the openshift-security-profilesproject that are reporting issues.
7.5.2. Installing the Security Profiles Operator using the CLI Copia collegamentoCollegamento copiato negli appunti!
Prerequisites
-
You must have
cluster-adminprivileges.
Procedure
Define a
Namespaceobject:Example
namespace-object.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Namespaceobject:oc create -f namespace-object.yaml
$ oc create -f namespace-object.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Define an
OperatorGroupobject:Example
operator-group-object.yamlapiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: security-profiles-operator namespace: openshift-security-profiles
apiVersion: operators.coreos.com/v1 kind: OperatorGroup metadata: name: security-profiles-operator namespace: openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
OperatorGroupobject:oc create -f operator-group-object.yaml
$ oc create -f operator-group-object.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Define a
Subscriptionobject:Example
subscription-object.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Subscriptionobject:oc create -f subscription-object.yaml
$ oc create -f subscription-object.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
If you are setting the global scheduler feature and enable defaultNodeSelector, you must create the namespace manually and update the annotations of the openshift-security-profiles namespace, or the namespace where the Security Profiles Operator was installed, with openshift.io/node-selector: “”. This removes the default node selector and prevents deployment failures.
Verification
Verify the installation succeeded by inspecting the following CSV file:
oc get csv -n openshift-security-profiles
$ oc get csv -n openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that the Security Profiles Operator is operational by running the following command:
oc get deploy -n openshift-security-profiles
$ oc get deploy -n openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.5.3. Configuring logging verbosity Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator supports the default logging verbosity of 0 and an enhanced verbosity of 1.
Procedure
To enable enhanced logging verbosity, patch the
spodconfiguration and adjust the value by running the following command:oc -n openshift-security-profiles patch spod \ spod --type=merge -p '{"spec":{"verbosity":1}}'$ oc -n openshift-security-profiles patch spod \ spod --type=merge -p '{"spec":{"verbosity":1}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
securityprofilesoperatordaemon.security-profiles-operator.x-k8s.io/spod patched
securityprofilesoperatordaemon.security-profiles-operator.x-k8s.io/spod patchedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.6. Managing seccomp profiles Copia collegamentoCollegamento copiato negli appunti!
Create and manage seccomp profiles and bind them to workloads.
The Security Profiles Operator supports only Red Hat Enterprise Linux CoreOS (RHCOS) worker nodes. Red Hat Enterprise Linux (RHEL) nodes are not supported.
7.6.1. Creating seccomp profiles Copia collegamentoCollegamento copiato negli appunti!
Use the SeccompProfile object to create profiles.
SeccompProfile objects can restrict syscalls within a container, limiting the access of your application.
Procedure
Create a project by running the following command:
oc new-project my-namespace
$ oc new-project my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
SeccompProfileobject:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
The seccomp profile will be saved in /var/lib/kubelet/seccomp/operator/<namespace>/<name>.json.
An init container creates the root directory of the Security Profiles Operator to run the Operator without root group or user ID privileges. A symbolic link is created from the rootless profile storage /var/lib/openshift-security-profiles to the default seccomp root path inside of the kubelet root /var/lib/kubelet/seccomp/operator.
7.6.2. Applying seccomp profiles to a pod Copia collegamentoCollegamento copiato negli appunti!
Create a pod to apply one of the created profiles.
Procedure
Create a pod object that defines a
securityContext:Copy to Clipboard Copied! Toggle word wrap Toggle overflow View the profile path of the
seccompProfile.localhostProfileattribute by running the following command:oc get seccompprofile profile1 --output wide
$ oc get seccompprofile profile1 --output wideCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME STATUS AGE SECCOMPPROFILE.LOCALHOSTPROFILE profile1 Installed 14s operator/profile1.json
NAME STATUS AGE SECCOMPPROFILE.LOCALHOSTPROFILE profile1 Installed 14s operator/profile1.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow View the path to the localhost profile by running the following command:
oc get sp profile1 --output=jsonpath='{.status.localhostProfile}'$ oc get sp profile1 --output=jsonpath='{.status.localhostProfile}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
operator/profile1.json
operator/profile1.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the
localhostProfileoutput to the patch file:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the profile to any other workload, such as a
Deploymentobject, by running the following command:oc -n my-namespace patch deployment myapp --patch-file patch.yaml --type=merge
$ oc -n my-namespace patch deployment myapp --patch-file patch.yaml --type=mergeCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
deployment.apps/myapp patched
deployment.apps/myapp patchedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Confirm the profile was applied correctly by running the following command:
oc -n my-namespace get deployment myapp --output=jsonpath='{.spec.template.spec.securityContext}' | jq .$ oc -n my-namespace get deployment myapp --output=jsonpath='{.spec.template.spec.securityContext}' | jq .Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.6.2.1. Binding workloads to profiles with ProfileBindings Copia collegamentoCollegamento copiato negli appunti!
You can use the ProfileBinding resource to bind a security profile to the SecurityContext of a container.
Procedure
To bind a pod that uses a
quay.io/security-profiles-operator/test-nginx-unprivileged:1.21image to the exampleSeccompProfileprofile, create aProfileBindingobject in the same namespace with the pod and theSeccompProfileobjects:Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantUsing the
image: "*"wildcard attribute binds all new pods with a default security profile in a given namespace.Label the namespace with
enable-binding=trueby running the following command:oc label ns my-namespace spo.x-k8s.io/enable-binding=true
$ oc label ns my-namespace spo.x-k8s.io/enable-binding=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Define a pod named
test-pod.yaml:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the pod:
oc create -f test-pod.yaml
$ oc create -f test-pod.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf the pod already exists, you must re-create the pod for the binding to work properly.
Verification
Confirm the pod inherits the
ProfileBindingby running the following command:oc get pod test-pod -o jsonpath='{.spec.containers[*].securityContext.seccompProfile}'$ oc get pod test-pod -o jsonpath='{.spec.containers[*].securityContext.seccompProfile}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
{"localhostProfile":"operator/profile.json","type":"Localhost"}{"localhostProfile":"operator/profile.json","type":"Localhost"}Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.6.3. Recording profiles from workloads Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator can record system calls with ProfileRecording objects, making it easier to create baseline profiles for applications.
When using the log enricher for recording seccomp profiles, verify the log enricher feature is enabled. See Additional resources for more information.
A container with privileged: true security context restraints prevents log-based recording. Privileged containers are not subject to seccomp policies, and log-based recording makes use of a special seccomp profile to record events.
Procedure
Create a project by running the following command:
oc new-project my-namespace
$ oc new-project my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow Label the namespace with
enable-recording=trueby running the following command:oc label ns my-namespace spo.x-k8s.io/enable-recording=true
$ oc label ns my-namespace spo.x-k8s.io/enable-recording=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a
ProfileRecordingobject containing arecorder: logsvariable:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a workload to record:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the pod is in a
Runningstate by entering the following command:oc -n my-namespace get pods
$ oc -n my-namespace get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME READY STATUS RESTARTS AGE my-pod 2/2 Running 0 18s
NAME READY STATUS RESTARTS AGE my-pod 2/2 Running 0 18sCopy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the enricher indicates that it receives audit logs for those containers:
oc -n openshift-security-profiles logs --since=1m --selector name=spod -c log-enricher
$ oc -n openshift-security-profiles logs --since=1m --selector name=spod -c log-enricherCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
I0523 14:19:08.747313 430694 enricher.go:445] log-enricher "msg"="audit" "container"="redis" "executable"="/usr/local/bin/redis-server" "namespace"="my-namespace" "node"="xiyuan-23-5g2q9-worker-eastus2-6rpgf" "pid"=656802 "pod"="my-pod" "syscallID"=0 "syscallName"="read" "timestamp"="1684851548.745:207179" "type"="seccomp"
I0523 14:19:08.747313 430694 enricher.go:445] log-enricher "msg"="audit" "container"="redis" "executable"="/usr/local/bin/redis-server" "namespace"="my-namespace" "node"="xiyuan-23-5g2q9-worker-eastus2-6rpgf" "pid"=656802 "pod"="my-pod" "syscallID"=0 "syscallName"="read" "timestamp"="1684851548.745:207179" "type"="seccomp"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Remove the pod:
oc -n my-namespace delete pod my-pod
$ oc -n my-namespace delete pod my-podCopy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the Security Profiles Operator reconciles the two seccomp profiles:
oc get seccompprofiles -lspo.x-k8s.io/recording-id=test-recording
$ oc get seccompprofiles -lspo.x-k8s.io/recording-id=test-recordingCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output for seccompprofile
NAME STATUS AGE test-recording-nginx Installed 2m48s test-recording-redis Installed 2m48s
NAME STATUS AGE test-recording-nginx Installed 2m48s test-recording-redis Installed 2m48sCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.6.3.1. Merging per-container profile instances Copia collegamentoCollegamento copiato negli appunti!
By default, each container instance records into a separate profile. The Security Profiles Operator can merge the per-container profiles into a single profile. Merging profiles is useful when deploying applications using ReplicaSet or Deployment objects.
Procedure
Edit a
ProfileRecordingobject to include amergeStrategy: containersvariable:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Label the namespace by running the following command:
oc label ns my-namespace security.openshift.io/scc.podSecurityLabelSync=false pod-security.kubernetes.io/enforce=privileged pod-security.kubernetes.io/audit=privileged pod-security.kubernetes.io/warn=privileged --overwrite=true
$ oc label ns my-namespace security.openshift.io/scc.podSecurityLabelSync=false pod-security.kubernetes.io/enforce=privileged pod-security.kubernetes.io/audit=privileged pod-security.kubernetes.io/warn=privileged --overwrite=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the workload with the following YAML:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow To record the individual profiles, delete the deployment by running the following command:
oc delete deployment nginx-deploy -n my-namespace
$ oc delete deployment nginx-deploy -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow To merge the profiles, delete the profile recording by running the following command:
oc delete profilerecording test-recording -n my-namespace
$ oc delete profilerecording test-recording -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow To start the merge operation and generate the results profile, run the following command:
oc get seccompprofiles -lspo.x-k8s.io/recording-id=test-recording -n my-namespace
$ oc get seccompprofiles -lspo.x-k8s.io/recording-id=test-recording -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output for seccompprofiles
NAME STATUS AGE test-recording-nginx-record Installed 55s
NAME STATUS AGE test-recording-nginx-record Installed 55sCopy to Clipboard Copied! Toggle word wrap Toggle overflow To view the permissions used by any of the containers, run the following command:
oc get seccompprofiles test-recording-nginx-record -o yaml
$ oc get seccompprofiles test-recording-nginx-record -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7. Managing SELinux profiles Copia collegamentoCollegamento copiato negli appunti!
Create and manage SELinux profiles and bind them to workloads.
The Security Profiles Operator supports only Red Hat Enterprise Linux CoreOS (RHCOS) worker nodes. Red Hat Enterprise Linux (RHEL) nodes are not supported.
7.7.1. Creating SELinux profiles Copia collegamentoCollegamento copiato negli appunti!
Use the SelinuxProfile object to create profiles.
The SelinuxProfile object has several features that allow for better security hardening and readability:
-
Restricts the profiles to inherit from to the current namespace or a system-wide profile. Because there are typically many profiles installed on the system, but only a subset should be used by cluster workloads, the inheritable system profiles are listed in the
spodinstance inspec.selinuxOptions.allowedSystemProfiles. - Performs basic validation of the permissions, classes and labels.
-
Adds a new keyword
@selfthat describes the process using the policy. This allows reusing a policy between workloads and namespaces easily, as the usage of the policy is based on the name and namespace. - Adds features for better security hardening and readability compared to writing a profile directly in the SELinux CIL language.
Procedure
Create a project by running the following command:
oc new-project nginx-deploy
$ oc new-project nginx-deployCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a policy that can be used with a non-privileged workload by creating the following
SelinuxProfileobject:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for
selinuxdto install the policy by running the following command:oc wait --for=condition=ready selinuxprofile nginx-secure
$ oc wait --for=condition=ready selinuxprofile nginx-secureCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
selinuxprofile.security-profiles-operator.x-k8s.io/nginx-secure condition met
selinuxprofile.security-profiles-operator.x-k8s.io/nginx-secure condition metCopy to Clipboard Copied! Toggle word wrap Toggle overflow The policies are placed into an
emptyDirin the container owned by the Security Profiles Operator. The policies are saved in Common Intermediate Language (CIL) format in/etc/selinux.d/<name>_<namespace>.cil.Access the pod by running the following command:
oc -n openshift-security-profiles rsh -c selinuxd ds/spod
$ oc -n openshift-security-profiles rsh -c selinuxd ds/spodCopy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
View the file contents with
catby running the following command:cat /etc/selinux.d/nginx-secure.cil
$ cat /etc/selinux.d/nginx-secure.cilCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that a policy has been installed by running the following command:
semodule -l | grep nginx-secure
$ semodule -l | grep nginx-secureCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
nginx-secure
nginx-secureCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7.2. Applying SELinux profiles to a pod Copia collegamentoCollegamento copiato negli appunti!
Create a pod to apply one of the created profiles.
For SELinux profiles, the namespace must be labelled to allow privileged workloads.
Procedure
Apply the
scc.podSecurityLabelSync=falselabel to thenginx-deploynamespace by running the following command:oc label ns nginx-deploy security.openshift.io/scc.podSecurityLabelSync=false
$ oc label ns nginx-deploy security.openshift.io/scc.podSecurityLabelSync=falseCopy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the
privilegedlabel to thenginx-deploynamespace by running the following command:oc label ns nginx-deploy --overwrite=true pod-security.kubernetes.io/enforce=privileged
$ oc label ns nginx-deploy --overwrite=true pod-security.kubernetes.io/enforce=privilegedCopy to Clipboard Copied! Toggle word wrap Toggle overflow Obtain the SELinux profile usage string by running the following command:
oc get selinuxprofile.security-profiles-operator.x-k8s.io/nginx-secure -ojsonpath='{.status.usage}'$ oc get selinuxprofile.security-profiles-operator.x-k8s.io/nginx-secure -ojsonpath='{.status.usage}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
nginx-secure.process
nginx-secure.processCopy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the output string in the workload manifest in the
.spec.containers[].securityContext.seLinuxOptionsattribute:Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantThe SELinux
typemust exist before creating the workload.
7.7.2.1. Applying SELinux log policies Copia collegamentoCollegamento copiato negli appunti!
To log policy violations or AVC denials, set the SElinuxProfile profile to permissive.
This procedure defines logging policies. It does not set enforcement policies.
Procedure
Add
permissive: trueto anSElinuxProfile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7.2.2. Binding workloads to profiles with ProfileBindings Copia collegamentoCollegamento copiato negli appunti!
You can use the ProfileBinding resource to bind a security profile to the SecurityContext of a container.
Procedure
To bind a pod that uses a
quay.io/security-profiles-operator/test-nginx-unprivileged:1.21image to the exampleSelinuxProfileprofile, create aProfileBindingobject in the same namespace with the pod and theSelinuxProfileobjects:Copy to Clipboard Copied! Toggle word wrap Toggle overflow ImportantUsing the
image: "*"wildcard attribute binds all new pods with a default security profile in a given namespace.Label the namespace with
enable-binding=trueby running the following command:oc label ns my-namespace spo.x-k8s.io/enable-binding=true
$ oc label ns my-namespace spo.x-k8s.io/enable-binding=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Define a pod named
test-pod.yaml:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the pod:
oc create -f test-pod.yaml
$ oc create -f test-pod.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteIf the pod already exists, you must re-create the pod for the binding to work properly.
Verification
Confirm the pod inherits the
ProfileBindingby running the following command:oc get pod test-pod -o jsonpath='{.spec.containers[*].securityContext.seLinuxOptions.type}'$ oc get pod test-pod -o jsonpath='{.spec.containers[*].securityContext.seLinuxOptions.type}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
profile.process
profile.processCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7.2.3. Replicating controllers and SecurityContextConstraints Copia collegamentoCollegamento copiato negli appunti!
When you deploy SELinux policies for replicating controllers, such as deployments or daemon sets, note that the Pod objects spawned by the controllers are not running with the identity of the user who creates the workload. Unless a ServiceAccount is selected, the pods might revert to using a restricted SecurityContextConstraints (SCC) which does not allow use of custom security policies.
Procedure
Create a project by running the following command:
oc new-project nginx-secure
$ oc new-project nginx-secureCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the following
RoleBindingobject to allow SELinux policies to be used in thenginx-securenamespace:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Roleobject:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
ServiceAccountobject:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create the
Deploymentobject:Copy to Clipboard Copied! Toggle word wrap Toggle overflow - 1
- The
.seLinuxOptions.typemust exist before the Deployment is created.
NoteThe SELinux type is not specified in the workload and is handled by the SCC. When the pods are created by the deployment and the
ReplicaSet, the pods will run with the appropriate profile.
Ensure that your SCC is usable by only the correct service account. Refer to Additional resources for more information.
7.7.3. Recording profiles from workloads Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator can record system calls with ProfileRecording objects, making it easier to create baseline profiles for applications.
When using the log enricher for recording SELinux profiles, verify the log enricher feature is enabled. See Additional resources for more information.
A container with privileged: true security context restraints prevents log-based recording. Privileged containers are not subject to SELinux policies, and log-based recording makes use of a special SELinux profile to record events.
Procedure
Create a project by running the following command:
oc new-project my-namespace
$ oc new-project my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow Label the namespace with
enable-recording=trueby running the following command:oc label ns my-namespace spo.x-k8s.io/enable-recording=true
$ oc label ns my-namespace spo.x-k8s.io/enable-recording=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a
ProfileRecordingobject containing arecorder: logsvariable:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a workload to record:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the pod is in a
Runningstate by entering the following command:oc -n my-namespace get pods
$ oc -n my-namespace get podsCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME READY STATUS RESTARTS AGE my-pod 2/2 Running 0 18s
NAME READY STATUS RESTARTS AGE my-pod 2/2 Running 0 18sCopy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the enricher indicates that it receives audit logs for those containers:
oc -n openshift-security-profiles logs --since=1m --selector name=spod -c log-enricher
$ oc -n openshift-security-profiles logs --since=1m --selector name=spod -c log-enricherCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
I0517 13:55:36.383187 348295 enricher.go:376] log-enricher "msg"="audit" "container"="redis" "namespace"="my-namespace" "node"="ip-10-0-189-53.us-east-2.compute.internal" "perm"="name_bind" "pod"="my-pod" "profile"="test-recording_redis_6kmrb_1684331729" "scontext"="system_u:system_r:selinuxrecording.process:s0:c4,c27" "tclass"="tcp_socket" "tcontext"="system_u:object_r:redis_port_t:s0" "timestamp"="1684331735.105:273965" "type"="selinux"
I0517 13:55:36.383187 348295 enricher.go:376] log-enricher "msg"="audit" "container"="redis" "namespace"="my-namespace" "node"="ip-10-0-189-53.us-east-2.compute.internal" "perm"="name_bind" "pod"="my-pod" "profile"="test-recording_redis_6kmrb_1684331729" "scontext"="system_u:system_r:selinuxrecording.process:s0:c4,c27" "tclass"="tcp_socket" "tcontext"="system_u:object_r:redis_port_t:s0" "timestamp"="1684331735.105:273965" "type"="selinux"Copy to Clipboard Copied! Toggle word wrap Toggle overflow
Verification
Remove the pod:
oc -n my-namespace delete pod my-pod
$ oc -n my-namespace delete pod my-podCopy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm the Security Profiles Operator reconciles the two SELinux profiles:
oc get selinuxprofiles -lspo.x-k8s.io/recording-id=test-recording
$ oc get selinuxprofiles -lspo.x-k8s.io/recording-id=test-recordingCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output for selinuxprofile
NAME USAGE STATE test-recording-nginx test-recording-nginx.process Installed test-recording-redis test-recording-redis.process Installed
NAME USAGE STATE test-recording-nginx test-recording-nginx.process Installed test-recording-redis test-recording-redis.process InstalledCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7.3.1. Merging per-container profile instances Copia collegamentoCollegamento copiato negli appunti!
By default, each container instance records into a separate profile. The Security Profiles Operator can merge the per-container profiles into a single profile. Merging profiles is useful when deploying applications using ReplicaSet or Deployment objects.
Procedure
Edit a
ProfileRecordingobject to include amergeStrategy: containersvariable:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Label the namespace by running the following command:
oc label ns my-namespace security.openshift.io/scc.podSecurityLabelSync=false pod-security.kubernetes.io/enforce=privileged pod-security.kubernetes.io/audit=privileged pod-security.kubernetes.io/warn=privileged --overwrite=true
$ oc label ns my-namespace security.openshift.io/scc.podSecurityLabelSync=false pod-security.kubernetes.io/enforce=privileged pod-security.kubernetes.io/audit=privileged pod-security.kubernetes.io/warn=privileged --overwrite=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the workload with the following YAML:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow To record the individual profiles, delete the deployment by running the following command:
oc delete deployment nginx-deploy -n my-namespace
$ oc delete deployment nginx-deploy -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow To merge the profiles, delete the profile recording by running the following command:
oc delete profilerecording test-recording -n my-namespace
$ oc delete profilerecording test-recording -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow To start the merge operation and generate the results profile, run the following command:
oc get selinuxprofiles -lspo.x-k8s.io/recording-id=test-recording -n my-namespace
$ oc get selinuxprofiles -lspo.x-k8s.io/recording-id=test-recording -n my-namespaceCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output for selinuxprofiles
NAME USAGE STATE test-recording-nginx-record test-recording-nginx-record.process Installed
NAME USAGE STATE test-recording-nginx-record test-recording-nginx-record.process InstalledCopy to Clipboard Copied! Toggle word wrap Toggle overflow To view the permissions used by any of the containers, run the following command:
oc get selinuxprofiles test-recording-nginx-record -o yaml
$ oc get selinuxprofiles test-recording-nginx-record -o yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.7.3.2. About seLinuxContext: RunAsAny Copia collegamentoCollegamento copiato negli appunti!
Recording of SELinux policies is implemented with a webhook that injects a special SELinux type to the pods being recorded. The SELinux type makes the pod run in permissive mode, logging all the AVC denials into audit.log. By default, a workload is not allowed to run with a custom SELinux policy, but uses an auto-generated type.
To record a workload, the workload must use a service account that has permissions to use an SCC that allows the webhook to inject the permissive SELinux type. The privileged SCC contains seLinuxContext: RunAsAny.
In addition, the namespace must be labeled with pod-security.kubernetes.io/enforce: privileged if your cluster enables the Pod Security Admission because only the privileged Pod Security Standard allows using a custom SELinux policy.
7.8. Advanced Security Profiles Operator tasks Copia collegamentoCollegamento copiato negli appunti!
Use advanced tasks to enable metrics, configure webhooks, or restrict syscalls.
7.8.1. Restrict the allowed syscalls in seccomp profiles Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator does not restrict syscalls in seccomp profiles by default. You can define the list of allowed syscalls in the spod configuration.
Procedure
To define the list of
allowedSyscalls, adjust thespecparameter by running the following command:oc -n openshift-security-profiles patch spod spod --type merge \ -p '{"spec":{"allowedSyscalls": ["exit", "exit_group", "futex", "nanosleep"]}}'$ oc -n openshift-security-profiles patch spod spod --type merge \ -p '{"spec":{"allowedSyscalls": ["exit", "exit_group", "futex", "nanosleep"]}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow
The Operator will install only the seccomp profiles, which have a subset of syscalls defined into the allowed list. All profiles not complying with this ruleset are rejected.
When the list of allowed syscalls is modified in the spod configuration, the Operator will identify the already installed profiles which are non-compliant and remove them automatically.
7.8.2. Base syscalls for a container runtime Copia collegamentoCollegamento copiato negli appunti!
You can use the baseProfileName attribute to establish the minimum required syscalls for a given runtime to start a container.
Procedure
Edit the
SeccompProfilekind object and addbaseProfileName: runc-v1.0.0to thespecfield:Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.3. Enabling memory optimization in the spod daemon Copia collegamentoCollegamento copiato negli appunti!
The controller running inside of spod daemon process watches all pods available in the cluster when profile recording is enabled. This can lead to very high memory usage in large clusters, resulting in the spod daemon running out of memory or crashing.
To prevent crashes, the spod daemon can be configured to only load the pods labeled for profile recording into the cache memory.
SPO memory optimization is not enabled by default.
Procedure
Enable memory optimization by running the following command:
oc -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableMemoryOptimization":true}}'$ oc -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableMemoryOptimization":true}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow To record a security profile for a pod, the pod must be labeled with
spo.x-k8s.io/enable-recording: "true":Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.4. Customizing daemon resource requirements Copia collegamentoCollegamento copiato negli appunti!
The default resource requirements of the daemon container can be adjusted by using the field daemonResourceRequirements from the spod configuration.
Procedure
To specify the memory and cpu requests and limits of the daemon container, run the following command:
oc -n openshift-security-profiles patch spod spod --type merge -p \ '{"spec":{"daemonResourceRequirements": { \ "requests": {"memory": "256Mi", "cpu": "250m"}, \ "limits": {"memory": "512Mi", "cpu": "500m"}}}}'$ oc -n openshift-security-profiles patch spod spod --type merge -p \ '{"spec":{"daemonResourceRequirements": { \ "requests": {"memory": "256Mi", "cpu": "250m"}, \ "limits": {"memory": "512Mi", "cpu": "500m"}}}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.5. Setting a custom priority class name for the spod daemon pod Copia collegamentoCollegamento copiato negli appunti!
The default priority class name of the spod daemon pod is set to system-node-critical. A custom priority class name can be configured in the spod configuration by setting a value in the priorityClassName field.
Procedure
Configure the priority class name by running the following command:
oc -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"priorityClassName":"my-priority-class"}}'$ oc -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"priorityClassName":"my-priority-class"}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
securityprofilesoperatordaemon.openshift-security-profiles.x-k8s.io/spod patched
securityprofilesoperatordaemon.openshift-security-profiles.x-k8s.io/spod patchedCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.6. Using metrics Copia collegamentoCollegamento copiato negli appunti!
The openshift-security-profiles namespace provides metrics endpoints, which are secured by the kube-rbac-proxy container. All metrics are exposed by the metrics service within the openshift-security-profiles namespace.
The Security Profiles Operator includes a cluster role and corresponding binding spo-metrics-client to retrieve the metrics from within the cluster. There are two metrics paths available:
-
metrics.openshift-security-profiles/metrics: for controller runtime metrics -
metrics.openshift-security-profiles/metrics-spod: for the Operator daemon metrics
Procedure
To view the status of the metrics service, run the following command:
oc get svc/metrics -n openshift-security-profiles
$ oc get svc/metrics -n openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE metrics ClusterIP 10.0.0.228 <none> 443/TCP 43s
NAME TYPE CLUSTER-IP EXTERNAL-IP PORT(S) AGE metrics ClusterIP 10.0.0.228 <none> 443/TCP 43sCopy to Clipboard Copied! Toggle word wrap Toggle overflow To retrieve the metrics, query the service endpoint using the default
ServiceAccounttoken in theopenshift-security-profilesnamespace by running the following command:oc run --rm -i --restart=Never --image=registry.fedoraproject.org/fedora-minimal:latest \ -n openshift-security-profiles metrics-test -- bash -c \ 'curl -ks -H "Authorization: Bearer $(cat /var/run/secrets/kubernetes.io/serviceaccount/token)" https://metrics.openshift-security-profiles/metrics-spod'$ oc run --rm -i --restart=Never --image=registry.fedoraproject.org/fedora-minimal:latest \ -n openshift-security-profiles metrics-test -- bash -c \ 'curl -ks -H "Authorization: Bearer $(cat /var/run/secrets/kubernetes.io/serviceaccount/token)" https://metrics.openshift-security-profiles/metrics-spod'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
# HELP security_profiles_operator_seccomp_profile_total Counter about seccomp profile operations. # TYPE security_profiles_operator_seccomp_profile_total counter security_profiles_operator_seccomp_profile_total{operation="delete"} 1 security_profiles_operator_seccomp_profile_total{operation="update"} 2# HELP security_profiles_operator_seccomp_profile_total Counter about seccomp profile operations. # TYPE security_profiles_operator_seccomp_profile_total counter security_profiles_operator_seccomp_profile_total{operation="delete"} 1 security_profiles_operator_seccomp_profile_total{operation="update"} 2Copy to Clipboard Copied! Toggle word wrap Toggle overflow To retrieve metrics from a different namespace, link the
ServiceAccountto thespo-metrics-clientClusterRoleBindingby running the following command:oc get clusterrolebinding spo-metrics-client -o wide
$ oc get clusterrolebinding spo-metrics-client -o wideCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
NAME ROLE AGE USERS GROUPS SERVICEACCOUNTS spo-metrics-client ClusterRole/spo-metrics-client 35m openshift-security-profiles/default
NAME ROLE AGE USERS GROUPS SERVICEACCOUNTS spo-metrics-client ClusterRole/spo-metrics-client 35m openshift-security-profiles/defaultCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.6.1. controller-runtime metrics Copia collegamentoCollegamento copiato negli appunti!
The controller-runtime metrics and the DaemonSet endpoint metrics-spod provide a set of default metrics. Additional metrics are provided by the daemon, which are always prefixed with security_profiles_operator_.
| Metric key | Possible labels | Type | Purpose |
|---|---|---|---|
|
|
| Counter | Amount of seccomp profile operations. |
|
|
| Counter | Amount of seccomp profile audit operations. Requires the log enricher to be enabled. |
|
|
| Counter | Amount of seccomp profile bpf operations. Requires the bpf recorder to be enabled. |
|
|
| Counter | Amount of seccomp profile errors. |
|
|
| Counter | Amount of SELinux profile operations. |
|
|
| Counter | Amount of SELinux profile audit operations. Requires the log enricher to be enabled. |
|
|
| Counter | Amount of SELinux profile errors. |
7.8.7. Using the log enricher Copia collegamentoCollegamento copiato negli appunti!
The Security Profiles Operator contains a log enrichment feature, which is disabled by default. The log enricher container runs with privileged permissions to read the audit logs from the local node. The log enricher runs within the host PID namespace, hostPID.
The log enricher must have permissions to read the host processes.
Procedure
Patch the
spodconfiguration to enable the log enricher by running the following command:oc -n openshift-security-profiles patch spod spod \ --type=merge -p '{"spec":{"enableLogEnricher":true}}'$ oc -n openshift-security-profiles patch spod spod \ --type=merge -p '{"spec":{"enableLogEnricher":true}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
securityprofilesoperatordaemon.security-profiles-operator.x-k8s.io/spod patched
securityprofilesoperatordaemon.security-profiles-operator.x-k8s.io/spod patchedCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteThe Security Profiles Operator will re-deploy the
spoddaemon set automatically.View the audit logs by running the following command:
oc -n openshift-security-profiles logs -f ds/spod log-enricher
$ oc -n openshift-security-profiles logs -f ds/spod log-enricherCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
I0623 12:51:04.257814 1854764 deleg.go:130] setup "msg"="starting component: log-enricher" "buildDate"="1980-01-01T00:00:00Z" "compiler"="gc" "gitCommit"="unknown" "gitTreeState"="clean" "goVersion"="go1.16.2" "platform"="linux/amd64" "version"="0.4.0-dev" I0623 12:51:04.257890 1854764 enricher.go:44] log-enricher "msg"="Starting log-enricher on node: 127.0.0.1" I0623 12:51:04.257898 1854764 enricher.go:46] log-enricher "msg"="Connecting to local GRPC server" I0623 12:51:04.258061 1854764 enricher.go:69] log-enricher "msg"="Reading from file /var/log/audit/audit.log" 2021/06/23 12:51:04 Seeked /var/log/audit/audit.log - &{Offset:0 Whence:2}I0623 12:51:04.257814 1854764 deleg.go:130] setup "msg"="starting component: log-enricher" "buildDate"="1980-01-01T00:00:00Z" "compiler"="gc" "gitCommit"="unknown" "gitTreeState"="clean" "goVersion"="go1.16.2" "platform"="linux/amd64" "version"="0.4.0-dev" I0623 12:51:04.257890 1854764 enricher.go:44] log-enricher "msg"="Starting log-enricher on node: 127.0.0.1" I0623 12:51:04.257898 1854764 enricher.go:46] log-enricher "msg"="Connecting to local GRPC server" I0623 12:51:04.258061 1854764 enricher.go:69] log-enricher "msg"="Reading from file /var/log/audit/audit.log" 2021/06/23 12:51:04 Seeked /var/log/audit/audit.log - &{Offset:0 Whence:2}Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.7.1. Using the log enricher to trace an application Copia collegamentoCollegamento copiato negli appunti!
You can use the Security Profiles Operator log enricher to trace an application.
Procedure
To trace an application, create a
SeccompProfilelogging profile:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Create a pod object to use the profile:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Examine the log enricher output by running the following command:
oc -n openshift-security-profiles logs -f ds/spod log-enricher
$ oc -n openshift-security-profiles logs -f ds/spod log-enricherCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example 7.1. Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.8.8. Configuring webhooks Copia collegamentoCollegamento copiato negli appunti!
Profile binding and profile recording objects can use webhooks. Profile binding and recording object configurations are MutatingWebhookConfiguration CRs, managed by the Security Profiles Operator.
To change the webhook configuration, the spod CR exposes a webhookOptions field that allows modification of the failurePolicy, namespaceSelector, and objectSelector variables. This allows you to set the webhooks to "soft-fail" or restrict them to a subset of a namespaces so that even if the webhooks failed, other namespaces or resources are not affected.
Procedure
Set the
recording.spo.iowebhook configuration to record only pods labeled withspo-record=trueby creating the following patch file:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Patch the
spod/spodinstance by running the following command:oc -n openshift-security-profiles patch spod \ spod -p $(cat /tmp/spod-wh.patch) --type=merge$ oc -n openshift-security-profiles patch spod \ spod -p $(cat /tmp/spod-wh.patch) --type=mergeCopy to Clipboard Copied! Toggle word wrap Toggle overflow To view the resulting
MutatingWebhookConfigurationobject, run the following command:oc get MutatingWebhookConfiguration \ spo-mutating-webhook-configuration -oyaml$ oc get MutatingWebhookConfiguration \ spo-mutating-webhook-configuration -oyamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9. Advanced Audit Logging Framework Copia collegamentoCollegamento copiato negli appunti!
The Advanced Audit Logging Framework provided in OpenShift Container Platform Security Profiles Operator (SPO) 0.10.0 provides logging of container activities in an Red Hat Enterprise Linux CoreOS (RHCOS) container back to the hosting cluster. With the Advanced Audit Logging Framework, you can correlate an OpenShift Container Platform user with their direct actions on the node during oc exec, oc rsh, and oc debug sessions. The advanced audit logging results in detailed logs in a JSON Lines format.
7.9.1. Benefits of Advanced Audit Logging Framework Copia collegamentoCollegamento copiato negli appunti!
The kubectl exec, oc exec, oc rsh and oc debug commands do not pass user authentication details into the exec session on the container, making it hard to correlate Kubernetes user actions caused by actions on the host. The audit logger in SPO addresses this with mutating webhooks that inject the request UID from the Kubernetes API server as an environment variable into the session. Every request to the API server including the request to start a new exec session has a request UID. This request UID is then logged by the Advanced Audit Logging Framework. The request ID is used to correlate the activity with the API server audit logs, providing an audit trail within the node.
With the addition of the Advanced Audit Logging Framework, SPO now has two use cases:
- Pod auditing
- Node auditing
The use of privileged seccompProfile configuration is required only for the case of node auditing.
The Security Profiles Operator supports only Red Hat Enterprise Linux CoreOS (RHCOS) worker nodes appropriate to the version of OpenShift Container Platform in use.
Red Hat Enterprise Linux (RHEL) nodes are not supported.
7.9.2. Performance considerations Copia collegamentoCollegamento copiato negli appunti!
It is important to consider the performance cost of using seccomp profiles for extensive logging. SPO is designed to minimize this impact by primarily logging only process creations and handling them asynchronously. This approach helps prevent logging from becoming a bottleneck on your nodes.
The Advanced Audit Logging feature uses eBPF as a supplemental data source. While it is possible for eBPF to be used as a primary data source for this type of logging, that functionality is not currently a configurable feature within the Operator. For most use cases, the default asynchronous, process-creation-focused logging approach provides an excellent balance between security visibility and cluster performance.
7.9.3. Prerequisites for use of the Advanced Audit Logging Framework Copia collegamentoCollegamento copiato negli appunti!
Before enabling the Advanced Audit Logging Framework, ensure the following requirements are met.
Security Profiles Operator version 0.10.0 or later is installed. Those instructions can be found at Installing the Security Profiles Operator. The Advanced Audit Logging Framework requires Security Profiles Operator version 0.10.0 or later.
For node debugging sessions:
-
To audit
oc debugnode sessions, CRI-O version 1.33 or later is required. It is available in OpenShift Container Platform 4.20 or later. -
The --privileged-seccomp-profile flag must be configured in CRI-O to apply
seccompProfilesto privileged containers. - The supported Linux used with the Advanced Audit Logging Framework is Red Hat Enterprise Linux CoreOS (RHCOS) running in a container in OpenShift Container Platform 4.20 or later.
If you are using the CRI-O runtime, you must configure it to allow seccompProfile to be applied to privileged containers. Add the following flag to your CRI-O runtime configuration: --privileged-seccomp-profile=/var/lib/kubelet/seccomp/operator/profile1.json. This is explained in more detail in the Advanced Audit Logging installation and enablement steps. The --privileged-seccomp-profile flag is available starting with OCP 4.20 and later.
If you are using any version of SPO before 0.9.0, you must perform a migration procedure to install versions 0.9.0 or 0.10.0. The migration procedure converts SPO to operate on cluster-scoped resources.
First-time installation of SPO version 0.10.0 does not require migration. Also, if you are currently on SPO 0.9.0, you do not require migration and can directly upgrade to SPO 0.10.0.
Do not attempt to upgrade directly from SPO versions before 0.9.0 to either 0.9.0 or 0.10.0 if you are currently running SPO. You must perform the migration procedure to convert SPO for operation at the cluster level.
This change allows Advanced Audit Logging of events inside the worker node.
This capability is not provided for control nodes since SPO does not operate on etcd nodes.
7.9.4. The Audit JSON log enricher Copia collegamentoCollegamento copiato negli appunti!
The SPO Advanced Audit Logging Framework is enabled by the Audit JSON log enricher. Similar to the log enricher feature, the Audit JSON log enricher watches the auditd (/var/log/audit/audit.log) or the syslog (/var/log/syslog) daemons and generates a new audit log in JSON lines format.
Each JSON line includes the following:
- Timestamp: When the activity happened, shown in a standard ISO format
-
Executable Name: The name of the program that was run (
bash,ls). -
Linux Command Line Arguments (
cmdline): The extra instructions given when the program was started (ls -l /home). -
User and Group IDs (
UID/GID): The identification numbers of the system user who ran the program. -
System Calls (
syscalls): A list of system calls (syscalls) that the process made
This log format and configuration is similar to how Kubernetes records audit logs. This is useful for:
- Seeing what users and automated processes are doing inside a pod.
-
Tracking when someone uses commands such as
kubectl execto enter a running container and run commands or scripts. - Monitoring activities in debug containers where users might run various tools.
7.9.5. Kubernetes API log compared to Advanced Audit Logging output Copia collegamentoCollegamento copiato negli appunti!
To understand the value of Advanced Audit Logging, compare the Kubernetes API Server Audit Log to the Advanced Audit Logging output:
Kubernetes API Server Audit Log
The correlation key is the SPO_EXEC_REQUEST_UID on the last line in the above file.
Advanced Audit Logging Output
7.9.6. Enabling Advanced Audit Logging Copia collegamentoCollegamento copiato negli appunti!
To enable Advanced Audit Logging, configure the Audit JSON log enricher and specify a set of filters to only log user activity.
Procedure
Enable the JSON enricher by running the following command:
kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true}}'# kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Monitor the SPOD pods for correct restart and wait for all SPOD pods to show
Runningbefore proceeding.Check the pods for application of the change with the following command:
oc get pods -n openshift-security-profiles -l name=spod -w
$ oc get pods -n openshift-security-profiles -l name=spod -wCopy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding.NoteEach configuration change triggers a restart of the SPOD pods. After applying a patch, wait for all SPOD pods to return to the
Runningstate before continuing.The Audit JSON log enricher uses eBPF as a supplemental data source. While processing
auditdlogs from/var/log/audit/audit.log, the enricher attempts to fetch ephemeral data from/proc/<pid>directories. Due to a race condition, these files might be deleted before they can be read. To ensure data completeness, the enricher falls back to fetching the necessary information from eBPF whenever it is not found in/proc/<pid>.
7.9.7. Audit JSON Log Enricher configuration Copia collegamentoCollegamento copiato negli appunti!
The Audit JSON Log Enricher requires some configuration to set interval, configure the destination of the log data and set the audit log file path. This procedure demonstrates how to set up and fine tune your Advanced Audit Logging Framework audit logs.
Each configuration change triggers a restart of the SPOD pods. After applying a patch, wait for all SPOD pods to return to the Running state before continuing.
Setting the audit log interval determines how often audit logs are created using the auditLogIntervalSeconds option.
Procedure
Configure the audit log interval to 30 seconds by using the following command:
kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogIntervalSeconds":30}}}'# kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogIntervalSeconds":30}}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding. By default, audit logs go to your standard output in JSON lines format. You can send them to a file instead.Configure the security profiles operator to store the log file on the node. Update the security-profiles-operator-profile
ConfigMapwith two keys. This exampleyamluses both keys to set up a host path volume at/tmp/logs.Save this JSON in a file, such as
patch-volume-source.jsonand check it using the following command:cat patch-volume-source.json
$ cat patch-volume-source.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
json-enricher-log-volume-source.json: Defines the type of volume (for example, a host path and empty directory) where logs will be stored. This must be a JSON string representing acorev1.VolumeSourceobject. -
json-enricher-log-volume-mount-path: Specifies the directory path where the log file will be generated.
-
Update the config map by saving this JSON in this file called
patch-volume-source.jsonand then update the config map with the following command:kubectl patch configmap security-profiles-operator-profile -n openshift-security-profiles --patch-file patch-volume-source.json
# kubectl patch configmap security-profiles-operator-profile -n openshift-security-profiles --patch-file patch-volume-source.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding.To set the audit log file path, configure the JSON log enricher with the full path to your audit log file by including the filename, using this command:
kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogPath":"/tmp/logs/audit1.log"}}}'# kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogPath":"/tmp/logs/audit1.log"}}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding
7.9.8. Audit log file fine-tuning and rotation Copia collegamentoCollegamento copiato negli appunti!
For audit logging to a file, you can manage file size and how long each file is kept. These options are similar to Kubernetes API server log settings.
Procedure
You configure these by patching the JSON log enricher options:
kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogPath":"/tmp/logs/audit1.log","auditLogMaxSize":500,"auditLogMaxBackups":2,"auditLogMaxAge":10}}}'# kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true,"verbosity":0,"jsonEnricherOptions":{"auditLogPath":"/tmp/logs/audit1.log","auditLogMaxSize":500,"auditLogMaxBackups":2,"auditLogMaxAge":10}}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding.-
auditLogMaxSize: The maximum size (in megabytes) a log file can reach before it’s rotated (a new file is started). -
auditLogMaxBackups: The maximum number of older, rotated log files to keep. Set to 0 for no limit. -
auditLogMaxAge: The maximum number of days to keep old log files.
-
Increase the logging level for the JSON log enricher container to help with debugging. A value of
0sets minimal logs. A value of1sets more detailed logs. You can choose either of these two levels and enable either level with the following command:kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true, "verbosity": 1}}'# kubectl -n openshift-security-profiles patch spod spod --type=merge -p '{"spec":{"enableJsonEnricher":true, "verbosity": 1}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all SPOD pods show
Runningbefore proceeding.
7.9.9. Advanced Audit Logs for a specific pod Copia collegamentoCollegamento copiato negli appunti!
To enable single pod log activity, create a SeccompProfile to log specific syscalls such as execve and clone a ProfileBinding to automatically apply this profile to pods in a target namespace. The SeccompProfile applies to the cluster and the ProfileBinding applies to the workloads in that namespace.
With CRI-O versions 1.33 and newer, starting with OpenShift Container Platform 4.20, a feature was introduced to allow SeccompProfiles for privileged containers. You can apply the SecompProfile we created to the CRI-O configuration. The key is to configure the CRI-O runtime to use the profile by passing an additional flag.
To do this, you must add the flag –privileged-seccomp-profile to the CRI-O runtime configuration. This step ensures that even privileged debugging pods are subject to the SeccompProfile logging, maintaining complete audit coverage.
You must bind the profile to a namespace in order to apply it to a workload. This will automatically apply the profile to new pods in the default namespace.
Procedure
Create a file such as
profile1.yamlwith the following content:Copy to Clipboard Copied! Toggle word wrap Toggle overflow This profile allows all normal actions (
defaultAction: SCMP_ACT_ALLOW). It specifically tells the system to log when a process tries to run a new program (execve), create a new process (clone), or get its own process ID (getpid). These actions often indicate user interaction within a pod.Use`kubectl apply` to apply this
SeccompProfileprofile to your cluster as in the following command:kubectl apply -f profile1.yaml
# kubectl apply -f profile1.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow NoteSPO must use the privileged
SeccompProfileCreate a file named
image_sec_comp.yamlcontaining the followingyaml:Copy to Clipboard Copied! Toggle word wrap Toggle overflow Apply the binding using the following command:
kubectl apply -f image_sec_comp.yaml
# kubectl apply -f image_sec_comp.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Label the namespace to activate it using the following command:
kubectl label ns default spo.x-k8s.io/enable-binding=true
# kubectl label ns default spo.x-k8s.io/enable-binding=trueCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create a pod using the profile:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow -
type:
Localhostmeans you are using a profile you have defined in the cluster. -
localhostProfile:
operator/profile1.jsontells the pod to use the profile1 you created. Theoperator/part indicates where the Security Profiles Operator stores these profiles.
-
type:
Apply the pod definition to create the pod by running the following command:
kubectl apply -f my-pod.yaml
# kubectl apply -f my-pod.yamlCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exec/rsh into the pod and run the following command:
kubectl exec -it my-nginx-pod -- /bin/sh
# kubectl exec -it my-nginx-pod -- /bin/shCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create an empty file by running this command:
touch /tmp/audittest/demo-file
# touch /tmp/audittest/demo-fileCopy to Clipboard Copied! Toggle word wrap Toggle overflow To monitor the advanced audit log tail, use the following command:
kubectl -n openshift-security-profiles logs --since=1m --selector name=spod -c json-enricher --max-log-requests 6 -f
# kubectl -n openshift-security-profiles logs --since=1m --selector name=spod -c json-enricher --max-log-requests 6 -fCopy to Clipboard Copied! Toggle word wrap Toggle overflow Alternatively, to monitor or inspect the advanced audit log file, you need to identify the node on which the pod is scheduled:
kubectl get pod my-pod -o wide
# kubectl get pod my-pod -o wideCopy to Clipboard Copied! Toggle word wrap Toggle overflow The audit log file specified in the
auditLogPathis written to the node’s file system where the pod is running. To monitor or inspect the audit logs, you must access the node directly and check the file at the specified path such as/tmp/logs/audit1.log.
SSH to a node by using the following command:
sudo ssh core@<node-name>
$ sudo ssh core@<node-name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow View the audit log by using the following command:
cat /tmp/logs/audit1.log
$ cat /tmp/logs/audit1.logCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow By following above steps, you can enable and monitor audit logs in JSON lines format for your Kubernetes pods, giving you better visibility into their activities.
7.9.10. Monitoring the audit logs Copia collegamentoCollegamento copiato negli appunti!
There are two ways to monitor the advanced audit logs generated by the json-enricher container. By following these steps you can enable and monitor audit logs in JSON lines format for your Kubernetes pods, giving you better visibility into their activities.
Procedure
To monitor the advanced audit log tail use the following command:
kubectl -n openshift-security-profiles logs --since=1m --selector name=spod -c json-enricher --max-log-requests 6 -f
# kubectl -n openshift-security-profiles logs --since=1m --selector name=spod -c json-enricher --max-log-requests 6 -fCopy to Clipboard Copied! Toggle word wrap Toggle overflow -
To monitor the advanced audit log file, it is specified in the
auditLogPathand written to the node’s file system where the pod is running. To monitor or inspect the audit logs, you must access the node directly and check the file at the specified path such as/tmp/logs/audit1.log. Identify the node on which the pod is scheduled using the following command:
kubectl get pod my-pod -o wide
# kubectl get pod my-pod -o wideCopy to Clipboard Copied! Toggle word wrap Toggle overflow SSH to a node with the following command:
sudo ssh core@<node-name>
$ sudo ssh core@<node-name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow View the audit log with the following command:
cat /tmp/logs/audit1.log
$ cat /tmp/logs/audit1.logCopy to Clipboard Copied! Toggle word wrap Toggle overflow The example output should look like this:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9.11. Auditing node debugging sessions Copia collegamentoCollegamento copiato negli appunti!
To audit kubectl debug sessions, you must enable privileged seccomp profiles in CRI-O.
If you are using the CRI-O runtime, you must configure it to allow seccomp profiles on privileged containers by adding the --privileged-seccomp-profile=/var/lib/kubelet/seccomp/operator/profile1.json flag to your CRI-O runtime configuration.
The --privileged-seccomp-profile flag is available starting with OpenShift Container Platform 4.20 or later and CRI-O version 1.33 or later.
Procedure
SSH into the target node using the following command:
ssh core@<node_ip_address>
# ssh core@<node_ip_address>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Check to see if the files are there:
ls /var/lib/kubelet/seccomp/operator/
# ls /var/lib/kubelet/seccomp/operator/Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
kubelet-config.json profile1.json
# kubelet-config.json profile1.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow Stop the
kubeletwith the following commands:systemctl stop kubelet
# systemctl stop kubeletCopy to Clipboard Copied! Toggle word wrap Toggle overflow Stop CRI-O with the command:
systemctl stop crio
# systemctl stop crioCopy to Clipboard Copied! Toggle word wrap Toggle overflow Set the CRI-O options with the following command:
echo "CRIO_CONFIG_OPTIONS --privileged-seccomp-profile=/var/lib/kubelet/seccomp/operator/profile1.json" > /etc/sysconfig/crio
# echo "CRIO_CONFIG_OPTIONS --privileged-seccomp-profile=/var/lib/kubelet/seccomp/operator/profile1.json" > /etc/sysconfig/crioCopy to Clipboard Copied! Toggle word wrap Toggle overflow Now restart the cubelet with this command:
systemctl start kubelet
# systemctl start kubeletCopy to Clipboard Copied! Toggle word wrap Toggle overflow Restart CRI-O with this command:
systemctl start crio
# systemctl start crioCopy to Clipboard Copied! Toggle word wrap Toggle overflow To audit kubectl debug sessions, run the following command:
kubectl debug node/<node_name> -it --image=ubuntu -- bash
# kubectl debug node/<node_name> -it --image=ubuntu -- bashCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create the file on the container for the debugging information.
chrootto the host with this command:chroot /host
# chroot /hostCopy to Clipboard Copied! Toggle word wrap Toggle overflow Go into the
/tmpdirectory with this command:cd /tmp
# cd /tmpCopy to Clipboard Copied! Toggle word wrap Toggle overflow Create an empty file named
demonodedebugwith this command:touch demonodedebug
# touch demonodedebugCopy to Clipboard Copied! Toggle word wrap Toggle overflow Exit the node with the command:
exit
# exitCopy to Clipboard Copied! Toggle word wrap Toggle overflow To monitor the logs, SSH to a node with this command:
sudo ssh core@<node_name>
$ sudo ssh core@<node_name>Copy to Clipboard Copied! Toggle word wrap Toggle overflow View the audit log using this command:
cat /tmp/logs/audit1.log
$ cat /tmp/logs/audit1.logCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output:
Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9.12. Correlate with Kubernetes audit logs Copia collegamentoCollegamento copiato negli appunti!
Use the requestUID from the Security Profiles Operator (SPO) log to find the corresponding API server log entry, confirming who initiated the session.
Procedure
Start the pod by running the following command:
oc exec my-pod -c nginx -- sh -c "touch /tmp/testfile.txt"
$ oc exec my-pod -c nginx -- sh -c "touch /tmp/testfile.txt"Copy to Clipboard Copied! Toggle word wrap Toggle overflow Identify the node where the pod is running:
NODE=$(oc get pod my-pod -o jsonpath='{.spec.nodeName}')$ NODE=$(oc get pod my-pod -o jsonpath='{.spec.nodeName}')Copy to Clipboard Copied! Toggle word wrap Toggle overflow Access the node and check the JSON enriched audit log using the following commands:
oc debug node/$NODE chroot /host # grep "testfile" /tmp/logs/audit1.log | jq .
# oc debug node/$NODE # chroot /host # grep "testfile" /tmp/logs/audit1.log | jq .Copy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9.13. Audit JSON Log Enricher Output Copia collegamentoCollegamento copiato negli appunti!
The Audit JSON Log Enricher captures two entries for this exec session, the SPO-EXEC_REQUEST_UID injection and the command run on the pod. They are connected by looking for the common UID value.
The first listing is the container runtime wrapper.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow The second listing is the actual command executed.
Copy to Clipboard Copied! Toggle word wrap Toggle overflow You can search the Kubernetes API audit log by using the
requestUIDwith the following command:oc adm node-logs --role=master --path=kube-apiserver/audit.log | grep request_UID
$ oc adm node-logs --role=master --path=kube-apiserver/audit.log | grep request_UIDCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9.14. Kubernetes API audit log output Copia collegamentoCollegamento copiato negli appunti!
The output of the Kubernetes API audit log is YAML. It contains the SPO_EXEC_REQUEST_UID field which provides the correlation key with which you can search the Advanced Audit Logging output.
The final field in this example, SPO_EXEC_REQUEST_UID is the correlation key.
7.9.15. Correlation key Copia collegamentoCollegamento copiato negli appunti!
The connection of the two correlation keys enables administrators to establish a complete audit trail. Who executed a command, from Kubernetes API audit log kube:admin at IP xxx.xxx.xxx.xxx and what the command did at the system level, can be found in the SPO JSON Enricher log touch /tmp/testfile.txt.
The requestUID field in Audit JSON Enricher logs matches the annotations.execmetadata.spo.io/SPO_EXEC_REQUEST_UID annotation in the Kubernetes API audit log.
aec3e0e1-xxxx-xxxx-xxxx-a7c58241f1a9
aec3e0e1-xxxx-xxxx-xxxx-a7c58241f1a9
7.9.16. Correlating with API Server Audit Log Copia collegamentoCollegamento copiato negli appunti!
By default, when you use the kubectl exec command to access a pod or container, Kubernetes does not pass the user’s authentication details into that session’s environment. This means the Audit JSON log enricher cannot provide audit information for exec commands. The UID or GID shown, maps to the system user. In most cases this would be the root user.
To address this, the Audit JSON log enricher relies on mutating webhooks (execmetadata.spo.io and nodedebuggingpod.spo.io). The webhook injects the exec requestUID as an environment variable into the exec session. When the administrator enables audit logging on the API server, the webhooks add the SPO_EXEC_REQUEST_UID audit annotation. The API server audit log contains this information. This request ID is also available in the JSON lines produced by the Audit JSON log enricher, specifically within the requestUID field.
By default, these webhooks are enabled for all namespaces with the Audit JSON log enricher enabled. To reduce the scope of this webhook you can disable it for certain namespaces.
Procedure
Edit the spod security profile by running the following command:
oc edit spod spod -n openshift-security-profiles
$ oc edit spod spod -n openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow Add
webhookOptionsto thespec. Locate thespecsection and add the followingwebhookOptionsblock to instruct the webhook to apply to a specific namespace.spec: webhookOptions: - name: execmetadata.spo.io # or nodedebuggingpod.spo.io namespaceSelector: #...add rulesspec: webhookOptions: - name: execmetadata.spo.io # or nodedebuggingpod.spo.io namespaceSelector: #...add rulesCopy to Clipboard Copied! Toggle word wrap Toggle overflow After saving your changes, the Operator reconfigures the mutating webhook, allowing request details to be passed into
oc execsessions cluster-wide.
7.9.17. Using the mutating webhook Copia collegamentoCollegamento copiato negli appunti!
This webhook injects the environment variable SPO_EXEC_REQUEST_UID into your exec request. If a container in your pod already defines an environment variable with this exact name, the webhook injected value will override it for this exec session.
When you use kubectl debug node/<node_name>, the nodedebuggingpod.spo.io webhook automatically injects the SPO_EXEC_REQUEST_UID environment variable into the debug pod.
7.9.17.1. The Debug Pod Copia collegamentoCollegamento copiato negli appunti!
This webhook primarily identifies kubectl debug pods by the label app.kubernetes.io/managed-by: kubectl-debug, which is added by the kubectl client. Because this label might vary across different Kubernetes client implementations, such as how oc debug in OpenShift uses debug.openshift.io/managed-by: oc-debug, you might need to configure additional webhookOptions to ensure the webhook catches all relevant debug pods.
For example, to add oc debug pods, use the following yaml:
7.9.18. Disabling Advanced Audit Logging Copia collegamentoCollegamento copiato negli appunti!
You can disable advanced audit logging and revert all configurations by deleting the test pod, the seccompProfile, the JSON Log Enricher and resetting all spod pod options.
Procedure
Delete the test pod with the following command:
oc delete pod my-pod
oc delete pod my-podCopy to Clipboard Copied! Toggle word wrap Toggle overflow Delete the
seccompProfileusing this command:oc delete seccompprofile profile1 -n openshift-security-profiles
oc delete seccompprofile profile1 -n openshift-security-profilesCopy to Clipboard Copied! Toggle word wrap Toggle overflow Disable the JSON Log Enricher and reset all options:
oc patch spod spod -n openshift-security-profiles --type merge -p '{ "spec": { "enableJsonEnricher": false, "jsonEnricherOptions": { "auditLogPath": "", "auditLogMaxSize": 0, "auditLogMaxBackups": 0, "auditLogMaxAge": 0, "auditLogIntervalSeconds": 0 } }}'oc patch spod spod -n openshift-security-profiles --type merge -p '{ "spec": { "enableJsonEnricher": false, "jsonEnricherOptions": { "auditLogPath": "", "auditLogMaxSize": 0, "auditLogMaxBackups": 0, "auditLogMaxAge": 0, "auditLogIntervalSeconds": 0 } }}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Wait for
spodpods to restart. Run the following command to check:oc get pods -n openshift-security-profiles -l name=spod -w
oc get pods -n openshift-security-profiles -l name=spod -wCopy to Clipboard Copied! Toggle word wrap Toggle overflow Wait until all
spodpods showRunning.Revert the ConfigMap volume patch with the following command:
oc patch configmap security-profiles-operator-profile -n openshift-security-profiles --type merge -p '{"data":{"patch-volume-source.json":""}}'oc patch configmap security-profiles-operator-profile -n openshift-security-profiles --type merge -p '{"data":{"patch-volume-source.json":""}}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Verify that the configuration has been successfully updated:
oc get spod spod -n openshift-security-profiles -o jsonpath='{.spec.enableJsonEnricher}'oc get spod spod -n openshift-security-profiles -o jsonpath='{.spec.enableJsonEnricher}'Copy to Clipboard Copied! Toggle word wrap Toggle overflow Expected output:
false
falseCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.9.19. Additional resources Copia collegamentoCollegamento copiato negli appunti!
7.10. Troubleshooting the Security Profiles Operator Copia collegamentoCollegamento copiato negli appunti!
Troubleshoot the Security Profiles Operator to diagnose a problem or provide information in a bug report.
7.10.1. Inspecting seccomp profiles Copia collegamentoCollegamento copiato negli appunti!
Corrupted seccomp profiles can disrupt your workloads. Ensure that the user cannot abuse the system by not allowing other workloads to map any part of the path /var/lib/kubelet/seccomp/operator.
Procedure
Confirm that the profile is reconciled by running the following command:
oc -n openshift-security-profiles logs openshift-security-profiles-<id>
$ oc -n openshift-security-profiles logs openshift-security-profiles-<id>Copy to Clipboard Copied! Toggle word wrap Toggle overflow Example 7.2. Example output
Copy to Clipboard Copied! Toggle word wrap Toggle overflow Confirm that the
seccompprofiles are saved into the correct path by running the following command:oc exec -t -n openshift-security-profiles openshift-security-profiles-<id> \ -- ls /var/lib/kubelet/seccomp/operator/my-namespace/my-workload$ oc exec -t -n openshift-security-profiles openshift-security-profiles-<id> \ -- ls /var/lib/kubelet/seccomp/operator/my-namespace/my-workloadCopy to Clipboard Copied! Toggle word wrap Toggle overflow Example output
profile-block.json profile-complain.json
profile-block.json profile-complain.jsonCopy to Clipboard Copied! Toggle word wrap Toggle overflow
7.11. Uninstalling the Security Profiles Operator Copia collegamentoCollegamento copiato negli appunti!
You can remove the Security Profiles Operator from your cluster by using the OpenShift Container Platform web console.
7.11.1. Uninstall the Security Profiles Operator using the web console Copia collegamentoCollegamento copiato negli appunti!
To remove the Security Profiles Operator, you must first delete the seccomp and SELinux profiles. After the profiles are removed, you can then remove the Operator and its namespace by deleting the openshift-security-profiles project.
Prerequisites
-
You have access to the web console as a user with
cluster-adminprivileges. - The Security Profiles Operator is installed.
Procedure
To remove the Security Profiles Operator by using the OpenShift Container Platform web console:
-
Navigate to the Ecosystem
Installed Operators page. -
Delete all
seccompprofiles, SELinux profiles, and webhook configurations. -
Switch to the Administration
Ecosystem Installed Operators page. -
Click the Options menu
on the Security Profiles Operator entry and select Uninstall Operator.
-
Switch to the Home
Projects page. -
Search for
security profiles. Click the Options menu
next to the openshift-security-profiles project, and select Delete Project.
-
Confirm the deletion by typing
openshift-security-profilesin the dialog box, and click Delete.
-
Confirm the deletion by typing
Delete the
MutatingWebhookConfigurationobject by running the following command:oc delete MutatingWebhookConfiguration spo-mutating-webhook-configuration
$ oc delete MutatingWebhookConfiguration spo-mutating-webhook-configurationCopy to Clipboard Copied! Toggle word wrap Toggle overflow