Custom compliance checks
Custom image checks give you a way to write and run your own compliance checks to assess, measure, and enforce security baselines in your environment.
Prisma Cloud lets you implement your own custom image checks with simple scripts. Custom compliance checks are supported for Linux containers (docker or CRI-O), Windows containers (docker), and Linux Hosts. Custom compliance checks are not supported for Tanzu Application Service (TAS) defender.
A custom image check consists of a single script. The script’s exit code determines the result of the check, where "0" stands for pass and "1" stands for fail.
Scripts are executed in the default shell. The most common default shell for Linux is bash, but that’s not always the case. For Windows container images, the default shell is cmd.exe.
If you want to use a specific shell, or if your default shell is in a non-standard location, use the shebang interpreter directive at the top of your compliance check to specify the path to the executable.
For example, #!/bin/bash specifies that the Linux Bourne-again (bash) shell should parse and interpret the compliance check.
For containers, Defender runs the compliance checks inside a restricted sandboxed container instantiated from the image being scanned, thus avoiding the unnecessary risk associated with running arbitrary code.
For hosts, Defender runs the compliance checks on the host itself with unrestricted privileges to allow execution of any script. To limit exposure, this feature is disabled by default.
Every compliance check in the system has a unique ID. Custom checks are automatically assigned an ID, starting with the number 9000. As new custom checks are added, they are automatically assigned the next available ID (9001, 9002, and so on).
Prisma Cloud drops the cached compliance and vulnerability scan results for registries, and rescans registry images, whenever:
- A new rule referencing a custom compliance check is added, or
- An existing compliance check referenced by some existing rule is updated, or
- An existing rule is updated with a new custom compliance check.
In a scaled-out environment with large registries, repeated changes to custom compliance checks could adversely impact on the performance of Prisma Cloud.
Create a new Custom Check
Create a new compliance rule that includes your custom check, and specify the action to take when the check fails (ignore, alert, block).
- Enable custom compliance checks for hosts (By default, this is disabled).
- Go toManage > Defenders > Advanced Settings.
- SetCustom Compliance Checks for hoststo enabled.
You must redeploy the Defenders everytime you enable
Custom Compliance Checks for hosts. If you enable the feature, and then later disable it, the disabled state is effective immediately. You don’t have to redeploy Defenders when you switch to the disabled state.
- Go toDefend > Compliance > Custom.
- SelectAdd check.
- Enter aNameand aDescription.
- Specify theSeverityof the compliance issue.
- Enter a script.
- Update the compliance policy to run your check.
- Go toDefend > Compliance > Containers and Imagesfor containers orDefend > Compliance > Hostsfor hosts.
- SelectAdd rule.
- Enter aRule name,Notes, and select theScopefor the resources.
- UnderCompliance actions, narrow the compliance checks displayed.For containers, on theAll typesdrop-down list, selectCustom > Image.For hosts, on theAll typesdrop-down list, selectCustom > Custom.You should see a list of custom checks you’ve implemented, starting with ID 9000.
- Select an action for your custom check (Ignore,Alert, orBlock).
- Validate your setup by reviewing the compliance reports underMonitor > Compliance.
The following example scripts show how to run some basic checks, such as checking file permissions. Use them as starting point for your scripts. Any special utilities or programs required by your script must be installed in the image being evaluated.
File permissions (Linux)
The following script checks the permissions for the /bin/busybox file. Assuming busybox is installed in your image, this check should pass.
if [ $(stat -c %a /bin/busybox) -eq 755 ]; then echo 'test permission failure' && exit 1; fi
File exists (Linux)
The following script checks if /tmp/foo.txt exists in the container file system. If it doesn’t exist, the check fails.
if [ ! -f /tmp/foo.txt ]; then echo "File not found!" exit 1 fi
User exists (Linux)
The following script checks if the user John exists. If the user exists, the check passes. Otherwise, it fails.
if grep -Fxq "John" /etc/passwd then echo yes else echo "user not found!" exit 1 fi
File exists (Windows)
The following script checks if C:\Users exists. If it does, the check passes.