Refactor (#27)

* wip commit

* wip commit

* refactor wip

* more wip

* removing test file

* fixing docker and other configs

* reademe

---------

Author: Zeerg

.dockerignore

@@ -1,4 +1,5 @@
 images*
 Dockerfile
 docker-compose.yaml
-.git
+.git
+config.toml

.gitignore

@@ -1,2 +1,5 @@
 .DS_Store
-bin/
+bin/
+defaultConfig.json
+kubeSystemConfig.json
+config.toml

Dockerfile

@@ -4,15 +4,12 @@ FROM golang:alpine as build
 RUN mkdir /app
 WORKDIR /app
 COPY . ./
-RUN go mod download && go build -o /helix-honeypot
+WORKDIR /app/cmd
+RUN go get ./... && go build -o /helix-honeypot
 
 #Final Stage
 FROM alpine:latest
 WORKDIR /
 COPY --from=build /helix-honeypot /helix-honeypot
-RUN addgroup -S helix && adduser -S helix -G helix
-USER helix
-
-EXPOSE 80
 
 ENTRYPOINT ["/helix-honeypot"]

cmd/main.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"fmt"
+	"os"
+
+	"helix-honeypot/server"
+)
+
+func main() {
+	// Start the server based on the run mode
+	err := server.StartHoneypot()
+	if err != nil {
+		fmt.Println("Failed To Start Server:", err)
+		os.Exit(1)
+	}
+}

config/config.go

@@ -1,24 +1,180 @@
 package config
 
 import (
+	"fmt"
 	"os"
+	"io/ioutil"
+	"strings"
+
+	"helix-honeypot/model"
+	"github.com/BurntSushi/toml"
 )
 
-type Config struct {
-	HTTP HTTPConfig
+// GetEnvAsBool gets environment variables as boolean values. It returns false if the value is not "true" (case-insensitive), otherwise it returns true
+func GetEnvAsBool(key string) bool {
+	value := os.Getenv(key)
+	return strings.ToLower(value) == "true"
 }
 
-// If env vars are empty set a default
-func GetEnv(key, defaultValue string) string {
-	value := os.Getenv(key) // try to get the env var
-	if len(value) == 0 {
-		return defaultValue // if empty set default
-	}
-	return value // if not empty return env var
+func LoadK8SConfig(cfg *model.K8SConfig) model.K8SConfig {
+    apiVersion := os.Getenv("K8SAPI_VERSION")
+    ipBase := os.Getenv("IP_BASE")
+    host := os.Getenv("K8S_HOST")
+    port := os.Getenv("K8S_PORT")
+
+    if apiVersion != "" {
+        cfg.APIVersion = apiVersion
+    }
+    if ipBase != "" {
+        cfg.IPBase = ipBase
+    }
+    if host != "" {
+        cfg.Host = host
+    }
+    if port != "" {
+        cfg.Port = port
+    }
+
+    // Since the zero value for a boolean in Go is `false`, 
+    // we only need to check if the environment variable is "true".
+    if strings.ToLower(os.Getenv("GENERATE_KUBE_SYSTEM")) == "true" {
+        cfg.GenerateKubeSys = true
+    }
+    if strings.ToLower(os.Getenv("GENERATE_RANDOMNESS")) == "true" {
+        cfg.GenerateRand = true
+    }
+
+    return *cfg
+}
+
+func LoadHTTPConfig(cfg *model.HTTPConfig) model.HTTPConfig {
+    host := os.Getenv("HELIX_HTTP_HOST")
+    port := os.Getenv("HELIX_HTTP_PORT")
+
+    if host != "" {
+        cfg.Host = host
+    }
+    if port != "" {
+        cfg.Port = port
+    }
+
+    return *cfg
+}
+
+func LoadUDPConfig(cfg *model.UDPConfig) model.UDPConfig {
+    host := os.Getenv("HELIX_UDP_HOST")
+    port := os.Getenv("HELIX_UDP_PORT")
+
+    if host != "" {
+        cfg.Host = host
+    }
+    if port != "" {
+        cfg.Port = port
+    }
+
+    return *cfg
+}
+
+func LoadTCPConfig(cfg *model.TCPConfig) model.TCPConfig {
+    host := os.Getenv("HELIX_TCP_HOST")
+    port := os.Getenv("HELIX_TCP_PORT")
+
+    if host != "" {
+        cfg.Host = host
+    }
+    if port != "" {
+        cfg.Port = port
+    }
+
+    return *cfg
+}
+
+func LoadDEFConfig(cfg *model.DEFConfig) model.DEFConfig {
+    host := os.Getenv("HELIX_DEF_HOST")
+    port := os.Getenv("HELIX_DEF_PORT")
+
+    if host != "" {
+        cfg.Host = host
+    }
+    if port != "" {
+        cfg.Port = port
+    }
+
+    return *cfg
 }
 
-func NewConfig() *Config {
-	return &Config{
-		HTTP: LoadHTTPConfig(),
+func LoadMongoDBConfig(cfg *model.MongoDBConfig) model.MongoDBConfig {
+	username := os.Getenv("MONGODB_USERNAME")
+	password := os.Getenv("MONGODB_PASSWORD")
+	host := os.Getenv("MONGODB_HOST")
+	database := os.Getenv("MONGODB_DATABASE")
+	collection := os.Getenv("MONGODB_COLLECTION")
+
+	if username != "" {
+		cfg.Username = username
+	}
+	if password != "" {
+		cfg.Password = password
+	}
+	if host != "" {
+		cfg.Host = host
+	}
+	if database != "" {
+		cfg.Database = database
+	}
+	if collection != "" {
+		cfg.Collection = collection
+	}
+
+	// Format the MongoDB URI
+	uri := fmt.Sprintf("mongodb+srv://%s:%s@%s/", cfg.Username, cfg.Password, cfg.Host)
+	cfg.URI = uri
+
+	if strings.ToLower(os.Getenv("LOG_TO_MONGODB")) == "true" {
+		cfg.LogToMongoDB = true
 	}
+
+	return *cfg
+}
+
+func LoadRunModeConfig(cfg *model.RunModeConfig) model.RunModeConfig {
+    runMode := os.Getenv("RUN_MODE")
+    location := os.Getenv("HELIX_LOCATION")
+
+    if runMode != "" {
+        cfg.RunMode = runMode
+    }
+    if location != "" {
+        cfg.Location = location
+    }
+
+    return *cfg
+}
+
+func NewConfig(configFile string) (*model.Config, error) {
+    var cfg model.Config
+    
+    // Check if the config file exists
+    if _, err := os.Stat(configFile); err == nil {
+        // If the config file exists, load default values from TOML file
+        data, err := ioutil.ReadFile(configFile)
+        if err != nil {
+            return nil, err
+        }
+        _, err = toml.Decode(string(data), &cfg)
+        if err != nil {
+            return nil, err
+        }
+    }
+
+    // Override with environment variables
+    cfg.HTTP = LoadHTTPConfig(&cfg.HTTP)
+    cfg.UDP = LoadUDPConfig(&cfg.UDP)
+    cfg.TCP = LoadTCPConfig(&cfg.TCP)
+    cfg.K8S = LoadK8SConfig(&cfg.K8S)
+    cfg.DEF = LoadDEFConfig(&cfg.DEF)
+    cfg.MongoDB = LoadMongoDBConfig(&cfg.MongoDB)
+    cfg.RunMode = LoadRunModeConfig(&cfg.RunMode)
+
+    return &cfg, nil
 }

config/http.go

@@ -1,14 +1,53 @@
 version: '3.7'
 
 services:
-  helix-honeypot-ad:
-   build: ./
-   ports:
-     - "8000:80"
-   entrypoint: [/helix-honeypot, -mode=ad]
-   volumes:
-     - /dev/urandom:/dev/urandom
-  helix-honeypot:
+  helix-honeypot-k8s:
     build: ./
     ports:
-      - "80:80"
+      - "8111:8111"
+    environment:
+      - RUN_MODE=k8s
+      - HELIX_LOCATION=testing
+      - K8SAPI_VERSION=v1.21
+      - IP_BASE=192.168
+      - GENERATE_KUBE_SYSTEM=true
+      - GENERATE_RANDOMNESS=true
+      - K8S_HOST=0.0.0.0
+      - K8S_PORT=8111
+
+  helix-honeypot-http:
+    build: ./
+    ports:
+      - "8000:8000"
+    environment:
+      - RUN_MODE=http
+      - HELIX_HTTP_HOST=0.0.0.0
+      - HELIX_HTTP_PORT=8000
+
+  helix-honeypot-tcp:
+    build: ./
+    ports:
+      - "3000:3000"
+    environment:
+      - RUN_MODE=tcp
+      - HELIX_TCP_HOST=0.0.0.0
+      - HELIX_TCP_PORT=3000
+
+  helix-honeypot-udp:
+    build: ./
+    ports:
+      - "53:53/udp"
+    environment:
+      - RUN_MODE=udp
+      - HELIX_UDP_HOST=0.0.0.0
+      - HELIX_UDP_PORT=53
+
+  helix-honeypot-def:
+    build: ./
+    ports:
+      - "8001:8001"
+    environment:
+      - RUN_MODE=def
+      - HELIX_DEF_HOST=0.0.0.0
+      - HELIX_DEF_PORT=8001
+

docker-compose.yaml

@@ -3,23 +3,38 @@ module helix-honeypot
 go 1.19
 
 require (
+	github.com/BurntSushi/toml v0.3.1
+	github.com/denisbrodbeck/machineid v1.0.1
 	github.com/google/gnostic v0.6.9
-	github.com/labstack/echo/v4 v4.9.0
-	github.com/labstack/gommon v0.3.1
-	google.golang.org/protobuf v1.28.1
+	github.com/google/uuid v1.3.0
+	github.com/klauspost/cpuid/v2 v2.2.5
+	github.com/labstack/echo/v4 v4.10.2
+	github.com/labstack/gommon v0.4.0
+	github.com/mitchellh/hashstructure/v2 v2.0.2
+	github.com/sirupsen/logrus v1.9.3
+	go.mongodb.org/mongo-driver v1.12.0
+	google.golang.org/protobuf v1.30.0
 )
 
 require (
 	github.com/golang-jwt/jwt v3.2.2+incompatible // indirect
-	github.com/golang/protobuf v1.5.2 // indirect
-	github.com/mattn/go-colorable v0.1.11 // indirect
-	github.com/mattn/go-isatty v0.0.14 // indirect
+	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/golang/snappy v0.0.1 // indirect
+	github.com/klauspost/compress v1.13.6 // indirect
+	github.com/mattn/go-colorable v0.1.13 // indirect
+	github.com/mattn/go-isatty v0.0.19 // indirect
+	github.com/montanaflynn/stats v0.0.0-20171201202039-1bf9dbcd8cbe // indirect
 	github.com/valyala/bytebufferpool v1.0.0 // indirect
-	github.com/valyala/fasttemplate v1.2.1 // indirect
-	golang.org/x/crypto v0.0.0-20210817164053-32db794688a5 // indirect
-	golang.org/x/net v0.0.0-20211015210444-4f30a5c0130f // indirect
-	golang.org/x/sys v0.0.0-20211103235746-7861aae1554b // indirect
-	golang.org/x/text v0.3.7 // indirect
-	golang.org/x/time v0.0.0-20201208040808-7e3f01d25324 // indirect
-	gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b // indirect
+	github.com/valyala/fasttemplate v1.2.2 // indirect
+	github.com/xdg-go/pbkdf2 v1.0.0 // indirect
+	github.com/xdg-go/scram v1.1.2 // indirect
+	github.com/xdg-go/stringprep v1.0.4 // indirect
+	github.com/youmark/pkcs8 v0.0.0-20181117223130-1be2e3e5546d // indirect
+	golang.org/x/crypto v0.10.0 // indirect
+	golang.org/x/net v0.11.0 // indirect
+	golang.org/x/sync v0.0.0-20220722155255-886fb9371eb4 // indirect
+	golang.org/x/sys v0.9.0 // indirect
+	golang.org/x/text v0.10.0 // indirect
+	golang.org/x/time v0.3.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
 )