From b55fe1b0948608a0fcdc9acdad94a3f88fbf189f Mon Sep 17 00:00:00 2001 From: James Cleverley-Prance Date: Sun, 2 Apr 2023 23:08:28 +0100 Subject: [PATCH] doc: add README --- README.md | 22 ++++++++++++++++++++++ 1 file changed, 22 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..79f23dc --- /dev/null +++ b/README.md @@ -0,0 +1,22 @@ +# CoreDNS Enum + +A tool to enumerate Kubernetes network information through CoreDNS alone. It attempts to list service IPs and ports, and service endpoint IPs where possible. + +The tool has two modes: wildcard & bruteforce. It will automagically detect if the version of CoreDNS you are targetting supports wildcards (< v1.9.0) and fallback to the bruteforce method if not. The bruteforce mode also tries to guess the sensible CIDR ranges to scan by default (through parsing the API server HTTPS certicate). You can override this. + + +``` +Usage: + coredns-enum [flags] + +Flags: + --cidr string Range to scan in bruteforce mode + -h, --help help for coredns-enum + -v, --loglevel int Set loglevel (-1 => 5) (default 1) + -t, --max-workers int Number of 'workers' to use for concurrency (default 50) + -m, --mode string Select mode: wildcard|bruteforce|auto (default "auto") + -n, --nsip string Nameserver to use (detected by default) + --nsport int Nameserver port to use (detected by default) (default 53) + --timeout float32 DNS query timeout (seconds) (default 0.5) + --zone string DNS zone (default "cluster.local") +```