Breaking changes
New
- Allow AllRecordData’s parsing impls to accept an unsized [u8] as the source octets. (#310 by @xofyarg)
- Made
sign::records::FamilyName
public. (#312 by @achow101)
Bug fixes
- Accept an empty record type bitmap when scanning NSEC/NSEC3 data. (#310 by @xofyarg)
- Fix serialization of ProtoRrsig to conform with RFC 4034. ([#313 by @achow101)
- Add an
?Sized
bound toMessage::is_answer
. (#318 by @xofyarg) - Bring back
MessageBuilder::as_target
. (#318 by @xofyarg) - Bring back
impl FreezeBuilder for StaticCompressor
. (#318 by @xofyarg) sign::records::RecordsIter::skip_before
now stops at the first name in zone even if the apex itself doesn’t appear. (#314 by @achow101)
Unstable features
- New unstable feature
unstable-stelline
for the Stelline testing framework as a “normal” module of domain. (#315) - Renamed the domain name types in
zonetree
fromDname
toName
. (#308)
Other changes
- The minimum Rust version is now 1.78. (#320)
Released 2024-04-30.
Breaking changes
- All types and functions referring to domain names have been changed from
using the term “dname” to just “name.” For instance,
Dname
has becomeName
,ToDname
has becomeToName
, andToDname::to_dname
has becomeToName::to_name
. (#290) - The
ToName
andToRelativeName
traits have been changed to have a pair of methods a latry_to_name
andto_name
for octets builders with limited and unlimited buffers, reflecting the pattern used elsewhere. (#285) - The types for IANA-registered parameters in
base::iana
have been changed from enums to a newtypes around their underlying integer type and associated constants for the registered values. (This was really always the better way to structure this.) (#276, #298) - The
Txt
record data type now rejects empty record data as invalid. As a consequenceTxtBuilder
converts an empty builder into TXT record data consisting of one empty character string which requiresTxtBuilder::finish
to be able to return an error. (#267) Txt
record data serialization has been redesigned. It now serialized as a sequence of character strings. It also deserializes from such a sequence. If supported by the format, it alternatively deserializes from a string that is broken up into 255 octet chunks if necessary. (#268)- The text formatting for
CharStr
has been redesigned. TheDisplay
impl now uses a modified version of the representation format that doesn’t escape white space but also doesn’t enclose the string in quotes. Methods for explicitly formatting in quoted and unquoted presentation format are provided. (#270) - The
validate::RrsigExt
trait now accepts anything that implsAsRef<Record<..>>
to allow the use of smart pointers. (#288 by @hunts) - The stub resolver now uses the new client transports. This doesn’t change how it is used but does change how it queries the configured servers. (#215)
- The sub resolver’s server configuration
Transport
type has been changed to be eitherTransport::UdpTcp
for trying UDP and if that leads to a truncated answer try TCP andTransport::Tcp
for only trying TCP. The stub resolver uses these accordingly now (#296) - Many error types have been changed from enums to structs that hide internal error details. Enums have been kept for errors where distinguishing variants might be meaningful for dealing with the error. (#277)
- Renamed
Dnskey::is_zsk
tois_zone_key
. (#292) - Split RRSIG timestamp handling from
Serial
into a new typerdata::dnssec::Timestamp
. ([#294]) - Upgraded
octseq
to 0.5. (#257) - The minimum Rust version is now 1.70. (#304)
New
- Add impls for
AsRef<RelativeDname<[u8]>>
andBorrow<RelativeDname<[u8]>>
toRelativeDname<_>
. (#251 by @torin-carey) - Added
name::Chain::fmt_with_dots
to format an absolute chained name with a final dot. (#253) - Added a new
ParseAnyRecordData
trait for record data types that can parse any type of record data. (#256) - Added implementations of
OctetsFrom
andDebug
toAllOptData
and the specific options types that didn’t have them yet. (#257) - Added missing ordering impls to
ZoneRecordData
,AllRecordData
,Opt
, andSvcbRdata
. (#293) - Added
Name::reverse_from_addr
that creates a domain name for the reverse lookup of an IP address. (#289) - Added
OptBuilder::clone_from
to replace the OPT record with the content of another OPT record. (#299) - Added
Message::for_slice_ref
that returns aMessage<&[u8]>
. (#300)
Bug fixes
- Fixed the display implementation of
name::Chain<_, _>
. (#253) - Fixed the display implementation of
rdata::Txt<..>
. It now displays each embedded character string separately in quoted form. (#259) - Fixed the extended part returned by
OptRcode::to_parts
(it was shifted by 4 bits too many) and return all 12 bits for theInt
variant inOptRcode::to_int
. (#258) - Fixed a bug in the
inplace
zonefile parser that made it reject character string of length 255. (#284)
Unstable features
- Added the module
net::client
with experimental support for client message transport, i.e., sending of requests and receiving responses as well as caching of responses. This is gated by theunstable-client-transport
feature. (#215,#275) - Added the module
net::server
with experimental support for server transports, processing requests through a middleware chain and a service trait. This is gated by theunstable-server-transport
feature. (#274) - Added the module
zonetree
providing basic traits representing a collection of zones and their data. Thezonetree::in_memory
module provides an in-memory implementation. Thezonetree::parsed
module provides a way to classify RRsets before inserting them into a tree. This is gated by theunstable-zonetree
feature. (#286)
Released 2023-12-29.
Bug fixes
- Fixed various issues preventing building in a no-std environment. (#247 by @dzamlo, #248 by @reitermarkus)
Other changes
- The
resolv
feature now depends onfutures_util
instead offutures
, trimming unused dependencies from the dependency tree. (#246 by @WhyNotHugo)
Released 2023-11-16.
New
- Removed the
Sized
bound for octets types used by thetsig
module. (#241 by @torin-carey) - Added an impl for
AsRef<Message<[u8]>>
for any message. (#242 by @torin-carey)
Bug fixes
- Fixed in scanning absolute domain names from a zonefile that resulted in illegal wire data being produced. (#240 by [@xofyarg)]
Released 2023-10-27.
Bug fixes
- Added missing
?Sized
bounds to the octets type for parsingZoneRecordData
andUnknownRecordData
. (#237 by @hunts)
Released 2023-09-18.
Breaking changes
- Move the
flatten_into
method for converting domain names into a straight, flat form into a newFlattenInto
trait. This trait is only implemented for types that actually are or contain domain names. (#216) - Marked various methods and functions that return values without side
effects as
#[must_use]
. ([#228] by @WhyNotHugo) - Changed the signature of
FoundSrvs::merge
to use a non-mutother
. (#232) - The minimum Rust version is now 1.67. (#235)
New
- Added support for the ZONEMD record type. (#229 by @xofyarg)
- Re-exported the octseq crate as
dep::octseq
. (#230) - Added a blanket impl for mut refs to
Composer
. (#231 by @xofyarg)
Released 2023-09-18
New
- Added a new method
FoundSrvs::into_srvs
that converts the value into an iterator over the found SRV records without resolving them further. (#174, #214 by @WhyNotHugo); this was added in 0.7.2 but missing in 0.8.0) - Added impl of
Borrow<Dname<[u8]>>
andAsRef<Dname<[u8]>>
forDname<_>
. (#219 by [@iximeow}], #225) - Added
Dname::fmt_with_dot
that can be used when wanting to display a domain name with a dot at the end. (#210)
Bug Fixes
- Fixed trait bounds on
FoundSrvs::into_stream
to make it usable again. (#174, [#214 by @WhyNotHugo]; this was fixed in 0.7.2 but missing in 0.8.0) - Fixed scanning of domain names that are just the root label. (#210)
- Fixed
util::base64::SymbolConverter
to also include the final group in the output if there is padding. (#212)
Released 2023-05-12
Breaking Changes
- The minimal required Rust version is now 1.65. (#160)
- The
random
feature has been dropped in favour of usingrand
. (#204) - The generic octets foundation has been moved to a new crate octseq and completely revamped with Generic Associated Types stabilized in Rust 1.65. This required changes all over the code but, hopefully, should result in relatively few changes when using the crate. (#160)
- The range, slice, and split methods on the domain name types have changed.
They have been merge into a single method taking ranges – except for those
on
Dname
that require type changes. The split methods now take references and don’t changeself
anymore. (#160) - The
Parse
,Compose
, andScan
traits have been demoted to mere extension traits for foreign types (primarily the built-in integers, so that you can do things likeu16::parse
). All other types now simply have methods matching the patterns. Where generics are necessary, dedicated traits have been added. E.g., there now areParseRecordData
andComposeRecordData
traits that are implemented by all record data types. (#160) - The
Deref
andDerefMut
impls have been removed for most types that had them to follow guidance that they are exclusively for use by pointer types – which none of them are.len
andis_empty
methods have been added where appropriate, additional methods may be added. (#205) - Various functions and methods of the
tsig
module now expect the current time as an argument to allow use of the module in a no-std environment. (#152) - Parsing of representation format and zonefiles has been completely re-written. (#142, based on work in #109 by Martin Fischer)
- All types that wrap an octets sequence only now allow unsized octets
sequence types. They all have an associated function
from_slice
to create a reference to a value wrapping an (unsized) octets slice and methodfor_slice
that converts a&self
into such a reference. Where the latter already existed but returned a value wrapping a&[u8]
(e.g.,Dname<_>
andMessage<_>
, the return type has changed accordingly. (#168) - Removed
CharStr::from_bytes
. UseCharStr::from_octets
instead. (#168) Message::from_octets
now returns a new error typeShortMessage
. (#168)- Dropped
Deref
impls forDname<_>
,RelativeDname<_>
. (#168) - Renamed
opt::KeyTag::new
toopt::KeyTag::from_octets
. (#168) - Renamed
rdata::Txt::try_from_slice
tobuild_from_slice
. (#168) - The
new
method of the following record data types now check whether the wire format representation of the record data is too long and thus returns a result:Tsig<_, _>
,Dnskey<_>
,Rrsig<_, _>
,Ds<_>
,Cdnskey<_>
,Cds<_>
. (#169) - The
new
function forrdata::Null<_>
has been replaced with afrom_octets
andfrom_slice
pair. TheDeref
impl was removed. (#169) - The
rdata::svcb
module has been refactored to work in the same way as other type-length-value constructs. The names of types, methods, and functions have changed both to match the usual nomenclature as well as to match the terms used in the SVCB draft. (#176) - The
base::iana::SvcbParamKey
type has been renamed toSvcParamKey
to match the terms used in the SVCB draft. (#176) - The
TcpKeepalive
option has been changed to use anOption<u16>
as its data and allow for an empty option in accordance with the RFC. (#185) - Renamed the sub-modules of
rdata
that contain record data types to use a name derived from their content rather than their RFC number – with the exception ofrdata::rfc1035
. (#189) - Renamed the sub-modules of
base::opt
that contain option data types to use short-hand names rather than their RFC number. (#190) - TTL values are now using a newtype
base::record::Ttl
that wraps the rawu32
and improves conversions. (#202 by @CrabNejonas) - Changes all option data types to ensure their wire format is at most 65,535 octets long. This requires changing the signatures of some creator functions. Their naming scheme and signatures are also changed to follow the pattern established with record data. (#193)
- Renamed
UnknownOptData::from_octets
tonew
and return a result. (#193) - Completely redesigns DNS cookie options, adding support for standard server cookies introduced in RFC 9018. (#193)
- Change the type of
ExtendedError
’s text toStr<Octs>
and change the return type ofset_text
to()
. (#193) - Changed the type
TcpKeepalive
’s content to a newtypeIdleTimeout
to make it easier to convert to and from durations. (#193) - Changes Padding to just contain the padding octets and drop
PaddingMode
. Instead, the methods onOptBuilder
should be used to add padding. (#193)
New
Display
impls are now available for all EDNS0 options. (#157)- Adds a
FromStr
implementation and related functions toRelativeDname
. (#177) - Add a
Debug
impl tobase::message::Message
so it can be unwrapped etc. (#199) - New methods
make_canonical
onDname
andRelativeDname
that convert the name into its canonical, i.e., lowercase form. Similarly, new methodsToDname::to_canonical_dname
andToRelativeDname::to_canonical_relative_dname
that produce new canonical names. (#200) - Added a
MAX_LEN
constant to various types that wrap length-limited octets sequences. (#201 by @CrabNejonas)
Released 2023-03-02
New
- Added a new method
FoundSrvs::into_srvs
that converts the value into an iterator over the found SRV records without resolving them further. (#174)
Bug Fixes
- Fix trait bounds on
FoundSrvs::into_stream
to make it usable again. (#174)
Released 2022-10-06.
New
- Added a method
flatten_into
to record data types that converts a value with a parsed (and thus possibly compressed) domain name into a one with a normal domain name. (#151 by @xofyarg)
Other Changes
Released 2022-09-15.
Breaking Changes
-
The minimum supported Rust version is now 1.56.1. (#128)
-
The
OctetsBuilder
trait does not requireAsRef<[u8]>
andAsMut<[u8]>
any more. These have been added as explicit trait bounds where needed. In return,Cow<[u8]>
can now be used as an octets builder whereAsMut<[u8]>
is not needed. (#130). -
The
Display
implementation forUncertainDname
now ends an absolute name with a dot to match the behaviour of theFromStr
implementation. (#116) -
The salt and hash parameters of
Nsec3
andNsec3Param
have been wrapped in newtypes. (#116) -
Functions depending on the
rand
crate have been moved behind a newrandom
feature asrand
is not available on all systems, even with std support. The feature is, however, part of the default features.In particular, this means that
Header::set_random_id
,MessageBuilder::request_axfr
, andopt::rfc7830::PaddingMode::Random
are only available if the feature is enabled. (#117 by @Jezza) -
resolv::Resolver::Query
now has to beSend
. This will allow the resolver to be used in async functions spawned onto a Tokio runtime.The stub resolver’s query struct is already Send, so no actual changes are necessary. However, because this changes the definition of the Resolver trait, this is a breaking change, anyway. (#125)
New
- ``base::header::Flag` for easier working for the flags of a message header. (#109 by @tomaskrizek)
base::name::OwnedLabel
now implementsClone
andCopy
as well asDisplay
andDebug
. (#112)base::record::Record::into_owner_and_name
allows decomposing a record into its two parts that aren’tCopy
. (#114)- Initial support for SVCB and HTTPS record types. (#115 by @xofyarg)
- Introduced Serde support for all relevant types. (#116)
- The
OctetsBuilder
trait is now also implemented for mutable references of types that are octet builders and turn into themselves when frozen (i.e.,OctetsBuilder::Octets = Self
). (#121) - Support for [
heapless::Vec<u8, N>
] as an octets sequence via the newheapless
feature. (#122 by @bugadani) - The parameter types for SVCB record data now also implement
Eq
(#135)
Bug Fixes
- Correctly encode and decode the address in EDNS client subnet when the number of bits isn’t divisible by 8. (#101 and #102 by @xofyarg)
validate
:- Support for no-std environments now actually works. (#117 by @Jezza)
- Canonalize IANA types when scanning so that, e.g.,
CLASS3
becomesClass::Ch
instead ofClass::Int(3)
. (#127 by @vavrusa) resolv
: Fixed generation of the domain name to be used for reverse IPv6 lookups. (#131)
Other Changes
- Enable
doc_cfg
feature flag documentation for docs.rs. (#104 by Martin Fischer)
Released 2021-03-31.
This release is a maintenance release only in order to show the complete documentation on docs.rs.
Other Changes
- Enables all features when building for doc.rs. (#99)
Released 2021-03-22.
Breaking
- The crate
domain-resolv
has been merged into this crate as thedomain::resolv
crate. It requires theresolv
feature to be enabled. Thesync
feature fromdomain-resolv
has been renamed toresolv-sync
. (#74) - The trait
domain::base::octets::IntoOctets
has been merged intodomain::base::octets::OctetsBuilder
. It’s methodinto_octets
is now available asfreeze
onOctetsBuilder
. (#75) - Upgrade to tokio 1.0, bytes 1.0, and latest of other dependencies (#84 by @koivunej)
New
- Support for extended errors defined in RFC 8914. (#79 by @xofyarg)
- New traits
domain::base::octets::OctetsFrom
andOctetsInto
to convert types that are generic over octets sequences between different octets sequences. (#77)
Bug Fixes
- Fix domain name compressors when giving a root label only. (#76 by @vavrusa)
- Fix OptIter not skipping over other options correctly. (#76 by @vavrusa)
- Fix canonical comparison of TXT RDATA by taking the length labels into account. (#76 by @vavrusa)
- Fix parser not rejecting malformed TXT RDATA. (#80 by @vavrusa)
- Resolver: Host lookup now considers possibly separate CNAME chains for the responses to the A and AAAA queries. (#90 by [@varusa])
Other Changes
New
Bug Fixes
- Various minor fixes for building in no-std mode. (#72)
New
Dependencies
- Upgraded ring to 0.6.14 for fixes to 1024 bit RSASHA512. (#62)
New
Bug Fixes
- Fix calculation of block lengths in
TxtBuilder
. (#57, by @vavrusa) - Fix construction of options in OPT records. (#59, by @vavrusa)
This release contains a major restructuring and refactoring of the entire library. The previous set of crates has been merged into a single crate yet again with various modules being optional and available via features.
The following notes list the changes relative to the domain-core crate.
Reorganization
- The modules in
domain_core::bits
have been moved todomain::base
. - The modules
domain_core::{iana, utils}
have been moved todomain::base::{iana, utils}
respectively. - Master file parsing and generation functionality is now only available
if the feature
"master"
is enabled.
Breaking Changes
- All types that use octets sequences are now generic over the specific
type of sequence. For details of the mechanism, please have a look at
the documentation of the
base::octets
module. rdata::rfc4035::Nsec
is now generic over the type of the next name. This is necessary because [RFC 6762] allows compression for its next name. (#20, reported by Tom Pusateri)- Removed the failure crate. All error types now impl
fmt::Display
and, if the"std"
feature is enabled,std::error::Error
. (#33)
New
base::message::Message::opt
returns a message’s OPT record if present. (#6, thanks to Marek Vavruša!)- unsafe
base::name::Dname::from_bytes_unchecked
in order to create names from well-known sequences. (#31) compose::Compose::compose_canonical
for composing the canonical form for DNSSEC signing. It has a default implementation just doingcompose
and has been implemented for all relevant types. [(#XX)]base::cmp::CanonicalOrd
for the ordering of record data and records for DNSSEC signing. Implemented for all relevant types. Also improved implementations ofPartialEq
andPartialOrd
for types generic over domain name types to be generic over the other values domain name type.- Allow
serial::Serial
to be created from datetimes, provide a constructor fornow
and addsub
. - Record data types for CDS and CDSKEY record types. (Provided by @vendemiat in #24).
Bug fixes
- Do not compress the target of an SRV record’s data. [(#18)]
- Fix multiple issues with
rdata::rfc4043
. (#42 via #38 by @vavrusa) - Fix multiple issues with
base::opt
. (#42 via #38 by @vavrusa) - Fixed infinite loops in
Message::canonical_name
. (#42 via #38 by @vavrusa)
Dependencies
- The
std
,bytes
, andchrono
crates are now optional and can be enabled via features.
- The new
sign
module provides DNSSEC signing. It is available if the"sign"
feature is enabled. - The new
tsig
module provides TSIG signing and validation. It is only available if the"tsig"
feature is enabled. - The new
validate
module provides functionality necessary for DNSSEC validation. It is only available if the"validate"
feature is enabled.