README.md

Kubescape Exceptions

Kubescape Exceptions is the proper way of excluding failed resources from effecting the risk score.

e.g. When a kube-system resource fails and it is ok, simply add the resource to the exceptions configurations.

Definitions

• name- Exception name - unique name representing the exception
• policyType- Do not change
• actions- List of available actions. Currently alertOnly is supported
• resources- List of resources to apply this exception on
  • designatorType: Attributes- An attribute-based declaration {key: value} Supported keys:
  • name: k8s resource name (case-sensitive, regex supported)
  • kind: k8s resource kind (case-sensitive, regex supported)
  • namespace: k8s resource namespace (case-sensitive, regex supported)
  • cluster: k8s cluster name (usually it is the current-context) (case-sensitive, regex supported)
  • resource labels as key value (case-sensitive, regex NOT supported)
• posturePolicies- An attribute-based declaration {key: value}
  • frameworkName - Framework names can be find here
  • controlName - Control names can be find here
  • controlID - Not yet supported
  • ruleName - Rule names can be find here

Usage

The resources list and posturePolicies list are design to be a combination of the resources and policies to exclude

You must declare at least one resource and one policy

e.g. If you wish to exclude all namespaces with the label "environment": "dev", the resource list should look as following:

"resources": [
    {
        "designatorType": "Attributes",
        "attributes": {
            "namespace": ".*",
            "environment": "dev"
        }
    }
]

But if you wish to exclude all namespaces OR any resource with the label "environment": "dev", the resource list should look as following:

"resources": [
    {
        "designatorType": "Attributes",
        "attributes": {
            "namespace": ".*"
        }
    },
    {
        "designatorType": "Attributes",
        "attributes": {
            "environment": "dev"
        }
    }
]

Same works with the posturePolicies list ->

e.g. If you wish to exclude the resources declared in the resources list that failed when scanning the NSA framework AND failed the Allowed hostPath control, the posturePolicies list should look as following:

"posturePolicies": [
    {
        "frameworkName": "NSA",
        "controlName": "Allowed hostPath" 
    }
]

But if you wish to exclude the resources declared in the resources list that failed when scanning the NSA framework OR failed the Allowed hostPath control, the posturePolicies list should look as following:

"posturePolicies": [
    {
        "frameworkName": "NSA" 
    },
    {
        "controlName": "Allowed hostPath" 
    }
]

Examples

Here are some examples demonstrating the different ways the exceptions file can be configured

Exclude control

Exclude the "Allowed hostPath" control by declaring the control in the "posturePolicies" section.

The resources

[
    {
        "name": "exclude-allowed-hostPath-control",
        "policyType": "postureExceptionPolicy",
        "actions": [
            "alertOnly"
        ],
        "resources": [
            {
                "designatorType": "Attributes",
                "attributes": {
                    "kind": ".*"
                }
            }
        ],
        "posturePolicies": [
            {
                "controlName": "Allowed hostPath" 
            }
        ]
    }
]

Exclude deployments in the default namespace that failed the "Allowed hostPath" control

[
    {
        "name": "exclude-deployments-in-ns-default",
        "policyType": "postureExceptionPolicy",
        "actions": [
            "alertOnly"
        ],
        "resources": [
            {
                "designatorType": "Attributes",
                "attributes": {
                    "namespace": "default",
                    "kind": "Deployment"
                }
            }
        ],
        "posturePolicies": [
            {
                "controlName": "Allowed hostPath" 
            }
        ]
    }
]

Exclude resources with label "app=nginx" running in a minikube cluster that failed the "NSA" or "MITRE" framework

[
    {
        "name": "exclude-nginx-minikube",
        "policyType": "postureExceptionPolicy",
        "actions": [
            "alertOnly"
        ],
        "resources": [
            {
                "designatorType": "Attributes",
                "attributes": {
                    "cluster": "minikube",
                    "app": "nginx"
                }
            }
        ],
        "posturePolicies": [
            {
                "frameworkName": "NSA" 
            },
            {
                "frameworkName": "MITRE" 
            }
        ]
    }
]