dns/dnsmessage: document that Skip does not fully validate the header

The Skip methods do not fully validate the name in header, the compression pointers are not followed Change-Id: If34a041d799a22117afac9bd23e76606f5d0c8f7 GitHub-Last-Rev: f8f2586 GitHub-Pull-Request: #196 Reviewed-on: https://go-review.googlesource.com/c/net/+/534175 LUCI-TryBot-Result: Go LUCI <[email protected]> Reviewed-by: Ian Lance Taylor <[email protected]> Reviewed-by: Damien Neil <[email protected]> Auto-Submit: Ian Lance Taylor <[email protected]>
golang · Oct 11, 2023 · 92728b3 · 92728b3
1 parent b225e7c
commit 92728b3
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/dns/dnsmessage/message.go b/dns/dnsmessage/message.go
@@ -751,6 +751,9 @@ func (p *Parser) AllAnswers() ([]Resource, error) {
 }
 
 // SkipAnswer skips a single Answer Resource.
+//
+// It does not perform a complete validation of the resource header, which means
+// it may return a nil error when the [AnswerHeader] would actually return an error.
 func (p *Parser) SkipAnswer() error {
 	return p.skipResource(sectionAnswers)
 }
@@ -801,6 +804,9 @@ func (p *Parser) AllAuthorities() ([]Resource, error) {
 }
 
 // SkipAuthority skips a single Authority Resource.
+//
+// It does not perform a complete validation of the resource header, which means
+// it may return a nil error when the [AuthorityHeader] would actually return an error.
 func (p *Parser) SkipAuthority() error {
 	return p.skipResource(sectionAuthorities)
 }
@@ -851,6 +857,9 @@ func (p *Parser) AllAdditionals() ([]Resource, error) {
 }
 
 // SkipAdditional skips a single Additional Resource.
+//
+// It does not perform a complete validation of the resource header, which means
+// it may return a nil error when the [AdditionalHeader] would actually return an error.
 func (p *Parser) SkipAdditional() error {
 	return p.skipResource(sectionAdditionals)
 }