From a933bdb6b813c9a27cd0ac383f825d3b68b932a5 Mon Sep 17 00:00:00 2001 From: Tarun Koyalwar <45962551+tarunKoyalwar@users.noreply.github.com> Date: Mon, 16 May 2022 01:33:16 +0530 Subject: [PATCH] blogs,readme,fmt,mispell etc --- README.md | 47 +++++++++++++++++++++++-------------- cmd/talosplus/subcmd/get.go | 2 +- pkg/core/crux.go | 6 ++--- pkg/gopool/pool.go | 2 +- pkg/internal/cmd.go | 2 +- pkg/shell/cmdwrap.go | 5 ++-- pkg/stringutils/string.go | 2 +- 7 files changed, 39 insertions(+), 27 deletions(-) diff --git a/README.md b/README.md index 8575316..db30916 100644 --- a/README.md +++ b/README.md @@ -12,20 +12,31 @@
- Features • - Screenshots • + Screenshots • + Blogs • + Features • Installation • Usage
-Talosplus is tool to run bash scripts at faster rate by executing commands in parallel using goroutines and with some exceptional features like Auto Scheduling, Filesystem Abstraction ,Stop/Resume, Buffers,Thread Safe ,Fail Safe, Serial + Parallel Execution, Notification Support etc provided that script follows given Syntax and is integrated with **MongoDB** which provides lot of flexiblity similar to `bbrf` especially for Bug Hunters, Security Professionals etc. +Talosplus is tool to run bash scripts at faster rate by executing commands in parallel using goroutines and with some exceptional features like **Auto Scheduling, Filesystem Abstraction ,Stop/Resume, Buffers,Thread Safe ,Fail Safe, Serial + Parallel Execution, Notification Support** etc provided that script follows given Syntax and is integrated with **MongoDB** which provides lot of flexiblity similar to `bbrf` especially for Bug Hunters, Security Professionals etc. + +# Blogs / How To Guides + +[Create Your Ultimate Bug Bounty Automation Without Nerdy Bash Skills](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-1-a78c2b109731) + +- [Part 1](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-1-a78c2b109731) + +- [Part 2](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-2-c8cd72018922) + +- [Part 3](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-3-7ee2b353a781) # Why ?? Why use this when bash scripts can be run directly ?? You can think of this like a middleware to run bash scripts . I wanted to create a perfect automation much like **@hakluke** . This project resolves all challenges and issues I faced while writing bash scripts and creating the perfect automation and makes it possible to leverage all important features with comments `Ex: #as:@nmapout, #from:@allsubs etc` . and adds a lot of additional features. -Even If you are a little intriqued, Consider reading my blog at `Blog` . Which describes how I overcame challenges I faced , how and when to use these comments ? and effective use of this project and detailed description of all its features like scheduling algo etc. +Even If you are a little intriqued, Consider reading [my blog](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-1-a78c2b109731) . Which describes how I overcame challenges I faced , how and when to use these comments ? and effective use of this project and detailed description of all its features like scheduling algo etc. ~~~ @@ -38,9 +49,10 @@ Will run every command it can find in parallel. - Sample Bash Script with Syntax at [here](static/script.png) -- Talosplus output at [here](static/cmdout.jpg) +- Talosplus output at [here](static/cmdout.png) + +- Custom Discord Notification at [here](static/notification.png) -- Discord Notification at [here](static/notification.png) # Features @@ -59,21 +71,18 @@ These are oversimplified features to name from my blog. # Installation Instructions -Install MongoDB +- Install MongoDB. -- Make Sure GO is Installed +- Download Binary From [Releases](https://github.com/tarunKoyalwar/talosplus/releases) . + +- Build From Source . ~~~sh -go install github.com/tarunKoyalwar/talosplus@latest +go install github.com/tarunKoyalwar/talosplus/cmd/talosplus@latest ~~~ -- - -
- -Refer to Blog `` for step by step instructions in detail +Refer to Blog [Part 3](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-3-7ee2b353a781) for step by step instructions in detail. # Usage @@ -83,6 +92,10 @@ talosplus -h This will display help for the tool ++ + +
Talosplus has every feature that would make it easy to write and run bash scripts . @@ -90,11 +103,11 @@ Talosplus has every feature that would make it easy to write and run bash script ## Writing Automation Scripts With Syntax To leverage all features of Talosplus like Auto Scheduling etc . It is essential the written bash script follows the syntax . Example of such bash script can be found at [subenum.sh](examples/subenum.sh) . -In detail guide of how to write such scripts and using the syntax can be found at [blog] +In detail guide of how to write such scripts and using the syntax can be found at [blog](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-2-c8cd72018922) ## Usage in Detail -In depth details on running any scripts ,configs , interacting with db , storing and retrieving any subdomain(or any variable from bash script) etc. and much more can be found at [blog] +In depth details on running any scripts ,configs , interacting with db , storing and retrieving any subdomain(or any variable from bash script) etc. and much more can be found at [blog](https://medium.com/@zealousme/create-your-ultimate-bug-bounty-automation-without-nerdy-bash-skills-part-3-7ee2b353a781) # Support diff --git a/cmd/talosplus/subcmd/get.go b/cmd/talosplus/subcmd/get.go index 559c264..9f0278c 100644 --- a/cmd/talosplus/subcmd/get.go +++ b/cmd/talosplus/subcmd/get.go @@ -97,7 +97,7 @@ var get cobra.Command = cobra.Command{ func init() { get.Flags().StringVar(&dbname, "db", "", "Database Name to use") get.Flags().StringVarP(&collname, "program", "p", "", "Program/Collection Name") - get.Flags().BoolVar(&show, "show", false, "Show All Enviornment Variables present in DB") + get.Flags().BoolVar(&show, "show", false, "Show All Environment Variables present in DB") get.Flags().BoolVar(&list, "list", false, "List All Variable Names Present in DB") get.Flags().BoolVar(&local, "local", false, "Show Local Settings [set using `use`]") } diff --git a/pkg/core/crux.go b/pkg/core/crux.go index 7e7fe20..fab26dd 100644 --- a/pkg/core/crux.go +++ b/pkg/core/crux.go @@ -72,7 +72,7 @@ func (s *Scripter) Schedule() { ioutils.Cout.Printf("[+] Skipping Following commands\n") - for k, _ := range needless { + for k := range needless { val := s.IndexedCMDs[k].Comment if val == "" { val = s.IndexedCMDs[k].Raw @@ -348,7 +348,7 @@ func (s *Scripter) Summarize() { notdeclared := []string{} for k, v := range shared.DefaultRegistry.FoundVars { if v { - ioutils.Cout.Printf("[+] Found Implicit Decleration of %v", k) + ioutils.Cout.Printf("[+] Found Implicit Declaration of %v", k) } else { notdeclared = append(notdeclared, k) } @@ -362,7 +362,7 @@ func (s *Scripter) Summarize() { for k, v := range shared.DefaultRegistry.FoundVars { if !v { - fatal += fmt.Sprintf("[-] Missing Decleration for %v\n", k) + fatal += fmt.Sprintf("[-] Missing Declaration for %v\n", k) } } diff --git a/pkg/gopool/pool.go b/pkg/gopool/pool.go index fc9cd55..857f99f 100644 --- a/pkg/gopool/pool.go +++ b/pkg/gopool/pool.go @@ -127,7 +127,7 @@ func (p *Pool) Operator() { p.JobMutex.Unlock() - //If interchannel commuication has happend then work is completed + //If interchannel commuication has happened then work is completed //add worker back to queue p.workerChannel <- 8 diff --git a/pkg/internal/cmd.go b/pkg/internal/cmd.go index afce7d0..f5624b2 100644 --- a/pkg/internal/cmd.go +++ b/pkg/internal/cmd.go @@ -24,7 +24,7 @@ func (c *Command) GenUID() { //sort to avoid duplicates sort.Strings(cmdarr) - //Lets use # as seperator + //Lets use # as separator suffix := strings.Join(cmdarr, "#") data := []byte(suffix) diff --git a/pkg/shell/cmdwrap.go b/pkg/shell/cmdwrap.go index 12965fb..f905c58 100644 --- a/pkg/shell/cmdwrap.go +++ b/pkg/shell/cmdwrap.go @@ -30,7 +30,7 @@ type CMDWrap struct { Comment string // Human Readable Comment Raw string //Raw Command to be passed CacheKey string // Unique Hash of Command to Cache - UID string //A Temporary UID of Raw Commmand + UID string //A Temporary UID of Raw Command ExportAs string // Export as variable name ExportFromFile string // IF @outfile is used then export data from here @@ -179,7 +179,6 @@ func (c *CMDWrap) Execute() error { err := c.cacheIn() if err != nil { ioutils.Cout.PrintWarning("Catched Data Was Not Found %v\n", err.Error()) - runerror = c.CMD.Run() } else { return nil } @@ -259,7 +258,7 @@ func (c *CMDWrap) genCacheKey() { //sort to avoid duplicates sort.Strings(tarr) - //Lets use # as seperator + //Lets use # as separator suffix := strings.Join(tarr, "#") data := []byte(suffix) diff --git a/pkg/stringutils/string.go b/pkg/stringutils/string.go index 1b62d01..9c2a49f 100644 --- a/pkg/stringutils/string.go +++ b/pkg/stringutils/string.go @@ -9,7 +9,7 @@ func SplitAtSpace(s string) []string { } -// Split : Similar to Strings.Feilds with Custom Seperator +// Split : Similar to Strings.Feilds with Custom separator func Split(s string, delim rune) []string { // Must trim the string first