Crate easy_upnp

easy-upnp

Easily open and close UPnP ports.

A minimalistic wrapper around IGD to open and close network ports via UPnP. Mainly this library is used in the CLI application upnp-daemon, but it can also be used as a library in other crates that just want to open and close ports with minimal possible configuration.

Example

Here is a hands-on example to demonstrate the usage. It will add some ports and immediately remove them again.

use std::error::Error;
use log::error;
use easy_upnp::{add_ports, delete_ports, Ipv4Cidr, PortMappingProtocol, UpnpConfig};

fn get_configs() -> Result<[UpnpConfig; 3], Box<dyn Error>> {
    let config_no_address = UpnpConfig {
        address: None,
        port: 80,
        protocol: PortMappingProtocol::TCP,
        duration: 3600,
        comment: "Webserver".to_string(),
    };

    let config_specific_address = UpnpConfig {
        address: Some(Ipv4Cidr::from_str("192.168.0.10/24")?),
        port: 8080,
        protocol: PortMappingProtocol::TCP,
        duration: 3600,
        comment: "Webserver alternative".to_string(),
    };

    let config_address_range = UpnpConfig {
        address: Some(Ipv4Cidr::from_str("192.168.0")?),
        port: 8081,
        protocol: PortMappingProtocol::TCP,
        duration: 3600,
        comment: "Webserver second alternative".to_string(),
    };

    Ok([
        config_no_address,
        config_specific_address,
        config_address_range,
    ])
}

fn main() -> Result<(), Box<dyn Error>> {
    for result in add_ports(get_configs()?) {
        if let Err(err) = result {
            error!("{}", err);
        }
    }

    for result in delete_ports(get_configs()?) {
        if let Err(err) = result {
            error!("{}", err);
        }
    }

    Ok(())
}

Structs

• Ipv4Cidr
  To represent IPv4 CIDR.
• UpnpConfig
  This struct defines a configuration for a port mapping.

Enums

• Error
  Convenience wrapper over all possible Errors
• PortMappingProtocol
  The protocol for which the given port will be opened. Possible values are UDP and TCP.

Functions

• add_ports
  Add port mappings.
• delete_ports
  Delete port mappings.