Create `TunProvider` trait

2 files changed, 44 insertions, 0 deletions

diff --git a/talpid-core/src/tunnel/mod.rs b/talpid-core/src/tunnel/mod.rs
index 4d27be32ec..a2b4bf276a 100644
--- a/talpid-core/src/tunnel/mod.rs
+++ b/talpid-core/src/tunnel/mod.rs
@@ -19,6 +19,9 @@ pub mod openvpn;
 #[cfg(any(target_os = "linux", target_os = "macos"))]
 pub mod wireguard;
 
+/// A module for low level platform specific tunnel device management.
+pub mod tun_provider;
+
 const OPENVPN_LOG_FILENAME: &str = "openvpn.log";
 const WIREGUARD_LOG_FILENAME: &str = "wireguard.log";
 
diff --git a/talpid-core/src/tunnel/tun_provider/mod.rs b/talpid-core/src/tunnel/tun_provider/mod.rs
new file mode 100644
index 0000000000..394fbfc1bb
--- /dev/null
+++ b/talpid-core/src/tunnel/tun_provider/mod.rs
@@ -0,0 +1,41 @@
+use std::net::IpAddr;
+#[cfg(unix)]
+use std::os::unix::io::AsRawFd;
+use talpid_types::BoxedError;
+
+/// Generic tunnel device.
+///
+/// Must be associated with a platform specific file descriptor representing the device.
+#[cfg(unix)]
+pub trait Tun: AsRawFd + Send {
+    /// Retrieve the tunnel interface name.
+    fn interface_name(&self) -> &str;
+}
+
+/// Stub tunnel device.
+#[cfg(windows)]
+pub trait Tun: Send {
+    /// Retrieve the tunnel interface name.
+    fn interface_name(&self) -> &str;
+}
+
+/// Factory of tunnel devices.
+pub trait TunProvider: Send + 'static {
+    /// Create a tunnel device using the provided configuration.
+    fn create_tun(&self, config: TunConfig) -> Result<Box<dyn Tun>, BoxedError>;
+}
+
+/// Configuration for creating a tunnel device.
+pub struct TunConfig {
+    /// IP addresses for the tunnel interface.
+    pub addresses: Vec<IpAddr>,
+}
+
+impl TunConfig {
+    /// Create a new tunnel device configuration using the specified tunnel addresses.
+    pub fn new(addresses: impl IntoIterator<Item = IpAddr>) -> Self {
+        TunConfig {
+            addresses: addresses.into_iter().collect(),
+        }
+    }
+}