fix: Fix webserver to use ServerBindAddr only is not blank as rest of…

… EdgeX Services closes #775 BREAKING CHANGE: Webserver will be locked down to listen just to `Host` value when If `ServerBindAddr ` is blank Signed-off-by: lenny <[email protected]>
lenny-goodell · Mar 31, 2021 · af5bee8 · af5bee8
1 parent 60c5fe5
commit af5bee8
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 5 deletions.
diff --git a/app-service-template/res/configuration.toml b/app-service-template/res/configuration.toml
@@ -21,6 +21,7 @@ BootTimeout = '30s'
 ClientMonitor = '15s'
 CheckInterval = '10s'
 Host = 'localhost'
+ServerBindAddr = '' # Leave blank so default to Host value unless different value is needed.
 Port = 49600  # TODO: set this port appropriately
 Protocol = 'http'
 ReadMaxLimit = 100

diff --git a/go.mod b/go.mod
@@ -6,7 +6,7 @@ require (
 	bitbucket.org/bertimus9/systemstat v0.0.0-20180207000608-0eeff89b0690
 	github.com/diegoholiveira/jsonlogic v1.0.1-0.20200220175622-ab7989be08b9
 	github.com/eclipse/paho.mqtt.golang v1.3.2
-	github.com/edgexfoundry/go-mod-bootstrap/v2 v2.0.0-dev.27
+	github.com/edgexfoundry/go-mod-bootstrap/v2 v2.0.0-dev.28
 	github.com/edgexfoundry/go-mod-core-contracts/v2 v2.0.0-dev.62
 	github.com/edgexfoundry/go-mod-messaging/v2 v2.0.0-dev.7
 	github.com/edgexfoundry/go-mod-registry/v2 v2.0.0-dev.4

diff --git a/internal/webserver/server.go b/internal/webserver/server.go
@@ -105,10 +105,14 @@ func (webserver *WebServer) StartWebServer(errChannel chan error) {
 
 // Helper function to handle HTTPs or HTTP connection based on the configured protocol
 func listenAndServe(webserver *WebServer, serviceTimeout time.Duration, errChannel chan error) {
-
-	// this allows env overrides to explicitly set the value used
-	// for ListenAndServe, as needed for different deployments
-	addr := fmt.Sprintf("%v:%d", webserver.config.Service.ServerBindAddr, webserver.config.Service.Port)
+	// The Host value is the default bind address value if the ServerBindAddr value is not specified
+	// this allows env overrides to explicitly set the value used for ListenAndServe,
+	// as needed for different deployments
+	bindAddress := webserver.config.Service.Host
+	if len(webserver.config.Service.ServerBindAddr) != 0 {
+		bindAddress = webserver.config.Service.ServerBindAddr
+	}
+	addr := fmt.Sprintf("%s:%d", bindAddress, webserver.config.Service.Port)
 
 	if webserver.config.Service.Protocol == "https" {
 		webserver.lc.Infof("Starting HTTPS Web Server on address %v", addr)