From 4e158149c5a358a3d4493e44c0177c9270879fef Mon Sep 17 00:00:00 2001 From: edoardottt Date: Mon, 24 May 2021 19:57:51 +0200 Subject: [PATCH] update --- README.md | 161 +++++++++++++++++++++++++++++++++++++++++++++++-- input/flags.go | 2 +- 2 files changed, 157 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 61f8764..eef2b46 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,164 @@ -# cariddi +

+
+ Take a list of domains and scan for endpoints, secrets, api keys, tokens and more...
+
+ + + go-report-card + + + + workflows + + + + ubuntu-build + + + + win10-build + + + + pr-welcome + -https://github.com/gocolly/colly/tree/master/_examples +
+ + + + Mainteinance yes + + + + ask me anything + + + + gobadge + + + + license-GPL3 + +
+ + Coded with 💙 by edoardottt. + +
+ + Share on Twitter! + +

+

+ Preview • + Install • + Get Started • + Examples • + Contributing +

-https://yourbasic.org/golang/multiline-string/ +Preview :bar_chart: +---------- -https://github.com/zricethezav/gitleaks/blob/master/config/default.go + -see also for secrets: https://github.com/tomnomnom/gf/tree/master/examples +Installation 📡 +---------- +You need [Go](https://golang.org/). + +- **Linux** + + - `git clone https://github.com/edoardottt/cariddi.git` + - `cd cariddi` + - `go get` + - `make linux` (to install) + - `make unlinux` (to uninstall) + + Or in one line: `git clone https://github.com/edoardottt/cariddi.git; cd cariddi; go get; make linux` + +- **Windows** (executable works only in cariddi folder.) + + - `git clone https://github.com/edoardottt/cariddi.git` + - `cd cariddi` + - `go get` + - `.\make.bat windows` (to install) + - `.\make.bat unwindows` (to uninstall) + +Get Started 🎉 +---------- + +`cariddi help` prints the help in the command line. + +``` +Usage of cariddi: + -c int + Concurrency level. (default 20) + -d int + Delay between a page crawled and another. + -e Hunt for juicy endpoints. + -ef string + Use an external file (txt, one per line) to use custom parameters for endpoints hunting. + -examples + Print the examples. + -h Print the help. + -oh string + Write the output into an HTML file. + -ot string + Write the output into a TXT file. + -plain + Print only the results. + -s Hunt for secrets. + -sf string + Use an external file (txt, one per line) to use custom regexes for secrets hunting. + -version + Print the version. +``` + + +Examples 💡 +---------- + + - `cat urls | cariddi -version` (Print the version) + - `cat urls | cariddi -h` (Print the help) + - `cat urls | cariddi -e` (Hunt for secrets) + - `cat urls | cariddi -d 2` (2 seconds between a page crawled and another) + - `cat urls | cariddi -c 200` (Set the concurrency level to 200) + - `cat urls | cariddi -s` (Hunt for juicy endpoints) + - `cat urls | cariddi -plain` (Print only useful things) + - `cat urls | cariddi -ot target_name` (Results in txt file) + - `cat urls | cariddi -oh target_name` (Results in html file) + +Contributing 🛠 +------- + +Just open an issue/pull request. See also [CONTRIBUTING.md](https://github.com/edoardottt/cariddi/blob/master/CONTRIBUTING.md) and [CODE OF CONDUCT.md](https://github.com/edoardottt/cariddi/blob/master/CODE_OF_CONDUCT.md) + +**Help me building this!** + +A special thanks to: + + - [zricethezav](https://github.com/zricethezav/gitleaks/blob/master/config/default.go) + +**To do:** + + - [ ] Tests (😂) + + - [ ] Tor support + + - [ ] Proxy support + + - [x] Plain output (print only results) + + - [x] HTML output + + - [x] Build an Input Struct and use it as parameter + + - [x] Output color + + - [x] TXT output + License 📝 ------- diff --git a/input/flags.go b/input/flags.go index 447b959..675adb0 100644 --- a/input/flags.go +++ b/input/flags.go @@ -51,7 +51,7 @@ func ScanFlag() Input { //verbosePtr := flag.Bool("v", false, "Verbose mode.") versionPtr := flag.Bool("version", false, "Print the version.") delayPtr := flag.Int("d", 0, "Delay between a page crawled and another.") - concurrencyPtr := flag.Int("c", 20, "Concurrency level (20 is default).") + concurrencyPtr := flag.Int("c", 20, "Concurrency level.") helpPtr := flag.Bool("h", false, "Print the help.") examplesPtr := flag.Bool("examples", false, "Print the examples.") plainPtr := flag.Bool("plain", false, "Print only the results.")