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 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352
//! Bindings for [`SCNetworkConfiguration`].
//!
//! [`SCNetworkConfiguration`]: https://developer.apple.com/documentation/systemconfiguration/scnetworkconfiguration?language=objc
use core_foundation::{
array::CFArray,
base::{TCFType, ToVoid},
string::CFString,
};
use system_configuration_sys::network_configuration::{
SCNetworkInterfaceCopyAll, SCNetworkInterfaceGetBSDName, SCNetworkInterfaceGetInterfaceType,
SCNetworkInterfaceGetLocalizedDisplayName, SCNetworkInterfaceGetTypeID, SCNetworkInterfaceRef,
SCNetworkServiceCopyAll, SCNetworkServiceGetEnabled, SCNetworkServiceGetInterface,
SCNetworkServiceGetServiceID, SCNetworkServiceGetTypeID, SCNetworkServiceRef,
SCNetworkSetCopyCurrent, SCNetworkSetGetServiceOrder, SCNetworkSetGetTypeID, SCNetworkSetRef,
};
use crate::preferences::SCPreferences;
core_foundation::declare_TCFType!(
/// Represents a network interface.
///
/// See [`SCNetworkInterfaceRef`] and its [methods] for details.
///
/// [`SCNetworkInterfaceRef`]: https://developer.apple.com/documentation/systemconfiguration/scnetworkinterfaceref?language=objc
/// [methods]: https://developer.apple.com/documentation/systemconfiguration/scnetworkconfiguration?language=objc
SCNetworkInterface,
SCNetworkInterfaceRef
);
core_foundation::impl_TCFType!(
SCNetworkInterface,
SCNetworkInterfaceRef,
SCNetworkInterfaceGetTypeID
);
// TODO: implement all the other methods a SCNetworkInterface has
impl SCNetworkInterface {
/// Get type of the network interface, if the type is recognized, returns `None` otherwise.
///
/// See [`SCNetworkInterfaceGetInterfaceType`] for details.
///
/// [`SCNetworkInterfaceGetInterfaceType`]: https://developer.apple.com/documentation/systemconfiguration/1517371-scnetworkinterfacegetinterfacety?language=objc
pub fn interface_type(&self) -> Option<SCNetworkInterfaceType> {
SCNetworkInterfaceType::from_cfstring(&self.interface_type_string()?)
}
/// Returns the raw interface type identifier.
///
/// See [`SCNetworkInterfaceGetInterfaceType`] for details.
///
/// [`SCNetworkInterfaceGetInterfaceType`]: https://developer.apple.com/documentation/systemconfiguration/1517371-scnetworkinterfacegetinterfacety?language=objc
pub fn interface_type_string(&self) -> Option<CFString> {
unsafe {
let ptr = SCNetworkInterfaceGetInterfaceType(self.0);
if ptr.is_null() {
None
} else {
Some(CFString::wrap_under_get_rule(ptr))
}
}
}
/// Returns the _BSD_ name for the interface, such as `en0`.
///
/// See [`SCNetworkInterfaceGetBSDName`] for details.
///
/// [`SCNetworkInterfaceGetBSDName`]: https://developer.apple.com/documentation/systemconfiguration/1516854-scnetworkinterfacegetbsdname?language=objc
pub fn bsd_name(&self) -> Option<CFString> {
unsafe {
let ptr = SCNetworkInterfaceGetBSDName(self.0);
if ptr.is_null() {
None
} else {
Some(CFString::wrap_under_get_rule(ptr))
}
}
}
/// Returns the localized display name for the interface.
///
/// See [`SCNetworkInterfaceGetLocalizedDisplayName`] for details.
///
/// [`SCNetworkInterfaceGetLocalizedDisplayName`]: https://developer.apple.com/documentation/systemconfiguration/1517060-scnetworkinterfacegetlocalizeddi?language=objc
pub fn display_name(&self) -> Option<CFString> {
unsafe {
let ptr = SCNetworkInterfaceGetLocalizedDisplayName(self.0);
if ptr.is_null() {
None
} else {
Some(CFString::wrap_under_get_rule(ptr))
}
}
}
}
/// Represents the possible network interface types.
///
/// See [_Network Interface Types_] documentation for details.
///
/// [_Network Interface Types_]: https://developer.apple.com/documentation/systemconfiguration/scnetworkconfiguration/network_interface_types?language=objc
#[derive(Debug)]
pub enum SCNetworkInterfaceType {
/// A 6to4 interface.
SixToFour,
/// Bluetooth interface.
Bluetooth,
/// Bridge interface.
Bridge,
/// Ethernet bond interface.
Bond,
/// Ethernet interface.
Ethernet,
/// FireWire interface.
FireWire,
/// IEEE80211 interface.
IEEE80211,
/// IPSec interface.
IPSec,
/// IrDA interface.
IrDA,
/// L2TP interface.
L2TP,
/// Modem interface.
Modem,
/// PPP interface.
PPP,
/// PPTP interface.
///
/// Deprecated, one should use the PPP variant.
PPTP,
/// Serial interface.
Serial,
/// VLAN interface.
VLAN,
/// WWAN interface.
WWAN,
/// IPv4 interface.
IPv4,
}
/// Bridge interface type referred to as `kSCNetworkInterfaceTypeBridge` in private headers.
static BRIDGE_INTERFACE_TYPE_ID: &str = "Bridge";
/// IrDA interface referenced as `kSCNetworkInterfaceTypeIrDA` but deprecated since macOS 12.
static IRDA_INTERFACE_TYPE_ID: &str = "IrDA";
impl SCNetworkInterfaceType {
/// Tries to construct a type by matching it to string constants used to identify a network
/// interface type. If no constants match it, `None` is returned.
pub fn from_cfstring(type_id: &CFString) -> Option<Self> {
use system_configuration_sys::network_configuration::*;
let id_is_equal_to = |const_str| -> bool {
let const_str = unsafe { CFString::wrap_under_get_rule(const_str) };
&const_str == type_id
};
unsafe {
if id_is_equal_to(kSCNetworkInterfaceType6to4) {
Some(SCNetworkInterfaceType::SixToFour)
} else if id_is_equal_to(kSCNetworkInterfaceTypeBluetooth) {
Some(SCNetworkInterfaceType::Bluetooth)
} else if type_id == &BRIDGE_INTERFACE_TYPE_ID {
Some(SCNetworkInterfaceType::Bridge)
} else if id_is_equal_to(kSCNetworkInterfaceTypeBond) {
Some(SCNetworkInterfaceType::Bond)
} else if id_is_equal_to(kSCNetworkInterfaceTypeEthernet) {
Some(SCNetworkInterfaceType::Ethernet)
} else if id_is_equal_to(kSCNetworkInterfaceTypeFireWire) {
Some(SCNetworkInterfaceType::FireWire)
} else if id_is_equal_to(kSCNetworkInterfaceTypeIEEE80211) {
Some(SCNetworkInterfaceType::IEEE80211)
} else if id_is_equal_to(kSCNetworkInterfaceTypeIPSec) {
Some(SCNetworkInterfaceType::IPSec)
} else if type_id == &IRDA_INTERFACE_TYPE_ID {
Some(SCNetworkInterfaceType::IrDA)
} else if id_is_equal_to(kSCNetworkInterfaceTypeL2TP) {
Some(SCNetworkInterfaceType::L2TP)
} else if id_is_equal_to(kSCNetworkInterfaceTypeModem) {
Some(SCNetworkInterfaceType::Modem)
} else if id_is_equal_to(kSCNetworkInterfaceTypePPP) {
Some(SCNetworkInterfaceType::PPP)
} else if id_is_equal_to(kSCNetworkInterfaceTypePPTP) {
Some(SCNetworkInterfaceType::PPTP)
} else if id_is_equal_to(kSCNetworkInterfaceTypeSerial) {
Some(SCNetworkInterfaceType::Serial)
} else if id_is_equal_to(kSCNetworkInterfaceTypeVLAN) {
Some(SCNetworkInterfaceType::VLAN)
} else if id_is_equal_to(kSCNetworkInterfaceTypeWWAN) {
Some(SCNetworkInterfaceType::WWAN)
} else if id_is_equal_to(kSCNetworkInterfaceTypeIPv4) {
Some(SCNetworkInterfaceType::IPv4)
} else {
None
}
}
}
}
/// Retrieve all current network interfaces
///
/// See [`SCNetworkInterfaceCopyAll`] for more details.
///
/// [`SCNetworkInterfaceCopyAll`]: https://developer.apple.com/documentation/systemconfiguration/1517090-scnetworkinterfacecopyall?language=objc
pub fn get_interfaces() -> CFArray<SCNetworkInterface> {
unsafe { CFArray::<SCNetworkInterface>::wrap_under_create_rule(SCNetworkInterfaceCopyAll()) }
}
core_foundation::declare_TCFType!(
/// Represents a network service.
///
/// See [`SCNetworkInterfaceRef`] and its [methods] for details.
///
/// [`SCNetworkInterfaceRef`]: https://developer.apple.com/documentation/systemconfiguration/scnetworkserviceref?language=objc
/// [methods]: https://developer.apple.com/documentation/systemconfiguration/scnetworkconfiguration?language=objc
SCNetworkService,
SCNetworkServiceRef
);
core_foundation::impl_TCFType!(
SCNetworkService,
SCNetworkServiceRef,
SCNetworkServiceGetTypeID
);
impl SCNetworkService {
/// Returns an array of all network services
pub fn get_services(prefs: &SCPreferences) -> CFArray<Self> {
unsafe {
let array_ptr = SCNetworkServiceCopyAll(prefs.to_void());
if array_ptr.is_null() {
return create_empty_array();
}
CFArray::<Self>::wrap_under_create_rule(array_ptr)
}
}
/// Returns true if the network service is currently enabled
pub fn enabled(&self) -> bool {
unsafe { SCNetworkServiceGetEnabled(self.0) == 0 }
}
/// Returns the network interface backing this network service, if it has one.
pub fn network_interface(&self) -> Option<SCNetworkInterface> {
unsafe {
let ptr = SCNetworkServiceGetInterface(self.0);
if ptr.is_null() {
None
} else {
Some(SCNetworkInterface::wrap_under_get_rule(ptr))
}
}
}
/// Returns the service identifier.
pub fn id(&self) -> Option<CFString> {
unsafe {
let ptr = SCNetworkServiceGetServiceID(self.0);
if ptr.is_null() {
None
} else {
Some(CFString::wrap_under_get_rule(ptr))
}
}
}
}
core_foundation::declare_TCFType!(
/// Represents a complete network configuration for a particular host.
///
/// See [`SCNetworkSet`] for details.
///
/// [`SCNetworkSet`]: https://developer.apple.com/documentation/systemconfiguration/scnetworksetref?language=objc
SCNetworkSet,
SCNetworkSetRef
);
core_foundation::impl_TCFType!(SCNetworkSet, SCNetworkSetRef, SCNetworkSetGetTypeID);
impl SCNetworkSet {
/// Constructs a new set of network services from the preferences.
pub fn new(prefs: &SCPreferences) -> Self {
let ptr = unsafe { SCNetworkSetCopyCurrent(prefs.to_void()) };
unsafe { SCNetworkSet::wrap_under_create_rule(ptr) }
}
/// Returns an list of network service identifiers, ordered by their priority.
pub fn service_order(&self) -> CFArray<CFString> {
unsafe {
let array_ptr = SCNetworkSetGetServiceOrder(self.0);
if array_ptr.is_null() {
return create_empty_array();
}
CFArray::<CFString>::wrap_under_get_rule(array_ptr)
}
}
}
fn create_empty_array<T>() -> CFArray<T> {
use std::ptr::null;
unsafe {
CFArray::wrap_under_create_rule(core_foundation::array::CFArrayCreate(
null() as *const _,
null() as *const _,
0,
null() as *const _,
))
}
}
#[cfg(test)]
mod test {
use super::*;
#[test]
fn test_get_all_interfaces() {
let _ = get_interfaces();
}
#[test]
fn test_get_type() {
for iface in get_interfaces().into_iter() {
if iface.interface_type().is_none() {
panic!(
"Interface {:?} ({:?}) has unrecognized type {:?}",
iface.display_name(),
iface.bsd_name(),
iface.interface_type_string()
)
}
}
}
#[test]
fn test_service_order() {
let prefs = SCPreferences::default(&CFString::new("test"));
let services = SCNetworkService::get_services(&prefs);
let set = SCNetworkSet::new(&prefs);
let service_order = set.service_order();
assert!(service_order.iter().all(|service_id| {
services
.iter()
.any(|service| service.id().as_ref() == Some(&*service_id))
}))
}
#[test]
fn test_empty_array() {
let empty = create_empty_array::<CFString>();
let values = empty.get_all_values();
assert!(values.is_empty())
}
}