]> Cypherpunks repositories - gostls13.git/commitdiff
encoding/json: revert Compact HTML escaping documentation
authorTom Thorogood <me+google@tomthorogood.co.uk>
Fri, 2 Aug 2019 07:53:44 +0000 (07:53 +0000)
committerDaniel Martí <mvdan@mvdan.cc>
Sun, 1 Sep 2019 16:43:30 +0000 (16:43 +0000)
This partly reverts CL 173417 as it incorrectly documented that Compact
performed HTML escaping and the output was safe to embed inside HTML
<script> tags. This has never been true.

Although Compact does escape U+2028 and U+2029, it doesn't escape <, >
or &. Compact is thus only performing a subset of HTML escaping and it's
output is not safe to embed inside HTML <script> tags.

A more complete fix would be for Compact to either never perform any
HTML escaping, as it was prior to CL 10883045, or to actually perform
the same HTML escaping as HTMLEscape. Neither change is likely safe
enough for go1.13.

Updates #30357

Change-Id: I912f0fe9611097d988048b28228c4a5b985080ba
GitHub-Last-Rev: aebababc9233c5705785b225377e80096d4bb8c4
GitHub-Pull-Request: golang/go#33427
Reviewed-on: https://go-review.googlesource.com/c/go/+/188717
Reviewed-by: Daniel Martí <mvdan@mvdan.cc>
Run-TryBot: Daniel Martí <mvdan@mvdan.cc>
TryBot-Result: Gobot Gobot <gobot@golang.org>

src/encoding/json/indent.go

index 1b49a369e3337def391dedd4df1e6a437e8bfee0..fba19548c92721d2f2fb0c63dd3accaa8a3077d3 100644 (file)
@@ -8,9 +8,6 @@ import "bytes"
 
 // Compact appends to dst the JSON-encoded src with
 // insignificant space characters elided.
-// Like Marshal, Compact applies HTMLEscape to any
-// string literals so that the JSON will be safe to embed
-// inside HTML <script> tags.
 func Compact(dst *bytes.Buffer, src []byte) error {
        return compact(dst, src, false)
 }