easy-upnp

![badge github] ![badge crates.io] ![badge docs.rs] ![badge license]

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.

```rust no_run use std::error::Error;

use cidrutils::cidr::Ipv4Cidr; use easyupnp::{addports, deleteports, PortMappingProtocol, UpnpConfig};

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

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> { addports(getconfigs()?);

delete_ports(get_configs()?);

Ok(())

} ```