Tun Route Daemon

A Rust crate that provides utilities for managing routes and configurations for TUN devices.

How to Use

1. Compilation: Make sure you have Rust installed on your system. Clone the repository and navigate to the project directory.

2. Build the Daemon: Use the following command to build the daemon:

   cargo build --release
   

3. Run the Daemon: To run the daemon, provide the required parameters tun_device_name and tun_device_ip. For example:

   ./target/release/tun-dev-daemon tun0 192.168.1.2
   

   Replace tun0 with the actual TUN device name and 192.168.1.2 with the desired IP address.

4. Workflow: The daemon follows the workflow outlined in the ASCII art diagram below. It initializes, checks the TUN device, stores old routes, sets specific and default routes, monitors the TUN device, and reverts changes if needed.

5. Stopping the Daemon: To stop the daemon, press Ctrl+C in the terminal where it is running.

Please ensure that you have necessary permissions to modify routes and interact with network configuration. The daemon will handle routing changes as per the provided workflow.

Daemon Workflow

  +-------+             +-------------------+
  | Start |------------>| Initialize Daemon |
  +-------+             +-------------------+
                                   |
                                   v
           +--------------------------------------+
           | Receive 'tun device name' and 'tun   |
           | device connection IP address'        |
           +--------------------------------------+
                                   |
                                   v
                        +------------------------+
                        | Check Tun Device        |
                        | Existence              |
                        +------------------------+
                                   |
                          +--------+---------+
                          |                  |
                          |                  |
                          v                  v
              +-------------------+    +-----------------+
              | Store Old Default |    | Log an error and|
              | Route             |    | exit or retry   |
              +-------------------+    +-----------------+
                          |
                          v
              +-------------------+
              | Set Specific Route|
              +-------------------+
                          |
                          v
              +-------------------+
              | Set Default Route |
              +-------------------+
                          |
                          v
              +-------------------+
              | Monitor Tun Device|
              +-------------------+
                          |
                +---------+----------+
                |                    |
                v                    v
    +----------------------+   +------------------+
    | Revert to Old Default|   | Keep Monitoring  |
    | Route                |   +------------------+
    +----------------------+
                |
                v
    +----------------------+
    | Remove Specific Route |
    +----------------------+
                |
                v
    +----------------------+
    |         Stop         |
    +----------------------+

Example Usage

use std::env;
use std::io::Result;
use tun_route_daemon::route_utils as tun_route_utils;

#[tokio::main]
async fn main() -> Result<()> {
    // Parse command-line arguments for 'tun_device_name' and 'tun_device_ip'
    let args: Vec<String> = env::args().collect();
    if args.len() < 3 {
        println!("Usage: {} <tun_device_name> <tun_device_ip>", args[0]);
        return Ok(());
    }
    let tun_device_name = &args[1];
    let tun_device_ip = &args[2];

    // Run the daemon logic using the run_daemon function
    if let Err(err) = tun_route_utils::run_daemon(tun_device_name, tun_device_ip).await {
        eprintln!("Error: {}", err);
    }

    Ok(())
}

For more details and advanced usage, please refer to the documentation and source code.