Merge branch 'main' into fix/additionals

Author: willstott101

.github/workflows/rust.yml

@@ -14,4 +14,6 @@ jobs:
     steps:
     - uses: actions/checkout@v2
     - name: Check formatting
-      run: cargo fmt -- --check
+      run: cargo +stable fmt -- --check
+    - name: Check linting
+      run: cargo +stable clippy -- -Dwarnings

.github/workflows/zeroconf_test.yaml

@@ -13,7 +13,7 @@ jobs:
     - name: Install our MSRV
       uses: dtolnay/rust-toolchain@stable
       with:
-         toolchain: "1.70"
+         toolchain: "1.74"
 
     - name: Compile example
       run: cargo build --example register

Cargo.toml

@@ -1,35 +1,33 @@
 [package]
 name = "libmdns"
-version = "0.8.0"
+version = "0.9.1"
 authors = ["Will Stott <[email protected]>"]
-
 description = "mDNS Responder library for building discoverable LAN services in Rust"
 repository = "https://github.com/librespot-org/libmdns"
 readme = "README.md"
 license = "MIT"
 edition = "2018"
+rust-version = "1.74"
 
 [dependencies]
 byteorder = "1.5"
-if-addrs = "0.11.0"
-hostname = "0.3.1"
-log = "0.4"
-multimap = "0.9"
-rand = "0.8"
 futures-util = "0.3"
-thiserror = "1.0"
-tokio = { version = "1.0", features = ["sync", "net", "rt"] }
-socket2 = { version = "0.5", features = ["all"] }
-
-[target.'cfg(windows)'.dependencies]
-winapi = { version = "0.3", features = ["netioapi"] }
-
-[target.'cfg(not(windows))'.dependencies]
-nix = { version = "0.27", features = ["net"] }
+hostname = "0.4"
+if-addrs = { version = "0.14", features = ["link-local"] }
+log = "0.4"
+multimap = { version = "0.10", default-features = false }
+rand = "0.9"
+socket2 = { version = "0.6", features = ["all"] }
+thiserror = "2"
+tokio = { version = "1", default-features = false, features = [
+    "sync",
+    "net",
+    "rt",
+] }
 
 [dev-dependencies]
-env_logger = { version = "0.10", default-features = false, features = [
-  "color",
-  "humantime",
-  "auto-color",
+env_logger = { version = "0.11", default-features = false, features = [
+    "color",
+    "humantime",
+    "auto-color",
 ] }

README.md

@@ -13,14 +13,14 @@ To use it, add this to your `Cargo.toml`:
 
 ```toml
 [dependencies]
-libmdns = "0.7"
+libmdns = "0.9"
 ```
 
-See the [example](https://github.com/librespot-org/libmdns/blob/stable-0.7.x/examples/register.rs) for use within code.
+See the [example](https://github.com/librespot-org/libmdns/blob/stable-0.9.x/examples/register.rs) for use within code.
 
 ## Dependencies
 
-libmdns' oldest supported Rust toolchain is `1.70.0`, _however it may compile fine on older versions of rust._
+libmdns' MSRV (oldest supported Rust toolchain) is 1.74.0.
 
 **We hold no strong garantees for sticking to a Minimum Supported Rust Version**. Please open an issue on GitHub if you need support for older compilers or different platforms.
 

examples/register.rs

@@ -3,13 +3,8 @@ pub fn main() {
     builder.parse_filters("libmdns=debug");
     builder.init();
 
-    let responder = libmdns::Responder::new().unwrap();
-    let _svc = responder.register(
-        "_http._tcp".to_owned(),
-        "libmdns Web Server".to_owned(),
-        80,
-        &["path=/"],
-    );
+    let responder = libmdns::Responder::new();
+    let _svc = responder.register("_http._tcp", "libmdns Web Server", 80, &["path=/"]);
 
     loop {
         ::std::thread::sleep(::std::time::Duration::from_secs(10));

examples/register_with_ip_list.rs

@@ -10,12 +10,7 @@ pub fn main() {
     ];
 
     let responder = libmdns::Responder::new_with_ip_list(vec).unwrap();
-    let _svc = responder.register(
-        "_http._tcp".to_owned(),
-        "libmdns Web Server".to_owned(),
-        80,
-        &["path=/"],
-    );
+    let _svc = responder.register("_http._tcp", "libmdns Web Server", 80, &["path=/"]);
 
     loop {
         ::std::thread::sleep(::std::time::Duration::from_secs(10));

examples/zeroconf_test.py

@@ -1,12 +1,12 @@
-from zeroconf import ServiceBrowser, Zeroconf, IPVersion, ZeroconfServiceTypes
+from zeroconf import ServiceBrowser, ServiceListener, Zeroconf, IPVersion, ZeroconfServiceTypes
 from time import sleep
 
 
 TYPE = "_http._tcp.local."
 NAME = "libmdns Web Server"
 
 
-class MyListener:
+class MyListener(ServiceListener):
     def __init__(self):
         self.found = []
 

src/address_family.rs

@@ -1,15 +1,10 @@
 use super::MDNS_PORT;
-use if_addrs::get_if_addrs;
+use if_addrs::{get_if_addrs, IfAddr};
 use socket2::{Domain, Protocol, SockAddr, Socket, Type};
+use std::collections::HashSet;
 use std::io;
 use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr, UdpSocket};
 
-#[cfg(not(windows))]
-use nix::net::if_::if_nametoindex;
-
-#[cfg(windows)]
-use win::if_nametoindex;
-
 pub enum Inet {}
 
 pub enum Inet6 {}
@@ -34,8 +29,7 @@ pub trait AddressFamily {
         socket.set_reuse_address(true)?;
         socket.set_nonblocking(true)?;
 
-        #[cfg(not(windows))]
-        #[cfg(not(target_os = "illumos"))]
+        #[cfg(all(unix, not(any(target_os = "solaris", target_os = "illumos"))))]
         socket.set_reuse_port(true)?;
 
         socket.bind(&addr)?;
@@ -53,14 +47,13 @@ impl AddressFamily for Inet {
     const DOMAIN: Domain = Domain::IPV4;
 
     fn join_multicast(socket: &Socket, multiaddr: &Self::Addr) -> io::Result<()> {
-        let addresses = get_address_list()?;
-        if addresses.is_empty() {
+        let addrs = get_one_nonloopback_ipv4_addr_per_iface()?;
+        if addrs.is_empty() {
             socket.join_multicast_v4(multiaddr, &Ipv4Addr::UNSPECIFIED)
         } else {
-            for (_, address) in addresses {
-                if let IpAddr::V4(ip) = address {
-                    socket.join_multicast_v4(multiaddr, &ip)?;
-                }
+            // TODO: If any join succeeds return success (log failures)
+            for ip in addrs {
+                socket.join_multicast_v4(multiaddr, &ip)?;
             }
             Ok(())
         }
@@ -76,44 +69,61 @@ impl AddressFamily for Inet6 {
     const DOMAIN: Domain = Domain::IPV6;
 
     fn join_multicast(socket: &Socket, multiaddr: &Self::Addr) -> io::Result<()> {
-        let addresses = get_address_list()?;
-        if addresses.is_empty() {
+        let indexes = get_one_nonloopback_ipv6_index_per_iface()?;
+        if indexes.is_empty() {
             socket.join_multicast_v6(multiaddr, 0)
         } else {
-            // We join multicast by interface, but each interface can have more than one ipv6 address.
-            // So we have to check we're not registering more than once, as the resulting error is then
-            // fatal to ipv6 listening.
-            // TODO: Make each interface resilient to failures on another.
-            let mut registered = Vec::new();
-            for (iface_name, address) in addresses {
-                if let IpAddr::V6(_) = address {
-                    let ipv6_index = if_nametoindex(iface_name.as_str()).unwrap_or(0);
-                    if ipv6_index != 0 && !registered.contains(&ipv6_index) {
-                        socket.join_multicast_v6(multiaddr, ipv6_index)?;
-                        registered.push(ipv6_index);
-                    }
-                }
+            // TODO: If any join succeeds return success (log failures)
+            for ipv6_index in indexes {
+                socket.join_multicast_v6(multiaddr, ipv6_index)?;
             }
             Ok(())
         }
     }
 }
 
-fn get_address_list() -> io::Result<Vec<(String, IpAddr)>> {
+fn get_one_nonloopback_ipv6_index_per_iface() -> io::Result<Vec<u32>> {
+    // There may be multiple ip addresses on a single interface and we join multicast by interface.
+    // Joining multicast on the same interface multiple times returns an error
+    // so we filter duplicate interfaces.
+    let mut collected_interfaces = HashSet::new();
     Ok(get_if_addrs()?
-        .iter()
-        .filter(|iface| !iface.is_loopback())
-        .map(|iface| (iface.name.clone(), iface.ip()))
+        .into_iter()
+        .filter_map(|iface| {
+            if iface.is_loopback() {
+                None
+            } else if matches!(iface.addr, IfAddr::V6(_)) {
+                if collected_interfaces.insert(iface.name.clone()) {
+                    iface.index
+                } else {
+                    None
+                }
+            } else {
+                None
+            }
+        })
         .collect())
 }
 
-#[cfg(windows)]
-mod win {
-    use std::ffi::{CString, NulError};
-    use winapi::shared::netioapi;
-
-    pub fn if_nametoindex(ifname: &str) -> Result<u32, NulError> {
-        let c_str = CString::new(ifname)?;
-        Ok(unsafe { netioapi::if_nametoindex(c_str.as_ptr()) })
-    }
+fn get_one_nonloopback_ipv4_addr_per_iface() -> io::Result<Vec<Ipv4Addr>> {
+    // There may be multiple ip addresses on a single interface and we join multicast by interface.
+    // Joining multicast on the same interface multiple times returns an error
+    // so we filter duplicate interfaces.
+    let mut collected_interfaces = HashSet::new();
+    Ok(get_if_addrs()?
+        .into_iter()
+        .filter_map(|iface| {
+            if iface.is_loopback() {
+                None
+            } else if let IpAddr::V4(ip) = iface.ip() {
+                if collected_interfaces.insert(iface.name.clone()) {
+                    Some(ip)
+                } else {
+                    None
+                }
+            } else {
+                None
+            }
+        })
+        .collect())
 }

src/dns_parser/builder.rs

@@ -41,7 +41,7 @@ impl Builder<Questions> {
     pub fn new_query(id: u16, recursion: bool) -> Builder<Questions> {
         let mut buf = Vec::with_capacity(512);
         let head = Header {
-            id: id,
+            id,
             query: true,
             opcode: Opcode::StandardQuery,
             authoritative: false,
@@ -57,7 +57,7 @@ impl Builder<Questions> {
         buf.extend([0u8; 12].iter());
         head.write(&mut buf[..12]);
         Builder {
-            buf: buf,
+            buf,
             max_size: Some(512),
             _state: PhantomData,
         }
@@ -66,10 +66,10 @@ impl Builder<Questions> {
     pub fn new_response(id: u16, recursion: bool, authoritative: bool) -> Builder<Questions> {
         let mut buf = Vec::with_capacity(512);
         let head = Header {
-            id: id,
+            id,
             query: false,
             opcode: Opcode::StandardQuery,
-            authoritative: authoritative,
+            authoritative,
             truncated: false,
             recursion_desired: recursion,
             recursion_available: false,
@@ -82,15 +82,15 @@ impl Builder<Questions> {
         buf.extend([0u8; 12].iter());
         head.write(&mut buf[..12]);
         Builder {
-            buf: buf,
+            buf,
             max_size: Some(512),
             _state: PhantomData,
         }
     }
 }
 
 impl<T> Builder<T> {
-    fn write_rr(&mut self, name: &Name, cls: QueryClass, ttl: u32, data: &RRData) {
+    fn write_rr(&mut self, name: &Name<'_>, cls: QueryClass, ttl: u32, data: &RRData<'_>) {
         name.write_to(&mut self.buf).unwrap();
         self.buf.write_u16::<BigEndian>(data.typ() as u16).unwrap();
         self.buf.write_u16::<BigEndian>(cls as u16).unwrap();
@@ -103,6 +103,12 @@ impl<T> Builder<T> {
         data.write_to(&mut self.buf).unwrap();
         let data_size = self.buf.len() - data_offset;
 
+        assert!(
+            (data_offset <= 65535),
+            "{} is too long to write to a RR record",
+            data_offset
+        );
+        #[allow(clippy::cast_possible_truncation)]
         BigEndian::write_u16(
             &mut self.buf[size_offset..size_offset + 2],
             data_size as u16,
@@ -166,7 +172,7 @@ impl<T: MoveTo<Questions>> Builder<T> {
     #[allow(dead_code)]
     pub fn add_question(
         self,
-        qname: &Name,
+        qname: &Name<'_>,
         qtype: QueryType,
         qclass: QueryClass,
     ) -> Builder<Questions> {
@@ -183,10 +189,10 @@ impl<T: MoveTo<Questions>> Builder<T> {
 impl<T: MoveTo<Answers>> Builder<T> {
     pub fn add_answer(
         self,
-        name: &Name,
+        name: &Name<'_>,
         cls: QueryClass,
         ttl: u32,
-        data: &RRData,
+        data: &RRData<'_>,
     ) -> Builder<Answers> {
         let mut builder = self.move_to::<Answers>();
 
@@ -216,10 +222,10 @@ impl<T: MoveTo<Nameservers>> Builder<T> {
     #[allow(dead_code)]
     pub fn add_nameserver(
         self,
-        name: &Name,
+        name: &Name<'_>,
         cls: QueryClass,
         ttl: u32,
-        data: &RRData,
+        data: &RRData<'_>,
     ) -> Builder<Nameservers> {
         let mut builder = self.move_to::<Nameservers>();
 
@@ -249,10 +255,10 @@ impl<T: MoveTo<Nameservers>> Builder<T> {
 impl<T: MoveTo<Additional>> Builder<T> {
     pub fn add_additional(
         self,
-        name: &Name,
+        name: &Name<'_>,
         cls: QueryClass,
         ttl: u32,
-        data: &RRData,
+        data: &RRData<'_>,
     ) -> Builder<Additional> {
         let mut builder = self.move_to::<Additional>();
 
@@ -288,7 +294,7 @@ mod test {
     #[test]
     fn build_query() {
         let mut bld = Builder::new_query(1573, true);
-        let name = Name::from_str("example.com").unwrap();
+        let name = Name::from_str("example.com");
         bld = bld.add_question(&name, QT::A, QC::IN);
         let result = b"\x06%\x01\x00\x00\x01\x00\x00\x00\x00\x00\x00\
                       \x07example\x03com\x00\x00\x01\x00\x01";
@@ -298,7 +304,7 @@ mod test {
     #[test]
     fn build_srv_query() {
         let mut bld = Builder::new_query(23513, true);
-        let name = Name::from_str("_xmpp-server._tcp.gmail.com").unwrap();
+        let name = Name::from_str("_xmpp-server._tcp.gmail.com");
         bld = bld.add_question(&name, QT::SRV, QC::IN);
         let result = b"[\xd9\x01\x00\x00\x01\x00\x00\x00\x00\x00\x00\
             \x0c_xmpp-server\x04_tcp\x05gmail\x03com\x00\x00!\x00\x01";