README
¶
KubeSnake
KubeSnake is an offensive Kubernetes attack-path engine that models how an attacker propagates through a cluster.
KubeSnake is built on top of libpwn, a library of reusable attack testing primitives.
Local Development
Setup
One time installations.
- Install Docker
- Install
kubectl - Install
task - Install
k3dwithtask k3d:install
Development Lifecycle
- Start the cluster with
task up - Iterate
- Destroy the cluster with
task down
End-to-end smoke tests
The project includes a small e2e-framework based smoke suite that provisions a k3d cluster, applies test manifests, and validates container state.
- Run the suite with
task e2e. - Ensure
k3dandkubectlare installed and available on yourPATH. - Optionally pre-load container images into the cluster by setting
KUBESNAKE_E2E_IMAGESto a comma-separated list of image names (for example,KUBESNAKE_E2E_IMAGES=kubesnake:dev).
Directories
¶
| Path | Synopsis |
|---|---|
|
cmd
|
|
|
kubesnake
command
Package embed is the embed command for the kubesnake CLI.
|
Package embed is the embed command for the kubesnake CLI. |
|
internal
|
|
|
app
Package app contains the top level application logic for kubesnake.
|
Package app contains the top level application logic for kubesnake. |
|
certs
Package certs provides embedded CA certificates for TLS connections.
|
Package certs provides embedded CA certificates for TLS connections. |
|
config
Package config provides configuration schema, loading, and embedding for kubesnake.
|
Package config provides configuration schema, loading, and embedding for kubesnake. |
|
http
Package http provides HTTP client utilities with embedded TLS certificates.
|
Package http provides HTTP client utilities with embedded TLS certificates. |
|
test
|
|
|
common
Package common provides shared utilities for e2e test scenarios.
|
Package common provides shared utilities for e2e test scenarios. |
Click to show internal directories.
Click to hide internal directories.