1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253
use socket2::{Domain, SockAddr as SockAddr2, Socket, Type}; use std::io::ErrorKind; use std::net::{IpAddr, Ipv4Addr, Ipv6Addr, SocketAddr}; use std::time::Duration; use thiserror::Error; /// An error that occurred during the SSDP discovery #[derive(Error, Debug)] pub enum SsdpProbeError { #[error("an IO error was encountered")] Io(#[from] std::io::Error), #[error("could convert address {:?}", .0)] AddressConversionError(SockAddr2), #[error("got ipv6 address {:?} but expected an ipv4 one", .0)] UnexpectedIpv4(Ipv4Addr), #[error("got ipv4 address {:?} but expected an ipv6 one", .0)] UnexpectedIpv6(Ipv6Addr), } /// Perform an UPnP SSDP discovery on IPv4. /// /// This will use the standard address `239.255.255.250:1900` /// /// # Arguments /// - `marker`: marker used to filter the results (if this is present in the received response, /// then the address will be returned /// - `max_results`: stop the discovery when the number of results is equal to this /// - `max_duration`: stop the discovery after this duration /// /// # Returned Value /// A list of all the addresses that responded to the discovery with a response containing the /// sequence of bytes given in `marker`. Note that there will be no duplicates in the list. /// # See /// [`ssdp_probe_v6`](fn.ssdp_probe_v6.html) pub fn ssdp_probe_v4( marker: &[u8], max_results: usize, max_duration: Duration, ) -> Result<Vec<Ipv4Addr>, SsdpProbeError> { ssdp_probe( marker, max_results, max_duration, SocketAddr::new(IpAddr::from(Ipv4Addr::new(0, 0, 0, 0)), 1900), SsdpMSearch { host: SocketAddr::new(IpAddr::from(Ipv4Addr::new(239, 255, 255, 250)), 1900), mx: 3, st: "upnp:rootdevice", extra_lines: "", }, SocketAddr::new(IpAddr::from(Ipv4Addr::new(239, 255, 255, 250)), 1900), Domain::ipv4(), ) .and_then(|results| { results .into_iter() .map(|it| match it { IpAddr::V4(address) => Ok(address), IpAddr::V6(address) => Err(SsdpProbeError::UnexpectedIpv6(address)), }) .collect() }) } /// Perform an UPnP SSDP discovery on IPv6. /// /// This will use the standard link-local address `[FF:02::C]:1900` /// /// # Arguments /// - `marker`: marker used to filter the results (if this is present in the received response, /// then the address will be returned /// - `max_results`: stop the discovery when the number of results is equal to this /// - `max_duration`: stop the discovery after this duration /// /// # Returned Value /// A list of all the addresses that responded to the discovery with a response containing the /// sequence of bytes given in `marker`. Note that there will be no duplicates in the list. /// /// # See /// [`ssdp_probe_v4`](fn.ssdp_probe_v4.html) pub fn ssdp_probe_v6( marker: &[u8], max_results: usize, max_duration: Duration, ) -> Result<Vec<Ipv6Addr>, SsdpProbeError> { ssdp_probe( marker, max_results, max_duration, SocketAddr::new(IpAddr::from(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0)), 1900), SsdpMSearch { host: SocketAddr::new( IpAddr::from(Ipv6Addr::new(0xFF, 0x02, 0, 0, 0, 0, 0, 0xC)), 1900, ), mx: 3, st: "upnp:rootdevice", extra_lines: "", }, SocketAddr::new( IpAddr::from(Ipv6Addr::new(0xFF, 0x02, 0, 0, 0, 0, 0, 0xC)), 1900, ), Domain::ipv6(), ) .and_then(|results| { results .into_iter() .map(|it| match it { IpAddr::V4(address) => Err(SsdpProbeError::UnexpectedIpv4(address)), IpAddr::V6(address) => Ok(address), }) .collect() }) } /// Representation of an M-SEARCH SSDP request pub struct SsdpMSearch<'a> { /// Host (address to use to respond to the query) pub host: SocketAddr, /// Max number of seconds to wait before sending response pub mx: usize, /// Search Target, possible values include (non exhaustive list): /// - `ssdp:all`: search for all devices and services /// - `upnp:rootdevice`: search only for root devices /// - `uuid:<device-UUID>` search for a specific device using its UUID pub st: &'a str, /// Extra lines appended to the M-SEARCH query pub extra_lines: &'a str, } impl<'a> SsdpMSearch<'a> { /// Get a properly formatted SSDP M-SEARCH payload for this pub fn get_payload(&self) -> Vec<u8> { format!( r#"M-SEARCH * HTTP/1.1 HOST: {} MAN: "ssdp:discover" MX: {} ST: {} {} "#, self.host, self.mx, self.st, self.extra_lines ) .into_bytes() } } /// Perform an UPnP SSDP discovery, this is a "low level" method that is exposed if you wanna /// tweak some parameters, most use cases should be ok with the /// [`ssdp_probe_v4`](fn.ssdp_probe_v4.html) and [ssdp_probe_v6](fn.ssdp_probe_v6.html) functions. /// /// # Arguments /// - `marker`: marker used to filter the results (if this is present in the received response, /// then the address will be returned /// - `max_results`: stop the discovery when the number of results is equal to this /// - `max_duration`: stop the discovery after this duration /// - `bind_address`: address to bind to receive the responses, note that the port may automatically /// be changed is one one provided is already in use, you should probably stick to the default ip /// and port reserved for SSDP /// - `m_search`: query to perform, note that the port in the host will be automatically changed to /// the one used by the `bind_address` (as is may be changed if the given one is not available) /// - `address`: address to send the search to, should be one one of the standard SSDP ones /// - `domain`: whether to use IPv4 or IPv6, should be coherent with the addresses passed in /// `address` and `m_search.host` /// /// # Returned Value /// A list of all the addresses that responded to the discovery with a response containing the /// sequence of bytes given in `marker`. Note that there will be no duplicates in the list. /// /// # See /// [SsdpMSearch](struct.SsdpMSearch.html) pub fn ssdp_probe( marker: &[u8], max_results: usize, max_duration: Duration, mut bind_address: SocketAddr, mut m_search: SsdpMSearch, address: SocketAddr, domain: Domain, ) -> Result<Vec<IpAddr>, SsdpProbeError> { log::debug!( "Starting an SSDP probe on {:?} searching for '{}', stopping after {} results or {}s", address, String::from_utf8_lossy(marker), max_results, max_duration.as_secs_f32() ); let socket = Socket::new(domain, Type::dgram(), None)?; socket.set_multicast_ttl_v4(4)?; socket.set_read_timeout(Some(Duration::from_millis(100)))?; let bind_result = socket.bind(&SockAddr2::from(bind_address)); if let Err(e) = &bind_result { if e.kind() == ErrorKind::AddrInUse { bind_address.set_port(0); socket.bind(&SockAddr2::from(bind_address))?; } else { bind_result?; } } m_search.host.set_port(bind_address.port()); socket.send_to(&m_search.get_payload(), &SockAddr2::from(address))?; let mut result = vec![]; let mut data = [0u8; 1024]; let start = std::time::Instant::now(); loop { match socket.recv_from(&mut data) { Ok((count, addr)) => { log::debug!( "Received SSDP data from {:?}: {:?}", addr, String::from_utf8_lossy(&data[0..count]) ); if data[0..count].windows(marker.len()).any(|it| it == marker) { let addr = addr .as_std() .ok_or_else(|| SsdpProbeError::AddressConversionError(addr))? .ip(); if result.iter().any(|it| it == &addr) { log::debug!("Not adding {:?} to SSDP as it was already added", addr); } else { log::debug!("Adding {:?} to SSDP probe results", addr); result.push(addr); } } if result.len() >= max_results { break; } } Err(e) => { if e.kind() == ErrorKind::TimedOut || e.kind() == ErrorKind::WouldBlock { if start.elapsed() > max_duration { log::debug!("SSDP max duration elapsed, returning"); break; } } else { return Err(SsdpProbeError::from(e)); } } } } log::debug!("SSDP probe finished, results: {:?}", result); Ok(result) }