aboutsummaryrefslogtreecommitdiff
path: root/src/encoding/json/decode_test.go
diff options
context:
space:
mode:
authorJoe Tsai <joetsai@digital-static.net>2025-06-21 21:27:09 -0700
committerGopher Robot <gobot@golang.org>2025-06-24 06:41:42 -0700
commit2e9bb62bfed92ef24a6744fbdc3cf24eb672cd56 (patch)
treed9c4a66c873fa306149de87d713d69f4555cc377 /src/encoding/json/decode_test.go
parented7815726db4a0eb904d7cae2532cde48348d7ff (diff)
downloadgo-2e9bb62bfed92ef24a6744fbdc3cf24eb672cd56.tar.xz
encoding/json/v2: reject unquoted dash as a JSON field name
In this blog: https://blog.trailofbits.com/2025/06/17/unexpected-security-footguns-in-gos-parsers/ the concern was raised that whenever "-" is combined with other options, the "-" is intepreted as as a name, rather than an ignored field, which may go contrary to user expectation. Static analysis demonstrates that there are ~2k instances of `json:"-,omitempty" in the wild, where almost all of them intended for the field to be ignored. To prevent this footgun, reject any tags that has "-," as a prefix and warn the user to choose one of the reasonable alternatives. The documentation of json/v2 already suggests `json:"'-'"` as the recommended way to explicitly specify dash as the name. See Example_fieldNames for example usages of the single-quoted literal. Update the v1 json documentation to suggest the same thing. Updates #71497 Change-Id: I7687b6eecdf82a5d894d057c78a4a90af4f5a6e4 Reviewed-on: https://go-review.googlesource.com/c/go/+/683175 LUCI-TryBot-Result: Go LUCI <golang-scoped@luci-project-accounts.iam.gserviceaccount.com> Reviewed-by: Johan Brandhorst-Satzkorn <johan.brandhorst@gmail.com> Reviewed-by: Damien Neil <dneil@google.com> Auto-Submit: Joseph Tsai <joetsai@digital-static.net> Reviewed-by: Daniel Martí <mvdan@mvdan.cc> Reviewed-by: Dmitri Shuralyov <dmitshur@google.com>
Diffstat (limited to 'src/encoding/json/decode_test.go')
-rw-r--r--src/encoding/json/decode_test.go21
1 files changed, 21 insertions, 0 deletions
diff --git a/src/encoding/json/decode_test.go b/src/encoding/json/decode_test.go
index 5bc3d3c856..473fd02833 100644
--- a/src/encoding/json/decode_test.go
+++ b/src/encoding/json/decode_test.go
@@ -1189,6 +1189,27 @@ var unmarshalTests = []struct {
out: []int{1, 2, 0, 4, 5},
err: &UnmarshalTypeError{Value: "bool", Type: reflect.TypeFor[int](), Offset: 9},
},
+
+ {
+ CaseName: Name("DashComma"),
+ in: `{"-":"hello"}`,
+ ptr: new(struct {
+ F string `json:"-,"`
+ }),
+ out: struct {
+ F string `json:"-,"`
+ }{"hello"},
+ },
+ {
+ CaseName: Name("DashCommaOmitEmpty"),
+ in: `{"-":"hello"}`,
+ ptr: new(struct {
+ F string `json:"-,omitempty"`
+ }),
+ out: struct {
+ F string `json:"-,omitempty"`
+ }{"hello"},
+ },
}
func TestMarshal(t *testing.T) {