rust-libp2p/misc/mdns/src/service.rs

// Copyright 2018 Parity Technologies (UK) Ltd.
//
// Permission is hereby granted, free of charge, to any person obtaining a
// copy of this software and associated documentation files (the "Software"),
// to deal in the Software without restriction, including without limitation
// the rights to use, copy, modify, merge, publish, distribute, sublicense,
// and/or sell copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following conditions:
//
// The above copyright notice and this permission notice shall be included in
// all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
// OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
// FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
// AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
// LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
// DEALINGS IN THE SOFTWARE.

extern crate data_encoding;
extern crate dns_parser;
extern crate futures;
extern crate libp2p_core;
extern crate multiaddr;
extern crate net2;
extern crate rand;
extern crate tokio_reactor;
extern crate tokio_timer;
extern crate tokio_udp;

#[cfg(test)]
extern crate tokio;

use crate::{SERVICE_NAME, META_QUERY_SERVICE, dns};
use dns_parser::{Packet, RData};
use futures::{prelude::*, task};
use libp2p_core::{Multiaddr, PeerId};
use multiaddr::Protocol;
use std::{fmt, io, net::Ipv4Addr, net::SocketAddr, str, time::Duration, time::Instant};
use tokio_reactor::Handle;
use tokio_timer::Interval;
use tokio_udp::UdpSocket;

pub use dns::MdnsResponseError;

/// A running service that discovers libp2p peers and responds to other libp2p peers' queries on
/// the local network.
///
/// # Usage
/// 
/// In order to use mDNS to discover peers on the local network, use the `MdnsService`. This is
/// done by creating a `MdnsService` then polling it in the same way as you would poll a stream.
///
/// Polling the `MdnsService` can produce either an `MdnsQuery`, corresponding to an mDNS query
/// received by another node on the local network, or an `MdnsResponse` corresponding to a response
/// to a query previously emitted locally. The `MdnsService` will automatically produce queries,
/// which means that you will receive responses automatically.
///
/// When you receive an `MdnsQuery`, use the `respond` method to send back an answer to the node
/// that emitted the query.
///
/// When you receive an `MdnsResponse`, use the provided methods to query the information received
/// in the response.
///
/// # Example
///
/// ```rust
/// # extern crate futures;
/// # extern crate libp2p_core;
/// # extern crate libp2p_mdns;
/// # use futures::prelude::*;
/// # use libp2p_mdns::service::{MdnsService, MdnsPacket};
/// # use std::{io, time::Duration};
/// # fn main() {
/// # let my_peer_id = libp2p_core::PublicKey::Rsa(vec![1, 2, 3, 4]).into_peer_id();
/// # let my_listened_addrs = Vec::new();
/// let mut service = MdnsService::new().expect("Error while creating mDNS service");
/// let _future_to_poll = futures::stream::poll_fn(move || -> Poll<Option<()>, io::Error> {
///     loop {
///         let packet = match service.poll() {
///             Async::Ready(packet) => packet,
///             Async::NotReady => return Ok(Async::NotReady),
///         };
///
///         match packet {
///             MdnsPacket::Query(query) => {
///                 println!("Query from {:?}", query.remote_addr());
///                 query.respond(
///                     my_peer_id.clone(),
///                     my_listened_addrs.clone(),
///                     Duration::from_secs(120),
///                 );
///             }
///             MdnsPacket::Response(response) => {
///                 for peer in response.discovered_peers() {
///                     println!("Discovered peer {:?}", peer.id());
///                     for addr in peer.addresses() {
///                         println!("Address = {:?}", addr);
///                     }
///                 }
///             }
///             MdnsPacket::ServiceDiscovery(query) => {
///                 query.respond(std::time::Duration::from_secs(120));
///             }
///         }
///     }
/// }).for_each(|_| Ok(()));
/// # }
pub struct MdnsService {
    /// Main socket for listening.
    socket: UdpSocket,
    /// Socket for sending queries on the network.
    query_socket: UdpSocket,
    /// Interval for sending queries.
    query_interval: Interval,
    /// Whether we send queries on the network at all.
    /// Note that we still need to have an interval for querying, as we need to wake up the socket
    /// regularly to recover from errors. Otherwise we could simply use an `Option<Interval>`.
    silent: bool,
    /// Buffer used for receiving data from the main socket.
    recv_buffer: [u8; 2048],
    /// Buffers pending to send on the main socket.
    send_buffers: Vec<Vec<u8>>,
    /// Buffers pending to send on the query socket.
    query_send_buffers: Vec<Vec<u8>>,
}

impl MdnsService {
    /// Starts a new mDNS service.
    #[inline]
    pub fn new() -> io::Result<MdnsService> {
        Self::new_inner(false)
    }

    /// Same as `new`, but we don't send automatically send queries on the network.
    #[inline]
    pub fn silent() -> io::Result<MdnsService> {
        Self::new_inner(true)
    }

    /// Starts a new mDNS service.
    fn new_inner(silent: bool) -> io::Result<MdnsService> {
        let socket = {
            #[cfg(unix)]
            fn platform_specific(s: &net2::UdpBuilder) -> io::Result<()> {
                net2::unix::UnixUdpBuilderExt::reuse_port(s, true)?;
                Ok(())
            }
            #[cfg(not(unix))]
            fn platform_specific(_: &net2::UdpBuilder) -> io::Result<()> { Ok(()) }
            let builder = net2::UdpBuilder::new_v4()?;
            builder.reuse_address(true)?;
            platform_specific(&builder)?;
            builder.bind(("0.0.0.0", 5353))?
        };

        let socket = UdpSocket::from_std(socket, &Handle::default())?;
        socket.set_multicast_loop_v4(true)?;
        socket.set_multicast_ttl_v4(255)?;
        // TODO: correct interfaces?
        socket.join_multicast_v4(&From::from([224, 0, 0, 251]), &Ipv4Addr::UNSPECIFIED)?;

        Ok(MdnsService {
            socket,
            query_socket: UdpSocket::bind(&From::from(([0, 0, 0, 0], 0)))?,
            query_interval: Interval::new(Instant::now(), Duration::from_secs(20)),
            silent,
            recv_buffer: [0; 2048],
            send_buffers: Vec::new(),
            query_send_buffers: Vec::new(),
        })
    }

    /// Polls the service for packets.
    pub fn poll(&mut self) -> Async<MdnsPacket> {
        // Send a query every time `query_interval` fires.
        // Note that we don't use a loop here—it is pretty unlikely that we need it, and there is
        // no point in sending multiple requests in a row.
        match self.query_interval.poll() {
            Ok(Async::Ready(_)) => {
                if !self.silent {
                    let query = dns::build_query();
                    self.query_send_buffers.push(query.to_vec());
                }
            }
            Ok(Async::NotReady) => (),
            _ => unreachable!("A tokio_timer::Interval never errors"), // TODO: is that true?
        };

        // Flush the send buffer of the main socket.
        while !self.send_buffers.is_empty() {
            let to_send = self.send_buffers.remove(0);
            match self
                .socket
                .poll_send_to(&to_send, &From::from(([224, 0, 0, 251], 5353)))
            {
                Ok(Async::Ready(bytes_written)) => {
                    debug_assert_eq!(bytes_written, to_send.len());
                }
                Ok(Async::NotReady) => {
                    self.send_buffers.insert(0, to_send);
                    break;
                }
                Err(_) => {
                    // Errors are non-fatal because they can happen for example if we lose
                    // connection to the network.
                    self.send_buffers.clear();
                    break;
                }
            }
        }

        // Flush the query send buffer.
        // This has to be after the push to `query_send_buffers`.
        while !self.query_send_buffers.is_empty() {
            let to_send = self.query_send_buffers.remove(0);
            match self
                .query_socket
                .poll_send_to(&to_send, &From::from(([224, 0, 0, 251], 5353)))
            {
                Ok(Async::Ready(bytes_written)) => {
                    debug_assert_eq!(bytes_written, to_send.len());
                }
                Ok(Async::NotReady) => {
                    self.query_send_buffers.insert(0, to_send);
                    break;
                }
                Err(_) => {
                    // Errors are non-fatal because they can happen for example if we lose
                    // connection to the network.
                    self.query_send_buffers.clear();
                    break;
                }
            }
        }

        // Check for any incoming packet.
        match self.socket.poll_recv_from(&mut self.recv_buffer) {
            Ok(Async::Ready((len, from))) => {
                match Packet::parse(&self.recv_buffer[..len]) {
                    Ok(packet) => {
                        if packet.header.query {
                            if packet
                                .questions
                                .iter()
                                .any(|q| q.qname.to_string().as_bytes() == SERVICE_NAME)
                            {
                                return Async::Ready(MdnsPacket::Query(MdnsQuery {
                                    from,
                                    query_id: packet.header.id,
                                    send_buffers: &mut self.send_buffers,
                                }));
                            } else if packet
                                .questions
                                .iter()
                                .any(|q| q.qname.to_string().as_bytes() == META_QUERY_SERVICE)
                            {
                                // TODO: what if multiple questions, one with SERVICE_NAME and one with META_QUERY_SERVICE?
                                return Async::Ready(MdnsPacket::ServiceDiscovery(
                                    MdnsServiceDiscovery {
                                        from,
                                        query_id: packet.header.id,
                                        send_buffers: &mut self.send_buffers,
                                    },
                                ));
                            } else {
                                // Note that ideally we would use a loop instead. However as of the
                                // writing of this code non-lexical lifetimes haven't been merged
                                // yet, and I can't manage to write this code without having borrow
                                // issues.
                                task::current().notify();
                                return Async::NotReady;
                            }
                        } else {
                            return Async::Ready(MdnsPacket::Response(MdnsResponse {
                                packet,
                                from,
                            }));
                        }
                    }
                    Err(_) => {
                        // Ignore errors while parsing the packet. We need to poll again for the
                        // next packet.
                        // Note that ideally we would use a loop instead. However as of the writing
                        // of this code non-lexical lifetimes haven't been merged yet, and I can't
                        // manage to write this code without having borrow issues.
                        task::current().notify();
                        return Async::NotReady;
                    }
                }
            }
            Ok(Async::NotReady) => (),
            Err(_) => {
                // Error are non-fatal and can happen if we get disconnected from example.
                // The query interval will wake up the task at some point so that we can try again.
            }
        };

        Async::NotReady
    }
}

impl fmt::Debug for MdnsService {
    fn fmt(&self, fmt: &mut fmt::Formatter) -> fmt::Result {
        fmt.debug_struct("MdnsService")
            .field("silent", &self.silent)
            .finish()
    }
}

/// A valid mDNS packet received by the service.
#[derive(Debug)]
pub enum MdnsPacket<'a> {
    /// A query made by a remote.
    Query(MdnsQuery<'a>),
    /// A response sent by a remote in response to one of our queries.
    Response(MdnsResponse<'a>),
    /// A request for service discovery.
    ServiceDiscovery(MdnsServiceDiscovery<'a>),
}

/// A received mDNS query.
pub struct MdnsQuery<'a> {
    /// Sender of the address.
    from: SocketAddr,
    /// Id of the received DNS query. We need to pass this ID back in the results.
    query_id: u16,
    /// Queue of pending buffers.
    send_buffers: &'a mut Vec<Vec<u8>>,
}

impl<'a> MdnsQuery<'a> {
    /// Respond to the query.
    ///
    /// Pass the ID of the local peer, and the list of addresses we're listening on.
    ///
    /// If there are more than 2^16-1 addresses, ignores the others.
    ///
    /// > **Note**: Keep in mind that we will also receive this response in an `MdnsResponse`.
    #[inline]
    pub fn respond<TAddresses>(
        self,
        peer_id: PeerId,
        addresses: TAddresses,
        ttl: Duration,
    ) -> Result<(), MdnsResponseError>
    where
        TAddresses: IntoIterator<Item = Multiaddr>,
        TAddresses::IntoIter: ExactSizeIterator,
    {
        let response =
            dns::build_query_response(self.query_id, peer_id, addresses.into_iter(), ttl)?;
        self.send_buffers.push(response);
        Ok(())
    }

    /// Source address of the packet.
    #[inline]
    pub fn remote_addr(&self) -> &SocketAddr {
        &self.from
    }
}

impl<'a> fmt::Debug for MdnsQuery<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("MdnsQuery")
            .field("from", self.remote_addr())
            .field("query_id", &self.query_id)
            .finish()
    }
}

/// A received mDNS service discovery query.
pub struct MdnsServiceDiscovery<'a> {
    /// Sender of the address.
    from: SocketAddr,
    /// Id of the received DNS query. We need to pass this ID back in the results.
    query_id: u16,
    /// Queue of pending buffers.
    send_buffers: &'a mut Vec<Vec<u8>>,
}

impl<'a> MdnsServiceDiscovery<'a> {
    /// Respond to the query.
    #[inline]
    pub fn respond(self, ttl: Duration) {
        let response = dns::build_service_discovery_response(self.query_id, ttl);
        self.send_buffers.push(response);
    }

    /// Source address of the packet.
    #[inline]
    pub fn remote_addr(&self) -> &SocketAddr {
        &self.from
    }
}

impl<'a> fmt::Debug for MdnsServiceDiscovery<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("MdnsServiceDiscovery")
            .field("from", self.remote_addr())
            .field("query_id", &self.query_id)
            .finish()
    }
}

/// A received mDNS response.
pub struct MdnsResponse<'a> {
    packet: Packet<'a>,
    from: SocketAddr,
}

impl<'a> MdnsResponse<'a> {
    /// Returns the list of peers that have been reported in this packet.
    ///
    /// > **Note**: Keep in mind that this will also contain the responses we sent ourselves.
    pub fn discovered_peers<'b>(&'b self) -> impl Iterator<Item = MdnsPeer<'b>> {
        let packet = &self.packet;
        self.packet.answers.iter().filter_map(move |record| {
            if record.name.to_string().as_bytes() != SERVICE_NAME {
                return None;
            }

            let record_value = match record.data {
                RData::PTR(record) => record.0.to_string(),
                _ => return None,
            };

            let peer_name = {
                let mut iter = record_value.splitn(2, |c| c == '.');
                let name = match iter.next() {
                    Some(n) => n.to_owned(),
                    None => return None,
                };
                if iter.next().map(|v| v.as_bytes()) != Some(SERVICE_NAME) {
                    return None;
                }
                name
            };

            let peer_id = match data_encoding::BASE32_DNSCURVE.decode(peer_name.as_bytes()) {
                Ok(bytes) => match PeerId::from_bytes(bytes) {
                    Ok(id) => id,
                    Err(_) => return None,
                },
                Err(_) => return None,
            };

            Some(MdnsPeer {
                packet,
                record_value,
                peer_id,
            })
        })
    }

    /// Source address of the packet.
    #[inline]
    pub fn remote_addr(&self) -> &SocketAddr {
        &self.from
    }
}

impl<'a> fmt::Debug for MdnsResponse<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("MdnsResponse")
            .field("from", self.remote_addr())
            .finish()
    }
}

/// A peer discovered by the service.
pub struct MdnsPeer<'a> {
    /// The original packet which will be used to determine the addresses.
    packet: &'a Packet<'a>,
    /// Cached value of `concat(base32(peer_id), service name)`.
    record_value: String,
    /// Id of the peer.
    peer_id: PeerId,
}

impl<'a> MdnsPeer<'a> {
    /// Returns the id of the peer.
    #[inline]
    pub fn id(&self) -> &PeerId {
        &self.peer_id
    }

    /// Returns the list of addresses the peer says it is listening on.
    ///
    /// Filters out invalid addresses.
    pub fn addresses<'b>(&'b self) -> impl Iterator<Item = Multiaddr> + 'b {
        let my_peer_id = &self.peer_id;
        let record_value = &self.record_value;
        self.packet
            .additional
            .iter()
            .filter_map(move |add_record| {
                if &add_record.name.to_string() != record_value {
                    return None;
                }

                if let RData::TXT(ref txt) = add_record.data {
                    Some(txt)
                } else {
                    None
                }
            })
            .flat_map(|txt| txt.iter())
            .filter_map(move |txt| {
                // TODO: wrong, txt can be multiple character strings
                let addr = match dns::decode_character_string(txt) {
                    Ok(a) => a,
                    Err(_) => return None,
                };
                if !addr.starts_with(b"dnsaddr=") {
                    return None;
                }
                let addr = match str::from_utf8(&addr[8..]) {
                    Ok(a) => a,
                    Err(_) => return None,
                };
                let mut addr = match addr.parse::<Multiaddr>() {
                    Ok(a) => a,
                    Err(_) => return None,
                };
                match addr.pop() {
                    Some(Protocol::P2p(ref peer_id)) if peer_id == my_peer_id => (),
                    _ => return None,
                };
                Some(addr)
            })
    }
}

impl<'a> fmt::Debug for MdnsPeer<'a> {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.debug_struct("MdnsPeer")
            .field("peer_id", &self.peer_id)
            .finish()
    }
}

#[cfg(test)]
mod tests {
    use libp2p_core::PublicKey;
    use std::{io, time::Duration};
    use tokio::{self, prelude::*};
    use crate::service::{MdnsPacket, MdnsService};

    #[test]
    fn discover_ourselves() {
        let mut service = MdnsService::new().unwrap();
        let peer_id =
            PublicKey::Rsa((0..32).map(|_| rand::random::<u8>()).collect()).into_peer_id();
        let stream = stream::poll_fn(move || -> Poll<Option<()>, io::Error> {
            loop {
                let packet = match service.poll() {
                    Async::Ready(packet) => packet,
                    Async::NotReady => return Ok(Async::NotReady),
                };

                match packet {
                    MdnsPacket::Query(query) => {
                        query.respond(peer_id.clone(), None, Duration::from_secs(120)).unwrap();
                    }
                    MdnsPacket::Response(response) => {
                        for peer in response.discovered_peers() {
                            if peer.id() == &peer_id {
                                return Ok(Async::Ready(None));
                            }
                        }
                    }
                    MdnsPacket::ServiceDiscovery(_) => {}
                }
            }
        });

        tokio::run(
            stream
                .map_err(|err| panic!("{:?}", err))
                .for_each(|_| Ok(())),
        );
    }
}