code refactoring to provide abstracted library

[xm1k3]

func main() {
	// Parse the command line flags and read config files
	options := runner.ParseOptions()

	agentFactory, err := runner.New(options)
	if err != nil {
		gologger.Fatal().Msgf("Could not create runner: %s\n", err)
	}
	newRunner, err := runner.NewRunner(options, agentFactory)
	if err != nil {
		gologger.Fatal().Msgf("Could not create runner: %s\n", err)
	}

	err = newRunner.Run(context.Background())
	if err != nil {
		gologger.Fatal().Msgf("Could not run enumeration: %s\n", err)
	}
}

[xm1k3]

agentFactory, err := runner.New(options)
if err != nil {
	gologger.Fatal().Msgf("Could not create runner: %s\n", err)
}

[github-advanced-security]

You have successfully added a new CodeQL configuration .github/workflows/codeql-analysis.yml:analyze/language:go. As part of the setup process, we have scanned this repository and found 1 existing alert. Please check the repository Security tab to see all alerts.

[tarunKoyalwar]

$ go run . -s "ssl:'hackerone.com'" -v

  __  ______  _________ _   _____  _____
 / / / / __ \/ ___/ __ \ | / / _ \/ ___/
/ /_/ / / / / /__/ /_/ / |/ /  __/ /    
\__,_/_/ /_/\___/\____/|___/\___/_/

		projectdiscovery.io

[INF] Current uncover version v1.0.3 (latest)
[shodan] 2606:4700::6810:6434:2083
[shodan] 104.16.100.52:8443
[shodan] 104.16.99.52:8443
[shodan] 2606:4700::6810:6434:2087
[shodan] 2606:4700::6810:6334:443
[shodan] 2606:4700::6810:6334:8443
[shodan] 2606:4700::6810:6334:2087
[shodan] 104.16.99.52:2083
[shodan] 104.16.99.52:443
[shodan] 104.16.100.52:443
[shodan] 104.16.100.52:2083
[shodan] 2606:4700::6810:6434:8443
[shodan] 2606:4700::6810:6434:443
[shodan] 2606:4700::6810:6334:2083
[shodan] 164.92.231.194:443

[tarunKoyalwar]

Integration / Library Code

• Now uncover is completely abstracted i.e logic/code does not need to be changed downstream (nuclei etc) if we add new/sources

uncover/examples/main.go

Lines 1 to 44 in fe9e479

	package main
	import (
	"context"
	"fmt"
	"github.com/projectdiscovery/gologger"
	"github.com/projectdiscovery/uncover"
	"github.com/projectdiscovery/uncover/sources"
	)
	func main() {
	opts := uncover.Options{
	Agents: []string{"shodan"},
	Queries: []string{"ssl:'hackerone.com'"},
	Limit: 50,
	MaxRetry: 2,
	Timeout: 20,
	}
	u, err := uncover.New(&opts)
	if err != nil {
	panic(err)
	}
	allagents := u.AllAgents()
	gologger.Info().Msgf("Available uncover agents/sources :")
	for _, v := range allagents {
	fmt.Println(v)
	}
	fmt.Println("\n\n- Uncover Results:")
	result := func(result sources.Result) {
	fmt.Println(result.IpPort())
	}
	// Execute executes and returns a channel with all results
	// ch , err := u.Execute(context.Background())
	// Execute with Callback calls u.Execute() internally and abstracts channel handling logic
	if err := u.ExecuteWithCallback(context.TODO(), result); err != nil {
	panic(err)
	}
	}

[tarunKoyalwar]

Follow up Issue

• replace https://github.com/projectdiscovery/nuclei/blob/main/v2/pkg/protocols/common/uncover/uncover.go with ^

[Mzack9999]

Implementation: lgtm
Notes:

• suggesting minor optional refactor
• I think we should make it clear in the readme that now the runner is not reusable anymore with different queries, but a new instance needs to be created with new options

[Mzack9999]

lgtm

[ehsandeep]

This works

echo jira | ./uncover -v

but not this:

echo jira | ./uncover

[tarunKoyalwar]

$ ./uncover -q "ssl:hackerone.com" -e shodan  -v

  __  ______  _________ _   _____  _____
 / / / / __ \/ ___/ __ \ | / / _ \/ ___/
/ /_/ / / / / /__/ /_/ / |/ /  __/ /    
\__,_/_/ /_/\___/\____/|___/\___/_/

		projectdiscovery.io

[INF] Current uncover version v1.0.4-dev (dev)
[shodan] 104.16.100.52:443
[shodan] 104.16.99.52:2083
[shodan] 104.16.100.52:2083
[shodan] 2606:4700::6810:6434:8443
[shodan] 2606:4700::6810:6434:2083
[shodan] 104.16.99.52:8443
[shodan] 104.16.100.52:8443
[shodan] 2606:4700::6810:6434:443
[shodan] 2606:4700::6810:6334:2083
[shodan] 2606:4700::6810:6334:443
[shodan] 104.16.99.52:443
[shodan] 2606:4700::6810:6334:8443
[shodan] 164.92.231.194:443

$ ./uncover -q "ssl:hackerone.com" -e shodan 

  __  ______  _________ _   _____  _____
 / / / / __ \/ ___/ __ \ | / / _ \/ ___/
/ /_/ / / / / /__/ /_/ / |/ /  __/ /    
\__,_/_/ /_/\___/\____/|___/\___/_/

		projectdiscovery.io

[INF] Current uncover version v1.0.4-dev (dev)
104.16.100.52:443
104.16.99.52:2083
104.16.100.52:2083
2606:4700::6810:6434:8443
2606:4700::6810:6434:2083
104.16.99.52:8443
104.16.100.52:8443
2606:4700::6810:6434:443
2606:4700::6810:6334:2083
2606:4700::6810:6334:443
104.16.99.52:443
2606:4700::6810:6334:8443
164.92.231.194:443