Skip to main content
Version: main

The Custom Rules

vArmor allows users to customize access control rules in the EnhanceProtect and DefenseInDepth modes based on the enforcer syntax. AppArmor, BPF, and NetworkProxy control the disposition action and auditing behavior of a rule via its qualifiers, while Seccomp uses the OCI action semantics (such as SCMP_ACT_ERRNO).

Different enforcers recognize different sets of rule qualifiers, and the actions that can be derived from them are shown in the table below:

EnforcerRecognized QualifiersDerivable Actions
AppArmorRules are raw AppArmor text; qualifiers such as audit / deny are written directly by the author and are not re-parsed by vArmorDENIED / AUDIT
BPFRecognizes only deny and auditDENIED / AUDIT
NetworkProxyRecognizes allow, deny, and audit, combined with defaultActionDENIED / AUDIT

The "Derivable Actions" column refers to actions derived from rule qualifiers, so none of them include ALLOWED. ALLOWED is unrelated to any qualifier; it is produced only in the DefenseInDepth mode with allowViolations=true, when access not covered by the allowlist is allowed and logged. See Disposition Actions and Auditing of the policy modes for details.

AppArmor enforcer​

The AppArmor enforcer supports users in customizing policies based on the syntax of AppArmor.

Please refer to the syntax of security profiles for AppArmor to set custom rules in the .spec.policy.enhanceProtect.appArmorRawRules or .spec.policy.defenseInDepth.appArmor.appArmorRawRules field. Please ensure that each rule ends with a comma.

Use case:

policy:
enforcer: AppArmor
mode: EnhanceProtect
enhanceProtect:
# Audit the actions that violate the mandatory access control rules.
# Any detected violation will be logged to /var/log/varmor/violations.log file in the host.
# It's disabled by default.
auditViolations: true
attackProtectionRules:
- rules:
- disable-chmod
- rules:
- mitigate-sa-leak
targets:
- "/bin/bash"
- "/bin/dash"
- "/bin/sh"
appArmorRawRules:
- rules: |
audit deny /etc/hosts r,
audit deny /etc/shadow r,
- rules: "audit deny /etc/hostname r,"
targets:
- "/bin/bash"

Seccomp enforcer​

The Seccomp enforcer supports users in customizing policies based on the syntax of OCI specification.

Please refer to this document to set custom syscalls blocklist rules in the .spec.policy.enhanceProtect.syscallRawRules or .spec.policy.defenseInDepth.seccomp.syscallRawRules field.

Use case:

policy:
enforcer: Seccomp
mode: EnhanceProtect
enhanceProtect:
syscallRawRules:
# disallow chmod +x XXX, chmod 111 XXX, chmod 001 XXX, chmod 010 XXX...
- names:
- fchmodat
action: SCMP_ACT_ERRNO
args:
- index: 2
value: 0x40 # S_IXUSR
valueTwo: 0x40
op: SCMP_CMP_MASKED_EQ
- index: 2
value: 0x8 # S_IXGRP
valueTwo: 0x8
op: SCMP_CMP_MASKED_EQ
- index: 2
value: 1 # S_IXOTH
valueTwo: 1
op: SCMP_CMP_MASKED_EQ

BPF enforcer​

The BPF enforcer supports custom rules for file access, program execution, networking and mounts.

Rule counts and node capacity​

The following limits apply separately to each generated BPF configuration:

Rule typeLimit
File access64 rules
Program execution64 rules
Network (socket and egress rules combined)64 rules
Mounts: node supports bpf_loop64 rules
Mounts: node does not support bpf_loop50 rules

The Agent detects bpf_loop support automatically and selects the corresponding mount-rule limit. When deploying a policy across nodes with different limits, use the lower applicable limit.

Limits count generated entries, not rule items in the policy YAML. Entries generated by built-in and custom rules share the corresponding limit; one configuration item can produce multiple rules. Changes to targets matched by toServices or toPods can also increase the network-rule count. Capabilities and ptrace settings are not subject to these list-entry limits.

Each node supports BPF protection for up to 256 containers at the same time. This capacity is shared by all BPF policies on the node, rather than allocated separately to each policy or namespace. It is not a limit on the total number of containers the node can run.

Custom rule syntax​

Please refer to BpfRawRules and the syntaxes below to set custom rules in .spec.policy.enhanceProtect.bpfRawRules.

  • File Permission

    Permission / Permission AbbreviateImplied PermissionsDescription
    read / r-
    rename
    hard link
    Restrict read permission.
    Prohibit abusing 'rename oldpath newpath' to bypass read restrictions on oldpath.
    Prohibit abusing 'ln TARGET LINK_NAME' to bypass read restrictions on TARGET.
    write / w-
    append
    rename
    hard link
    symbol link
    chmod
    chown
    Restrict write permission.
    Prohibit using the O_APPEND flag to bypass map_file_to_perms() for append operations.
    Prohibit abusing 'rename oldpath newpath' to bypass write restrictions on newpath.
    Prohibit abusing 'ln TARGET LINK_NAME' to bypass write restrictions on LINK_NAME.
    Prohibit abusing symlink to bypass write restrictions on the target file.
    WIP
    WIP
    exec / x-Prohibit execution permission.
    append / a-Prohibit append permission.
  • File Globbing Syntax

    GlobbingDescriptionExamplesNotes
    *- Used only to match file names.
    - It will match dot files except the special dot files . and ..
    - Supports only a single *, and does not support ** and * appearing together.
    - fi* matches any file name starting with 'fi'.
    - *le matches any file name ending with 'le'.
    - *.log matches any file name ending with '.log'
    The behavior of this globbing may change in future versions.
    **- Match zero, one, or multiple characters in multi-level directories.
    - It will match dot files except the special dot files . and ..
    - Supports only a single **, and does not support ** and * appearing together.
    - /tmp/**/33 matches any file that starts with /tmp and ends with /33, including /tmp/33.
    - /tmp/** matches any file or directory that starts with /tmp.
    - /tm** matches any file or directory that starts with /tm.
    - /t**/33 matches any file or directory that starts with /t and ends with /33.
  • Network Permission

    • Currently, vArmor supports connection access control for specified IP addresses, IP address blocks (CIDR blocks), and ports.
    • When specific IP addresses or IP address blocks are specified without specifying ports, it defaults to affecting all ports.
    • Please refer to NetworkEgressRule for specific details.

Use case:

policy:
enforcer: BPF
mode: EnhanceProtect
enhanceProtect:
# Audit the actions that violate the mandatory access control rules.
# Any detected violation will be logged to /var/log/varmor/violations.log file in the host.
# It's disabled by default.
auditViolations: true
bpfRawRules:
processes:
- pattern: "**ping"
permissions:
- exec
qualifiers:
- audit
- deny
network:
egresses:
toDestinations:
- ip: fdbd:dc01:ff:307:9329:268d:3a27:2ca7
qualifiers:
- audit
- cidr: 192.168.1.1/24 # 192.168.1.0 to 192.168.1.255
ports:
- port: 80
endPort: 8080
qualifiers:
- audit
sockets:
- protocols:
- "udp"
qualifiers:
- audit

NetworkProxy enforcer​

Use the NetworkProxy guide for a complete workflow and NetworkProxyRules for field definitions. Configure enhanceProtect.networkProxyRawRules or defenseInDepth.networkProxy according to the selected mode.

  • L4 rules match destination IP/CIDR and port.
  • For plaintext HTTP and MITM, HTTP rules match Host/authority, path, method and destination port.
  • For TLS passthrough, HTTP rules with hosts match SNI and port; path and method restrictions are ignored. A hostless HTTP rule contributes no SNI permission.
  • Deny takes precedence. Under default deny, a matching L4 allow can authorize traffic independently of a narrower HTTP allow. audit alone does not authorize traffic.

This policy fragment allows only the specified plaintext HTTP request, with audit:

policy:
enforcer: NetworkProxy
mode: EnhanceProtect
enhanceProtect:
networkProxyRawRules:
egress:
defaultAction: deny
httpRules:
- qualifiers: [allow, audit]
match:
hosts: [backend.example.com]
ports: [{port: 80}]
paths: [{prefix: /public/}]
methods: [GET]

For HTTPS path/method enforcement, configure MITM and application trust. Use the Quick Start for complete, runnable resources.

Logging depends on both the actual decision and matching audit rules. Default allow with a silent deny generates no event; default deny with an allowed rule without audit also generates none. See the full audit matrix. NetworkProxy uses DENIED and AUDIT, not ALLOWED.