private/protocol/xml/xmlutil: Updated XML encoding to ensure line fee…

…d is escaped.
aws · Apr 26, 2021 · e2224a6 · e2224a6
1 parent 92c4507
commit e2224a6
Show file tree

Hide file tree

Showing 2 changed files with 36 additions and 17 deletions.
diff --git a/private/protocol/xml/xmlutil/build_test.go b/private/protocol/xml/xmlutil/build_test.go
@@ -153,6 +153,12 @@ func TestBuildXML(t *testing.T) {
 			Input:  &namedEmptyPayload{},
 			Expect: "<namedEmptyPayload></namedEmptyPayload>",
 		},
+		"escape line feed and carriage return": {
+			Input: &implicitPayload{
+				StrVal: aws.String("this\nstring\rhas\r\nescapable\n\rcharacters"),
+			},
+			Expect: "<StrVal>this&#xA;string&#xD;has&#xD;&#xA;escapable&#xA;&#xD;characters</StrVal>",
+		},
 	}
 
 	for name, c := range cases {

diff --git a/private/protocol/xml/xmlutil/xml_to_struct.go b/private/protocol/xml/xmlutil/xml_to_struct.go
@@ -18,6 +18,14 @@ type XMLNode struct {
 	parent     *XMLNode
 }
 
+// textEncoder is a string type alias that implemnts the TextMarshaler interface.
+// This alias type is used to ensure that the line feed (\n) (U+000A) is escaped.
+type textEncoder string
+
+func (t textEncoder) MarshalText() (text []byte, err error) {
+	return []byte(t), nil
+}
+
 // NewXMLElement returns a pointer to a new XMLNode initialized to default values.
 func NewXMLElement(name xml.Name) *XMLNode {
 	return &XMLNode{
@@ -130,30 +138,35 @@ func StructToXML(e *xml.Encoder, node *XMLNode, sorted bool) error {
 		attrs = sortedAttrs
 	}
 
-	e.EncodeToken(xml.StartElement{Name: node.Name, Attr: attrs})
+	startElement := xml.StartElement{Name: node.Name, Attr: attrs}
 
 	if node.Text != "" {
-		e.EncodeToken(xml.CharData([]byte(node.Text)))
-	} else if sorted {
-		sortedNames := []string{}
-		for k := range node.Children {
-			sortedNames = append(sortedNames, k)
-		}
-		sort.Strings(sortedNames)
+		e.EncodeElement(textEncoder(node.Text), startElement)
+	} else {
+		e.EncodeToken(startElement)
 
-		for _, k := range sortedNames {
-			for _, v := range node.Children[k] {
-				StructToXML(e, v, sorted)
+		if sorted {
+			sortedNames := []string{}
+			for k := range node.Children {
+				sortedNames = append(sortedNames, k)
 			}
-		}
-	} else {
-		for _, c := range node.Children {
-			for _, v := range c {
-				StructToXML(e, v, sorted)
+			sort.Strings(sortedNames)
+
+			for _, k := range sortedNames {
+				for _, v := range node.Children[k] {
+					StructToXML(e, v, sorted)
+				}
+			}
+		} else {
+			for _, c := range node.Children {
+				for _, v := range c {
+					StructToXML(e, v, sorted)
+				}
 			}
 		}
+
+		e.EncodeToken(xml.EndElement{Name: node.Name})
 	}
 
-	e.EncodeToken(xml.EndElement{Name: node.Name})
 	return e.Flush()
 }