Making pcap handlers shared globally

.github/dependabot.yml

@@ -19,26 +19,26 @@ updates:
     labels:
       - "Type: Maintenance"
 
-#  # Maintain dependencies for docker
-#  - package-ecosystem: "docker"
-#    directory: "/"
-#    schedule:
-#      interval: "weekly"
-#    target-branch: "dev"
-#    commit-message:
-#      prefix: "chore"
-#      include: "scope"
-#    labels:
-#      - "Type: Maintenance"
-#
-#  # Maintain dependencies for GitHub Actions
-#  - package-ecosystem: "github-actions"
-#    directory: "/"
-#    schedule:
-#      interval: "weekly"
-#    target-branch: "dev"
-#    commit-message:
-#      prefix: "chore"
-#      include: "scope"
-#    labels:
-#      - "Type: Maintenance"
+ # Maintain dependencies for docker
+ - package-ecosystem: "docker"
+   directory: "/"
+   schedule:
+     interval: "weekly"
+   target-branch: "dev"
+   commit-message:
+     prefix: "chore"
+     include: "scope"
+   labels:
+     - "Type: Maintenance"
+
+ # Maintain dependencies for GitHub Actions
+ - package-ecosystem: "github-actions"
+   directory: "/"
+   schedule:
+     interval: "weekly"
+   target-branch: "dev"
+   commit-message:
+     prefix: "chore"
+     include: "scope"
+   labels:
+     - "Type: Maintenance"

.github/workflows/build-test.yml

@@ -11,14 +11,14 @@ jobs:
   build-linux:
     runs-on: ubuntu-latest
     steps:
+      - name: Check out code
+        uses: actions/checkout@v3
+
       - name: Set up Go
         uses: actions/setup-go@v4
         with:
           go-version: 1.21.x
 
-      - name: Check out code
-        uses: actions/checkout@v3
-
       - name: Install libpcap-dev
         run: sudo apt install libpcap-dev
 
@@ -39,10 +39,14 @@ jobs:
         run: bash run.sh
         working-directory: integration_tests/
 
-      - name: Race Condition Tests
+      - name: Race Condition Tests - Standard User
         run: |
           go run -race . -host scanme.sh
-          sudo go run -race . -host scanme.sh
+        working-directory: v2/cmd/naabu/
+
+      - name: Race Condition Tests - Root User
+        run: |
+          sudo go run -race . -host scanme.sh -Pn
         working-directory: v2/cmd/naabu/
 
   build-mac:
@@ -76,10 +80,14 @@ jobs:
         run: bash run.sh
         working-directory: integration_tests/
 
-      - name: Race Condition Tests
+      - name: Race Condition Tests - Standard User
         run: |
           go run -race . -host scanme.sh
-          sudo go run -race . -host scanme.sh
+        working-directory: v2/cmd/naabu/
+
+      - name: Race Condition Tests - Root User
+        run: |
+          sudo go run -race . -host scanme.sh -Pn
         working-directory: v2/cmd/naabu/
 
   build-windows:

README.md

@@ -351,7 +351,7 @@ Naabu also supports excluding CDN/WAF IPs being port scanned. If used, only `80`
 Currently `cloudflare`, `akamai`, `incapsula` and `sucuri` IPs are supported for exclusions.
 
 # Scan Status
-Naabu exposes json scan info on a local port bound to localhost at `http://localhost:63636` (the port can be changed via the `-metrics-port` flag)
+Naabu exposes json scan info on a local port bound to localhost at `http://localhost:63636/metrics` (the port can be changed via the `-metrics-port` flag)
 
 # Using naabu as library
 The following sample program scan the port `80` of `scanme.sh`. The results are returned via the `OnResult` callback:

integration_tests/run.sh

@@ -14,7 +14,7 @@ mv integration-test ../../../integration_tests/integration-test
 cd ../../../integration_tests
 echo "::endgroup::"
 
-./integration-test
+sudo ./integration-test
 if [ $? -eq 0 ]
 then
   exit 0

v2/cmd/integration-test/library.go

@@ -1,21 +1,29 @@
 package main
 
 import (
+	"context"
+	"errors"
 	"os"
+	"os/user"
 
 	"github.com/projectdiscovery/naabu/v2/internal/testutils"
+	"github.com/projectdiscovery/naabu/v2/pkg/privileges"
 	"github.com/projectdiscovery/naabu/v2/pkg/result"
 	"github.com/projectdiscovery/naabu/v2/pkg/runner"
 )
 
 var libraryTestcases = map[string]testutils.TestCase{
-	"naabu as library": &httpxLibrary{},
+	"sdk - one passive execution":         &naabuPassiveSingleLibrary{},
+	"sdk - one execution - connect":       &naabuSingleLibrary{scanType: "c"},
+	"sdk - multiple executions - connect": &naabuMultipleExecLibrary{scanType: "c"},
+	"sdk - one execution - syn":           &naabuSingleLibrary{scanType: "s"},
+	"sdk - multiple executions - syn":     &naabuMultipleExecLibrary{scanType: "s"},
 }
 
-type httpxLibrary struct {
+type naabuPassiveSingleLibrary struct {
 }
 
-func (h *httpxLibrary) Execute() error {
+func (h *naabuPassiveSingleLibrary) Execute() error {
 	testFile := "test.txt"
 	err := os.WriteFile(testFile, []byte("scanme.sh"), 0644)
 	if err != nil {
@@ -24,10 +32,11 @@ func (h *httpxLibrary) Execute() error {
 	defer os.RemoveAll(testFile)
 
 	options := runner.Options{
-		HostsFile: testFile,
-		Ports:     "80",
-		Passive:   true,
-		OnResult:  func(hr *result.HostResult) {},
+		HostsFile:         testFile,
+		Ports:             "80",
+		Passive:           true,
+		SkipHostDiscovery: true,
+		OnResult:          func(hr *result.HostResult) {},
 	}
 
 	naabuRunner, err := runner.NewRunner(&options)
@@ -36,5 +45,98 @@ func (h *httpxLibrary) Execute() error {
 	}
 	defer naabuRunner.Close()
 
-	return naabuRunner.RunEnumeration()
+	return naabuRunner.RunEnumeration(context.TODO())
+}
+
+type naabuSingleLibrary struct {
+	scanType string
+}
+
+func (h *naabuSingleLibrary) Execute() error {
+	if h.scanType == "s" && !privileges.IsPrivileged {
+		usr, _ := user.Current()
+		return errors.New("invalid user" + usr.Name)
+	}
+
+	testFile := "test.txt"
+	err := os.WriteFile(testFile, []byte("scanme.sh"), 0644)
+	if err != nil {
+		return err
+	}
+	defer os.RemoveAll(testFile)
+
+	var got bool
+
+	options := runner.Options{
+		HostsFile:         testFile,
+		Ports:             "80",
+		SkipHostDiscovery: true,
+		ScanType:          h.scanType,
+		OnResult: func(hr *result.HostResult) {
+			got = true
+		},
+		WarmUpTime: 2,
+	}
+
+	naabuRunner, err := runner.NewRunner(&options)
+	if err != nil {
+		return err
+	}
+	defer naabuRunner.Close()
+
+	if err = naabuRunner.RunEnumeration(context.TODO()); err != nil {
+		return err
+	}
+	if !got {
+		return errors.New("no results found")
+	}
+
+	return nil
+}
+
+type naabuMultipleExecLibrary struct {
+	scanType string
+}
+
+func (h *naabuMultipleExecLibrary) Execute() error {
+	if h.scanType == "s" && !privileges.IsPrivileged {
+		usr, _ := user.Current()
+		return errors.New("invalid user" + usr.Name)
+	}
+
+	testFile := "test.txt"
+	err := os.WriteFile(testFile, []byte("scanme.sh"), 0644)
+	if err != nil {
+		return err
+	}
+	defer os.RemoveAll(testFile)
+
+	var got bool
+
+	options := runner.Options{
+		HostsFile:         testFile,
+		Ports:             "80",
+		ScanType:          h.scanType,
+		SkipHostDiscovery: true,
+		OnResult: func(hr *result.HostResult) {
+			got = true
+		},
+		WarmUpTime: 2,
+	}
+
+	for i := 0; i < 3; i++ {
+		naabuRunner, err := runner.NewRunner(&options)
+		if err != nil {
+			return err
+		}
+
+		if err = naabuRunner.RunEnumeration(context.TODO()); err != nil {
+			return err
+		}
+		if !got {
+			return errors.New("no results found")
+		}
+		naabuRunner.Close()
+	}
+	return nil
 }

v2/cmd/naabu/main.go

@@ -1,11 +1,13 @@
 package main
 
 import (
+	"context"
+	"os"
+	"os/signal"
+
 	_ "github.com/projectdiscovery/fdmax/autofdmax"
 	"github.com/projectdiscovery/gologger"
 	"github.com/projectdiscovery/naabu/v2/pkg/runner"
-	"os"
-	"os/signal"
 )
 
 func main() {
@@ -35,7 +37,7 @@ func main() {
 		}
 	}()
 
-	err = naabuRunner.RunEnumeration()
+	err = naabuRunner.RunEnumeration(context.TODO())
 	if err != nil {
 		gologger.Fatal().Msgf("Could not run enumeration: %s\n", err)
 	}

v2/go.mod

@@ -3,6 +3,7 @@ module github.com/projectdiscovery/naabu/v2
 go 1.21
 
 require (
+	github.com/Mzack9999/gcache v0.0.0-20230410081825-519e28eab057
 	github.com/asaskevich/govalidator v0.0.0-20230301143203-a9d515a09cc2
 	github.com/google/gopacket v1.1.19
 	github.com/logrusorgru/aurora v2.0.3+incompatible
@@ -34,7 +35,6 @@ require (
 require (
 	aead.dev/minisign v0.2.0 // indirect
 	github.com/Masterminds/semver/v3 v3.2.1 // indirect
-	github.com/Mzack9999/gcache v0.0.0-20230410081825-519e28eab057 // indirect
 	github.com/Mzack9999/go-http-digest-auth-client v0.6.1-0.20220414142836-eb8883508809 // indirect
 	github.com/VividCortex/ewma v1.2.0 // indirect
 	github.com/akrylysov/pogreb v0.10.1 // indirect

v2/pkg/result/results.go

@@ -7,6 +7,8 @@ import (
 	"golang.org/x/exp/maps"
 )
 
+type ResultFn func(*HostResult)
+
 type HostResult struct {
 	Host  string
 	IP    string

v2/pkg/runner/options.go

@@ -6,6 +6,7 @@ import (
 
 	"github.com/projectdiscovery/naabu/v2/pkg/privileges"
 	"github.com/projectdiscovery/naabu/v2/pkg/result"
+	"github.com/projectdiscovery/naabu/v2/pkg/scan"
 	fileutil "github.com/projectdiscovery/utils/file"
 
 	"github.com/projectdiscovery/goflags"
@@ -61,7 +62,8 @@ type Options struct {
 	ProxyAuth         string              // Socks5 proxy authentication (username:password)
 	Resolvers         string              // Resolvers (comma separated or file)
 	baseResolvers     []string
-	OnResult          OnResultCallback // OnResult callback
+	OnResult          result.ResultFn // callback on final host result
+	OnReceive         result.ResultFn // callback on response receive
 	CSV               bool
 	Resume            bool
 	ResumeCfg         *ResumeCfg
@@ -96,9 +98,6 @@ type Options struct {
 	MetricsPort int
 }
 
-// OnResultCallback (hostResult)
-type OnResultCallback func(*result.HostResult)
-
 // ParseOptions parses the command line flags provided by a user
 func ParseOptions() *Options {
 	options := &Options{}
@@ -141,7 +140,7 @@ func ParseOptions() *Options {
 
 	flagSet.CreateGroup("config", "Configuration",
 		flagSet.BoolVarP(&options.ScanAllIPS, "sa", "scan-all-ips", false, "scan all the IP's associated with DNS record"),
-		flagSet.StringSliceVarP(&options.IPVersion, "iv", "ip-version", nil, "ip version to scan of hostname (4,6) - (default 4)", goflags.NormalizedStringSliceOptions),
+		flagSet.StringSliceVarP(&options.IPVersion, "iv", "ip-version", []string{scan.IPv4}, "ip version to scan of hostname (4,6) - (default 4)", goflags.NormalizedStringSliceOptions),
 		flagSet.StringVarP(&options.ScanType, "s", "scan-type", SynScan, "type of port scan (SYN/CONNECT)"),
 		flagSet.StringVar(&options.SourceIP, "source-ip", "", "source ip and port (x.x.x.x:yyy)"),
 		flagSet.BoolVarP(&options.InterfacesList, "il", "interface-list", false, "list available interfaces and public ip"),
@@ -198,7 +197,7 @@ func ParseOptions() *Options {
 		flagSet.BoolVar(&options.Version, "version", false, "display version of naabu"),
 		flagSet.BoolVar(&options.EnableProgressBar, "stats", false, "display stats of the running scan (deprecated)"),
 		flagSet.IntVarP(&options.StatsInterval, "stats-interval", "si", DefautStatsInterval, "number of seconds to wait between showing a statistics update (deprecated)"),
-		flagSet.IntVarP(&options.MetricsPort, "metrics-port", "mp", 63636, "port to expose nuclei metrics on"),
+		flagSet.IntVarP(&options.MetricsPort, "metrics-port", "mp", 63636, "port to expose naabu metrics on"),
 	)
 
 	_ = flagSet.Parse()
@@ -211,8 +210,6 @@ func ParseOptions() *Options {
 	// Check if stdin pipe was given
 	options.Stdin = !options.DisableStdin && fileutil.HasStdin()
 
-	// Read the inputs and configure the logging
-	options.configureOutput()
 	options.ResumeCfg = NewResumeCfg()
 	if options.ShouldLoadResume() {
 		if err := options.ResumeCfg.ConfigureResume(); err != nil {
@@ -230,9 +227,7 @@ func ParseOptions() *Options {
 	if !options.DisableUpdateCheck {
 		latestVersion, err := updateutils.GetToolVersionCallback("naabu", version)()
 		if err != nil {
-			if options.Verbose {
-				gologger.Error().Msgf("naabu version check failed: %v", err.Error())
-			}
+			gologger.Verbose().Msgf("naabu version check failed: %v", err.Error())
 		} else {
 			gologger.Info().Msgf("Current naabu version %v %v", version, updateutils.GetVersionDescription(version, latestVersion))
 		}