Skip to content
This repository was archived by the owner on Apr 10, 2025. It is now read-only.

Commit 1ec5d02

Browse files
authored
Update README.md
1 parent b384542 commit 1ec5d02

File tree

1 file changed

+8
-4
lines changed

1 file changed

+8
-4
lines changed

README.md

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ Retrieve the RBAC permissions of Kubernetes identities - service accounts, pods,
33

44
![example](docs/example.png)
55

6-
The [policy library](./lib) includes ~20 policies that identify identities possessing risky permissions, each detecting a different attack path. See the Recommendations section [here](https://www.paloaltonetworks.com/resources/whitepapers/kubernetes-privilege-escalation-excessive-permissions-in-popular-platforms) for advice on addressing powerful permissions in Kubernetes clusters.
6+
The [policy library](./lib) includes over 20 policies that detect identities possessing risky permissions, each alerting on a different attack path.
77

88
## Quick Start
99

@@ -31,18 +31,22 @@ The [policy library](./lib) includes ~20 policies that identify identities posse
3131
```
3232
./rbac-police eval lib/
3333
```
34+
5. Inspect the permissions of violating principals and identify the Roles and ClusterRoles granting them risky privileges. See the Recommendations section [here](https://www.paloaltonetworks.com/resources/whitepapers/kubernetes-privilege-escalation-excessive-permissions-in-popular-platforms) for remediation advice.
35+
```
36+
./rbac-police expand -z sa=production-ns:violating-sa
37+
```
3438

3539
## Usage
3640
### Set severity threshold
3741
Only evaluate policies with a severity equal to or higher than a threshold.
3842
```
3943
./rbac-police eval lib/ -s High
4044
```
41-
### Inspect the permissions of a specific identity
45+
### Inspect the permissions of specific identities
4246
```
4347
./rbac-police expand -z sa=kube-system:metrics-server
4448
./rbac-police expand -z user=example@email.com
45-
./rbac-police expand # all identities
49+
./rbac-police expand # all identities
4650
```
4751
### Discover protections
4852
Improve accuracy by considering features gates and admission controllers that can protect against certain attacks. Note that [NodeRestriction](https://kubernetes.io/docs/reference/access-authn-authz/admission-controllers/#noderestriction) is identified by impersonating a node and *dry-run creating a pod*, which may be logged by some systems.
@@ -53,7 +57,7 @@ Improve accuracy by considering features gates and admission controllers that ca
5357
Control which identities are evaluated for violations, default are `sa,node,combined` (see [policies.md](docs/policies.md) for more information).
5458
```
5559
./rbac-police eval lib/ --violations sa,user
56-
./rbac-police eval lib/ --violations all # sa,node,combined,user,group
60+
./rbac-police eval lib/ --violations all # sa,node,combined,user,group
5761
```
5862
Note that by default, `rbac-police` only looks into service accounts assigned to a pod. Use `-a` to include all service accounts.
5963
### Scope to a namespace

0 commit comments

Comments
 (0)