Do value encoding in EncodeValues, add tests (#52)

Co-authored-by: Marcus Sorensen <[email protected]>

Author: Marcus Sorensen

cloudstack/cloudstack.go

@@ -465,16 +465,15 @@ func (cs *CloudStackClient) newRawRequest(api string, post bool, params url.Valu
 	params.Set("response", "json")
 
 	// Generate signature for API call
-	// * Serialize parameters, URL encoding only values and sort them by key, done by encodeValues
+	// * Serialize parameters, URL encoding only values and sort them by key, done by EncodeValues
 	// * Convert the entire argument string to lowercase
 	// * Replace all instances of '+' to '%20'
 	// * Calculate HMAC SHA1 of argument string with CloudStack secret
 	// * URL encode the string and convert to base64
-	s := encodeValues(params)
+	s := EncodeValues(params)
 	s2 := strings.ToLower(s)
-	s3 := strings.Replace(s2, "+", "%20", -1)
 	mac := hmac.New(sha1.New, []byte(cs.secret))
-	mac.Write([]byte(s3))
+	mac.Write([]byte(s2))
 	signature := base64.StdEncoding.EncodeToString(mac.Sum(nil))
 
 	var err error
@@ -523,7 +522,7 @@ func (cs *CloudStackClient) newRawRequest(api string, post bool, params url.Valu
 
 // Custom version of net/url Encode that only URL escapes values
 // Unmodified portions here remain under BSD license of The Go Authors: https://go.googlesource.com/go/+/master/LICENSE
-func encodeValues(v url.Values) string {
+func EncodeValues(v url.Values) string {
 	if v == nil {
 		return ""
 	}
@@ -541,7 +540,12 @@ func encodeValues(v url.Values) string {
 				buf.WriteByte('&')
 			}
 			buf.WriteString(prefix)
-			buf.WriteString(url.QueryEscape(v))
+			escaped := url.QueryEscape(v)
+			// we need to ensure + (representing a space) is encoded as %20
+			escaped = strings.Replace(escaped, "+", "%20", -1)
+			// we need to ensure * is not escaped
+			escaped = strings.Replace(escaped, "%2A", "*", -1)
+			buf.WriteString(escaped)
 		}
 	}
 	return buf.String()

generate/generate.go

@@ -532,16 +532,15 @@ func (as *allServices) GeneralCode() ([]byte, error) {
 	pn("	params.Set(\"response\", \"json\")")
 	pn("")
 	pn("	// Generate signature for API call")
-	pn("	// * Serialize parameters, URL encoding only values and sort them by key, done by encodeValues")
+	pn("	// * Serialize parameters, URL encoding only values and sort them by key, done by EncodeValues")
 	pn("	// * Convert the entire argument string to lowercase")
 	pn("	// * Replace all instances of '+' to '%%20'")
 	pn("	// * Calculate HMAC SHA1 of argument string with CloudStack secret")
 	pn("	// * URL encode the string and convert to base64")
-	pn("	s := encodeValues(params)")
+	pn("	s := EncodeValues(params)")
 	pn("	s2 := strings.ToLower(s)")
-	pn("	s3 := strings.Replace(s2, \"+\", \"%%20\", -1)")
 	pn("	mac := hmac.New(sha1.New, []byte(cs.secret))")
-	pn("	mac.Write([]byte(s3))")
+	pn("	mac.Write([]byte(s2))")
 	pn("	signature := base64.StdEncoding.EncodeToString(mac.Sum(nil))")
 	pn("")
 	pn("	var err error")
@@ -590,7 +589,7 @@ func (as *allServices) GeneralCode() ([]byte, error) {
 	pn("")
 	pn("// Custom version of net/url Encode that only URL escapes values")
 	pn("// Unmodified portions here remain under BSD license of The Go Authors: https://go.googlesource.com/go/+/master/LICENSE")
-	pn("func encodeValues(v url.Values) string {")
+	pn("func EncodeValues(v url.Values) string {")
 	pn("	if v == nil {")
 	pn("		return \"\"")
 	pn("	}")
@@ -608,7 +607,12 @@ func (as *allServices) GeneralCode() ([]byte, error) {
 	pn("				buf.WriteByte('&')")
 	pn("			}")
 	pn("			buf.WriteString(prefix)")
-	pn("			buf.WriteString(url.QueryEscape(v))")
+	pn("			escaped := url.QueryEscape(v)")
+	pn("			// we need to ensure + (representing a space) is encoded as %%20")
+	pn("			escaped = strings.Replace(escaped, \"+\", \"%%20\", -1)")
+	pn("			// we need to ensure * is not escaped")
+	pn("			escaped = strings.Replace(escaped, \"%%2A\", \"*\", -1)")
+	pn("			buf.WriteString(escaped)")
 	pn("		}")
 	pn("	}")
 	pn("	return buf.String()")

go.mod

@@ -2,4 +2,20 @@ module github.com/apache/cloudstack-go/v2
 
 go 1.17
 
-require github.com/golang/mock v1.6.0
+require (
+	github.com/golang/mock v1.6.0
+	github.com/onsi/ginkgo/v2 v2.9.1
+	github.com/onsi/gomega v1.27.4
+)
+
+require (
+	github.com/go-logr/logr v1.2.3 // indirect
+	github.com/go-task/slim-sprig v0.0.0-20210107165309-348f09dbbbc0 // indirect
+	github.com/google/go-cmp v0.5.9 // indirect
+	github.com/google/pprof v0.0.0-20210407192527-94a9f03dee38 // indirect
+	golang.org/x/net v0.8.0 // indirect
+	golang.org/x/sys v0.6.0 // indirect
+	golang.org/x/text v0.8.0 // indirect
+	golang.org/x/tools v0.7.0 // indirect
+	gopkg.in/yaml.v3 v3.0.1 // indirect
+)