fix: add check listen address

Signed-off-by: Zixuan Liu <nodeces@gmail.com>

Author: nodece

config.go

@@ -16,11 +16,16 @@ type Config struct {
 	JoinAddress string
 	// DataDir holds raft data.
 	DataDir string
-	// ListenAddress is a network address for raft server and HTTP server.
+	// ListenAddress is a network address for raft server and HTTP(S) server,
+	// the address is a specified address, such as 10.1.1.19:6780.
 	ListenAddress string
 	// TLSConfig is used to configure a TLS server and client.
-	// You have to provide a peer certificate.
-	// We recommend using cfssl tool to create this certificates.
+	// If TLSConfig is not nil, we will set TLSConfig to the raft server and the HTTPS server,
+	// otherwise we will start a server without any security.
+	//
+	// Note:
+	// You have to provide a peer certificate when TLSConfig is not nil,
+	// we recommend using cfssl tool to create this certificates.
 	TLSConfig *tls.Config
 	// RaftConfig provides any necessary configuration for the Raft server.
 	RaftConfig *raft.Config

dispatcher.go

@@ -3,6 +3,7 @@ package hraftdispatcher
 import (
 	"context"
 	"crypto/tls"
+	"fmt"
 	"github.com/soheilhy/cmux"
 	"net"
 
@@ -53,8 +54,20 @@ func NewHRaftDispatcher(config *Config) (*HRaftDispatcher, error) {
 
 	logger := zap.NewExample()
 
+	// check ListenAddress is network address
+	listenAddress, err := net.ResolveTCPAddr("tcp", config.ListenAddress)
+	if err != nil {
+		return nil, err
+	}
+	if listenAddress.IP == nil {
+		return nil, errors.New("host is omitted in ListenAddress")
+	}
+	ip := net.ParseIP(listenAddress.IP.String())
+	if ip != nil && ip.IsUnspecified() {
+		return nil, fmt.Errorf("cannot use unspecified IP %s", ip)
+	}
+
 	var ln net.Listener
-	var err error
 	if config.TLSConfig == nil {
 		ln, err = net.Listen("tcp", config.ListenAddress)
 	} else {
@@ -71,7 +84,6 @@ func NewHRaftDispatcher(config *Config) (*HRaftDispatcher, error) {
 
 	streamLayer, err := store.NewTCPStreamLayer(raftLn, config.TLSConfig)
 	if err != nil {
-		logger.Error(err.Error())
 		return nil, err
 	}
 

dispatcher_test.go

@@ -3,6 +3,7 @@ package hraftdispatcher
 import (
 	"crypto/tls"
 	"crypto/x509"
+	"github.com/casbin/hraft-dispatcher/store/mocks"
 	"io/ioutil"
 	"os"
 	"testing"
@@ -529,3 +530,27 @@ m = g(r.sub, p.sub) && r.obj == p.obj && r.act == p.act
 
 	return e, dispatcher, nil
 }
+
+func TestNewHRaftDispatcher(t *testing.T) {
+	_, err := NewHRaftDispatcher(&Config{
+		Enforcer:      &mocks.MockIDistributedEnforcer{},
+		ServerID:      "test",
+		JoinAddress:   "",
+		DataDir:       "/tmp/hraft-dispatcher",
+		ListenAddress: ":6780",
+		TLSConfig:     nil,
+		RaftConfig:    nil,
+	})
+	assert.EqualError(t, err, "host is omitted in ListenAddress")
+
+	_, err = NewHRaftDispatcher(&Config{
+		Enforcer:      &mocks.MockIDistributedEnforcer{},
+		ServerID:      "test",
+		JoinAddress:   "",
+		DataDir:       "/tmp/hraft-dispatcher",
+		ListenAddress: "0.0.0.0:6780",
+		TLSConfig:     nil,
+		RaftConfig:    nil,
+	})
+	assert.EqualError(t, err, "cannot use unspecified IP 0.0.0.0")
+}