Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cyberark/kubiscan
A tool to scan Kubernetes cluster for risky permissions
https://github.com/cyberark/kubiscan
authorization conjbot kubernetes rbac
Last synced: 3 days ago
JSON representation
A tool to scan Kubernetes cluster for risky permissions
- Host: GitHub
- URL: https://github.com/cyberark/kubiscan
- Owner: cyberark
- License: gpl-3.0
- Created: 2018-10-29T13:50:44.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-10T09:24:49.000Z (12 days ago)
- Last Synced: 2024-12-19T13:05:45.937Z (3 days ago)
- Topics: authorization, conjbot, kubernetes, rbac
- Language: Python
- Homepage:
- Size: 7.55 MB
- Stars: 1,329
- Watchers: 29
- Forks: 131
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
[![GitHub release][release-img]][release]
[![License][license-img]][license]
A tool for scanning Kubernetes cluster for risky permissions in Kubernetes's Role-based access control (RBAC) authorization model.
The tool was published as part of the "Securing Kubernetes Clusters by Eliminating Risky Permissions" research https://www.cyberark.com/threat-research-blog/securing-kubernetes-clusters-by-eliminating-risky-permissions/.
---
## Table of Contents
- [Overview](#overview)
- [What can it do?](#what-can-it-do)
- [Usage](#usage)
- [Container](#container)
- [Directly with Python3](#directly-with-python3)
- [Prerequisites](#prerequisites)
- [Example for installation on Ubuntu](#example-for-installation-on-ubuntu)
- [With KubeConfig file](#with-kubeconfig-file)
- [From a remote with ServiceAccount token](#from-a-remote-with-serviceaccount-token)
- [Examples](#examples)
- [Demo](#demo)
- [Risky Roles YAML](#risky-roles-yaml)
- [Showcase](#%EF%B8%8F-showcase)
- [License](#license)
- [References](#references)
---
## Overview
KubiScan helps cluster administrators identify permissions that attackers could potentially exploit to compromise the clusters.
This can be especially helpful on large environments where there are lots of permissions that can be challenging to track.
KubiScan gathers information about risky roles\clusterroles, rolebindings\clusterrolebindings, users and pods, automating traditional manual processes and giving administrators the visibility they need to reduce risk.
## What can it do?
- Identify risky Roles\ClusterRoles
- Identify risky RoleBindings\ClusterRoleBindings
- Identify risky Subjects (Users, Groups and ServiceAccounts)
- Identify risky Pods\Containers
- Dump tokens from pods (all or by namespace)
- Get associated RoleBindings\ClusterRoleBindings to Role, ClusterRole or Subject (user, group or service account)
- List Subjects with specific kind ('User', 'Group' or 'ServiceAccount')
- List rules of RoleBinding or ClusterRoleBinding
- Show Pods that have access to secret data through a volume or environment variables
- Get bootstrap tokens for the cluster
- CVE scan
- EKS\AKS\GKE support
## Usage
### Container
You can run it like that:
```
./docker_run.sh
# For example: ./docker_run.sh ~/.kube/config
```
It will copy all the files linked inside the config file into the container and spwan a shell into the container.
To build the Docker image run:
```
docker build -t kubiscan .
```
### Directly with Python3
#### Prerequisites:
- __Python 3.6+__
- __Pip3__
- [__Kubernetes Python Client__](https://github.com/kubernetes-client/python)
- [__Prettytable__](https://pypi.org/project/PTable)
- __openssl__ (built-in in ubuntu) - used only for join token
#### Example for installation on Ubuntu:
```
apt-get update
apt-get install -y python3 python3-pip
pip3 install -r requirements.txt
```
Run `alias kubiscan='python3 //KubiScan.py'` to use `kubiscan`.
After installing all of the above requirements you can run it in two different ways:
#### With KubeConfig file:
Make sure you have access to `~/.kube/config` file and all the relevant certificates, simply run:
`kubiscan `
For example: `kubiscan -rs` will show all the risky subjects (users, service accounts and groups).
#### From a remote with ServiceAccount token
Some functionality requires a **privileged** service account with the following permissions:
- **resources**: `["roles", "clusterroles", "rolebindings", "clusterrolebindings", "pods", "secrets"]`
**verbs**: `["get", "list"]`
- **resources**: `["pods/exec"]`
**verbs**: `["create", "get"]`
But most of the functionalities are not, so you can use this settings for limited service account:
It can be created by running:
```
kubectl apply -f - << EOF
apiVersion: v1
kind: ServiceAccount
metadata:
name: kubiscan-sa
namespace: default
---
apiVersion: v1
kind: Secret
type: kubernetes.io/service-account-token
metadata:
name: kubiscan-sa-secret
annotations:
kubernetes.io/service-account.name: kubiscan-sa
---
kind: ClusterRoleBinding
apiVersion: rbac.authorization.k8s.io/v1
metadata:
name: kubiscan-clusterrolebinding
subjects:
- kind: ServiceAccount
name: kubiscan-sa
namespace: default
apiGroup: ""
roleRef:
kind: ClusterRole
name: kubiscan-clusterrole
apiGroup: ""
---
kind: ClusterRole
apiVersion: rbac.authorization.k8s.io/v1
metadata:
name: kubiscan-clusterrole
rules:
- apiGroups: ["*"]
resources: ["roles", "clusterroles", "rolebindings", "clusterrolebindings", "pods"]
verbs: ["get", "list"]
EOF
```
Note that from Kubernetes 1.24, the creation of service account doesn't create a secret. This means that we need to create the secret.
Before 1.24, you can remove the `Secret` object from the above commands and save the service account's token to a file:
`kubectl get secrets $(kubectl get sa kubiscan-sa -o=jsonpath='{.secrets[0].name}') -o=jsonpath='{.data.token}' | base64 -d > token`
From 1.24, you don't need to change anything and save the token like that:
```
kubectl get secrets kubiscan-sa-secret -o=jsonpath='{.data.token}' | base64 -d > token
```
After saving the token into the file, you can use it like that:
`python3 ./KubiScan.py -ho -t /token `
For example:
```
alias kubiscan='python3 //KubiScan.py
kubiscan -ho 192.168.21.129:8443 -t /token -rs
```
Notice that you can also use the certificate authority (ca.crt) to verify the SSL connection:
```
kubiscan -ho -t /token -c /ca.crt
```
To remove the privileged service account, run the following commands:
```
kubectl delete clusterroles kubiscan-clusterrole
kubectl delete clusterrolebindings kubiscan-clusterrolebinding
kubectl delete sa kubiscan-sa
kubectl delete secrets kubiscan-sa-secret
```
## Examples
To see all the examples, run `python3 KubiScan.py -e` or from within the container `kubiscan -e`.
## Demo
A small example of KubiScan usage:
## Risky Roles YAML
There is a file named `risky_roles.yaml`. This file contains templates for risky roles with priority.
Although the kind in each role is `Role`, these templates will be compared against any Role\ClusterRole in the cluster.
When each of these roles is checked against a role in the cluster, it checks if the role in the cluster contains the rules from the risky role. If it does, it will be marked as risky.
We added all the roles we found to be risky, but because each one can define the term "risky" in a different way, you can modify the file by adding\removing roles you think are more\less risky.
## ❤️ Showcase
* Presented at RSA 2020 ["Compromising Kubernetes Cluster by Exploiting RBAC Permissions"](https://www.youtube.com/watch?v=1LMo0CftVC4)
* Presented at RSA 2022 ["Attacking and Defending Kubernetes Cluster: Kubesploit vs KubiScan"](https://www.youtube.com/watch?v=xRqYSDKi6a0)
* Article by PortSwigger ["KubiScan: Open source Kubernetes security tool showcased at Black Hat 2020"](https://portswigger.net/daily-swig/kubiscan-open-source-kubernetes-security-tool-showcased-at-black-hat-2020)
## License
Copyright (c) 2020 CyberArk Software Ltd. All rights reserved
This repository is licensed under GPL-3.0 License - see [`LICENSE`](LICENSE) for more details.
## References:
For more comments, suggestions or questions, you can contact Eviatar Gerzi ([@g3rzi](https://twitter.com/g3rzi)) and CyberArk Labs.
[release-img]: https://img.shields.io/github/release/cyberark/kubiscan.svg
[release]: https://github.com/cyberark/kubiscan/releases
[license-img]: https://img.shields.io/github/license/cyberark/kubiscan.svg
[license]: https://github.com/cyberark/kubiscan/blob/master/LICENSE