mirror of
https://github.com/golang/go
synced 2024-11-24 22:57:57 -07:00
exp/template/html: normalize '<' in text and RCDATA nodes.
The template <{{.}} would violate the structure preservation property if allowed and not normalized, because when {{.}} emitted "", the "<" would be part of a text node, but if {{.}} emitted "a", the "<" would not be part of a text node. This change rewrites '<' in text nodes and RCDATA text nodes to '<' allowing template authors to write the common, and arguably more readable: Your price: {{.P1}} < list price {{.P2}} while preserving the structure preservation property. It also lays the groundwork for comment elision, rewriting Foo <!-- comment with secret project details --> Bar to Foo Bar R=nigeltao CC=golang-dev https://golang.org/cl/5043043
This commit is contained in:
parent
e213a0c0fc
commit
52a46bb773
@ -100,12 +100,12 @@ type escaper struct {
|
||||
derived map[string]*template.Template
|
||||
// called[templateName] is a set of called mangled template names.
|
||||
called map[string]bool
|
||||
// actionNodeEdits and templateNodeEdits are the accumulated edits to
|
||||
// apply during commit. Such edits are not applied immediately in case
|
||||
// a template set executes a given template in different escaping
|
||||
// contexts.
|
||||
// xxxNodeEdits are the accumulated edits to apply during commit.
|
||||
// Such edits are not applied immediately in case a template set
|
||||
// executes a given template in different escaping contexts.
|
||||
actionNodeEdits map[*parse.ActionNode][]string
|
||||
templateNodeEdits map[*parse.TemplateNode]string
|
||||
textNodeEdits map[*parse.TextNode][]byte
|
||||
}
|
||||
|
||||
// newEscaper creates a blank escaper for the given set.
|
||||
@ -117,6 +117,7 @@ func newEscaper(s *template.Set) *escaper {
|
||||
map[string]bool{},
|
||||
map[*parse.ActionNode][]string{},
|
||||
map[*parse.TemplateNode]string{},
|
||||
map[*parse.TextNode][]byte{},
|
||||
}
|
||||
}
|
||||
|
||||
@ -141,7 +142,7 @@ func (e *escaper) escape(c context, n parse.Node) context {
|
||||
case *parse.TemplateNode:
|
||||
return e.escapeTemplate(c, n)
|
||||
case *parse.TextNode:
|
||||
return e.escapeText(c, n.Text)
|
||||
return e.escapeText(c, n)
|
||||
case *parse.WithNode:
|
||||
return e.escapeBranch(c, &n.BranchNode, "with")
|
||||
}
|
||||
@ -386,6 +387,9 @@ func (e *escaper) escapeListConditionally(c context, n *parse.ListNode, filter f
|
||||
for k, v := range e1.templateNodeEdits {
|
||||
e.editTemplateNode(k, v)
|
||||
}
|
||||
for k, v := range e1.textNodeEdits {
|
||||
e.editTextNode(k, v)
|
||||
}
|
||||
}
|
||||
return c, ok
|
||||
}
|
||||
@ -493,11 +497,35 @@ var delimEnds = [...]string{
|
||||
}
|
||||
|
||||
// escapeText escapes a text template node.
|
||||
func (e *escaper) escapeText(c context, s []byte) context {
|
||||
func (e *escaper) escapeText(c context, n *parse.TextNode) context {
|
||||
s, written := n.Text, 0
|
||||
var b bytes.Buffer
|
||||
for len(s) > 0 {
|
||||
c1, s1 := contextAfterText(c, s)
|
||||
if c.state == c1.state && (c.state == stateText || c.state == stateRCDATA) {
|
||||
i0, i1 := len(n.Text)-len(s), len(n.Text)-len(s1)
|
||||
for i := i0; i < i1; i++ {
|
||||
if n.Text[i] == '<' {
|
||||
b.Write(n.Text[written:i])
|
||||
b.WriteString("<")
|
||||
written = i + 1
|
||||
}
|
||||
}
|
||||
}
|
||||
c, s = c1, s1
|
||||
}
|
||||
if written != 0 && c.state != stateError {
|
||||
b.Write(n.Text[written:])
|
||||
e.editTextNode(n, b.Bytes())
|
||||
}
|
||||
return c
|
||||
}
|
||||
|
||||
// contextAfterText starts in context c, consumes some tokens from the front of
|
||||
// s, then returns the context after those tokens and the unprocessed suffix.
|
||||
func contextAfterText(c context, s []byte) (context, []byte) {
|
||||
if c.delim == delimNone {
|
||||
c, s = transitionFunc[c.state](c, s)
|
||||
continue
|
||||
return transitionFunc[c.state](c, s)
|
||||
}
|
||||
|
||||
i := bytes.IndexAny(s, delimEnds[c.delim])
|
||||
@ -506,13 +534,10 @@ func (e *escaper) escapeText(c context, s []byte) context {
|
||||
// Decode the value so non-HTML rules can easily handle
|
||||
// <button onclick="alert("Hi!")">
|
||||
// without having to entity decode token boundaries.
|
||||
d := c.delim
|
||||
c.delim = delimNone
|
||||
c = e.escapeText(c, []byte(html.UnescapeString(string(s))))
|
||||
if c.state != stateError {
|
||||
c.delim = d
|
||||
for u := []byte(html.UnescapeString(string(s))); len(u) != 0; {
|
||||
c, u = transitionFunc[c.state](c, u)
|
||||
}
|
||||
return c
|
||||
return c, nil
|
||||
}
|
||||
if c.delim != delimSpaceOrTagEnd {
|
||||
// Consume any quote.
|
||||
@ -520,9 +545,7 @@ func (e *escaper) escapeText(c context, s []byte) context {
|
||||
}
|
||||
// On exiting an attribute, we discard all state information
|
||||
// except the state and element.
|
||||
c, s = context{state: stateTag, element: c.element}, s[i:]
|
||||
}
|
||||
return c
|
||||
return context{state: stateTag, element: c.element}, s[i:]
|
||||
}
|
||||
|
||||
// editActionNode records a change to an action pipeline for later commit.
|
||||
@ -541,6 +564,14 @@ func (e *escaper) editTemplateNode(n *parse.TemplateNode, callee string) {
|
||||
e.templateNodeEdits[n] = callee
|
||||
}
|
||||
|
||||
// editTextNode records a change to a text node for later commit.
|
||||
func (e *escaper) editTextNode(n *parse.TextNode, text []byte) {
|
||||
if _, ok := e.textNodeEdits[n]; ok {
|
||||
panic(fmt.Sprintf("node %s shared between templates", n))
|
||||
}
|
||||
e.textNodeEdits[n] = text
|
||||
}
|
||||
|
||||
// commit applies changes to actions and template calls needed to contextually
|
||||
// autoescape content and adds any derived templates to the set.
|
||||
func (e *escaper) commit() {
|
||||
@ -556,6 +587,9 @@ func (e *escaper) commit() {
|
||||
for n, name := range e.templateNodeEdits {
|
||||
n.Name = name
|
||||
}
|
||||
for n, s := range e.textNodeEdits {
|
||||
n.Text = s
|
||||
}
|
||||
}
|
||||
|
||||
// template returns the named template given a mangled template name.
|
||||
|
@ -396,6 +396,21 @@ func TestEscape(t *testing.T) {
|
||||
"{{range .A}}{{. | noescape}}{{end}}",
|
||||
"<a><b>",
|
||||
},
|
||||
{
|
||||
"No tag injection",
|
||||
`{{"10$"}}<{{"script src,evil.org/pwnd.js"}}...`,
|
||||
`10$<script src,evil.org/pwnd.js...`,
|
||||
},
|
||||
{
|
||||
"No comment injection",
|
||||
`<{{"!--"}}`,
|
||||
`<!--`,
|
||||
},
|
||||
{
|
||||
"No RCDATA end tag injection",
|
||||
`<textarea><{{"/textarea "}}...</textarea>`,
|
||||
`<textarea></textarea ...</textarea>`,
|
||||
},
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
@ -1136,8 +1151,8 @@ func TestEscapeText(t *testing.T) {
|
||||
}
|
||||
|
||||
for _, test := range tests {
|
||||
b, e := []byte(test.input), escaper{}
|
||||
c := e.escapeText(context{}, b)
|
||||
b, e := []byte(test.input), newEscaper(nil)
|
||||
c := e.escapeText(context{}, &parse.TextNode{parse.NodeText, b})
|
||||
if !test.output.eq(c) {
|
||||
t.Errorf("input %q: want context\n\t%v\ngot\n\t%v", test.input, test.output, c)
|
||||
continue
|
||||
|
Loading…
Reference in New Issue
Block a user