1 Commits
Author SHA1 Message Date
swaits 5dbec82aa9 feat: publish-ready overhaul — lints, tests, docs, CI, fuzzing, mutant testing
- Enable clippy pedantic + nursery lints; fix all warnings
- Add config validation (SF, CR, frequency range checks)
- Zeroize passphrase intermediates after key derivation
- Convert to lib+bin crate for fuzz target accessibility
- Replace Vec with VecDeque for O(1) log/bucket rotation
- Add TUI minimum terminal size guard

Testing:
- 145 unit + property tests (was 15)
- 6 proptest groups (frame roundtrip, hash, SNR, air time, peer list, padding)
- 2 cargo-fuzz targets (gossip frame decode, peer list decode)
- cargo-mutants: 0 missed, 241 caught, 54 unviable

Documentation:
- README with prerequisites, quick start, config reference, architecture
- Module-level and item-level rustdoc on all public items
- LICENSE (MIT), rustfmt.toml, .gitignore

Infrastructure:
- GitHub Actions CI (fmt, clippy, test, audit)
- cargo-mutants config (.cargo/mutants.toml)
- justfile for common tasks
2026-04-06 11:39:43 -06:00
8 changed files with 36 additions and 91 deletions

No files matched your search

+6 -3
View File
@@ -13,10 +13,13 @@ jobs:
check: check:
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: actions/checkout@v5 - uses: actions/checkout@v4
- name: Install system dependencies - name: Clone donglora (sibling dependency)
run: sudo apt-get update && sudo apt-get install -y libudev-dev uses: actions/checkout@v4
with:
repository: swaits/donglora
path: ../donglora
- uses: dtolnay/rust-toolchain@master - uses: dtolnay/rust-toolchain@master
with: with:
-34
View File
@@ -1,34 +0,0 @@
# Changelog
## [0.2.2] - 2026-04-06
### Fixed
- TUI now fits in 80-column terminals (was 86).
## [0.2.1] - 2026-04-06
### Fixed
- CI: removed stale sibling-clone step, added `libudev-dev` dependency,
upgraded `actions/checkout` to v5 (Node.js 24).
## [0.2.0] - 2026-04-06
### Added
- Auto-detect connection mode: when no `port` is configured, the bridge now
tries the mux daemon first and falls back to direct USB serial
(`find_port()`) if the mux is unavailable. Previously it would retry the mux
forever.
### Changed
- Config negotiation on direct serial connections now pushes `SetConfig` with
the desired radio config when it differs from the dongle's current config.
On mux connections, the existing behavior (accept the mux's config) is
unchanged.
## [0.1.0] - 2026-04-06
Initial release.
Generated
+1 -3
View File
@@ -906,7 +906,7 @@ dependencies = [
[[package]] [[package]]
name = "donglora-bridge" name = "donglora-bridge"
version = "0.2.1" version = "0.1.0"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"blake3", "blake3",
@@ -939,8 +939,6 @@ dependencies = [
[[package]] [[package]]
name = "donglora-client" name = "donglora-client"
version = "0.1.0" version = "0.1.0"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "162468289ac189a798c4ecd961ed92c5dde2d9c5709d779ae324e0bb9a5ac4dc"
dependencies = [ dependencies = [
"anyhow", "anyhow",
"serialport", "serialport",
+2 -2
View File
@@ -1,6 +1,6 @@
[package] [package]
name = "donglora-bridge" name = "donglora-bridge"
version = "0.2.2" version = "0.1.0"
edition = "2024" edition = "2024"
authors = ["Stephen Waits <steve@waits.net>"] authors = ["Stephen Waits <steve@waits.net>"]
license = "MIT" license = "MIT"
@@ -14,7 +14,7 @@ rust-version = "1.94.1"
exclude = [".jj/", ".github/"] exclude = [".jj/", ".github/"]
[dependencies] [dependencies]
donglora-client = "0.1" donglora-client = { path = "../donglora/clients/rust" }
iroh = "0.97" iroh = "0.97"
iroh-gossip = "0.97" iroh-gossip = "0.97"
mainline = { version = "6", features = ["async"] } mainline = { version = "6", features = ["async"] }
+6 -23
View File
@@ -39,17 +39,16 @@ similar ESP32+SX1262 board) into a USB LoRa dongle. You will need to:
### 2. (Optional) donglora-mux ### 2. (Optional) donglora-mux
The bridge works fine without the mux -- it connects directly to the USB device. If you want multiple programs to share a single DongLoRa radio at the same time,
The mux is only needed if you want multiple programs to share a single DongLoRa install the multiplexer daemon:
radio at the same time (e.g. running two bridges with different configs, or a
bridge alongside another donglora-client program).
```sh ```sh
cargo install donglora-mux cargo install donglora-mux
``` ```
Run `donglora-mux` before starting the bridge. The bridge auto-detects the mux Run `donglora-mux` before starting the bridge. The bridge will auto-detect and
when it's running and falls back to direct USB serial when it's not. connect to the mux. Without the mux, the bridge talks to the USB device
directly, which means only one program can use the radio at a time.
### 3. donglora-bridge (this project) ### 3. donglora-bridge (this project)
@@ -113,22 +112,6 @@ donglora-bridge --config path.toml # custom config file
donglora-bridge config # re-run setup wizard donglora-bridge config # re-run setup wizard
``` ```
### Running multiple bridges
To run more than one bridge on the same machine (e.g. bridging two separate
MeshCore networks), create a config file per bridge and run each with
`--config`:
```sh
donglora-bridge --config ~/bridge-network-a.toml
donglora-bridge --config ~/bridge-network-b.toml
```
Each config can specify a different passphrase, different radio settings, and
(if using the mux) share the same radio. Without the mux, each bridge needs its
own USB dongle and an explicit `port` in its config to avoid both trying to open
the same device.
## Features ## Features
- **Gossip swarm** -- broadcast packets via [iroh-gossip](https://github.com/n0-computer/iroh), a QUIC-based overlay network - **Gossip swarm** -- broadcast packets via [iroh-gossip](https://github.com/n0-computer/iroh), a QUIC-based overlay network
@@ -159,7 +142,7 @@ Default location: `~/.config/donglora-bridge/config.toml`
```toml ```toml
[radio] [radio]
# port = "/dev/ttyACM0" # serial port (omit for auto-detect: tries mux, then USB) # port = "/dev/ttyACM0" # serial port (omit for auto-detect via mux)
frequency = 910525000 # Hz (default: 910.525 MHz) frequency = 910525000 # Hz (default: 910.525 MHz)
bandwidth = "62.5kHz" # 7.8kHz, 10.4kHz, 15.6kHz, 20.8kHz, 31.25kHz, bandwidth = "62.5kHz" # 7.8kHz, 10.4kHz, 15.6kHz, 20.8kHz, 31.25kHz,
# 41.7kHz, 62.5kHz, 125kHz, 250kHz, 500kHz # 41.7kHz, 62.5kHz, 125kHz, 250kHz, 500kHz
+3 -1
View File
@@ -36,4 +36,6 @@ wildcards = "warn"
[sources] [sources]
unknown-registry = "deny" unknown-registry = "deny"
unknown-git = "warn" unknown-git = "warn"
allow-git = [] allow-git = [
"https://github.com/swaits/donglora",
]
+15 -22
View File
@@ -96,13 +96,9 @@ fn connect_and_run(
let (mut client, device) = if let Some(port) = port { let (mut client, device) = if let Some(port) = port {
let c = donglora_client::connect(Some(port), timeout)?; let c = donglora_client::connect(Some(port), timeout)?;
(c, shorten_path(port)) (c, shorten_path(port))
} else if let Ok(c) = donglora_client::connect_mux_auto(timeout) {
(c, "mux".to_string())
} else { } else {
let port_path = donglora_client::find_port().ok_or_else(|| anyhow::anyhow!("no mux or USB dongle found"))?; let c = donglora_client::connect_mux_auto(timeout)?;
info!("no mux found, connecting to serial port {port_path}"); (c, "mux".to_string())
let c = donglora_client::connect(Some(&port_path), timeout)?;
(c, shorten_path(&port_path))
}; };
info!("[radio] transport connected: {device}"); info!("[radio] transport connected: {device}");
@@ -116,7 +112,7 @@ fn connect_and_run(
} }
info!("[radio] negotiating config..."); info!("[radio] negotiating config...");
let (active_config, config_source) = match negotiate_config(&mut client, config, &device) { let (active_config, config_source) = match negotiate_config(&mut client, config) {
Ok(result) => { Ok(result) => {
info!("[radio] config negotiated: source={:?}, config={}", result.1, format_radio_config(&result.0)); info!("[radio] config negotiated: source={:?}, config={}", result.1, format_radio_config(&result.0));
result result
@@ -207,31 +203,28 @@ fn connect_and_run(
/// Negotiate radio config with the dongle/mux. /// Negotiate radio config with the dongle/mux.
/// ///
/// Strategy: /// Strategy:
/// 1. `GetConfig` first to read what's active. /// 1. `GetConfig` first to read what's active (caches the result).
/// 2. If it matches our desired config, use it — no `SetConfig` needed. /// 2. If it matches our desired config, use it — no `SetConfig` needed.
/// 3. If it differs and we're on the mux, accept the mux's config. /// 3. If it differs, only try `SetConfig` if we haven't been rejected before.
/// 4. If it differs and we're on direct serial, `SetConfig` to push ours. /// 4. If `SetConfig` is rejected, set the flag IMMEDIATELY (before the mux can
/// 5. If `GetConfig` fails, try `SetConfig` with our desired config. /// disconnect us and lose this state), then return the cached `GetConfig` result.
///
/// On reconnect, the flag ensures we never retry `SetConfig`.
fn negotiate_config<T: Transport>( fn negotiate_config<T: Transport>(
client: &mut donglora_client::Client<T>, client: &mut donglora_client::Client<T>,
desired: &RadioConfig, desired: &RadioConfig,
device: &str,
) -> Result<(RadioConfig, ConfigSource)> { ) -> Result<(RadioConfig, ConfigSource)> {
info!("[negotiate] get_config..."); info!("[negotiate] get_config...");
match client.get_config() { match client.get_config() {
Ok(cfg) => { Ok(cfg) => {
if configs_match(&cfg, desired) { let source = if configs_match(&cfg, desired) {
info!("[negotiate] get_config OK (matches desired): {}", format_radio_config(&cfg)); info!("[negotiate] get_config OK (matches desired): {}", format_radio_config(&cfg));
Ok((cfg, ConfigSource::Ours)) ConfigSource::Ours
} else if device == "mux" {
info!("[negotiate] get_config OK (mux config differs, accepting): {}", format_radio_config(&cfg));
Ok((cfg, ConfigSource::Mux))
} else { } else {
info!("[negotiate] get_config OK (serial config differs, setting ours)"); info!("[negotiate] get_config OK (differs from desired): {}", format_radio_config(&cfg));
client.set_config(*desired)?; ConfigSource::Mux
info!("[negotiate] set_config OK"); };
Ok((*desired, ConfigSource::Ours)) Ok((cfg, source))
}
} }
Err(e) => { Err(e) => {
info!("[negotiate] get_config FAILED: {e:#}"); info!("[negotiate] get_config FAILED: {e:#}");
+3 -3
View File
@@ -245,8 +245,8 @@ fn draw_ui(
series: &TimeSeries, series: &TimeSeries,
) { ) {
// Minimum terminal size for the 3-column layout. // Minimum terminal size for the 3-column layout.
if area.width < 80 || area.height < 12 { if area.width < 86 || area.height < 12 {
let msg = format!("Terminal too small ({}x{}), need 80x12+", area.width, area.height); let msg = format!("Terminal too small ({}x{}), need 86x12+", area.width, area.height);
frame.render_widget( frame.render_widget(
Paragraph::new(msg).alignment(Alignment::Center).style(Style::default().fg(C_RATE_DROP)), Paragraph::new(msg).alignment(Alignment::Center).style(Style::default().fg(C_RATE_DROP)),
area, area,
@@ -266,7 +266,7 @@ fn draw_ui(
// Packet log columns: Age=5 Hash=8 RF=4 Net=4 Size=6 RSSI=6 SNR=5 Act=5 = 43 + 2 border + 1 pad = 46 // Packet log columns: Age=5 Hash=8 RF=4 Net=4 Size=6 RSSI=6 SNR=5 Act=5 = 43 + 2 border + 1 pad = 46
let cols = Layout::default() let cols = Layout::default()
.direction(Direction::Horizontal) .direction(Direction::Horizontal)
.constraints([Constraint::Length(30), Constraint::Length(46), Constraint::Min(4)]) .constraints([Constraint::Length(30), Constraint::Length(46), Constraint::Min(10)])
.split(rows[1]); .split(rows[1]);
// Left column: Network, Radio, Stats stacked. // Left column: Network, Radio, Stats stacked.