Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
oren-zohar authored Nov 10, 2021
1 parent 31e5a71 commit 2650c5e
Showing 1 changed file with 13 additions and 20 deletions.
33 changes: 13 additions & 20 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,13 @@
β”‚ β”œβ”€β”€ lib
β”‚ β”‚ β”œβ”€β”€ common.rego # Common functions
β”‚ β”‚ β”œβ”€β”€ data_adapter.rego # Input data adapter
β”‚ β”‚ └── ...
β”‚ β”‚ └── test.rego # Common Test functions
β”‚ β”œβ”€β”€ rules/cis
β”‚ β”‚ β”œβ”€β”€ cis_1_1_1 # rule package
β”‚ β”‚ β”‚ β”œβ”€β”€ rule.rego
β”‚ β”‚ β”‚ └── test.rego
β”‚ β”‚ └── ...
β”‚ └── cis.rego # Handles all CIS rules evalutations
β”‚ └── cis_k8s.rego # Handles all Kubernetes CIS rules evalutations
└── main.rego # Evaluate all policies and returns the findings

## Local Evaluation
Expand All @@ -20,8 +20,9 @@ should contain the list of rules you want to evaluate (also supports json)

```yaml
activated_rules:
cis_1_1_1: true
cis_1_1_2: true
cis_k8s:
cis_1_1_1: true
cis_1_1_2: true
```
##### `input.json`
Expand Down Expand Up @@ -52,12 +53,9 @@ should contain an beat/agent output, e.g. OSQuery
[
{
"evaluation": "violation",
"fields": [
{
"key": "filemode",
"value": "0700"
}
],
"evidence": {
"filemode": "0700"
},
"rule_name": "Ensure that the API server pod specification file permissions are set to 644 or more restrictive",
"tags": [
"CIS",
Expand All @@ -68,16 +66,10 @@ should contain an beat/agent output, e.g. OSQuery
},
{
"evaluation": "violation",
"fields": [
{
"key": "uid",
"value": "etc"
},
{
"key": "gid",
"value": "root"
}
],
"evidence": {
"gid": "root",
"uid": "etc"
},
"rule_name": "Ensure that the API server pod specification file ownership is set to root:root",
"tags": [
"CIS",
Expand All @@ -88,6 +80,7 @@ should contain an beat/agent output, e.g. OSQuery
}
]
```

</details>
Expand Down

0 comments on commit 2650c5e

Please sign in to comment.