release: nmrs 3.0

.github/workflows/contributors.yml

@@ -0,0 +1,25 @@
+name: Contributors
+
+on:
+  workflow_dispatch:
+  push:
+    branches:
+      - master
+
+permissions:
+  contents: write
+  pull-requests: write
+
+jobs:
+  contributors:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Update contributors in README
+        uses: akhilmhdh/contributors-readme-action@v2.3.11
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        with:
+          readme_path: README.md
+          image_size: 100
+          columns_per_row: 6
+          commit_message: "docs: update contributors in README"

Cargo.toml

@@ -12,7 +12,6 @@ license = "MIT"
 repository = "https://github.com/cachebag/nmrs"
 
 [workspace.lints.rust]
-unsafe_code = "forbid"
 # This shouldn't apply to nmrs-gui
 # missing_docs = "warn"
 unused = { level = "warn", priority = -1 }
@@ -33,7 +32,7 @@ uuid = { version = "1.23.1", features = ["v4", "v5"] }
 futures = "0.3.32"
 futures-timer = "3.0.3"
 base64 = "0.22.1"
-nmrs = { path = "nmrs", version = "2.2" }
+nmrs = { path = "nmrs", version = "3.0" }
 gtk = { version = "0.11.2", package = "gtk4" }
 glib = "0.22.5"
 dirs = "6.0.0"

README.md

@@ -43,7 +43,7 @@ async fn main() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
 
     // Scan for networks
-    let networks = nm.list_networks().await?;
+    let networks = nm.list_networks(None).await?;
 
     for net in networks {
         println!(
@@ -70,7 +70,7 @@ async fn main() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
 
     // Connect to a network
-    nm.connect("MyNetwork", WifiSecurity::WpaPsk {
+    nm.connect("MyNetwork", None, WifiSecurity::WpaPsk {
         psk: "password123".into()
     }).await?;
 
@@ -94,7 +94,7 @@ use nmrs::{NetworkManager, WifiSecurity, ConnectionError};
 async fn main() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
 
-    match nm.connect("MyNetwork", WifiSecurity::WpaPsk {
+    match nm.connect("MyNetwork", None, WifiSecurity::WpaPsk {
         psk: "wrong_password".into()
     }).await {
         Ok(_) => println!("Connected successfully"),
@@ -212,12 +212,12 @@ Edit `~/.config/nmrs/style.css` to customize the interface. There are also pre-d
 - [x] Active Connection  
 - [x] Settings  
 - [x] Settings Connection  
-- [ ] Agent Manager  
+- [x] Agent Manager  
 - [ ] Checkpoint  
 - [ ] DNS Manager  
 - [ ] PPP  
-- [ ] Secret Agent  
-- [X] VPN Connection (WireGuard)  
+- [x] Secret Agent  
+- [x] VPN Connection (WireGuard + plugin VPNs)  
 - [ ] VPN Plugin  
 - [ ] Wi-Fi P2P  
 - [ ] WiMAX NSP  
@@ -246,3 +246,34 @@ You may use, copy, modify, and distribute this software under the terms of eithe
 See the following files for full license texts:
 - [MIT License](./LICENSE-MIT)
 - [Apache License 2.0](./LICENSE-APACHE)
+
+## Contributors
+
+Thank you to everyone who has helped build, test, document, and review `nmrs`.
+
+<!-- readme: contributors -start -->
+<table>
+  <tr>
+    <td align="center"><a href="https://github.com/cachebag"><img src="https://avatars.githubusercontent.com/u/111914307?v=4" width="100px;" alt="cachebag"/><br /><sub><b>cachebag</b></sub></a></td>
+    <td align="center"><a href="https://github.com/stoutes"><img src="https://avatars.githubusercontent.com/u/31317041?v=4" width="100px;" alt="stoutes"/><br /><sub><b>stoutes</b></sub></a></td>
+    <td align="center"><a href="https://github.com/pluiee"><img src="https://avatars.githubusercontent.com/u/93393389?v=4" width="100px;" alt="pluiee"/><br /><sub><b>pluiee</b></sub></a></td>
+    <td align="center"><a href="https://github.com/JonnieCache"><img src="https://avatars.githubusercontent.com/u/211093?v=4" width="100px;" alt="JonnieCache"/><br /><sub><b>JonnieCache</b></sub></a></td>
+    <td align="center"><a href="https://github.com/tristanmsct"><img src="https://avatars.githubusercontent.com/u/69300092?v=4" width="100px;" alt="tristanmsct"/><br /><sub><b>tristanmsct</b></sub></a></td>
+    <td align="center"><a href="https://github.com/Rifat-R"><img src="https://avatars.githubusercontent.com/u/81259132?v=4" width="100px;" alt="Rifat-R"/><br /><sub><b>Rifat-R</b></sub></a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/of-the-stars"><img src="https://avatars.githubusercontent.com/u/47869156?v=4" width="100px;" alt="of-the-stars"/><br /><sub><b>of-the-stars</b></sub></a></td>
+    <td align="center"><a href="https://github.com/okhsunrog"><img src="https://avatars.githubusercontent.com/u/42293787?v=4" width="100px;" alt="okhsunrog"/><br /><sub><b>okhsunrog</b></sub></a></td>
+    <td align="center"><a href="https://github.com/ruthwik-01"><img src="https://avatars.githubusercontent.com/u/235033610?v=4" width="100px;" alt="ruthwik-01"/><br /><sub><b>ruthwik-01</b></sub></a></td>
+    <td align="center"><a href="https://github.com/joncorv"><img src="https://avatars.githubusercontent.com/u/151096562?v=4" width="100px;" alt="joncorv"/><br /><sub><b>joncorv</b></sub></a></td>
+    <td align="center"><a href="https://github.com/AK78gz"><img src="https://avatars.githubusercontent.com/u/89071188?v=4" width="100px;" alt="AK78gz"/><br /><sub><b>AK78gz</b></sub></a></td>
+    <td align="center"><a href="https://github.com/pwsandoval"><img src="https://avatars.githubusercontent.com/u/15174704?v=4" width="100px;" alt="pwsandoval"/><br /><sub><b>pwsandoval</b></sub></a></td>
+  </tr>
+  <tr>
+    <td align="center"><a href="https://github.com/ritiek"><img src="https://avatars.githubusercontent.com/u/20314742?v=4" width="100px;" alt="ritiek"/><br /><sub><b>ritiek</b></sub></a></td>
+    <td align="center"><a href="https://github.com/shubhsingh5901"><img src="https://avatars.githubusercontent.com/u/110416544?v=4" width="100px;" alt="shubhsingh5901"/><br /><sub><b>shubhsingh5901</b></sub></a></td>
+    <td align="center"><a href="https://github.com/cinnamonstic"><img src="https://avatars.githubusercontent.com/u/182801542?v=4" width="100px;" alt="cinnamonstic"/><br /><sub><b>cinnamonstic</b></sub></a></td>
+    <td align="center"><a href="https://github.com/tuned-willow"><img src="https://avatars.githubusercontent.com/u/250158319?v=4" width="100px;" alt="tuned-willow"/><br /><sub><b>tuned-willow</b></sub></a></td>
+  </tr>
+</table>
+<!-- readme: contributors -end -->

docs/src/SUMMARY.md

@@ -16,8 +16,10 @@
   - [WPA-PSK Networks](./guide/wifi-wpa-psk.md)
   - [WPA-EAP (Enterprise)](./guide/wifi-enterprise.md)
   - [Hidden Networks](./guide/wifi-hidden.md)
+  - [Per-Device Wi-Fi Scoping](./guide/wifi-per-device.md)
 - [VPN Connections](./guide/vpn.md)
   - [WireGuard Setup](./guide/vpn-wireguard.md)
+  - [OpenVPN Setup](./guide/vpn-openvpn.md)
   - [VPN Management](./guide/vpn-management.md)
 - [Ethernet Management](./guide/ethernet.md)
 - [Bluetooth](./guide/bluetooth.md)
@@ -40,6 +42,8 @@
 - [WiFi Auto-Connect](./examples/wifi-auto-connect.md)
 - [Enterprise WiFi](./examples/enterprise-wifi.md)
 - [WireGuard VPN Client](./examples/wireguard-client.md)
+- [OpenVPN Client](./examples/openvpn-client.md)
+- [.ovpn File Import](./examples/ovpn-import.md)
 - [Network Monitor Dashboard](./examples/network-monitor.md)
 - [Connection Manager](./examples/connection-manager.md)
 

docs/src/advanced/async-runtimes.md

@@ -12,7 +12,7 @@ use nmrs::NetworkManager;
 #[tokio::main]
 async fn main() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
-    let networks = nm.list_networks().await?;
+    let networks = nm.list_networks(None).await?;
     println!("{} networks found", networks.len());
     Ok(())
 }
@@ -49,7 +49,7 @@ use nmrs::NetworkManager;
 #[async_std::main]
 async fn main() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
-    let networks = nm.list_networks().await?;
+    let networks = nm.list_networks(None).await?;
     println!("{} networks found", networks.len());
     Ok(())
 }
@@ -69,7 +69,7 @@ use nmrs::NetworkManager;
 fn main() -> nmrs::Result<()> {
     smol::block_on(async {
         let nm = NetworkManager::new().await?;
-        let networks = nm.list_networks().await?;
+        let networks = nm.list_networks(None).await?;
         println!("{} networks found", networks.len());
         Ok(())
     })
@@ -93,7 +93,7 @@ use nmrs::NetworkManager;
 glib::MainContext::default().spawn_local(async {
     let nm = NetworkManager::new().await.unwrap();
 
-    let networks = nm.list_networks().await.unwrap();
+    let networks = nm.list_networks(None).await.unwrap();
     for net in &networks {
         println!("{}: {}%", net.ssid, net.strength.unwrap_or(0));
     }

docs/src/advanced/dbus.md

@@ -65,7 +65,7 @@ nmrs: nm.monitor_network_changes(callback)
 When connecting to a network, nmrs builds a settings dictionary and sends it via D-Bus:
 
 ```
-nmrs: nm.connect("MyWiFi", WifiSecurity::WpaPsk { psk: "..." })
+nmrs: nm.connect("MyWiFi", None, WifiSecurity::WpaPsk { psk: "..." })
   → Build settings HashMap
   → D-Bus: AddAndActivateConnection(settings, device_path, specific_object)
   ← D-Bus: Active connection path

docs/src/advanced/logging.md

@@ -21,7 +21,7 @@ async fn main() -> nmrs::Result<()> {
     env_logger::init();
 
     let nm = NetworkManager::new().await?;
-    nm.scan_networks().await?;
+    nm.scan_networks(None).await?;
 
     Ok(())
 }

docs/src/advanced/timeouts.md

@@ -98,7 +98,7 @@ let config = TimeoutConfig::new()
 
 let nm = NetworkManager::with_config(config).await?;
 
-match nm.connect("SlowNetwork", WifiSecurity::Open).await {
+match nm.connect("SlowNetwork", None, WifiSecurity::Open).await {
     Ok(_) => println!("Connected!"),
     Err(ConnectionError::Timeout) => {
         eprintln!("Connection timed out — try a longer timeout");

docs/src/api/builders.md

@@ -128,17 +128,14 @@ The `build()` method validates all fields and returns `Result<Settings, Connecti
 Convenience functions that wrap the builders:
 
 ```rust
-use nmrs::builders::{build_wifi_connection, build_ethernet_connection, build_wireguard_connection};
-use nmrs::{WifiSecurity, ConnectionOptions, VpnCredentials};
+use nmrs::builders::{build_wifi_connection, build_ethernet_connection};
+use nmrs::{WifiSecurity, ConnectionOptions};
 
 // Wi-Fi
 let wifi = build_wifi_connection("MyNetwork", &WifiSecurity::Open, &ConnectionOptions::default());
 
 // Ethernet
 let eth = build_ethernet_connection("eth0", &ConnectionOptions::default());
-
-// WireGuard (returns Result)
-let wg = build_wireguard_connection(&creds, &ConnectionOptions::default())?;
 ```
 
 ## When to Use Builders
@@ -151,6 +148,42 @@ Use the builders when you need:
 
 For standard connections, the `NetworkManager` API handles everything automatically.
 
+## OpenVpnBuilder
+
+Builds OpenVPN connection settings from an `OpenVpnConfig` or by importing a `.ovpn` file.
+
+### From Configuration
+
+```rust
+use nmrs::{OpenVpnConfig, OpenVpnAuthType};
+
+let config = OpenVpnConfig::new("CorpVPN", "vpn.example.com", 1194, false)
+    .with_auth_type(OpenVpnAuthType::PasswordTls)
+    .with_username("user")
+    .with_password("secret")
+    .with_ca_cert("/etc/openvpn/ca.crt")
+    .with_client_cert("/etc/openvpn/client.crt")
+    .with_client_key("/etc/openvpn/client.key");
+```
+
+### From .ovpn File
+
+```rust
+use nmrs::builders::OpenVpnBuilder;
+
+let config = OpenVpnBuilder::from_ovpn_file("client.ovpn")?
+    .username("user")
+    .password("secret")
+    .build()?;
+```
+
+Or use the high-level API directly:
+
+```rust
+let nm = NetworkManager::new().await?;
+nm.import_ovpn("client.ovpn", Some("user"), Some("secret")).await?;
+```
+
 ## Full API Reference
 
 See [docs.rs/nmrs](https://docs.rs/nmrs) for complete builder documentation.

docs/src/api/errors.md

@@ -36,15 +36,32 @@ pub enum ConnectionError {
     DeviceFailed(StateReason),
     ActivationFailed(ConnectionStateReason),
 
+    // Per-device errors
+    WifiInterfaceNotFound { interface: String },
+    NotAWifiDevice { interface: String },
+
+    // Radio errors
+    HardwareRadioKilled,
+    BluezUnavailable,
+
     // VPN errors
     NoVpnConnection,
     VpnFailed(String),
+    VpnIdAmbiguous { id: String },
+    IncompleteBuilder(String),
     InvalidPrivateKey(String),
     InvalidPublicKey(String),
     InvalidAddress(String),
     InvalidGateway(String),
     InvalidPeers(String),
 
+    // Connectivity
+    ConnectivityCheckDisabled,
+
+    // BSSID
+    ApBssidNotFound { ssid: String, bssid: String },
+    InvalidBssid(String),
+
     // Other
     InvalidUtf8(Utf8Error),
 }
@@ -127,15 +144,15 @@ pub enum ActiveConnectionState {
 ```rust
 async fn connect() -> nmrs::Result<()> {
     let nm = NetworkManager::new().await?;
-    nm.connect("MyWiFi", WifiSecurity::Open).await?;
+    nm.connect("MyWiFi", None, WifiSecurity::Open).await?;
     Ok(())
 }
 ```
 
 ### Specific Error Handling
 
 ```rust
-match nm.connect("MyWiFi", security).await {
+match nm.connect("MyWiFi", None, security).await {
     Ok(_) => println!("Connected"),
     Err(ConnectionError::AuthFailed) => eprintln!("Wrong password"),
     Err(ConnectionError::NotFound) => eprintln!("Network not found"),
@@ -151,7 +168,7 @@ use anyhow::{Context, Result};
 async fn connect() -> Result<()> {
     let nm = NetworkManager::new().await
         .context("Failed to connect to NetworkManager")?;
-    nm.connect("MyWiFi", WifiSecurity::Open).await
+    nm.connect("MyWiFi", None, WifiSecurity::Open).await
         .context("Failed to connect to MyWiFi")?;
     Ok(())
 }