BUG/MEDIUM: hcl: escape log targets on save

library used for saving hcl data does not escape strings, log targets can contain " char that needs to be escaped

Author: oktalz

configuration/file-storage-hcl.go

@@ -17,8 +17,11 @@ package configuration
 
 import (
 	"io/ioutil"
+	"strings"
 
+	"github.com/haproxytech/dataplaneapi/log"
 	"github.com/hashicorp/hcl"
+	"github.com/jinzhu/copier"
 	"github.com/rodaine/hclencoder"
 )
 
@@ -57,7 +60,48 @@ func (s *StorageHCL) Set(cfg *StorageDataplaneAPIConfiguration) {
 }
 
 func (s *StorageHCL) SaveAs(filename string) error {
-	hcl, err := hclencoder.Encode(s.cfg)
+	var err error
+	var hcl []byte
+	var localCopy StorageDataplaneAPIConfiguration
+	err = copier.Copy(&localCopy, &s.cfg)
+	if err != nil {
+		return err
+	}
+	// check if we have cluster log targets in config file
+	if s.cfg.Cluster != nil && len(s.cfg.Cluster.ClusterLogTargets) > 0 {
+		// since this can contain " character, escape it
+		for index, value := range localCopy.Cluster.ClusterLogTargets {
+			localCopy.Cluster.ClusterLogTargets[index].LogFormat = strings.Replace(value.LogFormat, `"`, `\"`, -1)
+		}
+	}
+	// check if we have cluster log targets in config file
+	if localCopy.Cluster != nil && len(localCopy.Cluster.ClusterLogTargets) > 0 {
+		// since this can contain " character, escape it
+		for index, value := range localCopy.Cluster.ClusterLogTargets {
+			localCopy.Cluster.ClusterLogTargets[index].LogFormat = strings.Replace(value.LogFormat, `"`, `\"`, -1)
+		}
+	}
+	if localCopy.LogTargets != nil && len(*localCopy.LogTargets) > 0 {
+		var logTargets []log.Target
+		for _, value := range *localCopy.LogTargets {
+			value.LogFormat = strings.Replace(value.LogFormat, `"`, `\"`, -1)
+			value.ACLFormat = strings.Replace(value.ACLFormat, `"`, `\"`, -1)
+			logTargets = append(logTargets, value)
+		}
+		localCopy.LogTargets = (*log.Targets)(&logTargets)
+	}
+	if localCopy.Log != nil {
+		if localCopy.Log.ACLFormat != nil {
+			aclF := strings.Replace(*localCopy.Log.ACLFormat, `"`, `\"`, -1)
+			localCopy.Log.ACLFormat = &aclF
+		}
+		if localCopy.Log.LogFormat != nil {
+			logF := strings.Replace(*localCopy.Log.LogFormat, `"`, `\"`, -1)
+			localCopy.Log.LogFormat = &logF
+		}
+	}
+
+	hcl, err = hclencoder.Encode(localCopy)
 	if err != nil {
 		return err
 	}

go.mod

@@ -31,6 +31,7 @@ require (
 	github.com/hashicorp/hcl v1.0.0
 	github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869 // indirect
 	github.com/jessevdk/go-flags v1.4.0
+	github.com/jinzhu/copier v0.3.4
 	github.com/lestrrat-go/apache-logformat v0.0.0-20210106032603-24d066f940f8
 	github.com/lestrrat-go/envload v0.0.0-20180220234015-a3eb8ddeffcc // indirect
 	github.com/nathanaelle/syslog5424/v2 v2.0.5

go.sum

@@ -222,6 +222,8 @@ github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869 h1:IPJ3dvxmJ4uc
 github.com/jehiah/go-strftime v0.0.0-20171201141054-1d33003b3869/go.mod h1:cJ6Cj7dQo+O6GJNiMx+Pa94qKj+TG8ONdKHgMNIyyag=
 github.com/jessevdk/go-flags v1.4.0 h1:4IU2WS7AumrZ/40jfhf4QVDMsQwqA7VEHozFRrGARJA=
 github.com/jessevdk/go-flags v1.4.0/go.mod h1:4FA24M0QyGHXBuZZK/XkWh8h0e1EYbRYJSGM75WSRxI=
+github.com/jinzhu/copier v0.3.4 h1:mfU6jI9PtCeUjkjQ322dlff9ELjGDu975C2p/nrubVI=
+github.com/jinzhu/copier v0.3.4/go.mod h1:DfbEm0FYsaqBcKcFuvmOZb218JkPGtvSHsKg8S8hyyg=
 github.com/jmespath/go-jmespath v0.4.0 h1:BEgLn5cpjn8UN1mAw4NjwDrS35OdebyEtFe+9YPoQUg=
 github.com/jmespath/go-jmespath v0.4.0/go.mod h1:T8mJZnbsbmF+m6zOOFylbeCJqk5+pHWvzYPziyZiYoo=
 github.com/jmespath/go-jmespath/internal/testify v1.5.1 h1:shLQSRRSCCPj3f2gpwzGwWFoC7ycTf1rcQZHOlsJ6N8=