[GH-ISSUE #1643] proto docs: clarify that SIG is also used for RRSIG at the top of docs #721

New issue

Open

opened 2026-03-15 23:58:17 +03:00 by kerem · 1 comment

kerem commented

2026-03-15 23:58:17 +03:00

Owner

Originally created by @firstdorsal on GitHub (Feb 20, 2022).
Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1643

Currently, one has to scroll far down (to the new() method) to find out that SIG is also used for RRSIG. This is therefore easy to overlook.

My suggestion would be to state this already in the top-level documentation for the SIG type, i.e. near the

NOTE: RFC 2535 was obsoleted with 4034+ ...

See e.g. https://docs.rs/trust-dns-proto/0.21.0-alpha.5/trust_dns_proto/rr/dnssec/rdata/sig/struct.SIG.html for how it currently looks.

Originally created by @firstdorsal on GitHub (Feb 20, 2022). Original GitHub issue: https://github.com/hickory-dns/hickory-dns/issues/1643 Currently, one has to scroll far down (to the `new()` method) to find out that `SIG` is also used for `RRSIG`. This is therefore easy to overlook. My suggestion would be to state this already in the top-level documentation for the `SIG` type, i.e. near the > NOTE: RFC 2535 was obsoleted with 4034+ ... See e.g. https://docs.rs/trust-dns-proto/0.21.0-alpha.5/trust_dns_proto/rr/dnssec/rdata/sig/struct.SIG.html for how it currently looks.

kerem added the

crate:proto

docs

labels

2026-03-15 23:58:17 +03:00

kerem commented

2026-03-15 23:58:28 +03:00

Author

Owner

@bluejekyll commented on GitHub (Feb 20, 2022):

The challenge with the SIG type is that it is only deprecated for DNSSEC usage, but is still used for SIG0 signing with dynamic-DNS.

So we need to make sure that’s clear in the docs. Definitely worth a review. We could alias SIG in RRSIG as well, not sure of that would help.

@bluejekyll commented on GitHub (Feb 20, 2022): The challenge with the SIG type is that it is only deprecated for DNSSEC usage, but is still used for SIG0 signing with dynamic-DNS. So we need to make sure that’s clear in the docs. Definitely worth a review. We could alias SIG in RRSIG as well, not sure of that would help.

kerem referenced this issue

2026-03-16 02:17:04 +03:00

[PR #721] [CLOSED] Create a parser state #1632