Merge pull request #9 from nccapo/refactor-package-naming

Refactor package naming

Author: CyberRoute

README.md

@@ -39,12 +39,12 @@ nmap -vvv -sT -p 1-65535 {target_IP}
 
 ## Example Simple scanner
 <div align="center">
-    <img src="/img/scanme.png" width="800px"</img> 
+    <img src="/assets/scanme.png" width="800px"</img>
 </div>
 
 ## Installation
 
-- On Linux, install `libpcap` 
+- On Linux, install `libpcap`
 ```bash
 sudo apt install -y libpcap-dev
 ```
@@ -122,7 +122,7 @@ func main() {
 ## Sample scan
 ```
 alessandro@xps:~/Development/scanme$ sudo go run main.go -ip 172.16.168.131
-[sudo] password for alessandro: 
+[sudo] password for alessandro:
 2024/01/11 15:04:53 scanning ip 172.16.168.131 with interface vmnet8, gateway <nil>, src 172.16.168.1
 2024/01/11 15:04:53 ICMP Echo Reply received from 172.16.168.131
 2024/01/11 15:04:54 last port scanned for 172.16.168.131 dst port 65535 assuming we've seen all we can
@@ -147,5 +147,3 @@ Scanme is developed by Alessandro Bresciani with some help from various projects
 ## Acknowledgments
 Inspired by and wanting to improve this https://github.com/google/gopacket/blob/master/examples/synscan/main.go
 Technical details checked here https://nmap.org/book/synscan.html and obviously https://github.com/nmap/nmap
-
-

data/services.csv api/services.csvdata/services.csv renamed to api/services.csv

@@ -1,26 +1,13 @@
-package utils
+// Package service is helper package for services which is external data and need to be parsed
+// to provide usefull information such as (port number, protocol and service name)
+package service
 
 import (
 	"encoding/csv"
 	"fmt"
-	"net"
 	"os"
 )
 
-// Listen on port 0 to get a free port assigned by the system.
-// Get the actual address, including the assigned port.
-func GetFreeTCPPort() (int, error) {
-
-	listener, err := net.Listen("tcp", ":0")
-	if err != nil {
-		return 0, err
-	}
-	defer listener.Close()
-
-	addr := listener.Addr().(*net.TCPAddr)
-	return addr.Port, nil
-}
-
 // ServiceInfo represents information about a service
 type ServiceInfo struct {
 	ServiceName string
@@ -32,7 +19,7 @@ type ServiceInfo struct {
 // https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.csv
 // and returns the service name for a given port number and protocol
 func GetServiceName(port, proto string) (string, error) {
-	file, err := os.Open("data/services.csv")
+	file, err := os.Open("api/services.csv")
 	if err != nil {
 		return "", err
 	}

img/scanme.png assets/scanme.pngimg/scanme.png renamed to assets/scanme.png

@@ -0,0 +1,17 @@
+// Package tcp provided way to get actual address including the assigned port
+package tcp
+
+import "net"
+
+// Listen on port 0 to get a free port assigned by the system.
+// Get the actual address, including the assigned port.
+func GetFreeTCPPort() (int, error) {
+	listener, err := net.Listen("tcp", ":0")
+	if err != nil {
+		return 0, err
+	}
+	defer listener.Close()
+
+	addr := listener.Addr().(*net.TCPAddr)
+	return addr.Port, nil
+}

utils/util.go internal/service/service.goutils/util.go renamed to internal/service/service.go

@@ -8,7 +8,8 @@ import (
 	"sync"
 	"time"
 
-	"github.com/CyberRoute/scanme/utils"
+	"github.com/CyberRoute/scanme/internal/service"
+	"github.com/CyberRoute/scanme/internal/tcp"
 	"github.com/google/gopacket"
 	"github.com/google/gopacket/layers"
 	"github.com/google/gopacket/pcap"
@@ -169,7 +170,7 @@ func (s *Scanner) sendARPRequest() (net.HardwareAddr, error) {
 
 func getFreeTCPPort() (layers.TCPPort, error) {
 	// Use the library or function that returns a free TCP port as an int.
-	tcpport, err := utils.GetFreeTCPPort()
+	tcpport, err := tcp.GetFreeTCPPort()
 	if err != nil {
 		return 0, err
 	}
@@ -396,7 +397,7 @@ func (s *Scanner) ConnScan() (map[layers.TCPPort]string, error) {
 				conn, err := net.DialTimeout("tcp", addr, 3*time.Second)
 				if err == nil {
 					conn.Close()
-					serviceName, err := utils.GetServiceName(strconv.Itoa(p), "tcp")
+					serviceName, err := service.GetServiceName(strconv.Itoa(p), "tcp")
 					if err != nil {
 						// Log or handle the error, and continue the loop
 						log.Printf("Error getting service name for port %d: %v", p, err)