golang/go

x/tools/go/analysis/structtag: stricter JSON tag checking

Open

#74,376 建立於 2025年6月25日

在 GitHub 查看
 (6 留言) (11 反應) (0 負責人)Go (133,883 star) (19,008 fork)batch import
AnalysisProposalProposal-Acceptedhelp wanted

描述

Background: This recent article https://blog.trailofbits.com/2025/06/17/unexpected-security-footguns-in-gos-parsers/ describes (among other things) a number of security weaknesses in Go's encoding/json package. Some of these could be mitigated by better static checking of struct field tags; indeed, the author of the post links to two semgrep rules that enforce these checks. Specifically:

  • semgrep -c r/trailofbits.go.unmarshal-tag-is-dash
  • semgrep -c r/trailofbits.go.unmarshal-tag-is-omitempty

Proposal: Let's add these two checks to the structtag analyzer so that users get immediate feedback in their LSP-enabled editor, and whenever they run go vet.

貢獻者指南

技術棧
go
領域
securitytooling
議題類型
feature
難度面向新貢獻者的預計實作難度，1 表示很小改動，5 表示專家級工作。
3
預計時間有經驗貢獻者完成調查、實作、測試並準備 pull request 的粗略時間範圍。
half day
活動狀態議題目前的可參與程度：新鮮、活躍、陳舊、阻塞或等待維護者輸入。
fresh
清晰度議題是否清楚說明預期改動、驗收標準和下一步。
clear
前置要求
Gogo/analysisstruct tagsencoding/json
新手友善度1-100 的估計分數，表示該議題對首次貢獻者的友善程度。
60
研究方向
Start by reading the referenced Trail of Bits blog post and the two semgrep rules to understand the desired checks. Then examine the existing structtag analyzer in golang.org/x/tools/go/analysis/passes/structtag to see its structure and how it reports issues. The implementation should add two new checks that detect JSON tags set to ' ' in Unmarshal contexts and missing 'omitempty' on fields that could cause security issues. Check the issue comments for any maintainer guidance.