set endpoint and port when registering

auth/host_session.go

@@ -15,6 +15,8 @@ import (
 	"github.com/gravitl/netmaker/models"
 	"github.com/gravitl/netmaker/mq"
 	"github.com/gravitl/netmaker/servercfg"
+	"golang.org/x/exp/slices"
+	"golang.org/x/exp/slog"
 )
 
 // SessionHandler - called by the HTTP router when user
@@ -31,7 +33,7 @@ func SessionHandler(conn *websocket.Conn) {
 		return
 	}
 
-	var registerMessage models.RegisterMsg
+	var registerMessage models.HostRegisterNonTokenReqDto
 	if err = json.Unmarshal(message, &registerMessage); err != nil {
 		logger.Log(0, "Failed to unmarshall data err=", err.Error())
 		return
@@ -140,7 +142,22 @@ func SessionHandler(conn *websocket.Conn) {
 					return
 				}
 			}
-			logic.CheckHostPorts(&result.Host)
+			if slices.Contains(registerMessage.CustomParams, models.HostRegisterCustomParamListenPort) {
+				slog.Info("checking custom host port", "port", result.Host.ListenPort)
+				isPortInUse, err := logic.CheckHostPorts(&result.Host, false)
+				if err != nil {
+					slog.Error("failed to check host port", "error", err)
+					handleHostRegErr(conn, err)
+					return
+				}
+				if isPortInUse {
+					slog.Error("port is already in use", "port", result.Host.ListenPort)
+					handleHostRegErr(conn, err)
+					return
+				}
+			} else {
+				logic.CheckHostPorts(&result.Host, true)
+			}
 			if err := logic.CreateHost(&result.Host); err != nil {
 				handleHostRegErr(conn, err)
 				return

controllers/enrollmentkeys.go

@@ -13,6 +13,8 @@ import (
 	"github.com/gravitl/netmaker/models"
 	"github.com/gravitl/netmaker/mq"
 	"github.com/gravitl/netmaker/servercfg"
+	"golang.org/x/exp/slices"
+	"golang.org/x/exp/slog"
 )
 
 func enrollmentKeyHandlers(r *mux.Router) {
@@ -157,14 +159,15 @@ func handleHostRegister(w http.ResponseWriter, r *http.Request) {
 		logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
 		return
 	}
-	// get the host
-	var newHost models.Host
-	if err = json.NewDecoder(r.Body).Decode(&newHost); err != nil {
+	reqBody := models.HostRegisterReqDto{}
+	if err = json.NewDecoder(r.Body).Decode(&reqBody); err != nil {
 		logger.Log(0, r.Header.Get("user"), "error decoding request body: ",
 			err.Error())
 		logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
 		return
 	}
+	// get the host
+	var newHost models.Host = reqBody.Host
 	hostExists := false
 	// re-register host with turn just in case.
 	if servercfg.IsUsingTurn() {
@@ -205,7 +208,23 @@ func handleHostRegister(w http.ResponseWriter, r *http.Request) {
 	hostPass := newHost.HostPass
 	if !hostExists {
 		// register host
-		logic.CheckHostPorts(&newHost)
+		if slices.Contains(reqBody.CustomParams, models.HostRegisterCustomParamListenPort) {
+			slog.Info("checking custom host port", "port", newHost.ListenPort)
+			isPortInUse, err := logic.CheckHostPorts(&newHost, false)
+			if err != nil {
+				slog.Error("failed to check host port", "error", err)
+				logic.ReturnErrorResponse(w, r, logic.FormatError(err, "internal"))
+				return
+			}
+			if isPortInUse {
+				slog.Error("port is already in use", "port", newHost.ListenPort)
+				logic.ReturnErrorResponse(w, r, logic.FormatError(fmt.Errorf("port %d is already in use", newHost.ListenPort), "badrequest"))
+				return
+			}
+		} else {
+			slog.Info("no custom host port set. attempting to use", "port", newHost.ListenPort)
+			logic.CheckHostPorts(&newHost, true)
+		}
 		// create EMQX credentials and ACLs for host
 		if servercfg.GetBrokerType() == servercfg.EmqxBrokerType {
 			if err := mq.CreateEmqxUser(newHost.ID.String(), newHost.HostPass, false); err != nil {

controllers/migrate.go

@@ -62,7 +62,7 @@ func migrate(w http.ResponseWriter, r *http.Request) {
 		return
 	}
 	if !logic.HostExists(&data.NewHost) {
-		logic.CheckHostPorts(&data.NewHost)
+		logic.CheckHostPorts(&data.NewHost, true)
 		if err = logic.CreateHost(&data.NewHost); err != nil {
 			logic.ReturnErrorResponse(w, r, logic.FormatError(err, "badrequest"))
 			return

logic/host_test.go

@@ -46,18 +46,32 @@ func TestCheckPorts(t *testing.T) {
 	CreateHost(&h)
 	t.Run("no change", func(t *testing.T) {
 		is := is.New(t)
-		CheckHostPorts(&testHost)
+		CheckHostPorts(&testHost, true)
+		t.Log(testHost.ListenPort)
+		t.Log(h.ListenPort)
+		is.Equal(testHost.ListenPort, 51830)
+	})
+	t.Run("no change with assign=false", func(t *testing.T) {
+		is := is.New(t)
+		CheckHostPorts(&testHost, false)
 		t.Log(testHost.ListenPort)
 		t.Log(h.ListenPort)
 		is.Equal(testHost.ListenPort, 51830)
 	})
 	t.Run("same listen port", func(t *testing.T) {
 		is := is.New(t)
 		testHost.ListenPort = 51821
-		CheckHostPorts(&testHost)
+		CheckHostPorts(&testHost, true)
 		t.Log(testHost.ListenPort)
 		t.Log(h.ListenPort)
 		is.Equal(testHost.ListenPort, 51822)
 	})
-
+	t.Run("no change for same listen port with assign=false", func(t *testing.T) {
+		is := is.New(t)
+		testHost.ListenPort = 51821
+		CheckHostPorts(&testHost, false)
+		t.Log(testHost.ListenPort)
+		t.Log(h.ListenPort)
+		is.Equal(testHost.ListenPort, 51821)
+	})
 }

logic/hosts.go

@@ -480,11 +480,11 @@ func GetRelatedHosts(hostID string) []models.Host {
 // CheckHostPort checks host endpoints to ensures that hosts on the same server
 // with the same endpoint have different listen ports
 // in the case of 64535 hosts or more with same endpoint, ports will not be changed
-func CheckHostPorts(h *models.Host) {
+func CheckHostPorts(h *models.Host, assignPort bool) (bool, error) {
 	portsInUse := make(map[int]bool, 0)
 	hosts, err := GetAllHosts()
 	if err != nil {
-		return
+		return false, err
 	}
 	for _, host := range hosts {
 		if host.ID.String() == h.ID.String() {
@@ -496,14 +496,17 @@ func CheckHostPorts(h *models.Host) {
 		}
 		portsInUse[host.ListenPort] = true
 	}
+	if !assignPort {
+		return portsInUse[h.ListenPort], nil
+	}
 	// iterate until port is not found or max iteration is reached
 	for i := 0; portsInUse[h.ListenPort] && i < maxPort-minPort+1; i++ {
 		h.ListenPort++
 		if h.ListenPort > maxPort {
 			h.ListenPort = minPort
 		}
 	}
-
+	return false, nil
 }
 
 // HostExists - checks if given host already exists

models/host.go

@@ -146,11 +146,25 @@ type Signal struct {
 	TimeStamp         int64        `json:"timestamp"`
 }
 
-// RegisterMsg - login message struct for hosts to join via SSO login
-type RegisterMsg struct {
-	RegisterHost Host   `json:"host"`
-	Network      string `json:"network,omitempty"`
-	User         string `json:"user,omitempty"`
-	Password     string `json:"password,omitempty"`
-	JoinAll      bool   `json:"join_all,omitempty"`
+// HostRegisterNonTokenReqDto - login message struct for hosts to join via SSO login
+type HostRegisterNonTokenReqDto struct {
+	RegisterHost Host                       `json:"host"`
+	Network      string                     `json:"network,omitempty"`
+	User         string                     `json:"user,omitempty"`
+	Password     string                     `json:"password,omitempty"`
+	JoinAll      bool                       `json:"join_all,omitempty"`
+	CustomParams []HostRegisterCustomParams `json:"customParams"`
+}
+
+// HostRegisterCustomParams - enum for host registration custom params
+type HostRegisterCustomParams int
+
+const (
+	HostRegisterCustomParamEndpointIp HostRegisterCustomParams = iota // EnumIndex = 0
+	HostRegisterCustomParamListenPort
+)
+
+type HostRegisterReqDto struct {
+	Host         Host                       `json:"host"`
+	CustomParams []HostRegisterCustomParams `json:"customParams"`
 }