Compare commits

...
14 Commits
Author SHA1 Message Date
VallierDevandClaude Opus 5.5 b636f1b278 Release v0.2.38
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:22:03 +08:00
VallierDevandClaude Opus 5.5 64d2ffbdd3 ICE: trust the system certificate store for TURN over TLS
A TLS-inspecting HTTP proxy re-signs the TURN certificate with a CA that the
host's administrator installed in the system store; OpenSSL accepts it while
the bundled Mozilla roots alone fail with UnknownIssuer.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 20:21:37 +08:00
VallierDevandClaude Opus 5.5 5656f33d86 Release v0.2.37
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 19:35:12 +08:00
VallierDevandClaude Opus 5.5 6a633e1bc4 ICE: gather TURN relays over TCP/TLS through the HTTP proxy with UU_USE_PROXY=1
Upstream webrtc-ice only gathers UDP relays. Forced-relay sessions also offer
turns:<ip>:<port>?transport=tcp, the only media path on hosts whose UDP cannot
reach the TURN servers but whose TCP goes through an HTTP proxy. Vendor
webrtc-ice 0.10.1 with a TCP/TLS dialer (optional HTTP CONNECT) that frames
STUN/ChannelData for the unchanged turn client. Certificates are chain-verified;
a name mismatch is accepted only for IP-literal TURN URLs. Enabled only with
UU_USE_PROXY=1; default UDP gathering is unchanged.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 19:34:24 +08:00
VallierDevandClaude Opus 5.5 ab137a1b20 Release v0.2.36
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 17:27:17 +08:00
VallierDevandClaude Opus 5.5 092ea713f8 X11: fall back to XGetImage when MIT-SHM attach is refused
XShmAttach fails asynchronously with BadAccess when the X server cannot reach
the segment (for example a server in another container); Xlib's default error
handler exited the host before the existing XGetImage fallback could run.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 17:26:01 +08:00
VallierDevandClaude Opus 5.5 53d5f0e144 viewer: request key frames until the first frame is shown (#124)
A session that joins a host already streaming to another viewer can receive a
clean stream with no IDR in flight, so the loss-driven PLI never fired. Ask
every 30 access units until something is presented, and warn after 300.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 16:36:35 +08:00
VallierDevandClaude Opus 5.5 6b5216df35 Release v0.2.35
Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 15:21:34 +08:00
VallierDevandClaude Opus 5.5 d66937a01c Signaling: honor the REST client's opt-in HTTP proxy policy (#123)
Route host and viewer WebSocket signaling through the shared reqwest client so UU_USE_PROXY=1 applies to signaling as well (HTTP/HTTPS proxies only, no direct fallback, no redirects, strict upgrade validation). ICE/WebRTC media is not proxied.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:42:12 +08:00
VallierDevandClaude Opus 5.5 825f964f7d doctor: warn about extra host instances; README: never share config.json (#122)
Count only top-level hosts (helpers such as the Wayland capture process and
the login window are children) and explain that two instances with one
identity kick each other out of the room.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:32:37 +08:00
VallierDevandClaude Opus 5.5 3f2da6f587 doctor: count re-executed host processes by executable (#122)
The host re-execs through /proc/self/exe, so its process name becomes "exe"
and pgrep -x uuremote-server missed duplicate hosts.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:26:34 +08:00
VallierDevandClaude Opus 5.5 027abba44d Signaling: log the shape of cloud room leaves without a peer id (#122)
Keys, value types and lengths only, as for SOAC offers.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 14:02:10 +08:00
VallierDevandClaude Opus 5.5 ef86019b39 Login: distinguish QR polling failures from expiry with safe diagnostics (#121)
Classify QR request failures (timeout/connect/decode/body/request) with phase, elapsed time and HTTP/API status only; never print tickets, URLs or server content. Extract and test the polling decisions; keep the 60 s timeout and official refresh behaviour.

Co-Authored-By: Claude Opus 5.5 <[email protected]>
2026-10-28 13:28:50 +08:00
shofukantktsandshofukantkts 003da254a6 Wayland: type mobile text_input via clipboard paste on Portal and compositors without spare keycodes (#119)
* Wayland: type mobile text_input via clipboard paste on Portal and compositors without spare keycodes

* Wayland: address review comments for mobile text_input clipboard fallback

- Guard external clipboard commands in unit tests to eliminate desktop side effects
- Narrow paste fallback to Wayland and Portal backends only
- Document clipboard override and two-way sync behavior in README (both zh and en)
- Unify disable switch via UU_WAYLAND_TEXT=0

---------

Co-authored-by: shofukantkts <[email protected]>
2026-10-27 22:14:56 +08:00
85 changed files with 15701 additions and 61 deletions

No files matched your search

+1 -1
View File
@@ -133,7 +133,7 @@ viewer does not reconnect them automatically.
| `UU_LOGIN_WINDOW=0` | don't auto-open the login window |
| `UU_ENGINE_DIR` | directory holding `libuu-wayland.so` / `libuu-portal.so` (`--features engine-plugins`, used by release packages: engines are dlopen'ed only on Wayland sessions; also searched next to the binary, `../lib/uu-remote-linux`, `~/.local/lib/uu-remote-linux`, `/usr/lib/uu-remote-linux`) |
| `UU_WOL_HELPER=1` | experimental: report LAN info (`api-ipv4…/api/v1/device/wake_on_lan/info` {mac, ip, subnet_mask}) after sign-in and answer `wake_on_lan` pushes (`target_device` {mac, ip, subnet_mask}) with a magic packet, like the official Windows host (field names from its log strings; not verified end to end). `wake_on_lan` push key names are always logged |
| `UU_USE_PROXY=1` | honor HTTP/SOCKS proxy env vars; cloud API clients bypass env proxies by default |
| `UU_USE_PROXY=1` | honor HTTP/HTTPS proxy env vars for REST and WebSocket signaling, and also gather TURN relays over TCP/TLS through that proxy (`vendor/webrtc-ice/PATCHES.md`; chain-verified, name mismatch tolerated for IP TURN URLs); clients bypass env proxies by default |
| `UU_REMOTE_ASSIST=0`, `UU_ASSIST_ALLOW=1`, `UU_ASSIST_UI=tty`, `UU_ASSIST_DEBUG=1` | disable assistance / allow at start / terminal UI for `assist` / include the server's short error message in assist errors |
Token has no expiry field; API code 1120 (HTTP 422) means invalid/expired → re-login. `config.json` is parsed once
Generated
+6 -3
View File
@@ -2741,7 +2741,7 @@ checksum = "06abde3611657adf66d383f00b093d7faecc7fa57071cce2578660c9f1010821"
[[package]]
name = "uu-remote-linux"
version = "0.2.34"
version = "0.2.38"
dependencies = [
"async-trait",
"base64 0.22.1",
@@ -2758,12 +2758,14 @@ dependencies = [
"nix 0.29.0",
"qrcode",
"rand 0.8.8",
"rcgen",
"reqwest",
"sdl2",
"serde",
"serde_json",
"sha2",
"tokio",
"tokio-rustls",
"tokio-tungstenite",
"webrtc",
"x11rb",
@@ -3008,23 +3010,24 @@ dependencies = [
[[package]]
name = "webrtc-ice"
version = "0.10.1"
source = "registry+https://github.com/rust-lang/crates.io-index"
checksum = "a1bbd6b3dea22cc6e961e22b012e843d8869e2ac8e76b96e54d4a25e311857ad"
dependencies = [
"arc-swap",
"async-trait",
"crc",
"log",
"rand 0.8.8",
"rustls-native-certs",
"serde",
"serde_json",
"stun",
"thiserror 1.0.69",
"tokio",
"tokio-rustls",
"turn",
"url",
"uuid",
"waitgroup",
"webpki-roots 1.0.9",
"webrtc-mdns",
"webrtc-util",
]
+8 -1
View File
@@ -1,6 +1,6 @@
[package]
name = "uu-remote-linux"
version = "0.2.34"
version = "0.2.38"
edition = "2021"
default-run = "uuremote-server"
authors = ["uu-remote-linux contributors"]
@@ -60,6 +60,11 @@ x11rb = { version = "0.13", features = ["damage", "shm", "allow-unsafe-code"], o
sdl2 = { version = "0.37", optional = true, features = ["use-pkgconfig"] }
[dev-dependencies]
# Synthetic loopback WSS certificates only; both crates already occur in Cargo.lock.
rcgen = "0.11.3"
tokio-rustls = { version = "0.26.6", default-features = false, features = ["ring", "tls12"] }
[build-dependencies]
cc = "1.0"
@@ -69,6 +74,8 @@ webrtc-srtp = { path = "vendor/webrtc-srtp" }
webrtc-dtls = { path = "vendor/webrtc-dtls" }
# Larger data-channel receive buffer (see vendor/webrtc/src/data_channel/mod.rs).
webrtc = { path = "vendor/webrtc" }
# TURN over TCP/TLS through an HTTP CONNECT proxy (vendor/webrtc-ice/PATCHES.md).
webrtc-ice = { path = "vendor/webrtc-ice" }
[[bench]]
name = "nvenc_pipeline_bench"
+13 -2
View File
@@ -45,7 +45,7 @@
| Mouse / keyboard | Absolute and relative motion, clicks, wheel, keys; no spurious key repeat on high-latency links; optional uinput virtual devices on Wayland (layout independent, see below) |
| Mac shortcuts | **Recommended**: turn off 「使用 macOS 快捷键」 (use macOS shortcuts) in the Mac viewer's remote-window menu; then Cmd+C/V/A/F/X/Z work as on a Mac (Cmd+C/V become Ctrl+Shift+C/V in terminals) and Ctrl+C always interrupts. With the option on, the viewer sends Cmd as Ctrl: in a terminal Ctrl+V / Cmd+V paste, Ctrl+C interrupts, copy is Cmd+Shift+C (X11) |
| Pointer shape | Remote cursor shape is mirrored to the viewer (X11) |
| Clipboard | Two-way text sync |
| Clipboard | Two-way text sync; Wayland mobile IME text inputs use clipboard paste fallback (see below) |
| Quality / frame rate / resolution | Auto, Original 20M, Ultra 8M, HD 2M, custom; 30/60/90/144 fps; on X11 a resolution choice changes the desktop resolution itself like the official Windows host (xrandr, adding the mode when missing; restored for "original" or on disconnect), `UU_DESKTOP_RESIZE=0` scales in the encoder instead; Wayland scales in the encoder |
| Sound | System audio captured from PulseAudio / PipeWire and sent as Opus |
| File transfer | Upload, download (including folders), create folder, rename, delete |
@@ -84,6 +84,8 @@ plugins, permissions and encoders only, no account data, tokens or addresses) an
Wayland limits: captures one screen by default; Hyprland can enable monitor switching as described below. Resolution is fixed. The native Hyprland backend now pipelines two shm screencopy buffers and passes the viewer's requested fps to both capture pacing and the encoder. Actual fps remains limited by the compositor, rendering and readback (the old serial path measured about 16–22 fps at 2560x1600; the pipeline is VM-measured only, not a hardware guarantee). The portal backend does not support dynamic resolution; see below for GNOME wake and lock recovery; the clipboard syncs while the viewer's remote window has focus. On the first connection the desktop asks for "Remote Desktop / Screen Sharing"
permission; the permission is remembered once granted.
**Mobile IME typing and clipboard on Wayland**: Mobile IME text (`text_input`) on Wayland is typed through spare keycodes on wlroots compositors. On Portal (GNOME / KDE) or compositors where keycodes are exhausted, it automatically falls back to typing via "system clipboard write + `Shift+Insert` (or `UU_WAYLAND_PASTE_KEY=ctrl_v`)". **Note**: This fallback replaces the host's existing clipboard contents and may echo back to the viewer's clipboard via two-way sync; set `UU_WAYLAND_TEXT=0` to completely disable Wayland mobile text input and clipboard paste fallback.
Scaled GNOME desktops using native Portal input use EIS on the same authorized session when `ConnectToEIS` and a screen `mapping_id` are available. Each axis is mapped using the matched region and actual frame dimensions, with no fixed resolution or scale factor. This avoids scaled-coordinate rejection by `NotifyPointerMotionAbsolute`. Portal builds require libei >= 1.1. Missing EIS support retains the legacy input path and its existing scaling limitations; other initialization failures are reported and trigger session recovery. After a successful EIS connection, all input uses EIS. Capture alone and uinput do not initialize EIS; missing optional logical dimensions do not block capture. Keyboard input uses the existing Windows VK to evdev mapping. Recovery keeps the encoder frame dimensions fixed but accepts logical-size changes after scaling. On GNOME, a display-change notification enables earlier recovery when previously streaming Portal capture remains paused without a valid format for a 200 ms grace after both conditions are present. Healthy renegotiation cancels the early check; repeated notifications do not postpone the same interruption. The five-second fallback remains without a related notification. Static video and valid-format pauses do not trigger recovery. Tested while connected on Ubuntu 26.04, GNOME Wayland, one 3840x2160 display: 200% -> 166.67% -> 200%, with continuously updating video and full-screen pointer control after recovery. Switching briefly freezes and goes black before recovering; five seconds is the fallback threshold, not total recovery time. See [#35](../../pull/35) for timing measurements and validation limits. Lock recovery still needs hardware acceptance testing; multi-monitor support, live resolution changes, and rotation/reflection transforms are outside this fix's scope. Capture settings remain at protocol version 4: advertised resolutions use pixel coordinates and DPR 1; Portal logical dimensions are used only for local input mapping.
GNOME Portal CONTROL no longer waits for a consent dialog or the first video frame. It announces the selected desktop before reporting secure-desktop state and receiving the official viewer's “auto unlock host” request. The official Android viewer requires this desktop selection before entering its auto-unlock flow, so the notification must precede capture readiness; actual screen dimensions, codec information and capture permissions still follow their real readiness state. Enable auto unlock in the viewer and use the current Linux user's login password. The host verifies it with PAM, unlocks the existing GNOME session, requests display wake, and restores capture, input and clipboard through the shared Portal session. Initial consent or revoked permissions still require local approval. Reconnect if physical or logical dimensions change.
@@ -210,6 +212,10 @@ Run inside your graphical session:
Scan the code with the **NetEase UU Remote mobile app** and confirm. Credentials are stored only on this
machine, in `~/.config/uuremote/config.json` (mode 0600).
A failed status query or the 60-second request timeout does not prove that the QR expired or that the phone confirmed login. The official-client refresh policy is unchanged: after a query error, click Refresh QR (Enter in a terminal; refresh after 60 seconds with neither a window nor a terminal). QR request diagnostics contain only the request phase, error category, elapsed time, HTTP/API status and last known scan state—not tickets, URLs or response content. A `connect` category alone does not identify a DNS, TLS or proxy cause.
The same file holds this machine's device identity (`device_id`, `client_id`, `system_id`), which reinstalls and new QR logins keep. **Do not copy `config.json` between machines or clone a second host from a snapshot/disk that includes the home directory**: two host instances with one identity, on the same or different machines, kick each other out of the room. The log then shows `Cloud room leave without peer identifier` every few seconds with reconnects, and viewers disconnect right after connecting. On a cloned or copied machine, stop the service, remove those three keys plus `token`, `csrf` and `user_id`, and run `uuremote-server login` to register a new device. A leftover instance on the same machine (for example an old `~/.local/bin/uuremote-server` started by hand) has the same effect; `uuremote-server doctor` warns when more than one host instance is running.
### 4. Run as a user service
`~/.config/systemd/user/uuremote-native.service`:
@@ -356,7 +362,12 @@ Common environment variables:
| `UU_LOGIN_WINDOW=0` | Do not open the login window automatically when credentials are missing |
| `UU_PORT_MAPPING=0` | Disable port mapping (the official host's controlled-side switch) |
| `UU_WOL_HELPER=1` | Experimental: act as a remote-boot helper like the official Windows host — report this host's LAN info after sign-in and send a magic packet to the LAN when the cloud asks to wake a PC (not verified end to end) |
| `UU_USE_PROXY=1` | Honor HTTP/SOCKS proxy environment variables; by default proxies are ignored and NetEase servers are reached directly |
| `UU_USE_PROXY=1` | Share environment HTTP/HTTPS proxy policy between REST and host/viewer WebSocket signaling; proxies are ignored by default |
`UU_USE_PROXY=1` uses only proxy settings already available to the current process. `HTTP_PROXY` / `HTTPS_PROXY` / `ALL_PROXY` (and lowercase forms) and `NO_PROXY` follow reqwest's standard selection, with uppercase taking precedence. Signaling rejects invalid/unsupported values in the selected variables (HTTP/HTTPS only, not SOCKS), proxy URLs with paths/queries/fragments, and CGI environments that would ignore proxies; this validation is intentionally stricter than silently ignoring bad values. No matching proxy or a `NO_PROXY` match still means direct access; a selected proxy failing does not trigger direct fallback. Certificate verification remains enabled and redirects are not followed, so room authentication is not forwarded to a redirect target.
With it the host also reaches the cloud TURN relays over TCP/TLS (CONNECT through the unauthenticated `http://` proxy in `HTTPS_PROXY`/`ALL_PROXY`, or directly without one), for hosts whose UDP cannot reach the TURN servers but whose TCP/proxy can. TURN certificates are chain-verified; a name mismatch is tolerated only when the cloud-supplied TURN address is an IP (media itself is end-to-end DTLS-SRTP). Without the setting only UDP relays are used, as before. **This creates no new network access**: login, signaling and media each still need an allowed network path. Connector errors expose only fixed categories/HTTP status; do not enable dependency TRACE logs that may record URLs or authentication information.
Host settings such as "lock after remote session" and "mute host" are stored in
`~/.config/uuremote/host_settings.json`. The same file stores `video_encoder`
+13 -2
View File
@@ -39,7 +39,7 @@
| 鼠标 / 键盘 | 绝对/相对移动、点击、滚轮、按键;修复了网络延迟导致的按键连发;Wayland 下可用 uinput 虚拟键鼠(不依赖键盘布局,见下文) |
| Mac 快捷键 | **推荐**:在 Mac 远控窗口菜单里关闭「使用 macOS 快捷键」,之后和在 Mac 上一样:Cmd+C/V/A/F/X/Z 是复制、粘贴、全选、查找、剪切、撤销(终端里 Cmd+C/V 自动变成 Ctrl+Shift+C/V),Ctrl+C 在终端里始终是中断。保持开启时,客户端会把 Cmd 和 Ctrl 都当成 Ctrl 发送:终端里 Ctrl+V / Cmd+V 自动转成粘贴,Ctrl+C 是中断,复制用 Cmd+Shift+C(X11) |
| 鼠标指针样式 | 远端指针形状实时同步(X11) |
| 剪贴板 | 双向文本同步 |
| 剪贴板 | 双向文本同步;Wayland 手机输入法输入通过剪贴板兜底粘贴,见下文 |
| 画质 / 帧率 / 分辨率 | 自动、原画 20M、超清 8M、高清 2M、自定义;30/60/90/144 帧;X11 下切换分辨率会像官方 Windows 被控端一样真正修改桌面分辨率(xrandr,缺少该模式时自动添加;选「原始」或断开后恢复),`UU_DESKTOP_RESIZE=0` 改为仅由编码器缩放;Wayland 仍由编码器缩放 |
| 声音 | 采集系统声音(PulseAudio / PipeWire),Opus 编码传到控制端 |
| 文件传输 | 上传、下载(含文件夹)、新建文件夹、重命名、删除 |
@@ -75,6 +75,8 @@ GNOME Wayland 的 Portal/EIS 路径已在 Ubuntu 26.04、GNOME 50、单屏 4K/20
Wayland 下的限制:默认采集单屏,Hyprland 可按上文启用切屏;分辨率固定;Hyprland 原生后端默认使用双缓冲流水线 shm screencopy,控制端帧率设置会同步到采集节拍和编码器,但实际帧率仍受合成器、渲染和读回速度限制(旧串行路径在 2560x1600 曾测得约 16~22 帧;流水线只在虚拟机里测量过,不代表实机保证);portal 后端暂不支持动态分辨率;GNOME 的屏幕唤醒与锁屏恢复见下;剪贴板只在控制端的远控窗口处于前台时同步。
**Wayland 手机输入法打字与剪贴板**:Wayland 下手机端输入法提交的文字(`text_input`)优先通过虚拟键盘空闲键码上屏;在 Portal(GNOME / KDE)或键码耗尽的环境下,自动通过「写系统剪贴板 + 触发 `Shift+Insert`(或 `UU_WAYLAND_PASTE_KEY=ctrl_v`)」兜底粘贴。**注意**:此兜底过程会覆盖被控端原有的剪贴板内容,且会被双向同步回传到控制端剪贴板;设置 `UU_WAYLAND_TEXT=0` 可完全关闭 Wayland 文字输入及该粘贴兜底。
GNOME 缩放桌面在使用 Portal 原生键鼠时,若支持 `ConnectToEIS` 和屏幕 `mapping_id`,通过同一授权会话的 EIS 接口注入输入,按匹配的区域与实际帧尺寸分别映射横纵坐标,没有固定分辨率或缩放倍率,可避免 `NotifyPointerMotionAbsolute` 在缩放时拒绝坐标。Portal 构建需要 libei ≥ 1.1。缺少 EIS 支持时保留旧输入路径及其既有缩放限制;其他初始化错误会明确报告并触发会话恢复。EIS 连接成功后全部输入统一使用 EIS。只采集画面或使用 uinput 时不会初始化 EIS;缺少可选的逻辑尺寸也不阻断采集。键盘沿用项目现有的 Windows VK → evdev 映射。恢复时保持编码器的采集帧尺寸不变,允许缩放后的逻辑尺寸变化。GNOME 显示配置变化后,已推流的 Portal 采集若持续「暂停且无有效格式」,会在关联通知后的 200 毫秒宽限结束后提前进入现有恢复流程;正常重协商恢复会取消提前判定,连续通知不会推迟同次异常的判定。未收到相关通知时保留五秒兜底;静态画面或有效格式下的暂停不会触发恢复。Ubuntu 26.04、GNOME Wayland 单屏 3840×2160 已实测保持连接切换 200%→166.67%→200%,恢复后画面持续更新且鼠标可控制全屏;切换期间会短暂停顿、黑屏后恢复,五秒是兜底判定阈值,并非总恢复时间。提前恢复的测量结果和验证范围见 [#35](../../pull/35)。此路径仍需实机验证锁屏恢复;多屏、连接中改变分辨率及旋转/镜像变换不属于本次修复范围。 捕获设置协议仍为版本 4:对客户端上报的分辨率统一使用像素坐标、DPR 为 1;Portal 逻辑尺寸仅用于本地输入映射。
GNOME Portal 的控制通道不再等待授权窗口或第一帧画面:先通知客户端当前选择桌面,再上报锁屏状态、接收官方客户端的「自动解锁被控端」请求。官方 Android 客户端需要桌面目标通知才会进入自动解锁流程,因此该通知不能等待采集就绪;真实屏幕尺寸、编码信息及采集权限仍按实际就绪状态上报。请在客户端启用自动解锁,使用当前 Linux 用户的登录密码;主机通过 PAM 验证后解锁当前 GNOME 会话、请求点亮屏幕,并恢复同一 Portal 会话中的画面、键鼠和剪贴板。首次授权或权限被撤销时仍需本机确认。物理或逻辑分辨率变化后需要重连。
@@ -193,6 +195,10 @@ cargo build --release --features wayland,portal # + GNOME/KDE Wayland
用手机上的 **网易 UU 远程 App** 扫码并确认即可。登录信息只保存在本机的
`~/.config/uuremote/config.json`(权限 0600)里。
登录状态查询失败或达到 60 秒请求超时不代表二维码已过期,也不代表手机已经确认。程序保留官方客户端的刷新策略:查询出错后点击「刷新二维码」(终端按回车;无窗口且无终端时 60 秒后刷新)。二维码请求诊断只包含请求阶段、错误类别、耗时、HTTP/API 状态及最后已知扫码状态,不输出票据、URL 或响应内容;`connect` 类别本身不能确定是 DNS、TLS 还是代理问题。
这个文件里还有本机的设备身份(`device_id`、`client_id`、`system_id`),重装软件和重新扫码登录都会沿用它。**不要在机器之间拷贝 `config.json`,也不要从带着家目录的快照/数据盘克隆出第二台主机**:同一身份的两个主机实例(不论在同一台还是不同机器上)会互相把对方踢出房间,日志表现为每隔几秒出现 `Cloud room leave without peer identifier` 并反复重连,控制端一连就断。克隆或拷贝出来的机器先停掉服务,删掉配置里这三个键和 `token`、`csrf`、`user_id`,再运行 `uuremote-server login` 注册为新设备。同一台机器上残留的旧实例(例如以前手动启动的 `~/.local/bin/uuremote-server`)也会这样,`uuremote-server doctor` 发现多个主机实例时会提示。
### 4. 作为用户服务常驻
`~/.config/systemd/user/uuremote-native.service`:
@@ -324,7 +330,12 @@ systemctl --user restart uuremote-native.service
| `UU_ASSIST_ALLOW=1` | 启动时就允许他人远程协助(覆盖窗口里保存的开关状态) |
| `UU_PORT_MAPPING=0` | 关闭端口映射(对应官方被控端的开关) |
| `UU_WOL_HELPER=1` | 实验性:让这台主机像官方 Windows 被控端一样充当「远程开机」辅助设备——登录后向网易上报本机局域网信息,收到云端唤醒请求时向同一局域网发送唤醒包(未经端到端验证) |
| `UU_USE_PROXY=1` | 使用环境变量里的 HTTP/SOCKS 代理;默认忽略代理、直连网易服务器 |
| `UU_USE_PROXY=1` | REST API 与 host/viewer WebSocket 信令共用环境 HTTP/HTTPS 代理策略;默认忽略代理、直连 |
`UU_USE_PROXY=1` 仅使用当前进程已有的代理配置;`HTTP_PROXY` / `HTTPS_PROXY` / `ALL_PROXY`(及小写形式)和 `NO_PROXY` 按 reqwest 的标准规则选择,大写优先。信令拒绝选定变量中的无效/不支持的代理 URL(仅 HTTP/HTTPS;不支持 SOCKS)、带路径/查询/片段的代理 URL,以及会忽略代理的 CGI 环境;此校验比 reqwest 默默忽略坏值更严格。未配置匹配代理或命中 `NO_PROXY` 时仍正常直连,选中代理后连接失败不会改为直连。信令保留 TLS 证书校验,不跟随重定向,也不转发认证头到重定向目标。
开启后主机还会经 TCP/TLS 连接云端 TURN 中继(使用 `HTTPS_PROXY`/`ALL_PROXY` 里的无认证 `http://` 代理做 CONNECT,没有代理则直连),适用于 UDP 到不了 TURN 服务器、只有 TCP/代理能出网的主机;TURN 证书按 CA 链校验,云端下发的 TURN 地址是 IP 时容忍名称不匹配(媒体本身由 DTLS-SRTP 端到端加密)。默认(不开代理)只用 UDP 中继,行为不变。**这不创建任何新的网络出口**:登录、信令和媒体仍需各自有允许使用的网络路径。连接器只返回固定错误类别/HTTP 状态;不要为诊断开启会记录 URL/认证信息的依赖库 TRACE 日志。
「远程结束后自动锁屏」「静音运行」等设置保存在 `~/.config/uuremote/host_settings.json`。同一文件里的 `video_encoder`(`auto`/`cpu`/`vaapi`/`nvenc`)和 `video_codec`(`auto`/`h264`/`h265`)用 `uuremote-server set-encoder`、`uuremote-server set-codec` 写入(非法参数退出码 2)。非 `auto` 的值优先于 `UU_VIDEO_ENCODER` / `UU_VIDEO_CODEC`;`auto` 或留空则落到环境变量,再落到 auto(有 NVIDIA 时 NVENC 优先,失败再 CPU;没有 NVIDIA 时就是 CPU,不探测;codec 仍是硬件优先 H.265、CPU 用 H.264)。探测在启动时后台进行,不挡住第一路出图。成功结果缓存到进程退出,但 NVIDIA 是否存在(`/proc/driver/nvidia/version` 或 `/dev/nvidia0`)与报告不一致时,下一次桌面连接会在后台再探测一次(`warm_auto_probe`),这一路仍用缓存的编码器,直到新结果写入。NVENC 失败只缓存 10 分钟,到期后的桌面连接同样在后台再探测一次,这一路仍用当前结果。`set-encoder` 和 `set-codec` 写完后若 `host.pid` 指向正在运行的本程序,都会发 `SIGUSR2`:编码器变化时进行中的桌面流立刻换编码器(不断开,沿用本会话已协商的 codec;新编码器起不来时按进程内 → FFmpeg 进程 → CPU 回退)。手改文件后可 `kill -USR2 $(cat ~/.config/uuremote/host.pid)`。`SIGUSR2` 不重新探测。codec 偏好仍在下次建立桌面连接时生效(运行中的 host 只记日志,不重开编码)。显式 `vaapi` 请求真彩时仍用 VAAPI、编码 4:2:0,并在 CaptureSettingSync 的 field 3 回报 4:2:0。所选编码器在本机不可用时,建流回退 CPU 并记 warning。VAAPI 进入 auto 要等 #33。
+17 -2
View File
@@ -56,6 +56,15 @@ static void track_injected_key(int keycode, int is_press) {
}
}
/* XShmAttach fails asynchronously (BadAccess when the X server cannot reach our segment, e.g. a
* server in another container); Xlib's default handler would exit the process before the XGetImage fallback. */
static volatile int g_shm_attach_failed = 0;
static int shm_attach_error(Display *display, XErrorEvent *event) {
(void)display; (void)event;
g_shm_attach_failed = 1;
return 0;
}
static void shm_open_image(void) {
g_use_shm = 0;
if (!XShmQueryExtension(g_display)) return;
@@ -66,9 +75,15 @@ static void shm_open_image(void) {
if (g_shminfo.shmid == -1) return;
g_shminfo.shmaddr = g_shm_image->data = (char *)shmat(g_shminfo.shmid, 0, 0);
g_shminfo.readOnly = False;
if (g_shminfo.shmaddr != (char *)-1 && XShmAttach(g_display, &g_shminfo)) {
if (g_shminfo.shmaddr != (char *)-1) {
XSync(g_display, False);
g_use_shm = 1;
g_shm_attach_failed = 0;
int (*previous)(Display *, XErrorEvent *) = XSetErrorHandler(shm_attach_error);
Status attached = XShmAttach(g_display, &g_shminfo);
XSync(g_display, False);
XSetErrorHandler(previous);
if (attached && !g_shm_attach_failed) g_use_shm = 1;
else fprintf(stderr, "X11 shared-memory capture unavailable; using XGetImage\n");
}
shmctl(g_shminfo.shmid, IPC_RMID, 0); // 标记删除,进程退出时自动回收;失败时也不遗留段
}
+21
View File
@@ -0,0 +1,21 @@
信令可走 HTTP 代理、二维码登录错误分类、重复主机实例诊断,以及 Wayland 手机端文字输入兜底。/ Signaling through an opt-in HTTP proxy, clearer QR login errors, duplicate-host diagnostics, and a Wayland fallback for mobile text input.
### 新增 / Added
- **信令遵循 `UU_USE_PROXY=1`(#123)**:主机和 Linux 控制端的 WebSocket 信令改用与 REST 接口相同的 HTTP 客户端,开启 `UU_USE_PROXY=1` 后也走环境里的 HTTP/HTTPS 代理(不支持 SOCKS;选中的代理失败不会改为直连;不跟随重定向)。不代理 ICE/WebRTC 媒体。默认(不开代理)行为不变。
Host and viewer signaling now use the same HTTP client as the REST API, so `UU_USE_PROXY=1` applies to signaling too (HTTP/HTTPS proxies only, no direct fallback, no redirects). Media is not proxied; the default is unchanged.
- **Wayland/Portal 手机端文字输入兜底(#119,感谢 @shofukantkts)**:没有空闲键码的合成器和 Portal 后端上,手机端输入的文字经剪贴板 + Shift+Insert 粘贴;`UU_WAYLAND_TEXT=0` 可关闭。
Mobile text input on Portal and compositors without spare keycodes is pasted via the clipboard and Shift+Insert; `UU_WAYLAND_TEXT=0` disables it.
### 修复 / Fixed
- **二维码登录错误分类(#121)**:状态查询失败不再一律提示「网络超时」,区分超时、连接失败、响应异常与二维码过期;诊断只含阶段、类别、耗时和状态码,不输出票据、URL 或服务器内容。
QR polling failures are no longer all reported as a network timeout; timeouts, connection failures, bad responses and expiry are distinguished, with diagnostics that never include tickets, URLs or server content.
- **重复主机实例(#122)**:同一身份的两个主机实例(拷贝了 `config.json`,或残留的旧手动实例)会互相把对方踢出房间,表现为控制端一连就断。`doctor` 现在能数到重新执行后进程名为 `exe` 的实例并给出提示;README 说明不要在机器之间拷贝 `config.json`;日志会记录无 peer id 的 leave 事件结构(仅键名/类型/长度)。
Two host instances sharing one identity kick each other out of the room. `doctor` now counts re-executed instances and warns about extras, the README explains not to copy `config.json` between machines, and leave events without a peer id log their shape (keys/types/lengths only).
### 验证范围 / Validation
单元测试与 CI。#123 在真实 Linux X11 主机上实测不开代理时信令与 iPhone 桌面连接正常;经真实代理的信令尚未实测。#122 的修复在报告环境实机验证。
### 下载 / Download
`uu-remote-linux_0.2.35_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.35-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.35`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+15
View File
@@ -0,0 +1,15 @@
修复 X11 共享内存被拒时主机直接退出,以及 Linux 控制端加入已有会话时可能永久黑屏。/ Fixes the host exiting when X11 refuses shared memory, and a possible black screen when the Linux viewer joins a host that already streams to another session.
### 修复 / Fixed
- **X11 MIT-SHM 被拒时直接退出**:X 服务器无法访问本程序的共享内存段时(例如 X 服务器在另一个容器里),`XShmAttach` 返回 BadAccess,Xlib 默认错误处理直接结束了进程,原有的 `XGetImage` 退路没有机会执行。现在捕获该错误并改用 `XGetImage` 抓屏。
When `XShmAttach` is refused (BadAccess, e.g. an X server in another container), the host now falls back to `XGetImage` instead of being terminated by Xlib's default error handler.
- **控制端加入已有会话时黑屏(#124,感谢 @shao-zhijie)**:Linux 控制端过去只在丢包或解码出错时请求关键帧;加入一条已在推流的干净 H.264 流时永远等不到 IDR。现在首帧显示前每 30 个访问单元请求一次关键帧(PLI),300 个仍无画面时日志给出提示。
The Linux viewer now requests key frames (PLI) every 30 access units until the first frame is shown, and logs a warning after 300.
### 验证范围 / Validation
单元测试与 CI。共享内存退路尚待在报告环境实机确认;#124 中官方 Mac 主机是否响应 PLI 尚未实测。
### 下载 / Download
`uu-remote-linux_0.2.36_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.36-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.36`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
`UU_USE_PROXY=1` 时经 TCP/TLS(可走 HTTP 代理)连接 TURN 中继,供 UDP 到不了中继服务器的主机使用。/ With `UU_USE_PROXY=1`, TURN relays are also reached over TCP/TLS (optionally through the HTTP proxy) for hosts whose UDP cannot reach the relay servers.
### 新增 / Added
- **TURN over TCP/TLS**:云端在强制中继的会话里也会下发 `turns:<IP>:<端口>?transport=tcp`,原来使用的 webrtc-ice 只支持 UDP 中继,UDP 被限制、只能经 HTTP 代理出网的主机因此拿不到任何中继候选,控制端一直"正在尝试重连"。现在开启 `UU_USE_PROXY=1` 后,主机会经 `HTTPS_PROXY`/`ALL_PROXY` 中的无认证 `http://` 代理(没有则直连)建立 TCP/TLS 中继连接。TURN 证书按 CA 链校验,仅在云端下发的地址为 IP 时容忍名称不匹配;媒体仍由 DTLS-SRTP 端到端加密。未开启时只用 UDP 中继,行为不变(`vendor/webrtc-ice/PATCHES.md`)。
With `UU_USE_PROXY=1` the host also opens TURN relays over TCP/TLS through the unauthenticated `http://` proxy (or directly), chain-verifying certificates and tolerating a name mismatch only for IP TURN URLs. The default stays UDP-only.
### 验证范围 / Validation
单元测试(经模拟代理的 CONNECT 与 STUN/ChannelData 分帧)与 CI;与真实 TURN 服务器的 TCP/TLS 分配尚待在报告环境实机确认。
### 下载 / Download
`uu-remote-linux_0.2.37_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.37-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.37`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+13
View File
@@ -0,0 +1,13 @@
TURN over TLS 改为同时信任系统证书库。/ TURN over TLS now also trusts the system certificate store.
### 修复 / Fixed
- **TURN over TLS 报 UnknownIssuer**:v0.2.37 的 TCP/TLS 中继只信任内置的 Mozilla 根证书;在会检查 TLS 的 HTTP 代理后面,中继证书由主机管理员装在系统证书库里的 CA 重新签发,OpenSSL 能通过、我们却报 `UnknownIssuer`。现在同时信任系统证书库(与 OpenSSL 一致)和内置根证书。仅影响 `UU_USE_PROXY=1` 时的 TCP/TLS 中继。
TCP/TLS relays (only with `UU_USE_PROXY=1`) now trust the system certificate store as well as the bundled Mozilla roots, so CAs added for TLS-inspecting proxies are honoured.
### 验证范围 / Validation
单元测试与 CI;报告环境实机验证进行中。
### 下载 / Download
`uu-remote-linux_0.2.38_<amd64|arm64>.deb`,或 `uu-remote-linux-v0.2.38-<x86_64|aarch64>-linux.tar.gz`(解压后运行 `./install.sh`),或 `docker pull ghcr.io/vallierdev/uu-remote-linux:v0.2.38`(x86_64)。
**非官方项目,与网易无关。** / **Unofficial, not affiliated with NetEase.**
+109 -9
View File
@@ -91,6 +91,48 @@ pub struct UUAuthClient {
guest_id: Option<String>,
}
/// QR failures are safe to display: never retain a URL, source error or response body.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum QrRequestErrorKind { Timeout, Connect, Decode, Body, Request }
impl QrRequestErrorKind {
fn from_reqwest(error: &reqwest::Error) -> Self {
if error.is_timeout() { Self::Timeout }
else if error.is_connect() { Self::Connect }
else if error.is_decode() { Self::Decode }
else if error.is_body() { Self::Body }
else { Self::Request }
}
fn label(self) -> &'static str {
match self { Self::Timeout => "timeout", Self::Connect => "connect", Self::Decode => "decode",
Self::Body => "body", Self::Request => "request" }
}
}
#[derive(Debug)]
pub struct QrRequestError {
pub kind: QrRequestErrorKind,
phase: &'static str,
elapsed_ms: u128,
http_status: Option<u16>,
}
impl std::fmt::Display for QrRequestError {
fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
write!(f, "phase={} kind={} elapsed_ms={} http_status={:?}",
self.phase, self.kind.label(), self.elapsed_ms, self.http_status)
}
}
impl QrRequestError {
pub fn response_received(&self) -> bool { self.http_status.is_some() }
fn new(kind: QrRequestErrorKind, phase: &'static str, started: std::time::Instant, http_status: Option<u16>) -> Self {
Self { kind, phase, elapsed_ms: started.elapsed().as_millis(), http_status }
}
}
async fn send_qr_request(request: reqwest::RequestBuilder, started: std::time::Instant) -> Result<(u16, serde_json::Value), QrRequestError> {
let resp = request.send().await.map_err(|e| QrRequestError::new(QrRequestErrorKind::from_reqwest(&e), "send", started, None))?;
let status = resp.status().as_u16();
let value = resp.json().await.map_err(|e| QrRequestError::new(QrRequestErrorKind::from_reqwest(&e), "response", started, Some(status)))?;
Ok((status, value))
}
/// Transport failures name only the outer request; the cause (certificate, proxy, DNS,
/// timeout) lives in the source chain. URL user-info (proxy credentials) and query
/// strings are removed before the chain is shown.
@@ -121,17 +163,20 @@ fn redact_urls(text: &str) -> String {
out
}
/// Cloud API clients ignore ambient HTTP/SOCKS proxy settings by default: a local
/// Cloud API and signaling clients ignore ambient HTTP/HTTPS proxy settings by default: a local
/// proxy that intercepts TLS breaks login and signaling. `UU_USE_PROXY=1` opts back
/// into reqwest's standard proxy environment handling.
pub fn http_client_builder() -> reqwest::ClientBuilder {
let builder = reqwest::Client::builder();
if std::env::var("UU_USE_PROXY").ok().as_deref().is_some_and(proxy_requested) {
if proxy_enabled() {
builder
} else {
builder.no_proxy()
}
}
pub(crate) fn proxy_enabled() -> bool {
std::env::var("UU_USE_PROXY").ok().as_deref().is_some_and(proxy_requested)
}
fn proxy_requested(value: &str) -> bool {
matches!(value.trim().to_ascii_lowercase().as_str(), "1" | "true" | "yes" | "on")
}
@@ -253,13 +298,13 @@ impl UUAuthClient {
/// Signed POST with an optional JSON body (None = empty body, like Moya `requestPlain`) and an
/// explicit timeout. The official clients long-poll the QR status with a 60 s request timeout.
pub async fn post_with_timeout(&self, path: &str, body: Option<&serde_json::Value>, timeout: std::time::Duration) -> Result<(u16, serde_json::Value), String> {
let body_str = body.map(serde_json::to_string).transpose().map_err(|e| e.to_string())?.unwrap_or_default();
let resp = self.http.post(format!("{}{}", BASE_URL, path)).timeout(timeout)
.headers(self.build_headers("POST", path, &body_str)).body(body_str)
.send().await.map_err(|e| format!("HTTP post {path} failed: {}", transport_error(&e)))?;
let status = resp.status().as_u16();
Ok((status, resp.json().await.unwrap_or(serde_json::Value::Null)))
pub async fn post_with_timeout(&self, path: &str, body: Option<&serde_json::Value>, timeout: std::time::Duration) -> Result<(u16, serde_json::Value), QrRequestError> {
let started = std::time::Instant::now();
let body_str = body.map(serde_json::to_string).transpose()
.map_err(|_| QrRequestError::new(QrRequestErrorKind::Request, "encode", started, None))?.unwrap_or_default();
let request = self.http.post(format!("{}{}", BASE_URL, path)).timeout(timeout)
.headers(self.build_headers("POST", path, &body_str)).body(body_str);
send_qr_request(request, started).await
}
/// Signed JSON POST to another API host (the signature covers the path only).
@@ -389,3 +434,58 @@ mod guest_tests {
for value in ["", "0", "false", "no", "off", "2"] { assert!(!super::proxy_requested(value)); }
}
}
#[cfg(test)]
mod qr_request_tests {
use super::*;
use std::time::{Duration, Instant};
use tokio::io::{AsyncReadExt, AsyncWriteExt};
// Synthetic, loopback-only responses: no account, device, proxy or live login API.
async fn response(reply: &'static [u8], stall: bool) -> QrRequestError {
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
let server = tokio::spawn(async move {
let (mut socket, _) = listener.accept().await.unwrap();
let mut request = [0u8; 4096];
let _ = socket.read(&mut request).await.unwrap();
socket.write_all(reply).await.unwrap();
if stall { std::future::pending::<()>().await; }
});
let request = reqwest::Client::builder().no_proxy().build().unwrap()
.post(format!("http://fixture-user:fixture-password@{addr}/fixture-path?token=fixture-ticket"))
.timeout(Duration::from_secs(2));
let error = send_qr_request(request, Instant::now()).await.unwrap_err();
server.abort();
let output = format!("{error} {error:?}");
for secret in ["fixture-user", "fixture-password", "fixture-path", "fixture-ticket", "fixture-body", "127.0.0.1", "http://"] {
assert!(!output.contains(secret));
}
error
}
#[tokio::test]
async fn qr_request_distinguishes_send_timeout_body_timeout_and_bad_json_without_secrets() {
let error = response(b"", true).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Timeout, "send", None));
assert!(!error.response_received());
let error = response(b"HTTP/1.1 200 OK\r\nContent-Length: 100\r\n\r\n", true).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Timeout, "response", Some(200)));
assert!(error.response_received());
let error = response(b"HTTP/1.1 502 Bad Gateway\r\nContent-Length: 12\r\n\r\nfixture-body", false).await;
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Decode, "response", Some(502)));
assert!(error.response_received());
}
#[tokio::test]
async fn qr_connection_failure_is_not_a_timeout() {
let listener = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let addr = listener.local_addr().unwrap();
drop(listener);
let request = reqwest::Client::builder().no_proxy().build().unwrap()
.post(format!("http://{addr}/fixture-ticket")).timeout(Duration::from_secs(2));
let error = send_qr_request(request, Instant::now()).await.unwrap_err();
assert_eq!((error.kind, error.phase, error.http_status), (QrRequestErrorKind::Connect, "send", None));
assert!(!format!("{error} {error:?}").contains("fixture-ticket"));
}
}
+50 -2
View File
@@ -147,11 +147,39 @@ pub async fn run() -> Result<(), String> {
Err(_) => line("config mode", "missing (run `uuremote-server login`)"),
}
line("service", command_output("systemctl", &["--user", "is-active", "uuremote-native.service"]).await.unwrap_or_else(|| "systemctl unavailable".into()));
let running = command_output("pgrep", &["-c", "-x", "uuremote-server"]).await.filter(|n| !n.is_empty()).unwrap_or_else(|| "unknown".into());
line("uuremote-server procs", format!("{running} (including this one; more than 2 means duplicates)"));
let running = host_processes();
line("uuremote-server procs", format!("{} (including this one; more than 2 means duplicates)", running.map_or_else(|| "unknown".into(), |n| n.to_string())));
if running.is_some_and(|n| n > 2) {
println!(" ! another host instance is running (check `pgrep -af uuremote`); stop the extra one, e.g. an old copy started by hand");
println!(" instances sharing one identity, on this or another machine, kick each other out of the room: never copy config.json between machines");
}
Ok(())
}
/// Hosts re-exec through /proc/self/exe (comm "exe"), so match the executable's file name, not the process name.
/// Helpers a host spawns (Wayland capture, login window) are its children and are not separate instances.
fn host_processes() -> Option<usize> {
let hosts: Vec<(u32, u32)> = std::fs::read_dir("/proc").ok()?.flatten()
.filter_map(|entry| Some((entry.file_name().to_str()?.parse::<u32>().ok()?, entry.path())))
.filter(|(_, dir)| std::fs::read_link(dir.join("exe")).is_ok_and(|exe| is_host_executable(&exe)))
.filter_map(|(pid, dir)| Some((pid, parent_pid(&std::fs::read_to_string(dir.join("stat")).ok()?)?)))
.collect();
Some(top_level(&hosts))
}
/// Field 4 of /proc/<pid>/stat; the command name in field 2 may contain spaces and parentheses.
fn parent_pid(stat: &str) -> Option<u32> {
stat.rsplit_once(')')?.1.split_whitespace().nth(1)?.parse().ok()
}
fn top_level(hosts: &[(u32, u32)]) -> usize {
hosts.iter().filter(|(_, parent)| !hosts.iter().any(|(pid, _)| pid == parent)).count()
}
fn is_host_executable(exe: &std::path::Path) -> bool {
exe.file_name().and_then(|name| name.to_str()).is_some_and(|name| name.trim_end_matches(" (deleted)") == "uuremote-server")
}
#[cfg(test)]
mod tests {
#[test]
@@ -174,4 +202,24 @@ mod tests {
assert!(!super::missing_display(DesktopBackend::Wayland, false, None, None));
assert!(!super::missing_display(DesktopBackend::X11, true, None, None));
}
#[test]
fn host_processes_match_the_executable_even_after_reexec() {
use std::path::Path;
for exe in ["/usr/bin/uuremote-server", "/home/u/.local/bin/uuremote-server", "/usr/bin/uuremote-server (deleted)"] {
assert!(super::is_host_executable(Path::new(exe)));
}
for exe in ["/usr/bin/uuremote-viewer", "/usr/bin/bash", "/usr/bin/uuremote-server-old"] {
assert!(!super::is_host_executable(Path::new(exe)));
}
}
#[test]
fn host_helpers_are_not_counted_as_instances() {
assert_eq!(super::parent_pid("8943 (exe) S 1699 8943 1699 0 -1"), Some(1699));
assert_eq!(super::parent_pid("12 (a) b (c) R 7 12"), Some(7));
// service 10 with a login window 11, a stale copy 20, doctor 30
assert_eq!(super::top_level(&[(10, 1), (11, 10), (20, 5), (30, 9)]), 3);
assert_eq!(super::top_level(&[(10, 1), (11, 10), (30, 9)]), 2);
}
}
+134 -4
View File
@@ -372,8 +372,93 @@ impl InputInjector {
if self.backend==crate::desktop_backend::DesktopBackend::Wayland { crate::wayland::key(symbol,pressed) }
else { unsafe { x11_key_symbol(symbol as libc::c_ulong,i32::from(pressed)) } }
}
/// Set clipboard content for text injection on Wayland / Portal.
/// Tries Portal RemoteDesktop.SetSelection first, then wl-copy as fallback.
fn set_clipboard_text(&self, text: &str) -> bool {
if text.is_empty() || text.len() > crate::clipboard::MAX_TEXT {
return false;
}
// In unit tests, never invoke external clipboard binaries (wl-copy)
// or alter the system clipboard to prevent side effects on developer desktops.
#[cfg(test)]
{
let _ = text;
false
}
#[cfg(not(test))]
{
// 1. Try Portal clipboard if session is bound and active
if let Some(portal) = self.portal.lock().unwrap().as_ref() {
if portal.clipboard_set(text).is_ok() {
return true;
}
}
// 2. Try wl-copy in Wayland session
if std::env::var_os("WAYLAND_DISPLAY").is_some() {
if let Ok(mut child) = std::process::Command::new("wl-copy")
.args(["--type", "text/plain;charset=utf-8"])
.stdin(std::process::Stdio::piped())
.stdout(std::process::Stdio::null())
.stderr(std::process::Stdio::null())
.spawn()
{
if let Some(mut stdin) = child.stdin.take() {
use std::io::Write;
let _ = stdin.write_all(text.as_bytes());
}
if let Ok(status) = child.wait() {
if status.success() {
return true;
}
}
}
}
false
}
}
/// Injects text by copying it to the clipboard and simulating a paste shortcut.
/// Uses Shift+Insert by default (broadest Linux compatibility across GUI apps and terminals),
/// or Ctrl+V if configured via UU_WAYLAND_PASTE_KEY=ctrl_v.
fn paste_text_via_clipboard(&self, text: &str) -> bool {
if !self.set_clipboard_text(text) {
return false;
}
// Give the clipboard daemon / compositor a brief moment to register the selection.
std::thread::sleep(std::time::Duration::from_millis(25));
let use_ctrl_v = std::env::var("UU_WAYLAND_PASTE_KEY")
.is_ok_and(|v| v.eq_ignore_ascii_case("ctrl_v") || v.eq_ignore_ascii_case("ctrl+v"));
if use_ctrl_v {
// Control_L (0xffe3) + 'v' (0x76)
self.inject_key(0xffe3, true);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0x76, true);
std::thread::sleep(std::time::Duration::from_millis(20));
self.inject_key(0x76, false);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xffe3, false);
} else {
// Shift_L (0xffe1) + Insert (0xff63)
self.inject_key(0xffe1, true);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xff63, true);
std::thread::sleep(std::time::Duration::from_millis(20));
self.inject_key(0xff63, false);
std::thread::sleep(std::time::Duration::from_millis(15));
self.inject_key(0xffe1, false);
}
// Brief delay allowing the target application to consume the paste event
std::thread::sleep(std::time::Duration::from_millis(25));
true
}
/// Mobile input-method text (`text_input`). X11 types it directly; Wayland re-maps a spare
/// keycode in the virtual keyboard's keymap. Other backends log once.
/// keycode in the virtual keyboard's keymap. Portal and other Wayland environments inject
/// via clipboard paste (Shift+Insert). Set UU_WAYLAND_TEXT=0 to disable Wayland text injection.
pub fn text_input(&self, text: &str) {
let _serial=self.serial.lock().unwrap();
let Ok(c_text)=std::ffi::CString::new(text.replace('\0',"")) else { return };
@@ -381,17 +466,31 @@ impl InputInjector {
let typed=unsafe { x11_type_utf8(c_text.as_ptr()) };
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
} else if self.backend==crate::desktop_backend::DesktopBackend::Wayland {
// Escape hatch: keep the old behaviour without rebuilding.
// Escape hatch: disable Wayland text typing/pasting entirely without rebuilding.
if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; }
let typed=crate::wayland::type_utf8(text);
if typed>=0 {
log::info!("Desktop text input: chars={} result={}", text.chars().count(), typed);
return;
}
// A keymap whose keycodes are all mapped cannot carry text; report it once.
// Fallback to clipboard paste if keymap has no spare keycodes or native typing failed
if self.paste_text_via_clipboard(text) {
log::info!("Desktop text input (Wayland clipboard paste fallback): chars={} result=ok", text.chars().count());
return;
}
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
log::warn!("Mobile text input unavailable on the Wayland backend (no spare keycode in this keymap)");
log::warn!("Mobile text input unavailable on the Wayland backend (native and clipboard fallback failed)");
}
} else if self.backend==crate::desktop_backend::DesktopBackend::Portal {
if std::env::var("UU_WAYLAND_TEXT").is_ok_and(|v|v=="0") { return; }
if self.paste_text_via_clipboard(text) {
log::info!("Desktop text input (Portal clipboard paste): chars={} result=ok", text.chars().count());
return;
}
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
if !WARNED.swap(true,std::sync::atomic::Ordering::Relaxed) {
log::warn!("Portal clipboard text paste failed: ensure clipboard permission or wl-copy is available");
}
} else {
static WARNED:std::sync::atomic::AtomicBool=std::sync::atomic::AtomicBool::new(false);
@@ -728,3 +827,34 @@ mod x11_monitor_pointer_tests {
crate::wayland::select(0).unwrap();
}
}
#[cfg(test)]
mod clipboard_paste_text_tests {
use super::*;
#[test]
fn rejects_empty_and_oversized_text() {
let input = InputInjector::new();
assert!(!input.set_clipboard_text(""));
let oversized = "a".repeat(crate::clipboard::MAX_TEXT + 1);
assert!(!input.set_clipboard_text(&oversized));
}
#[test]
fn text_input_handles_portal_backend_safely_without_side_effects() {
let mut input = InputInjector::new();
input.backend = crate::desktop_backend::DesktopBackend::Portal;
// In unit tests, set_clipboard_text avoids external commands so this
// will not mutate the host's actual clipboard.
input.text_input("测试输入法文字");
}
#[test]
fn text_input_respects_disable_env() {
let mut input = InputInjector::new();
input.backend = crate::desktop_backend::DesktopBackend::Portal;
std::env::set_var("UU_WAYLAND_TEXT", "0");
input.text_input("测试输入法文字");
std::env::remove_var("UU_WAYLAND_TEXT");
}
}
+108 -19
View File
@@ -8,7 +8,7 @@
//! (analysis/tools-fix-20261013/viewer-fieldmd.json). Results are written to the private
//! config file (chmod 600). Tokens and tickets are never printed or logged.
use crate::auth::{Credentials, UUAuthClient};
use crate::auth::{Credentials, QrRequestErrorKind, UUAuthClient};
use crate::login_ui::{LoginUi, Tone};
use serde_json::{json, Value};
use std::time::Duration;
@@ -127,6 +127,35 @@ fn render_qr(content: &str) -> Result<String, String> {
/// API code for an expired login QR code.
const QR_EXPIRED: i64 = 1190;
/// QR API errors must not echo server messages/validation fields: they may contain credentials.
fn qr_data<'a>(stage: &str, status: u16, body: &'a Value) -> Result<&'a Value, String> {
let code = body.get("code").and_then(Value::as_i64);
if status == 200 && code == Some(0) { return Ok(body.get("data").unwrap_or(&Value::Null)); }
Err(format!("{stage}: http_status={status} api_code={code:?}"))
}
#[derive(Debug, PartialEq, Eq)]
enum QrPollAction { Wait(i64), Scanned, Confirmed, Refresh(Duration), Failed(&'static str) }
/// Preserve the official refresh policy; a failed query says nothing about QR expiry.
fn qr_poll_action(last_status: i64, http_status: u16, body: &Value) -> QrPollAction {
if body.get("code").and_then(Value::as_i64) == Some(QR_EXPIRED) {
return QrPollAction::Failed("二维码已失效");
}
let Ok(data) = qr_data("qrcode status", http_status, body) else {
return QrPollAction::Failed("二维码状态查询失败");
};
match data.get("status").and_then(Value::as_i64) {
Some(1) => QrPollAction::Wait(1),
Some(2) if last_status != 2 => QrPollAction::Scanned,
Some(2) => QrPollAction::Wait(2),
Some(0) => QrPollAction::Refresh(Duration::from_millis(350)),
Some(3) => QrPollAction::Refresh(Duration::ZERO),
Some(4) => QrPollAction::Confirmed,
_ => QrPollAction::Failed("二维码状态响应异常"),
}
}
/// QR modules as RGBA pixels: `scale` pixels per module, `quiet` light modules around the code.
fn qr_rgba(content: &str, scale: usize, quiet: usize) -> Result<(Vec<u8>, usize), String> {
let code = qrcode::QrCode::new(content.as_bytes()).map_err(|e| format!("QR encode failed: {e}"))?;
@@ -276,8 +305,16 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
// every QR within seconds (#68).
let timeout = Duration::from_secs(60);
loop {
let (status, resp) = client.post_with_timeout("/api/v1/qrcode/gen/login", None, timeout).await?;
let d = match data("qrcode gen", status, &resp) {
let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/gen/login", None, timeout).await {
Ok(r) => r,
Err(e) if e.response_received() => {
eprintln!("QR generation response failed: {e}");
wait_for_refresh(ui, "二维码加载失败").await;
continue;
}
Err(e) => return Err(format!("QR generation failed: {e}")),
};
let d = match qr_data("qrcode gen", status, &resp) {
Ok(d) => d.clone(),
Err(e) => { println!("QR code could not be loaded ({e})"); wait_for_refresh(ui, "二维码加载失败").await; continue; }
};
@@ -303,24 +340,42 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
let query = json!({"token": ticket, "qrcode_jump_url": url, "login_status": login_status});
let (status, resp) = match client.post_with_timeout("/api/v1/qrcode/login/status", Some(&query), timeout).await {
Ok(r) => r,
Err(_) => break "网络超时,二维码已停止刷新",
Err(e) => {
eprintln!("QR status query failed: {e}; last_status={login_status}");
break match e.kind {
QrRequestErrorKind::Timeout => "二维码状态查询超时(不代表二维码已失效)",
_ => "二维码状态查询失败(不代表二维码已失效)",
};
}
};
let code = resp.get("code").and_then(|c| c.as_i64());
if code == Some(QR_EXPIRED) { break "二维码已失效"; }
let Ok(d) = data("qrcode status", status, &resp) else { break "二维码状态查询失败"; };
let st = d.get("status").and_then(|v| v.as_i64()).unwrap_or(login_status);
match st {
1 => {}
2 => if login_status != 2 {
match qr_poll_action(login_status, status, &resp) {
QrPollAction::Wait(st) => {
if st == 1 && login_status != 1 { ui.status("等待扫码…", Tone::Info); }
login_status = st;
}
QrPollAction::Scanned => {
login_status = 2;
println!("已扫码,请在手机上确认 (scanned, confirm on the phone)");
ui.status("已扫码,请在手机上确认登录", Tone::Ok);
},
3 => { println!("QR code expired; generating a new one"); break ""; }
0 => { tokio::time::sleep(Duration::from_millis(350)).await; break ""; }
4 => {
}
QrPollAction::Refresh(delay) => {
if delay.is_zero() { println!("QR code expired; generating a new one"); }
else { tokio::time::sleep(delay).await; }
break "";
}
QrPollAction::Confirmed => {
println!("已确认,正在完成登录 (confirmed, completing login)");
ui.status("已确认,正在完成登录…", Tone::Info);
let body = json!({"token": ticket, "qrcode_jump_url": url});
let (status, resp) = client.post_with_timeout("/api/v1/login/by_qrcode", Some(&body), timeout).await?;
let d = match data("qrcode login", status, &resp) {
let (status, resp) = match client.post_with_timeout("/api/v1/login/by_qrcode", Some(&body), timeout).await {
Ok(r) => r,
Err(e) if e.response_received() => {
eprintln!("QR login exchange response failed: {e}");
break "登录失败";
}
Err(e) => return Err(format!("QR login exchange failed: {e}")),
};
let d = match qr_data("qrcode login", status, &resp) {
Ok(d) => d,
Err(e) => { println!("QR login not granted ({e})"); break "登录失败"; }
};
@@ -339,9 +394,12 @@ pub(crate) async fn flow(ui: &LoginUi) -> Result<String, String> {
println!("Logged in as {} ({}); saved to {}", nickname, user, path.display());
return Ok(if nickname.is_empty() { user.to_string() } else { nickname.to_string() });
}
other => { println!("QR status: {other}"); break "二维码已失效"; }
QrPollAction::Failed(reason) => {
eprintln!("QR status query stopped: http_status={status} api_code={:?} status={:?} last_status={login_status}",
resp.get("code").and_then(Value::as_i64), resp.get("data").and_then(|d| d.get("status")).and_then(Value::as_i64));
break reason;
}
}
login_status = st;
};
if !failure.is_empty() { wait_for_refresh(ui, failure).await; }
}
@@ -376,6 +434,37 @@ async fn wait_for_refresh(ui: &LoginUi, reason: &str) {
#[cfg(test)]
mod tests {
use super::*;
#[test]
fn qr_poll_keeps_waiting_scanned_and_confirmed_distinct() {
let reply = |status| json!({"code": 0, "data": {"status": status}});
assert_eq!(qr_poll_action(1, 200, &reply(1)), QrPollAction::Wait(1));
assert_eq!(qr_poll_action(1, 200, &reply(2)), QrPollAction::Scanned);
assert_eq!(qr_poll_action(2, 200, &reply(2)), QrPollAction::Wait(2));
assert_eq!(qr_poll_action(2, 200, &reply(4)), QrPollAction::Confirmed);
assert_eq!(qr_poll_action(1, 200, &reply(0)), QrPollAction::Refresh(Duration::from_millis(350)));
assert_eq!(qr_poll_action(2, 200, &reply(3)), QrPollAction::Refresh(Duration::ZERO));
assert_eq!(qr_poll_action(2, 400, &json!({"code": 1190})), QrPollAction::Failed("二维码已失效"));
}
#[test]
fn qr_poll_failures_do_not_imply_expiry_or_confirmation() {
for last in [1, 2] {
for body in [json!(null), json!({"code": 1}), json!({"code": 0, "data": {"status": 4}})] {
assert_eq!(qr_poll_action(last, 503, &body), QrPollAction::Failed("二维码状态查询失败"));
}
assert_eq!(qr_poll_action(last, 200, &json!({"code": 1})), QrPollAction::Failed("二维码状态查询失败"));
for data in [json!(null), json!({}), json!({"status": "4"}), json!({"status": 99}), json!({"status": -1})] {
assert_eq!(qr_poll_action(last, 200, &json!({"code": 0, "data": data})), QrPollAction::Failed("二维码状态响应异常"));
}
}
}
#[test]
fn qr_api_errors_do_not_echo_server_content() {
let body = json!({"code": 1001, "msg": "fixture-token", "data": [{"loc": "fixture-ticket"}]});
assert_eq!(qr_data("qrcode gen", 400, &body).unwrap_err(), "qrcode gen: http_status=400 api_code=Some(1001)");
}
#[test]
fn status_ticket_prefers_status_query_ticket() {
assert_eq!(qr_ticket(&json!({"token": "old", "status_query_ticket": "new"})), Some("new"));
+2
View File
@@ -1,6 +1,7 @@
//! UU Remote Pure Native Linux Server (Rust Edition)
//! Zero-Wine, Zero-Python, Single-Binary, 5 Native Tools Integrated
mod ws_transport;
mod engine_plugin;
mod doctor;
mod wol;
@@ -629,6 +630,7 @@ async fn main() -> Result<(), Box<dyn std::error::Error>> {
virtual_audio::init();
let _audio_cleanup=virtual_audio::Cleanup;
log::info!("Starting uu-remote-linux host v{}...", env!("CARGO_PKG_VERSION"));
session_ice::configure_relay_transport();
// Before host.pid, and before assist: a missing or failed assist session must still handle SIGUSR2.
let _ = install_host_signals(None);
video::warm_auto_probe();
+75
View File
@@ -56,6 +56,31 @@ impl SessionIce {
}
}
/// With `UU_USE_PROXY=1`, also gather TURN relays over TCP/TLS (through the HTTP proxy when
/// one is configured); hosts whose UDP cannot reach the TURN servers then still get a relay.
pub fn configure_relay_transport() {
if !crate::auth::proxy_enabled() { return; }
let value = ["HTTPS_PROXY", "https_proxy", "ALL_PROXY", "all_proxy"].iter().find_map(|name| std::env::var(name).ok()).filter(|v| !v.is_empty());
let proxy = match value.as_deref().map(relay_proxy) {
Some(Ok(proxy)) => Some(proxy),
Some(Err(reason)) => { log::warn!("TURN over TCP/TLS disabled: {reason}"); return; }
None => None,
};
log::info!("TURN over TCP/TLS enabled: via_http_proxy={}", proxy.is_some());
webrtc::ice::agent::turn_tcp::set_relay_transport(webrtc::ice::agent::turn_tcp::RelayTransport { http_proxy: proxy });
}
/// `host:port` of an unauthenticated HTTP proxy URL; never echoes the value.
fn relay_proxy(value: &str) -> Result<String, &'static str> {
let url = reqwest::Url::parse(&if value.contains("://") { value.to_owned() } else { format!("http://{value}") })
.map_err(|_| "invalid proxy URL")?;
if url.scheme() != "http" { return Err("only http:// proxies are supported for TURN"); }
if !url.username().is_empty() || url.password().is_some() { return Err("proxy authentication is not supported for TURN"); }
let host = url.host_str().ok_or("invalid proxy URL")?;
let port = url.port_or_known_default().ok_or("invalid proxy URL")?;
Ok(format!("{host}:{port}")) // host_str() keeps IPv6 brackets
}
#[cfg(test)]
mod tests {
use super::*;
@@ -74,4 +99,54 @@ mod tests {
assert_eq!(config.ice_servers.len(),1);
assert!(config.ice_servers[0].urls.iter().all(|s|s.starts_with("stun:")));
}
#[test]
fn relay_proxy_accepts_plain_http_only() {
assert_eq!(super::relay_proxy("http://proxy.invalid:8889").unwrap(), "proxy.invalid:8889");
assert_eq!(super::relay_proxy("proxy.invalid:8889/").unwrap(), "proxy.invalid:8889");
assert_eq!(super::relay_proxy("http://[::1]:3128").unwrap(), "[::1]:3128");
for bad in ["socks5://proxy.invalid:1080", "https://proxy.invalid:443", "http://user:[email protected]:8889", "::"] {
assert!(super::relay_proxy(bad).is_err());
}
}
#[test]
fn turn_tcp_frames_stun_and_padded_channel_data() {
use webrtc::ice::agent::turn_tcp::frame_len;
assert_eq!(frame_len([0x01, 0x01, 0x00, 0x08]), Some(28));
assert_eq!(frame_len([0x40, 0x00, 0x00, 0x05]), Some(12));
assert_eq!(frame_len([0x40, 0x00, 0x00, 0x08]), Some(12));
assert_eq!(frame_len([0x80, 0x00, 0x00, 0x00]), None);
}
#[tokio::test]
async fn turn_tcp_connects_through_the_proxy_and_frames_the_stream() {
use tokio::io::{AsyncReadExt, AsyncWriteExt};
use webrtc::ice::agent::turn_tcp::{dial, set_relay_transport, RelayTransport};
use webrtc::util::Conn;
let proxy = tokio::net::TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy_addr = proxy.local_addr().unwrap();
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let mut head = Vec::new();
while !head.ends_with(b"\r\n\r\n") { let mut b = [0u8; 1]; socket.read_exact(&mut b).await.unwrap(); head.push(b[0]); }
assert!(String::from_utf8_lossy(&head).starts_with("CONNECT 192.0.2.1:2483 HTTP/1.1\r\n"));
socket.write_all(b"HTTP/1.1 200 Connection established\r\n\r\n").await.unwrap();
let mut frames = [0u8; 20 + 12];
socket.read_exact(&mut frames).await.unwrap();
socket.write_all(&frames).await.unwrap();
});
set_relay_transport(RelayTransport { http_proxy: Some(proxy_addr.to_string()) });
let target: std::net::SocketAddr = "192.0.2.1:2483".parse().unwrap();
let conn = dial("192.0.2.1", 2483, target, false).await.unwrap();
let mut stun = [0u8; 20]; stun[1] = 0x01;
let channel = [0x40, 0x00, 0x00, 0x05, 1, 2, 3, 4, 5, 0, 0, 0];
conn.send_to(&stun, target).await.unwrap();
conn.send_to(&channel, target).await.unwrap();
let mut buf = [0u8; 64];
assert_eq!(conn.recv_from(&mut buf).await.unwrap(), (20, target));
assert_eq!(conn.recv_from(&mut buf).await.unwrap(), (12, target));
assert_eq!(&buf[..12], &channel);
server.await.unwrap();
}
}
+3 -9
View File
@@ -7,7 +7,6 @@ use std::sync::atomic::{AtomicBool, AtomicU64, Ordering};
use std::sync::Arc;
use std::time::{Duration, Instant};
use tokio::sync::mpsc;
use tokio_tungstenite::connect_async;
use tokio_tungstenite::tungstenite::client::IntoClientRequest;
use tokio_tungstenite::tungstenite::Message;
@@ -231,14 +230,8 @@ mod refresh_tests {
async fn open_socket(
req: tokio_tungstenite::tungstenite::handshake::client::Request,
limit: Duration,
) -> Result<tokio_tungstenite::WebSocketStream<tokio_tungstenite::MaybeTlsStream<tokio::net::TcpStream>>, String> {
match tokio::time::timeout(limit, connect_async(req)).await {
Ok(result) => result.map(|(ws, _)| ws).map_err(|e| format!("WS connect failed: {}", e)),
Err(_) => {
log::warn!("Signaling connect timed out after {}s", limit.as_secs());
Err("WS connect timed out".into())
}
}
) -> Result<crate::ws_transport::Socket, String> {
crate::ws_transport::connect(req, limit).await
}
impl SignalingClient {
@@ -469,6 +462,7 @@ impl SignalingClient {
log::info!("Cloud peer event: generation={} event={} age_s={} pings={} last_ping_gap_s={} ice_id_present={}",generation,event_name,started.elapsed().as_secs(),pings,last_ping.elapsed().as_secs(),data.get("ice_id").is_some());
let ice_id = data.get("ice_id").and_then(|v| v.as_str()).unwrap_or("");
if ice_id.is_empty() {
log::info!("Cloud room leave shape: {}", crate::protocol::json_shape(data, 3));
log::warn!("Cloud room leave without peer identifier; renewing signaling (expiry cause unknown)");
if !send_event(&event_sender, SignalingEvent::Disconnected).await { break; }
} else {
+11 -1
View File
@@ -11,8 +11,14 @@ pub trait Decoder { fn set_codec(&mut self,codec:super::media::Codec)->Result<()
pub trait FrameSink { fn present(&mut self,frame:&Frame)->Result<(),String>; }
/// Counts only (access units, presented frames, decode errors) for the periodic stats line.
pub static STATS:[std::sync::atomic::AtomicU64;3]=[std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0),std::sync::atomic::AtomicU64::new(0)];
fn wants_key_frame(units:u64,presented:u64)->bool {presented==0 && units%30==0}
pub fn display(decoder:&mut dyn Decoder,sink:&mut dyn FrameSink,au:&[u8],codec:super::media::Codec,pli:&AtomicBool)->Result<(),String> {
STATS[0].fetch_add(1,Ordering::Relaxed);
let units=STATS[0].fetch_add(1,Ordering::Relaxed)+1;
// A later session can join a clean stream with no IDR in flight (#124): keep asking until a frame shows.
if wants_key_frame(units,STATS[1].load(Ordering::Relaxed)) {
pli.store(true,Ordering::Release);
if units==300 { log::warn!("Viewer desktop: no decodable frame after {units} access units; requesting key frames (another session may hold the host)"); }
}
// Local diagnostic: UU_VIEWER_DUMP_H264=path appends the first 300 access units (owner's own stream).
if codec==super::media::Codec::H264 && STATS[0].load(Ordering::Relaxed)<=300 { if let Some(path)=std::env::var_os("UU_VIEWER_DUMP_H264") {
use std::io::Write; if let Ok(mut f)=std::fs::OpenOptions::new().create(true).append(true).open(path){let _=f.write_all(au);}
@@ -32,5 +38,9 @@ pub fn display(decoder:&mut dyn Decoder,sink:&mut dyn FrameSink,au:&[u8],codec:s
use super::*;
struct Mock(bool);impl Decoder for Mock {fn set_codec(&mut self,_:crate::viewer::media::Codec)->Result<(),String>{Ok(())} fn decode(&mut self,_:&[u8])->Result<Vec<Frame>,String>{if self.0{Err("synthetic".into())}else{Ok(vec![Frame{width:1,height:1,rgb:vec![0;3],content:None}])}} fn reset(&mut self){self.0=false;}}
struct Sink(usize);impl FrameSink for Sink{fn present(&mut self,f:&Frame)->Result<(),String>{assert_eq!(f.rgb.len(),3);self.0+=1;Ok(())}}
#[test] fn requests_key_frames_until_the_first_frame(){
assert_eq!((1..=90).filter(|&n|wants_key_frame(n,0)).count(),3);
assert!(!(1..=90).any(|n|wants_key_frame(n,1)));
}
#[test] fn decode_error_requests_pli_and_recovers(){let mut d=Mock(true);let mut s=Sink(0);let p=AtomicBool::new(false);display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert!(p.load(Ordering::Acquire));display(&mut d,&mut s,&[],crate::viewer::media::Codec::H264,&p).unwrap();assert_eq!(s.0,1);}
}
+4 -6
View File
@@ -3,13 +3,11 @@
use base64::Engine as _;
use futures_util::{SinkExt, StreamExt};
use serde_json::Value;
use tokio::net::TcpStream;
use tokio_tungstenite::{connect_async, MaybeTlsStream, WebSocketStream};
use tokio_tungstenite::tungstenite::{client::IntoClientRequest, Message};
use std::{collections::VecDeque,time::Duration};
pub struct Signal {
ws: WebSocketStream<MaybeTlsStream<TcpStream>>,
ws: crate::ws_transport::Socket,
next_ack:u64,
pending:VecDeque<Value>,
legacy_prefix:bool,
@@ -17,14 +15,14 @@ pub struct Signal {
impl Signal {
pub async fn connect(urls:&[String], token:&str, timeout:Duration, legacy_prefix:bool)->Result<Self,String> {
for url in urls {
if let Ok(Ok(signal))=tokio::time::timeout(timeout,Self::one(url,token,legacy_prefix)).await {return Ok(signal)}
if let Ok(Ok(signal))=tokio::time::timeout(timeout,Self::one(url,token,legacy_prefix,timeout)).await {return Ok(signal)}
}
Err("Signaling connection failed (details omitted)".into())
}
async fn one(url:&str,token:&str,legacy_prefix:bool)->Result<Self,String> {
async fn one(url:&str,token:&str,legacy_prefix:bool,timeout:Duration)->Result<Self,String> {
let mut request=format!("{}/socket.io/?transport=websocket&EIO=4",url.trim_end_matches('/')).into_client_request().map_err(|_|"Invalid signaling endpoint")?;
request.headers_mut().insert("X-NRD-AUTH",token.parse().map_err(|_|"Invalid room authentication header")?);
let (ws,_)=connect_async(request).await.map_err(|_|"Signaling transport failed")?;
let ws=crate::ws_transport::connect(request,timeout).await?;
let mut s=Self{ws,next_ack:10,pending:VecDeque::new(),legacy_prefix};
let mut opened=false;
loop {
+1
View File
@@ -3,6 +3,7 @@
#[path = "auth.rs"] mod auth;
#[path = "config.rs"] mod config;
#[path = "protocol.rs"] mod protocol;
mod ws_transport;
mod viewer;
#[cfg(test)] #[path="hevc.rs"] mod hevc;
use viewer::clipboard;
+105
View File
@@ -0,0 +1,105 @@
//! Socket.IO's WebSocket transport uses the same opt-in proxy policy as the REST client.
//! No proxy addresses, room headers, response text or underlying errors are displayed.
use std::time::Duration;
use reqwest::header::{HeaderMap, CONNECTION, UPGRADE, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_KEY,
SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_PROTOCOL};
use tokio_tungstenite::{WebSocketStream, tungstenite::{handshake::{client::Request, derive_accept_key}, protocol::Role}};
pub type Socket = WebSocketStream<reqwest::Upgraded>;
/// Validate configuration rather than let reqwest silently ignore an unsupported proxy URL.
/// Selection/NO_PROXY matching still belongs to reqwest, not a second proxy implementation.
fn validate_proxy_url(value: &str) -> Result<(), &'static str> {
if value.is_empty() { return Ok(()); }
// Match reqwest's system-proxy parser before URL normalization (which would accept
// whitespace/Unicode that http::Uri rejects and the connector would silently ignore).
let uri: tokio_tungstenite::tungstenite::http::Uri = value.parse().map_err(|_| "Invalid signaling proxy configuration")?;
if uri.authority().is_none() { return Err("Invalid signaling proxy configuration"); }
let url = if value.contains("://") { reqwest::Url::parse(value) }
else { reqwest::Url::parse(&format!("http://{value}")) }
.map_err(|_| "Invalid signaling proxy configuration")?;
if !matches!(url.scheme(), "http" | "https") || url.host_str().is_none()
|| url.port_or_known_default().is_none() || url.path() != "/" || url.query().is_some() || url.fragment().is_some() {
return Err("Unsupported signaling proxy configuration (HTTP/HTTPS only)");
}
Ok(())
}
fn client() -> Result<reqwest::Client, String> {
if crate::auth::proxy_enabled() {
let mut configured = false;
for names in [["HTTP_PROXY", "http_proxy"], ["HTTPS_PROXY", "https_proxy"], ["ALL_PROXY", "all_proxy"]] {
if let Some(value) = names.iter().find_map(std::env::var_os) {
let value = value.to_str().ok_or("Invalid signaling proxy configuration")?;
validate_proxy_url(value)?;
configured |= !value.is_empty();
}
}
// reqwest disables environment proxies in CGI contexts; don't silently ignore an opt-in.
if configured && std::env::var_os("REQUEST_METHOD").is_some() {
return Err("Signaling environment proxies are disabled in CGI contexts".into());
}
}
crate::auth::http_client_builder().http1_only().redirect(reqwest::redirect::Policy::none())
.retry(reqwest::retry::never()).build().map_err(|_| "Signaling HTTP client setup failed".into())
}
pub async fn connect(request: Request, timeout: Duration) -> Result<Socket, String> {
let client = client()?;
match tokio::time::timeout(timeout, connect_with_client(&client, request)).await {
Ok(result) => result,
Err(_) => Err("WS connect failed: timeout".into()),
}
}
async fn connect_with_client(client: &reqwest::Client, request: Request) -> Result<Socket, String> {
let (mut parts, _) = request.into_parts();
if parts.method != reqwest::Method::GET || parts.headers.contains_key(SEC_WEBSOCKET_EXTENSIONS)
|| parts.headers.contains_key(SEC_WEBSOCKET_PROTOCOL) || parts.headers.contains_key("proxy-authorization") {
return Err("Unsupported signaling WebSocket request".into());
}
let mut url = reqwest::Url::parse(&parts.uri.to_string()).map_err(|_| "Invalid signaling endpoint")?;
if !url.username().is_empty() || url.password().is_some() || url.fragment().is_some() {
return Err("Invalid signaling endpoint".into());
}
let scheme = match url.scheme() { "ws" => "http", "wss" => "https", _ => return Err("Unsupported signaling endpoint scheme".into()) };
url.set_scheme(scheme).map_err(|_| "Invalid signaling endpoint")?;
let key = parts.headers.get(SEC_WEBSOCKET_KEY).ok_or("Missing WebSocket handshake key")?;
let accept = derive_accept_key(key.as_bytes());
for name in ["x-nrd-auth", "authorization", "cookie"] {
if let Some(value) = parts.headers.get_mut(name) { value.set_sensitive(true); }
}
// reqwest owns DNS/TCP/proxy CONNECT/TLS. No custom relay, direct fallback or redirect.
let response = client.get(url).version(reqwest::Version::HTTP_11).headers(parts.headers).send().await
.map_err(|e| if e.is_timeout() { "WS connect failed: timeout" } else if e.is_connect() { "WS connect failed: connection" } else { "WS connect failed: request" })?;
if response.status() != reqwest::StatusCode::SWITCHING_PROTOCOLS {
return Err(format!("WS upgrade refused: http_status={}", response.status().as_u16()));
}
verify_upgrade(response.version(), response.headers(), &accept)?;
let stream = response.upgrade().await.map_err(|_| "WS upgrade failed")?;
Ok(WebSocketStream::from_raw_socket(stream, Role::Client, None).await)
}
/// RFC 6455 §4.1: validate before handing upgraded bytes to the frame codec. Socket.IO
/// requests no extensions/subprotocols. Unlike a generic HTTP client we never follow redirects.
fn verify_upgrade(version: reqwest::Version, headers: &HeaderMap, accept: &str) -> Result<(), &'static str> {
let single = |name: reqwest::header::HeaderName| {
let mut values = headers.get_all(name).iter();
let value = values.next()?.to_str().ok()?;
values.next().is_none().then_some(value)
};
let connection_upgrade = headers.get_all(CONNECTION).iter().all(|value| value.to_str().is_ok())
&& headers.get_all(CONNECTION).iter().any(|value|
value.to_str().is_ok_and(|value| value.split(',').any(|token| token.trim().eq_ignore_ascii_case("upgrade"))));
if version != reqwest::Version::HTTP_11 || !connection_upgrade
|| !single(UPGRADE).is_some_and(|v| v.eq_ignore_ascii_case("websocket"))
|| single(SEC_WEBSOCKET_ACCEPT) != Some(accept)
|| headers.contains_key(SEC_WEBSOCKET_EXTENSIONS) || headers.contains_key(SEC_WEBSOCKET_PROTOCOL) {
return Err("Invalid signaling WebSocket upgrade response");
}
Ok(())
}
#[cfg(test)]
#[path = "ws_transport_tests.rs"]
mod tests;
+245
View File
@@ -0,0 +1,245 @@
use super::*;
use futures_util::{SinkExt, StreamExt};
use tokio::{io::{AsyncRead, AsyncReadExt, AsyncWriteExt}, net::{TcpListener, TcpStream}};
use tokio_tungstenite::tungstenite::{client::IntoClientRequest, Message};
fn request(url: &str) -> Request {
let mut request = url.into_client_request().unwrap();
request.headers_mut().insert("x-nrd-auth", "fixture-room-secret".parse().unwrap());
request
}
fn test_client() -> reqwest::ClientBuilder {
reqwest::Client::builder().no_proxy().http1_only()
.redirect(reqwest::redirect::Policy::none()).retry(reqwest::retry::never())
}
async fn read_headers<S: AsyncRead + Unpin>(socket: &mut S) -> String {
let mut bytes = Vec::new();
while !bytes.ends_with(b"\r\n\r\n") {
let mut byte = [0];
socket.read_exact(&mut byte).await.unwrap();
bytes.push(byte[0]);
assert!(bytes.len() < 16384);
}
String::from_utf8(bytes).unwrap()
}
fn header<'a>(request: &'a str, name: &str) -> Option<&'a str> {
request.lines().filter_map(|line| line.split_once(':'))
.find(|(key, _)| key.eq_ignore_ascii_case(name)).map(|(_, value)| value.trim())
}
async fn accept_upgrade(listener: TcpListener, proxy: bool) -> TcpStream {
let (mut socket, _) = listener.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with(if proxy { "GET http://" } else { "GET /" }));
assert!(header(&received, "x-nrd-auth") == Some("fixture-room-secret"));
if !proxy { assert!(header(&received, "proxy-authorization").is_none()); }
let accept = derive_accept_key(header(&received, "sec-websocket-key").unwrap().as_bytes());
let mut response = format!("HTTP/1.1 101 Switching Protocols\r\nConnection: keep-alive, Upgrade\r\nUpgrade: websocket\r\nSec-WebSocket-Accept: {accept}\r\n\r\n").into_bytes();
// The first Engine.IO frame shares a single write with the HTTP response.
response.extend_from_slice(&[0x81, 3, b'0', b'{', b'}']);
socket.write_all(&response).await.unwrap();
socket
}
async fn no_connection(listener: &TcpListener) {
assert!(tokio::time::timeout(Duration::from_millis(150), listener.accept()).await.is_err());
}
#[test]
fn strict_upgrade_validation_accepts_tokens_and_rejects_unsolicited_or_ambiguous_headers() {
let mut headers = HeaderMap::new();
headers.insert(CONNECTION, "keep-alive, Upgrade".parse().unwrap());
headers.insert(UPGRADE, "WebSocket".parse().unwrap());
headers.insert(SEC_WEBSOCKET_ACCEPT, "fixture-accept".parse().unwrap());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "fixture-accept").is_ok());
headers.append(CONNECTION, "keep-alive".parse().unwrap());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "fixture-accept").is_ok());
assert!(verify_upgrade(reqwest::Version::HTTP_2, &headers, "fixture-accept").is_err());
assert!(verify_upgrade(reqwest::Version::HTTP_11, &headers, "wrong").is_err());
for name in [CONNECTION, UPGRADE, SEC_WEBSOCKET_ACCEPT] {
let mut missing = headers.clone(); missing.remove(name);
assert!(verify_upgrade(reqwest::Version::HTTP_11, &missing, "fixture-accept").is_err());
}
for name in [UPGRADE, SEC_WEBSOCKET_ACCEPT, SEC_WEBSOCKET_EXTENSIONS, SEC_WEBSOCKET_PROTOCOL] {
let mut invalid = headers.clone(); invalid.append(name, "fixture-server-secret".parse().unwrap());
let error = verify_upgrade(reqwest::Version::HTTP_11, &invalid, "fixture-accept").unwrap_err();
assert!(!error.contains("fixture"));
}
}
#[test]
fn proxy_configuration_errors_never_echo_proxy_values() {
for proxy in ["", "127.0.0.1:3128", "http://127.0.0.1:3128", "https://fixture-user:[email protected]:3128"] {
assert!(validate_proxy_url(proxy).is_ok());
}
for proxy in ["socks5://fixture-user:[email protected]:3128", "http://127.0.0.1:3128/?fixture-token", "http://127.0.0.1:3128/#fixture-token", "http://127.0.0.1:3128/fixture-secret", "http://[fixture-invalid", " http://127.0.0.1:3128", "http://127.0.0.1:3128 ", "http://例子.invalid:3128"] {
let error = validate_proxy_url(proxy).unwrap_err();
assert!(!error.contains("fixture"));
assert!(!error.contains("127.0.0.1"));
}
}
#[tokio::test]
async fn upgrade_keeps_prefetched_frame_and_does_not_limit_socket_lifetime() {
let listener = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/?fixture-query-secret", listener.local_addr().unwrap());
let server = tokio::spawn(async move {
let socket = accept_upgrade(listener, false).await;
let mut socket = WebSocketStream::from_raw_socket(socket, Role::Server, None).await;
tokio::time::sleep(Duration::from_millis(1200)).await;
assert!(matches!(socket.next().await, Some(Ok(Message::Text(value))) if value == "fixture-client-frame"));
socket.send(Message::Text("fixture-late-frame".into())).await.unwrap();
});
let http = test_client().build().unwrap();
let mut socket = tokio::time::timeout(Duration::from_secs(1), connect_with_client(&http, request(&url))).await.unwrap().unwrap();
assert!(matches!(socket.next().await, Some(Ok(Message::Text(value))) if value == "0{}"));
// A one-second establishment deadline must not remain attached to the upgraded stream.
tokio::time::sleep(Duration::from_millis(1300)).await;
socket.send(Message::Text("fixture-client-frame".into())).await.unwrap();
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "fixture-late-frame"));
server.await.unwrap();
}
#[tokio::test]
async fn proxy_refusal_never_falls_back_to_origin_or_echoes_server_content() {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy_url = format!("http://{}", proxy.local_addr().unwrap());
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with("GET http://"));
assert!(header(&received, "proxy-authorization").is_some());
socket.write_all(b"HTTP/1.1 407 Proxy Authentication Required\r\nContent-Length: 19\r\n\r\nfixture-body-secret").await.unwrap();
});
let proxy = reqwest::Proxy::all(proxy_url).unwrap().basic_auth("fixture-user", "fixture-proxy-secret");
let http = test_client().proxy(proxy).build().unwrap();
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&http, request(&format!("ws://{}/fixture-path-secret", origin.local_addr().unwrap()))))
.await.expect("proxy refusal must not wait on a fallback origin");
let error = result.err().expect("proxy refusal must fail");
assert!(error.contains("407")); assert!(!error.contains("fixture"));
no_connection(&origin).await;
server.await.unwrap();
}
#[tokio::test]
async fn redirects_are_not_followed_with_room_credentials() {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let destination = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/", origin.local_addr().unwrap());
let location = format!("http://{}/fixture-redirect-secret", destination.local_addr().unwrap());
let server = tokio::spawn(async move {
let (mut socket, _) = origin.accept().await.unwrap();
let _ = read_headers(&mut socket).await;
socket.write_all(format!("HTTP/1.1 302 Found\r\nLocation: {location}\r\nContent-Length: 0\r\n\r\n").as_bytes()).await.unwrap();
});
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&test_client().build().unwrap(), request(&url)))
.await.expect("redirect must not wait on its destination");
let error = result.err().expect("redirect must fail");
assert!(error.contains("302")); assert!(!error.contains("fixture"));
no_connection(&destination).await;
server.await.unwrap();
}
// No global environment mutation: the subprocess has only synthetic loopback configuration.
#[test]
fn environment_policy_probe() {
let Ok(url) = std::env::var("UU_WS_TEST_ENDPOINT") else { return; };
assert!(url.starts_with("ws://127.0.0.1:"));
let runtime = tokio::runtime::Builder::new_current_thread().enable_all().build().unwrap();
runtime.block_on(async {
let mut socket = connect(request(&url), Duration::from_secs(5)).await.expect("fixture connection failed");
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "0{}"));
});
}
#[tokio::test]
async fn environment_proxy_opt_in_and_no_proxy_match_rest_policy() {
for (opt_in, bypass, via_proxy) in [(false, false, false), (true, false, true), (true, true, false)] {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let url = format!("ws://{}/socket.io/", origin.local_addr().unwrap());
let proxy_url = format!("http://fixture-user:fixture-proxy-secret@{}", proxy.local_addr().unwrap());
let (selected, unused) = if via_proxy { (proxy, origin) } else { (origin, proxy) };
let server = tokio::spawn(async move { let _socket = accept_upgrade(selected, via_proxy).await; });
let mut child = tokio::process::Command::new(std::env::current_exe().unwrap());
child.args(["--exact", "ws_transport::tests::environment_policy_probe", "--nocapture"])
.env_clear().env("UU_WS_TEST_ENDPOINT", url).env("HTTP_PROXY", proxy_url);
if opt_in { child.env("UU_USE_PROXY", "1"); }
if bypass { child.env("NO_PROXY", "127.0.0.1"); }
let output = tokio::time::timeout(Duration::from_secs(10), child.output()).await.unwrap().unwrap();
assert!(output.status.success(), "isolated proxy-policy subprocess failed");
assert!(!output.stdout.windows(b"fixture-room-secret".len()).any(|s| s == b"fixture-room-secret"));
assert!(!output.stderr.windows(b"fixture-proxy-secret".len()).any(|s| s == b"fixture-proxy-secret"));
no_connection(&unused).await;
server.await.unwrap();
}
}
#[tokio::test]
async fn wss_connect_keeps_origin_auth_inside_tls_and_requires_trusted_certificate() {
use std::sync::Arc;
use tokio_rustls::{rustls, TlsAcceptor};
use rustls::pki_types::{CertificateDer, PrivateKeyDer, PrivatePkcs8KeyDer};
// A fresh test certificate/key, kept only in memory. The mock does not relay anywhere:
// it accepts CONNECT and then speaks TLS + WebSocket on that same loopback socket.
let cert = rcgen::generate_simple_self_signed(vec!["localhost".into()]).unwrap();
let cert_der = cert.serialize_der().unwrap();
let root = reqwest::Certificate::from_der(&cert_der).unwrap();
let config = rustls::ServerConfig::builder_with_provider(Arc::new(rustls::crypto::ring::default_provider()))
.with_safe_default_protocol_versions().unwrap().with_no_client_auth()
.with_single_cert(vec![CertificateDer::from(cert_der)],
PrivateKeyDer::Pkcs8(PrivatePkcs8KeyDer::from(cert.serialize_private_key_der()))).unwrap();
let acceptor = TlsAcceptor::from(Arc::new(config));
for trusted in [false, true] {
let origin = TcpListener::bind("127.0.0.1:0").await.unwrap();
let proxy = TcpListener::bind("127.0.0.1:0").await.unwrap();
let port = origin.local_addr().unwrap().port();
let proxy_url = format!("http://{}", proxy.local_addr().unwrap());
let acceptor = acceptor.clone();
let server = tokio::spawn(async move {
let (mut socket, _) = proxy.accept().await.unwrap();
let received = read_headers(&mut socket).await;
assert!(received.starts_with(&format!("CONNECT localhost:{port} HTTP/1.1\r\n")));
assert!(header(&received, "x-nrd-auth").is_none());
assert!(header(&received, "proxy-authorization").is_some());
assert!(!received.contains("fixture-room-secret"));
socket.write_all(b"HTTP/1.1 200 Connection Established\r\n\r\n").await.unwrap();
let tls = acceptor.accept(socket).await;
if !trusted { assert!(tls.is_err()); return; }
let mut tls = tls.expect("fixture TLS handshake failed");
let received = read_headers(&mut tls).await;
assert!(received.starts_with("GET /socket.io/"));
assert!(header(&received, "x-nrd-auth") == Some("fixture-room-secret"));
assert!(header(&received, "proxy-authorization").is_none());
assert!(!received.contains("fixture-proxy-secret"));
let accept = derive_accept_key(header(&received, "sec-websocket-key").unwrap().as_bytes());
let mut response = format!("HTTP/1.1 101 Switching Protocols\r\nConnection: Upgrade\r\nUpgrade: websocket\r\nSec-WebSocket-Accept: {accept}\r\n\r\n").into_bytes();
response.extend_from_slice(&[0x81, 3, b'0', b'{', b'}']);
tls.write_all(&response).await.unwrap();
});
let proxy = reqwest::Proxy::all(proxy_url).unwrap().basic_auth("fixture-user", "fixture-proxy-secret");
let mut builder = test_client().proxy(proxy);
if trusted { builder = builder.add_root_certificate(root.clone()); }
let client = builder.build().unwrap();
let result = tokio::time::timeout(Duration::from_secs(5),
connect_with_client(&client, request(&format!("wss://localhost:{port}/socket.io/?fixture-query-secret")))).await.unwrap();
if trusted {
let mut socket = result.expect("trusted fixture WebSocket failed");
let message = tokio::time::timeout(Duration::from_secs(3), socket.next()).await.unwrap();
assert!(matches!(message, Some(Ok(Message::Text(value))) if value == "0{}"));
} else {
let error = result.err().expect("untrusted fixture certificate must fail");
assert!(!error.contains("fixture")); assert!(!error.contains("localhost"));
}
no_connection(&origin).await;
tokio::time::timeout(Duration::from_secs(5), server).await.unwrap().unwrap();
}
}
+11
View File
@@ -0,0 +1,11 @@
# Generated by Cargo
# will have compiled files and executables
/target/
/.idea/
# Remove Cargo.lock from gitignore if creating an executable, leave it for libraries
# More information here https://doc.rust-lang.org/cargo/guide/cargo-toml-vs-cargo-lock.html
Cargo.lock
# These are backup files generated by rustfmt
**/*.rs.bk
+49
View File
@@ -0,0 +1,49 @@
# webrtc-ice changelog
## Unreleased
### Breaking changes
* remove non used `MulticastDnsMode::Unspecified` variant [#404](https://github.com/webrtc-rs/webrtc/pull/404):
## v0.9.0
* Increased minimum support rust version to `1.60.0`.
### Breaking changes
* Make functions non-async [#338](https://github.com/webrtc-rs/webrtc/pull/338):
- `Agent`:
- `get_bytes_received`;
- `get_bytes_sent`;
- `on_connection_state_change`;
- `on_selected_candidate_pair_change`;
- `on_candidate`;
- `add_remote_candidate`;
- `gather_candidates`.
- `unmarshal_candidate`;
- `CandidateHostConfig::new_candidate_host`;
- `CandidatePeerReflexiveConfig::new_candidate_peer_reflexive`;
- `CandidateRelayConfig::new_candidate_relay`;
- `CandidateServerReflexiveConfig::new_candidate_server_reflexive`;
- `Candidate`:
- `addr`;
- `set_ip`.
## v0.8.2
* Add IP filter to ICE `AgentConfig` [#306](https://github.com/webrtc-rs/webrtc/pull/306) and [#318](https://github.com/webrtc-rs/webrtc/pull/318).
* Add `rust-version` at 1.57.0 to `Cargo.toml`. This was already the minimum version so does not constitute a change.
## v0.8.1
This release was released in error and contains no changes from 0.8.0.
## v0.8.0
* Increased min version of `log` dependency to `0.4.16`. [#250 Fix log at ^0.4.16 to make tests compile](https://github.com/webrtc-rs/webrtc/pull/250) by [@k0nserv](https://github.com/k0nserv).
* Increased serde's minimum version to 1.0.102 [#243 Fixes for cargo minimal-versions](https://github.com/webrtc-rs/webrtc/pull/243) contributed by [algesten](https://github.com/algesten)
## Prior to 0.8.0
Before 0.8.0 there was no changelog, previous changes are sometimes, but not always, available in the [GitHub Releases](https://github.com/webrtc-rs/ice/releases).
+125
View File
@@ -0,0 +1,125 @@
# THIS FILE IS AUTOMATICALLY GENERATED BY CARGO
#
# When uploading crates to the registry Cargo will automatically
# "normalize" Cargo.toml files for maximal compatibility
# with all versions of Cargo and also rewrite `path` dependencies
# to registry (e.g., crates.io) dependencies.
#
# If you are reading this file be aware that the original Cargo.toml
# will likely look very different (and much more reasonable).
# See Cargo.toml.orig for the original contents.
[package]
edition = "2021"
name = "webrtc-ice"
version = "0.10.1"
authors = ["Rain Liu <[email protected]>"]
description = "A pure Rust implementation of ICE"
homepage = "https://webrtc.rs"
documentation = "https://docs.rs/webrtc-ice"
readme = "README.md"
license = "MIT OR Apache-2.0"
repository = "https://github.com/webrtc-rs/ice"
[[example]]
name = "ping_pong"
path = "examples/ping_pong.rs"
bench = false
[dependencies.arc-swap]
version = "1"
[dependencies.async-trait]
version = "0.1"
[dependencies.crc]
version = "3"
[dependencies.log]
version = "0.4"
[dependencies.mdns]
version = "0.6.1"
package = "webrtc-mdns"
[dependencies.rand]
version = "0.8"
[dependencies.rustls-native-certs]
version = "0.8"
[dependencies.serde]
version = "1"
features = ["derive"]
[dependencies.serde_json]
version = "1"
[dependencies.stun]
version = "0.5.1"
[dependencies.thiserror]
version = "1"
[dependencies.tokio]
version = "1.32.0"
features = ["full"]
[dependencies.tokio-rustls]
version = "0.26.6"
default-features = false
features = ["ring", "tls12"]
[dependencies.turn]
version = "0.7.1"
[dependencies.url]
version = "2"
[dependencies.util]
version = "0.8.1"
features = [
"conn",
"vnet",
"sync",
]
default-features = false
package = "webrtc-util"
[dependencies.uuid]
version = "1"
features = ["v4"]
[dependencies.waitgroup]
version = "0.1"
[dependencies.webpki-roots]
version = "1"
[dev-dependencies.chrono]
version = "0.4.28"
[dev-dependencies.clap]
version = "3"
[dev-dependencies.env_logger]
version = "0.10"
[dev-dependencies.hyper]
version = "0.14.27"
features = ["full"]
[dev-dependencies.ipnet]
version = "2"
[dev-dependencies.lazy_static]
version = "1"
[dev-dependencies.regex]
version = "1.9.5"
[dev-dependencies.sha1]
version = "0.10"
[dev-dependencies.tokio-test]
version = "0.4"
+45
View File
@@ -0,0 +1,45 @@
[package]
name = "webrtc-ice"
version = "0.10.1"
authors = ["Rain Liu <[email protected]>"]
edition = "2021"
description = "A pure Rust implementation of ICE"
license = "MIT OR Apache-2.0"
documentation = "https://docs.rs/webrtc-ice"
homepage = "https://webrtc.rs"
repository = "https://github.com/webrtc-rs/ice"
[dependencies]
util = { version = "0.8.1", path = "../util", package = "webrtc-util", default-features = false, features = ["conn", "vnet", "sync"] }
turn = { version = "0.7.1", path = "../turn" }
stun = { version = "0.5.1", path = "../stun" }
mdns = { version = "0.6.1", path = "../mdns", package = "webrtc-mdns" }
arc-swap = "1"
async-trait = "0.1"
crc = "3"
log = "0.4"
rand = "0.8"
serde = { version = "1", features = ["derive"] }
serde_json = "1"
thiserror = "1"
tokio = { version = "1.32.0", features = ["full"] }
url = "2"
uuid = { version = "1", features = ["v4"] }
waitgroup = "0.1"
[dev-dependencies]
tokio-test = "0.4"
regex = "1.9.5"
env_logger = "0.10"
chrono = "0.4.28"
ipnet = "2"
clap = "3"
lazy_static = "1"
hyper = { version = "0.14.27", features = ["full"] }
sha1 = "0.10"
[[example]]
name = "ping_pong"
path = "examples/ping_pong.rs"
bench = false
+201
View File
@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
END OF TERMS AND CONDITIONS
APPENDIX: How to apply the Apache License to your work.
To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "[]"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.
Copyright [yyyy] [name of copyright owner]
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
+21
View File
@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2021 WebRTC.rs
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
+16
View File
@@ -0,0 +1,16 @@
# Local patch to webrtc-ice 0.10.1
Source: crates.io webrtc-ice 0.10.1 (MIT / Apache-2.0; upstream licenses retained).
Upstream gathers relay candidates only for `turn:` over UDP and logs "Unable to handle URL" for
`turn:?transport=tcp` and `turns:`. NetEase sessions that force relaying also offer
`turns:<host>:<port>?transport=tcp`, which is the only media path on hosts whose UDP cannot reach
the TURN servers but whose TCP goes through an HTTP proxy.
`src/agent/turn_tcp.rs` opens TCP (directly, or through an HTTP CONNECT proxy set by the
application with `set_relay_transport`), adds TLS for `turns:`, and exposes the stream to the
unchanged `turn` client as datagrams: one STUN message or ChannelData frame (with its 4-byte TCP
padding) per read. `agent_gather.rs` uses it for `ProtoType::Tcp` URLs. UDP gathering is unchanged.
TLS trusts the system certificate store (`rustls-native-certs`, as OpenSSL does) plus the bundled
Mozilla roots. A name mismatch is accepted only when the TURN URL is an IP literal.
+30
View File
@@ -0,0 +1,30 @@
<h1 align="center">
<a href="https://webrtc.rs"><img src="./doc/webrtc.rs.png" alt="WebRTC.rs"></a>
<br>
</h1>
<p align="center">
<a href="https://github.com/webrtc-rs/ice/actions">
<img src="https://github.com/webrtc-rs/ice/workflows/cargo/badge.svg">
</a>
<a href="https://codecov.io/gh/webrtc-rs/ice">
<img src="https://codecov.io/gh/webrtc-rs/ice/branch/main/graph/badge.svg">
</a>
<a href="https://deps.rs/repo/github/webrtc-rs/ice">
<img src="https://deps.rs/repo/github/webrtc-rs/ice/status.svg">
</a>
<a href="https://crates.io/crates/webrtc-ice">
<img src="https://img.shields.io/crates/v/webrtc-ice.svg">
</a>
<a href="https://docs.rs/webrtc-ice">
<img src="https://docs.rs/webrtc-ice/badge.svg">
</a>
<a href="https://doc.rust-lang.org/1.6.0/complement-project-faq.html#why-dual-mitasl2-license">
<img src="https://img.shields.io/badge/license-MIT%2FApache--2.0-blue" alt="License: MIT/Apache 2.0">
</a>
<a href="https://discord.gg/4Ju8UHdXMs">
<img src="https://img.shields.io/discord/800204819540869120?logo=discord" alt="Discord">
</a>
</p>
<p align="center">
A pure Rust implementation of ICE. Rewrite <a href="https://github.com/pion/ice/releases/tag/v2.0.14">Pion</a> ICE in Rust
</p>
+23
View File
@@ -0,0 +1,23 @@
codecov:
require_ci_to_pass: yes
max_report_age: off
token: 4bd5cec1-2807-4cd6-8430-d5f3efe32ce0
coverage:
precision: 2
round: down
range: 50..90
status:
project:
default:
enabled: no
threshold: 0.2
if_not_found: success
patch:
default:
enabled: no
if_not_found: success
changes:
default:
enabled: no
if_not_found: success
Binary file not shown.

After

Width:  |  Height:  |  Size: 32 KiB

+424
View File
@@ -0,0 +1,424 @@
use std::io;
use std::sync::Arc;
use std::time::Duration;
use clap::{App, AppSettings, Arg};
use hyper::service::{make_service_fn, service_fn};
use hyper::{Body, Client, Method, Request, Response, Server, StatusCode};
use ice::agent::agent_config::AgentConfig;
use ice::agent::Agent;
use ice::candidate::candidate_base::*;
use ice::candidate::*;
use ice::network_type::*;
use ice::state::*;
use ice::udp_network::UDPNetwork;
use ice::Error;
use rand::{thread_rng, Rng};
use tokio::net::UdpSocket;
use tokio::sync::{mpsc, watch, Mutex};
use util::Conn;
use webrtc_ice as ice;
#[macro_use]
extern crate lazy_static;
type SenderType = Arc<Mutex<mpsc::Sender<String>>>;
type ReceiverType = Arc<Mutex<mpsc::Receiver<String>>>;
lazy_static! {
// ErrUnknownType indicates an error with Unknown info.
static ref REMOTE_AUTH_CHANNEL: (SenderType, ReceiverType ) = {
let (tx, rx) = mpsc::channel::<String>(3);
(Arc::new(Mutex::new(tx)), Arc::new(Mutex::new(rx)))
};
static ref REMOTE_CAND_CHANNEL: (SenderType, ReceiverType) = {
let (tx, rx) = mpsc::channel::<String>(10);
(Arc::new(Mutex::new(tx)), Arc::new(Mutex::new(rx)))
};
}
// HTTP Listener to get ICE Credentials/Candidate from remote Peer
async fn remote_handler(req: Request<Body>) -> Result<Response<Body>, hyper::Error> {
//println!("received {:?}", req);
match (req.method(), req.uri().path()) {
(&Method::POST, "/remoteAuth") => {
let full_body =
match std::str::from_utf8(&hyper::body::to_bytes(req.into_body()).await?) {
Ok(s) => s.to_owned(),
Err(err) => panic!("{}", err),
};
let tx = REMOTE_AUTH_CHANNEL.0.lock().await;
//println!("body: {:?}", full_body);
let _ = tx.send(full_body).await;
let mut response = Response::new(Body::empty());
*response.status_mut() = StatusCode::OK;
Ok(response)
}
(&Method::POST, "/remoteCandidate") => {
let full_body =
match std::str::from_utf8(&hyper::body::to_bytes(req.into_body()).await?) {
Ok(s) => s.to_owned(),
Err(err) => panic!("{}", err),
};
let tx = REMOTE_CAND_CHANNEL.0.lock().await;
//println!("body: {:?}", full_body);
let _ = tx.send(full_body).await;
let mut response = Response::new(Body::empty());
*response.status_mut() = StatusCode::OK;
Ok(response)
}
// Return the 404 Not Found for other routes.
_ => {
let mut not_found = Response::default();
*not_found.status_mut() = StatusCode::NOT_FOUND;
Ok(not_found)
}
}
}
// Controlled Agent:
// cargo run --color=always --package webrtc-ice --example ping_pong
// Controlling Agent:
// cargo run --color=always --package webrtc-ice --example ping_pong -- --controlling
#[tokio::main]
async fn main() -> Result<(), Error> {
env_logger::init();
// .format(|buf, record| {
// writeln!(
// buf,
// "{}:{} [{}] {} - {}",
// record.file().unwrap_or("unknown"),
// record.line().unwrap_or(0),
// record.level(),
// chrono::Local::now().format("%H:%M:%S.%6f"),
// record.args()
// )
// })
// .filter(None, log::LevelFilter::Trace)
// .init();
let mut app = App::new("ICE Demo")
.version("0.1.0")
.author("Rain Liu <[email protected]>")
.about("An example of ICE")
.setting(AppSettings::DeriveDisplayOrder)
.setting(AppSettings::SubcommandsNegateReqs)
.arg(
Arg::with_name("use-mux")
.takes_value(false)
.long("use-mux")
.short('m')
.help("Use a muxed UDP connection over a single listening port"),
)
.arg(
Arg::with_name("FULLHELP")
.help("Prints more detailed help information")
.long("fullhelp"),
)
.arg(
Arg::with_name("controlling")
.takes_value(false)
.long("controlling")
.help("is ICE Agent controlling"),
);
let matches = app.clone().get_matches();
if matches.is_present("FULLHELP") {
app.print_long_help().unwrap();
std::process::exit(0);
}
let is_controlling = matches.is_present("controlling");
let use_mux = matches.is_present("use-mux");
let (local_http_port, remote_http_port) = if is_controlling {
(9000, 9001)
} else {
(9001, 9000)
};
let (weak_conn, weak_agent) = {
let (done_tx, done_rx) = watch::channel(());
println!("Listening on http://localhost:{local_http_port}");
let mut done_http_server = done_rx.clone();
tokio::spawn(async move {
let addr = ([0, 0, 0, 0], local_http_port).into();
let service =
make_service_fn(|_| async { Ok::<_, hyper::Error>(service_fn(remote_handler)) });
let server = Server::bind(&addr).serve(service);
tokio::select! {
_ = done_http_server.changed() => {
println!("receive cancel http server!");
}
result = server => {
// Run this server for... forever!
if let Err(e) = result {
eprintln!("server error: {e}");
}
println!("exit http server!");
}
};
});
if is_controlling {
println!("Local Agent is controlling");
} else {
println!("Local Agent is controlled");
};
println!("Press 'Enter' when both processes have started");
let mut input = String::new();
let _ = io::stdin().read_line(&mut input)?;
let udp_network = if use_mux {
use ice::udp_mux::*;
let port = if is_controlling { 4000 } else { 4001 };
let udp_socket = UdpSocket::bind(("0.0.0.0", port)).await?;
let udp_mux = UDPMuxDefault::new(UDPMuxParams::new(udp_socket));
UDPNetwork::Muxed(udp_mux)
} else {
UDPNetwork::Ephemeral(Default::default())
};
let ice_agent = Arc::new(
Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
udp_network,
..Default::default()
})
.await?,
);
let client = Arc::new(Client::new());
// When we have gathered a new ICE Candidate send it to the remote peer
let client2 = Arc::clone(&client);
ice_agent.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let client3 = Arc::clone(&client2);
Box::pin(async move {
if let Some(c) = c {
println!("posting remoteCandidate with {}", c.marshal());
let req = match Request::builder()
.method(Method::POST)
.uri(format!(
"http://localhost:{remote_http_port}/remoteCandidate"
))
.body(Body::from(c.marshal()))
{
Ok(req) => req,
Err(err) => {
println!("{err}");
return;
}
};
let resp = match client3.request(req).await {
Ok(resp) => resp,
Err(err) => {
println!("{err}");
return;
}
};
println!("Response from remoteCandidate: {}", resp.status());
}
})
},
));
let (ice_done_tx, mut ice_done_rx) = mpsc::channel::<()>(1);
// When ICE Connection state has change print to stdout
ice_agent.on_connection_state_change(Box::new(move |c: ConnectionState| {
println!("ICE Connection State has changed: {c}");
if c == ConnectionState::Failed {
let _ = ice_done_tx.try_send(());
}
Box::pin(async move {})
}));
// Get the local auth details and send to remote peer
let (local_ufrag, local_pwd) = ice_agent.get_local_user_credentials().await;
println!("posting remoteAuth with {local_ufrag}:{local_pwd}");
let req = match Request::builder()
.method(Method::POST)
.uri(format!("http://localhost:{remote_http_port}/remoteAuth"))
.body(Body::from(format!("{local_ufrag}:{local_pwd}")))
{
Ok(req) => req,
Err(err) => return Err(Error::Other(format!("{err}"))),
};
let resp = match client.request(req).await {
Ok(resp) => resp,
Err(err) => return Err(Error::Other(format!("{err}"))),
};
println!("Response from remoteAuth: {}", resp.status());
let (remote_ufrag, remote_pwd) = {
let mut rx = REMOTE_AUTH_CHANNEL.1.lock().await;
if let Some(s) = rx.recv().await {
println!("received: {s}");
let fields: Vec<String> = s.split(':').map(|s| s.to_string()).collect();
(fields[0].clone(), fields[1].clone())
} else {
panic!("rx.recv() empty");
}
};
println!("remote_ufrag: {remote_ufrag}, remote_pwd: {remote_pwd}");
let ice_agent2 = Arc::clone(&ice_agent);
let mut done_cand = done_rx.clone();
tokio::spawn(async move {
let mut rx = REMOTE_CAND_CHANNEL.1.lock().await;
loop {
tokio::select! {
_ = done_cand.changed() => {
println!("receive cancel remote cand!");
break;
}
result = rx.recv() => {
if let Some(s) = result {
if let Ok(c) = unmarshal_candidate(&s) {
println!("add_remote_candidate: {c}");
let c: Arc<dyn Candidate + Send + Sync> = Arc::new(c);
let _ = ice_agent2.add_remote_candidate(&c);
}else{
println!("unmarshal_candidate error!");
break;
}
}else{
println!("REMOTE_CAND_CHANNEL done!");
break;
}
}
};
}
});
ice_agent.gather_candidates()?;
println!("Connecting...");
let (_cancel_tx, cancel_rx) = mpsc::channel(1);
// Start the ICE Agent. One side must be controlled, and the other must be controlling
let conn: Arc<dyn Conn + Send + Sync> = if is_controlling {
ice_agent.dial(cancel_rx, remote_ufrag, remote_pwd).await?
} else {
ice_agent
.accept(cancel_rx, remote_ufrag, remote_pwd)
.await?
};
let weak_conn = Arc::downgrade(&conn);
// Send messages in a loop to the remote peer
let conn_tx = Arc::clone(&conn);
let mut done_send = done_rx.clone();
tokio::spawn(async move {
const RANDOM_STRING: &[u8] = b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
loop {
tokio::time::sleep(Duration::from_secs(3)).await;
let val: String = (0..15)
.map(|_| {
let idx = thread_rng().gen_range(0..RANDOM_STRING.len());
RANDOM_STRING[idx] as char
})
.collect();
tokio::select! {
_ = done_send.changed() => {
println!("receive cancel ice send!");
break;
}
result = conn_tx.send(val.as_bytes()) => {
if let Err(err) = result {
eprintln!("conn_tx send error: {err}");
break;
}else{
println!("Sent: '{val}'");
}
}
};
}
});
let mut done_recv = done_rx.clone();
tokio::spawn(async move {
// Receive messages in a loop from the remote peer
let mut buf = vec![0u8; 1500];
loop {
tokio::select! {
_ = done_recv.changed() => {
println!("receive cancel ice recv!");
break;
}
result = conn.recv(&mut buf) => {
match result {
Ok(n) => {
println!("Received: '{}'", std::str::from_utf8(&buf[..n]).unwrap());
}
Err(err) => {
eprintln!("conn_tx send error: {err}");
break;
}
};
}
};
}
});
println!("Press ctrl-c to stop");
/*let d = if is_controlling {
Duration::from_secs(500)
} else {
Duration::from_secs(5)
};
let timeout = tokio::time::sleep(d);
tokio::pin!(timeout);*/
tokio::select! {
/*_ = timeout.as_mut() => {
println!("received timeout signal!");
let _ = done_tx.send(());
}*/
_ = ice_done_rx.recv() => {
println!("ice_done_rx");
let _ = done_tx.send(());
}
_ = tokio::signal::ctrl_c() => {
println!();
let _ = done_tx.send(());
}
};
let _ = ice_agent.close().await;
(weak_conn, Arc::downgrade(&ice_agent))
};
let mut int = tokio::time::interval(Duration::from_secs(1));
loop {
int.tick().await;
println!(
"weak_conn: weak count = {}, strong count = {}, weak_agent: weak count = {}, strong count = {}",
weak_conn.weak_count(),
weak_conn.strong_count(),
weak_agent.weak_count(),
weak_agent.strong_count(),
);
if weak_conn.strong_count() == 0 && weak_agent.strong_count() == 0 {
break;
}
}
Ok(())
}
+255
View File
@@ -0,0 +1,255 @@
use std::net::IpAddr;
use std::time::Duration;
use util::vnet::net::*;
use super::*;
use crate::error::*;
use crate::mdns::*;
use crate::network_type::*;
use crate::udp_network::UDPNetwork;
use crate::url::*;
/// The interval at which the agent performs candidate checks in the connecting phase.
pub(crate) const DEFAULT_CHECK_INTERVAL: Duration = Duration::from_millis(200);
/// The interval used to keep candidates alive.
pub(crate) const DEFAULT_KEEPALIVE_INTERVAL: Duration = Duration::from_secs(2);
/// The default time till an Agent transitions disconnected.
pub(crate) const DEFAULT_DISCONNECTED_TIMEOUT: Duration = Duration::from_secs(5);
/// The default time till an Agent transitions to failed after disconnected.
pub(crate) const DEFAULT_FAILED_TIMEOUT: Duration = Duration::from_secs(25);
/// Wait time before nominating a host candidate.
pub(crate) const DEFAULT_HOST_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_secs(0);
/// Wait time before nominating a srflx candidate.
pub(crate) const DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(500);
/// Wait time before nominating a prflx candidate.
pub(crate) const DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(1000);
/// Wait time before nominating a relay candidate.
pub(crate) const DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT: Duration = Duration::from_millis(2000);
/// Max binding request before considering a pair failed.
pub(crate) const DEFAULT_MAX_BINDING_REQUESTS: u16 = 7;
/// The number of bytes that can be buffered before we start to error.
pub(crate) const MAX_BUFFER_SIZE: usize = 1000 * 1000; // 1MB
/// Wait time before binding requests can be deleted.
pub(crate) const MAX_BINDING_REQUEST_TIMEOUT: Duration = Duration::from_millis(4000);
pub(crate) fn default_candidate_types() -> Vec<CandidateType> {
vec![
CandidateType::Host,
CandidateType::ServerReflexive,
CandidateType::Relay,
]
}
pub type InterfaceFilterFn = Box<dyn (Fn(&str) -> bool) + Send + Sync>;
pub type IpFilterFn = Box<dyn (Fn(IpAddr) -> bool) + Send + Sync>;
/// Collects the arguments to `ice::Agent` construction into a single structure, for
/// future-proofness of the interface.
#[derive(Default)]
pub struct AgentConfig {
pub urls: Vec<Url>,
/// Controls how the UDP network stack works.
/// See [`UDPNetwork`]
pub udp_network: UDPNetwork,
/// It is used to perform connectivity checks. The values MUST be unguessable, with at least
/// 128 bits of random number generator output used to generate the password, and at least 24
/// bits of output to generate the username fragment.
pub local_ufrag: String,
/// It is used to perform connectivity checks. The values MUST be unguessable, with at least
/// 128 bits of random number generator output used to generate the password, and at least 24
/// bits of output to generate the username fragment.
pub local_pwd: String,
/// Controls mDNS behavior for the ICE agent.
pub multicast_dns_mode: MulticastDnsMode,
/// Controls the hostname for this agent. If none is specified a random one will be generated.
pub multicast_dns_host_name: String,
/// Control mDNS destination address
pub multicast_dns_dest_addr: String,
/// Defaults to 5 seconds when this property is nil.
/// If the duration is 0, the ICE Agent will never go to disconnected.
pub disconnected_timeout: Option<Duration>,
/// Defaults to 25 seconds when this property is nil.
/// If the duration is 0, we will never go to failed.
pub failed_timeout: Option<Duration>,
/// Determines how often should we send ICE keepalives (should be less then connectiontimeout
/// above) when this is nil, it defaults to 10 seconds.
/// A keepalive interval of 0 means we never send keepalive packets
pub keepalive_interval: Option<Duration>,
/// An optional configuration for disabling or enabling support for specific network types.
pub network_types: Vec<NetworkType>,
/// An optional configuration for disabling or enabling support for specific candidate types.
pub candidate_types: Vec<CandidateType>,
//LoggerFactory logging.LoggerFactory
/// Controls how often our internal task loop runs when in the connecting state.
/// Only useful for testing.
pub check_interval: Duration,
/// The max amount of binding requests the agent will send over a candidate pair for validation
/// or nomination, if after max_binding_requests the candidate is yet to answer a binding
/// request or a nomination we set the pair as failed.
pub max_binding_requests: Option<u16>,
pub is_controlling: bool,
/// lite agents do not perform connectivity check and only provide host candidates.
pub lite: bool,
/// It is used along with nat1to1ips to specify which candidate type the 1:1 NAT IP addresses
/// should be mapped to. If unspecified or CandidateTypeHost, nat1to1ips are used to replace
/// host candidate IPs. If CandidateTypeServerReflexive, it will insert a srflx candidate (as
/// if it was derived from a STUN server) with its port number being the one for the actual host
/// candidate. Other values will result in an error.
pub nat_1to1_ip_candidate_type: CandidateType,
/// Contains a list of public IP addresses that are to be used as a host candidate or srflx
/// candidate. This is used typically for servers that are behind 1:1 D-NAT (e.g. AWS EC2
/// instances) and to eliminate the need of server reflexisive candidate gathering.
pub nat_1to1_ips: Vec<String>,
/// Specify a minimum wait time before selecting host candidates.
pub host_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting srflx candidates.
pub srflx_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting prflx candidates.
pub prflx_acceptance_min_wait: Option<Duration>,
/// Specify a minimum wait time before selecting relay candidates.
pub relay_acceptance_min_wait: Option<Duration>,
/// Net is the our abstracted network interface for internal development purpose only
/// (see (github.com/pion/transport/vnet)[github.com/pion/transport/vnet]).
pub net: Option<Arc<Net>>,
/// A function that you can use in order to whitelist or blacklist the interfaces which are
/// used to gather ICE candidates.
pub interface_filter: Arc<Option<InterfaceFilterFn>>,
/// A function that you can use in order to whitelist or blacklist
/// the ips which are used to gather ICE candidates.
pub ip_filter: Arc<Option<IpFilterFn>>,
/// Controls if self-signed certificates are accepted when connecting to TURN servers via TLS or
/// DTLS.
pub insecure_skip_verify: bool,
}
impl AgentConfig {
/// Populates an agent and falls back to defaults if fields are unset.
pub(crate) fn init_with_defaults(&self, a: &mut AgentInternal) {
if let Some(max_binding_requests) = self.max_binding_requests {
a.max_binding_requests = max_binding_requests;
} else {
a.max_binding_requests = DEFAULT_MAX_BINDING_REQUESTS;
}
if let Some(host_acceptance_min_wait) = self.host_acceptance_min_wait {
a.host_acceptance_min_wait = host_acceptance_min_wait;
} else {
a.host_acceptance_min_wait = DEFAULT_HOST_ACCEPTANCE_MIN_WAIT;
}
if let Some(srflx_acceptance_min_wait) = self.srflx_acceptance_min_wait {
a.srflx_acceptance_min_wait = srflx_acceptance_min_wait;
} else {
a.srflx_acceptance_min_wait = DEFAULT_SRFLX_ACCEPTANCE_MIN_WAIT;
}
if let Some(prflx_acceptance_min_wait) = self.prflx_acceptance_min_wait {
a.prflx_acceptance_min_wait = prflx_acceptance_min_wait;
} else {
a.prflx_acceptance_min_wait = DEFAULT_PRFLX_ACCEPTANCE_MIN_WAIT;
}
if let Some(relay_acceptance_min_wait) = self.relay_acceptance_min_wait {
a.relay_acceptance_min_wait = relay_acceptance_min_wait;
} else {
a.relay_acceptance_min_wait = DEFAULT_RELAY_ACCEPTANCE_MIN_WAIT;
}
if let Some(disconnected_timeout) = self.disconnected_timeout {
a.disconnected_timeout = disconnected_timeout;
} else {
a.disconnected_timeout = DEFAULT_DISCONNECTED_TIMEOUT;
}
if let Some(failed_timeout) = self.failed_timeout {
a.failed_timeout = failed_timeout;
} else {
a.failed_timeout = DEFAULT_FAILED_TIMEOUT;
}
if let Some(keepalive_interval) = self.keepalive_interval {
a.keepalive_interval = keepalive_interval;
} else {
a.keepalive_interval = DEFAULT_KEEPALIVE_INTERVAL;
}
if self.check_interval == Duration::from_secs(0) {
a.check_interval = DEFAULT_CHECK_INTERVAL;
} else {
a.check_interval = self.check_interval;
}
}
pub(crate) fn init_ext_ip_mapping(
&self,
mdns_mode: MulticastDnsMode,
candidate_types: &[CandidateType],
) -> Result<Option<ExternalIpMapper>> {
if let Some(ext_ip_mapper) =
ExternalIpMapper::new(self.nat_1to1_ip_candidate_type, &self.nat_1to1_ips)?
{
if ext_ip_mapper.candidate_type == CandidateType::Host {
if mdns_mode == MulticastDnsMode::QueryAndGather {
return Err(Error::ErrMulticastDnsWithNat1to1IpMapping);
}
let mut candi_host_enabled = false;
for candi_type in candidate_types {
if *candi_type == CandidateType::Host {
candi_host_enabled = true;
break;
}
}
if !candi_host_enabled {
return Err(Error::ErrIneffectiveNat1to1IpMappingHost);
}
} else if ext_ip_mapper.candidate_type == CandidateType::ServerReflexive {
let mut candi_srflx_enabled = false;
for candi_type in candidate_types {
if *candi_type == CandidateType::ServerReflexive {
candi_srflx_enabled = true;
break;
}
}
if !candi_srflx_enabled {
return Err(Error::ErrIneffectiveNat1to1IpMappingSrflx);
}
}
Ok(Some(ext_ip_mapper))
} else {
Ok(None)
}
}
}
+911
View File
@@ -0,0 +1,911 @@
use std::net::{Ipv4Addr, Ipv6Addr};
use std::str::FromStr;
use std::sync::Arc;
use util::vnet::net::*;
use util::Conn;
use waitgroup::WaitGroup;
use super::*;
use crate::candidate::candidate_base::CandidateBaseConfig;
use crate::candidate::candidate_host::CandidateHostConfig;
use crate::candidate::candidate_relay::CandidateRelayConfig;
use crate::candidate::candidate_server_reflexive::CandidateServerReflexiveConfig;
use crate::candidate::*;
use crate::error::*;
use crate::network_type::*;
use crate::udp_network::UDPNetwork;
use crate::url::{ProtoType, SchemeType, Url};
use crate::util::*;
const STUN_GATHER_TIMEOUT: Duration = Duration::from_secs(5);
pub(crate) struct GatherCandidatesInternalParams {
pub(crate) udp_network: UDPNetwork,
pub(crate) candidate_types: Vec<CandidateType>,
pub(crate) urls: Vec<Url>,
pub(crate) network_types: Vec<NetworkType>,
pub(crate) mdns_mode: MulticastDnsMode,
pub(crate) mdns_name: String,
pub(crate) net: Arc<Net>,
pub(crate) interface_filter: Arc<Option<InterfaceFilterFn>>,
pub(crate) ip_filter: Arc<Option<IpFilterFn>>,
pub(crate) ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
pub(crate) agent_internal: Arc<AgentInternal>,
pub(crate) gathering_state: Arc<AtomicU8>,
pub(crate) chan_candidate_tx: ChanCandidateTx,
}
struct GatherCandidatesLocalParams {
udp_network: UDPNetwork,
network_types: Vec<NetworkType>,
mdns_mode: MulticastDnsMode,
mdns_name: String,
interface_filter: Arc<Option<InterfaceFilterFn>>,
ip_filter: Arc<Option<IpFilterFn>>,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
struct GatherCandidatesLocalUDPMuxParams {
network_types: Vec<NetworkType>,
interface_filter: Arc<Option<InterfaceFilterFn>>,
ip_filter: Arc<Option<IpFilterFn>>,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
udp_mux: Arc<dyn UDPMux + Send + Sync>,
}
struct GatherCandidatesSrflxMappedParasm {
network_types: Vec<NetworkType>,
port_max: u16,
port_min: u16,
ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
struct GatherCandidatesSrflxParams {
urls: Vec<Url>,
network_types: Vec<NetworkType>,
port_max: u16,
port_min: u16,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
}
impl Agent {
pub(crate) async fn gather_candidates_internal(params: GatherCandidatesInternalParams) {
Self::set_gathering_state(
&params.chan_candidate_tx,
&params.gathering_state,
GatheringState::Gathering,
)
.await;
let wg = WaitGroup::new();
for t in &params.candidate_types {
match t {
CandidateType::Host => {
let local_params = GatherCandidatesLocalParams {
udp_network: params.udp_network.clone(),
network_types: params.network_types.clone(),
mdns_mode: params.mdns_mode,
mdns_name: params.mdns_name.clone(),
interface_filter: Arc::clone(&params.interface_filter),
ip_filter: Arc::clone(&params.ip_filter),
ext_ip_mapper: Arc::clone(&params.ext_ip_mapper),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
Self::gather_candidates_local(local_params).await;
});
}
CandidateType::ServerReflexive => {
let ephemeral_config = match &params.udp_network {
UDPNetwork::Ephemeral(e) => e,
// No server reflexive for muxxed connections
UDPNetwork::Muxed(_) => continue,
};
let srflx_params = GatherCandidatesSrflxParams {
urls: params.urls.clone(),
network_types: params.network_types.clone(),
port_max: ephemeral_config.port_max(),
port_min: ephemeral_config.port_min(),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w1 = wg.worker();
tokio::spawn(async move {
let _d = w1;
Self::gather_candidates_srflx(srflx_params).await;
});
if let Some(ext_ip_mapper) = &*params.ext_ip_mapper {
if ext_ip_mapper.candidate_type == CandidateType::ServerReflexive {
let srflx_mapped_params = GatherCandidatesSrflxMappedParasm {
network_types: params.network_types.clone(),
port_max: ephemeral_config.port_max(),
port_min: ephemeral_config.port_min(),
ext_ip_mapper: Arc::clone(&params.ext_ip_mapper),
net: Arc::clone(&params.net),
agent_internal: Arc::clone(&params.agent_internal),
};
let w2 = wg.worker();
tokio::spawn(async move {
let _d = w2;
Self::gather_candidates_srflx_mapped(srflx_mapped_params).await;
});
}
}
}
CandidateType::Relay => {
let urls = params.urls.clone();
let net = Arc::clone(&params.net);
let agent_internal = Arc::clone(&params.agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
Self::gather_candidates_relay(urls, net, agent_internal).await;
});
}
_ => {}
}
}
// Block until all STUN and TURN URLs have been gathered (or timed out)
wg.wait().await;
Self::set_gathering_state(
&params.chan_candidate_tx,
&params.gathering_state,
GatheringState::Complete,
)
.await;
}
async fn set_gathering_state(
chan_candidate_tx: &ChanCandidateTx,
gathering_state: &Arc<AtomicU8>,
new_state: GatheringState,
) {
if GatheringState::from(gathering_state.load(Ordering::SeqCst)) != new_state
&& new_state == GatheringState::Complete
{
let cand_tx = chan_candidate_tx.lock().await;
if let Some(tx) = &*cand_tx {
let _ = tx.send(None).await;
}
}
gathering_state.store(new_state as u8, Ordering::SeqCst);
}
async fn gather_candidates_local(params: GatherCandidatesLocalParams) {
let GatherCandidatesLocalParams {
udp_network,
network_types,
mdns_mode,
mdns_name,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
} = params;
// If we wanna use UDP mux, do so
// FIXME: We still need to support TCP in combination with this option
if let UDPNetwork::Muxed(udp_mux) = udp_network {
let result = Self::gather_candidates_local_udp_mux(GatherCandidatesLocalUDPMuxParams {
network_types,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
udp_mux,
})
.await;
if let Err(err) = result {
log::error!("Failed to gather local candidates using UDP mux: {}", err);
}
return;
}
let ips = local_interfaces(&net, &interface_filter, &ip_filter, &network_types).await;
for ip in ips {
let mut mapped_ip = ip;
if mdns_mode != MulticastDnsMode::QueryAndGather && ext_ip_mapper.is_some() {
if let Some(ext_ip_mapper2) = ext_ip_mapper.as_ref() {
if ext_ip_mapper2.candidate_type == CandidateType::Host {
if let Ok(mi) = ext_ip_mapper2.find_external_ip(&ip.to_string()) {
mapped_ip = mi;
} else {
log::warn!(
"[{}]: 1:1 NAT mapping is enabled but no external IP is found for {}",
agent_internal.get_name(),
ip
);
}
}
}
}
let address = if mdns_mode == MulticastDnsMode::QueryAndGather {
mdns_name.clone()
} else {
mapped_ip.to_string()
};
//TODO: for network in networks
let network = UDP.to_owned();
if let UDPNetwork::Ephemeral(ephemeral_config) = &udp_network {
/*TODO:switch network {
case tcp:
// Handle ICE TCP passive mode
a.log.Debugf("GetConn by ufrag: %s\n", a.localUfrag)
conn, err = a.tcpMux.GetConnByUfrag(a.localUfrag)
if err != nil {
if !errors.Is(err, ErrTCPMuxNotInitialized) {
a.log.Warnf("error getting tcp conn by ufrag: %s %s %s\n", network, ip, a.localUfrag)
}
continue
}
port = conn.LocalAddr().(*net.TCPAddr).Port
tcpType = TCPTypePassive
// is there a way to verify that the listen address is even
// accessible from the current interface.
case udp:*/
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net,
ephemeral_config.port_max(),
ephemeral_config.port_min(),
SocketAddr::new(ip, 0),
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: could not listen {} {}: {}",
agent_internal.get_name(),
network,
ip,
err
);
continue;
}
};
let port = match conn.local_addr() {
Ok(addr) => addr.port(),
Err(err) => {
log::warn!(
"[{}]: could not get local addr: {}",
agent_internal.get_name(),
err
);
continue;
}
};
let host_config = CandidateHostConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address,
port,
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
..CandidateHostConfig::default()
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match host_config.new_candidate_host() {
Ok(candidate) => {
if mdns_mode == MulticastDnsMode::QueryAndGather {
if let Err(err) = candidate.set_ip(&ip) {
log::warn!(
"[{}]: Failed to create host candidate: {} {} {}: {:?}",
agent_internal.get_name(),
network,
mapped_ip,
port,
err
);
continue;
}
}
Arc::new(candidate)
}
Err(err) => {
log::warn!(
"[{}]: Failed to create host candidate: {} {} {}: {}",
agent_internal.get_name(),
network,
mapped_ip,
port,
err
);
continue;
}
};
{
if let Err(err) = agent_internal.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal.get_name(),
err
);
}
}
}
}
}
async fn gather_candidates_local_udp_mux(
params: GatherCandidatesLocalUDPMuxParams,
) -> Result<()> {
let GatherCandidatesLocalUDPMuxParams {
network_types,
interface_filter,
ip_filter,
ext_ip_mapper,
net,
agent_internal,
udp_mux,
} = params;
// Filter out non UDP network types
let relevant_network_types: Vec<_> =
network_types.into_iter().filter(|n| n.is_udp()).collect();
let udp_mux = Arc::clone(&udp_mux);
let local_ips =
local_interfaces(&net, &interface_filter, &ip_filter, &relevant_network_types).await;
let candidate_ips: Vec<std::net::IpAddr> = ext_ip_mapper
.as_ref() // Arc
.as_ref() // Option
.and_then(|mapper| {
if mapper.candidate_type != CandidateType::Host {
return None;
}
Some(
local_ips
.iter()
.filter_map(|ip| match mapper.find_external_ip(&ip.to_string()) {
Ok(ip) => Some(ip),
Err(err) => {
log::warn!(
"1:1 NAT mapping is enabled but not external IP is found for {}: {}",
ip,
err
);
None
}
})
.collect(),
)
})
.unwrap_or_else(|| local_ips.iter().copied().collect());
if candidate_ips.is_empty() {
return Err(Error::ErrCandidateIpNotFound);
}
let ufrag = {
let ufrag_pwd = agent_internal.ufrag_pwd.lock().await;
ufrag_pwd.local_ufrag.clone()
};
let conn = udp_mux.get_conn(&ufrag).await?;
let port = conn.local_addr()?.port();
for candidate_ip in candidate_ips {
let host_config = CandidateHostConfig {
base_config: CandidateBaseConfig {
network: UDP.to_owned(),
address: candidate_ip.to_string(),
port,
conn: Some(conn.clone()),
component: COMPONENT_RTP,
..Default::default()
},
tcp_type: TcpType::Unspecified,
};
let candidate: Arc<dyn Candidate + Send + Sync> =
Arc::new(host_config.new_candidate_host()?);
agent_internal.add_candidate(&candidate).await?;
}
Ok(())
}
async fn gather_candidates_srflx_mapped(params: GatherCandidatesSrflxMappedParasm) {
let GatherCandidatesSrflxMappedParasm {
network_types,
port_max,
port_min,
ext_ip_mapper,
net,
agent_internal,
} = params;
let wg = WaitGroup::new();
for network_type in network_types {
if network_type.is_tcp() {
continue;
}
let network = network_type.to_string();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let ext_ip_mapper2 = Arc::clone(&ext_ip_mapper);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net2,
port_max,
port_min,
if network_type.is_ipv4() {
SocketAddr::new(Ipv4Addr::new(0, 0, 0, 0).into(), 0)
} else {
SocketAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).into(), 0)
},
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: Failed to listen {}: {}",
agent_internal2.get_name(),
network,
err
);
return Ok(());
}
};
let laddr = conn.local_addr()?;
let mapped_ip = {
if let Some(ext_ip_mapper3) = &*ext_ip_mapper2 {
match ext_ip_mapper3.find_external_ip(&laddr.ip().to_string()) {
Ok(ip) => ip,
Err(err) => {
log::warn!(
"[{}]: 1:1 NAT mapping is enabled but no external IP is found for {}: {}",
agent_internal2.get_name(),
laddr,
err
);
return Ok(());
}
}
} else {
log::error!(
"[{}]: ext_ip_mapper is None in gather_candidates_srflx_mapped",
agent_internal2.get_name(),
);
return Ok(());
}
};
let srflx_config = CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: mapped_ip.to_string(),
port: laddr.port(),
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
rel_addr: laddr.ip().to_string(),
rel_port: laddr.port(),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match srflx_config.new_candidate_server_reflexive() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
log::warn!(
"[{}]: Failed to create server reflexive candidate: {} {} {}: {}",
agent_internal2.get_name(),
network,
mapped_ip,
laddr.port(),
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
wg.wait().await;
}
async fn gather_candidates_srflx(params: GatherCandidatesSrflxParams) {
let GatherCandidatesSrflxParams {
urls,
network_types,
port_max,
port_min,
net,
agent_internal,
} = params;
let wg = WaitGroup::new();
for network_type in network_types {
if network_type.is_tcp() {
continue;
}
for url in &urls {
let network = network_type.to_string();
let is_ipv4 = network_type.is_ipv4();
let url = url.clone();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let host_port = format!("{}:{}", url.host, url.port);
let server_addr = match net2.resolve_addr(is_ipv4, &host_port).await {
Ok(addr) => addr,
Err(err) => {
log::warn!(
"[{}]: failed to resolve stun host: {}: {}",
agent_internal2.get_name(),
host_port,
err
);
return Ok(());
}
};
let conn: Arc<dyn Conn + Send + Sync> = match listen_udp_in_port_range(
&net2,
port_max,
port_min,
if is_ipv4 {
SocketAddr::new(Ipv4Addr::new(0, 0, 0, 0).into(), 0)
} else {
SocketAddr::new(Ipv6Addr::new(0, 0, 0, 0, 0, 0, 0, 0).into(), 0)
},
)
.await
{
Ok(conn) => conn,
Err(err) => {
log::warn!(
"[{}]: Failed to listen for {}: {}",
agent_internal2.get_name(),
server_addr,
err
);
return Ok(());
}
};
let xoraddr =
match get_xormapped_addr(&conn, server_addr, STUN_GATHER_TIMEOUT).await {
Ok(xoraddr) => xoraddr,
Err(err) => {
log::warn!(
"[{}]: could not get server reflexive address {} {}: {}",
agent_internal2.get_name(),
network,
url,
err
);
return Ok(());
}
};
let (ip, port) = (xoraddr.ip, xoraddr.port);
let laddr = conn.local_addr()?;
let srflx_config = CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: ip.to_string(),
port,
component: COMPONENT_RTP,
conn: Some(conn),
..CandidateBaseConfig::default()
},
rel_addr: laddr.ip().to_string(),
rel_port: laddr.port(),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match srflx_config.new_candidate_server_reflexive() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
log::warn!(
"[{}]: Failed to create server reflexive candidate: {} {} {}: {:?}",
agent_internal2.get_name(),
network,
ip,
port,
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
}
wg.wait().await;
}
pub(crate) async fn gather_candidates_relay(
urls: Vec<Url>,
net: Arc<Net>,
agent_internal: Arc<AgentInternal>,
) {
let wg = WaitGroup::new();
for url in urls {
if url.scheme != SchemeType::Turn && url.scheme != SchemeType::Turns {
continue;
}
if url.username.is_empty() {
log::error!(
"[{}]:Failed to gather relay candidates: {:?}",
agent_internal.get_name(),
Error::ErrUsernameEmpty
);
return;
}
if url.password.is_empty() {
log::error!(
"[{}]: Failed to gather relay candidates: {:?}",
agent_internal.get_name(),
Error::ErrPasswordEmpty
);
return;
}
let network = NetworkType::Udp4.to_string();
let net2 = Arc::clone(&net);
let agent_internal2 = Arc::clone(&agent_internal);
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let turn_server_addr = format!("{}:{}", url.host, url.port);
let (loc_conn, rel_addr, rel_port) =
if url.proto == ProtoType::Udp && url.scheme == SchemeType::Turn {
let loc_conn = match net2.bind(SocketAddr::from_str("0.0.0.0:0")?).await {
Ok(c) => c,
Err(err) => {
log::warn!(
"[{}]: Failed to listen due to error: {}",
agent_internal2.get_name(),
err
);
return Ok(());
}
};
let local_addr = loc_conn.local_addr()?;
let rel_addr = local_addr.ip().to_string();
let rel_port = local_addr.port();
(loc_conn, rel_addr, rel_port)
/*TODO: case url.proto == ProtoType::UDP && url.scheme == SchemeType::TURNS{*/
} else if url.proto == ProtoType::Tcp && super::turn_tcp::enabled() {
// uu-remote-linux patch: TURN over TCP/TLS, optionally via an HTTP proxy.
let server = tokio::net::lookup_host(turn_server_addr.as_str()).await.ok()
.and_then(|mut addrs| addrs.next())
.unwrap_or_else(|| SocketAddr::from(([0, 0, 0, 0], url.port)));
let tls = url.scheme == SchemeType::Turns;
match super::turn_tcp::dial(&url.host, url.port, server, tls).await {
Ok(conn) => {
let local_addr = conn.local_addr()?;
let loc_conn: Arc<dyn Conn + Send + Sync> = Arc::new(conn);
(loc_conn, local_addr.ip().to_string(), local_addr.port())
}
Err(err) => {
log::warn!(
"[{}]: Failed to open TURN {} connection: {}",
agent_internal2.get_name(),
if tls { "TLS" } else { "TCP" },
err
);
return Ok(());
}
}
} else {
log::warn!(
"[{}]: Unable to handle URL in gather_candidates_relay {}",
agent_internal2.get_name(),
url
);
return Ok(());
};
let cfg = turn::client::ClientConfig {
stun_serv_addr: String::new(),
turn_serv_addr: turn_server_addr.clone(),
username: url.username,
password: url.password,
realm: String::new(),
software: String::new(),
rto_in_ms: 0,
conn: loc_conn,
vnet: Some(Arc::clone(&net2)),
};
let client = match turn::client::Client::new(cfg).await {
Ok(client) => Arc::new(client),
Err(err) => {
log::warn!(
"[{}]: Failed to build new turn.Client {} {}\n",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
};
if let Err(err) = client.listen().await {
let _ = client.close().await;
log::warn!(
"[{}]: Failed to listen on turn.Client {} {}",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
let relay_conn: Arc<dyn Conn + Send + Sync> = match client.allocate().await {
Ok(conn) => Arc::new(conn),
Err(err) => {
let _ = client.close().await;
log::warn!(
"[{}]: Failed to allocate on turn.Client {} {}",
agent_internal2.get_name(),
turn_server_addr,
err
);
return Ok(());
}
};
let raddr = relay_conn.local_addr()?;
let relay_config = CandidateRelayConfig {
base_config: CandidateBaseConfig {
network: network.clone(),
address: raddr.ip().to_string(),
port: raddr.port(),
component: COMPONENT_RTP,
conn: Some(Arc::clone(&relay_conn)),
..CandidateBaseConfig::default()
},
rel_addr,
rel_port,
relay_client: Some(Arc::clone(&client)),
};
let candidate: Arc<dyn Candidate + Send + Sync> =
match relay_config.new_candidate_relay() {
Ok(candidate) => Arc::new(candidate),
Err(err) => {
let _ = relay_conn.close().await;
let _ = client.close().await;
log::warn!(
"[{}]: Failed to create relay candidate: {} {}: {}",
agent_internal2.get_name(),
network,
raddr,
err
);
return Ok(());
}
};
{
if let Err(err) = agent_internal2.add_candidate(&candidate).await {
if let Err(close_err) = candidate.close().await {
log::warn!(
"[{}]: Failed to close candidate: {}",
agent_internal2.get_name(),
close_err
);
}
log::warn!(
"[{}]: Failed to append to localCandidates and run onCandidateHdlr: {}",
agent_internal2.get_name(),
err
);
}
}
Result::<()>::Ok(())
});
}
wg.wait().await;
}
}
+490
View File
@@ -0,0 +1,490 @@
use std::str::FromStr;
use ipnet::IpNet;
use tokio::net::UdpSocket;
use util::vnet::*;
use super::agent_vnet_test::*;
use super::*;
use crate::udp_mux::{UDPMuxDefault, UDPMuxParams};
use crate::util::*;
#[tokio::test]
async fn test_vnet_gather_no_local_ip_address() -> Result<()> {
let vnet = Arc::new(net::Net::new(Some(net::NetConfig::default())));
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&vnet)),
..Default::default()
})
.await?;
let local_ips = local_interfaces(
&vnet,
&a.interface_filter,
&a.ip_filter,
&[NetworkType::Udp4],
)
.await;
assert!(local_ips.is_empty(), "should return no local IP");
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_dynamic_ip_address() -> Result<()> {
let cider = "1.2.3.0/24";
let ipnet = IpNet::from_str(cider).map_err(|e| Error::Other(e.to_string()))?;
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: cider.to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(!local_ips.is_empty(), "should have one local IP");
for ip in &local_ips {
if ip.is_loopback() {
panic!("should not return loopback IP");
}
if !ipnet.contains(ip) {
panic!("{ip} should be contained in the CIDR {ipnet}");
}
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_listen_udp() -> Result<()> {
let cider = "1.2.3.0/24";
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: cider.to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(!local_ips.is_empty(), "should have one local IP");
for ip in local_ips {
let _ = listen_udp_in_port_range(&nw, 0, 0, SocketAddr::new(ip, 0)).await?;
let result = listen_udp_in_port_range(&nw, 4999, 5000, SocketAddr::new(ip, 0)).await;
assert!(
result.is_err(),
"listenUDP with invalid port range did not return ErrPort"
);
let conn = listen_udp_in_port_range(&nw, 5000, 5000, SocketAddr::new(ip, 0)).await?;
let port = conn.local_addr()?.port();
assert_eq!(
port, 5000,
"listenUDP with port restriction of 5000 listened on incorrect port ({port})"
);
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_nat_1to1_as_host_candidates() -> Result<()> {
let external_ip0 = "1.2.3.4";
let external_ip1 = "1.2.3.5";
let local_ip0 = "10.0.0.1";
let local_ip1 = "10.0.0.2";
let map0 = format!("{external_ip0}/{local_ip0}");
let map1 = format!("{external_ip1}/{local_ip1}");
let wan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
static_ips: vec![map0.clone(), map1.clone()],
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
connect_router2router(&lan, &wan).await?;
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec![local_ip0.to_owned(), local_ip1.to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec![map0.clone(), map1.clone()],
net: Some(Arc::clone(&nw)),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 2, "There must be two candidates");
let mut laddrs = vec![];
for candi in &candidates {
if let Some(conn) = candi.get_conn() {
let laddr = conn.local_addr()?;
assert_eq!(
candi.port(),
laddr.port(),
"Unexpected candidate port: {}",
candi.port()
);
laddrs.push(laddr);
}
}
if candidates[0].address() == external_ip0 {
assert_eq!(
candidates[1].address(),
external_ip1,
"Unexpected candidate IP: {}",
candidates[1].address()
);
assert_eq!(
laddrs[0].ip().to_string(),
local_ip0,
"Unexpected listen IP: {}",
laddrs[0].ip()
);
assert_eq!(
laddrs[1].ip().to_string(),
local_ip1,
"Unexpected listen IP: {}",
laddrs[1].ip()
);
} else if candidates[0].address() == external_ip1 {
assert_eq!(
candidates[1].address(),
external_ip0,
"Unexpected candidate IP: {}",
candidates[1].address()
);
assert_eq!(
laddrs[0].ip().to_string(),
local_ip1,
"Unexpected listen IP: {}",
laddrs[0].ip(),
);
assert_eq!(
laddrs[1].ip().to_string(),
local_ip0,
"Unexpected listen IP: {}",
laddrs[1].ip(),
)
}
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_nat_1to1_as_srflx_candidates() -> Result<()> {
let wan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
static_ips: vec!["1.2.3.4/10.0.0.1".to_owned()],
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
connect_router2router(&lan, &wan).await?;
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec!["10.0.0.1".to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec!["1.2.3.4".to_owned()],
nat_1to1_ip_candidate_type: CandidateType::ServerReflexive,
net: Some(nw),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 2, "There must be two candidates");
let mut candi_host = None;
let mut candi_srflx = None;
for candidate in candidates {
match candidate.candidate_type() {
CandidateType::Host => {
candi_host = Some(candidate);
}
CandidateType::ServerReflexive => {
candi_srflx = Some(candidate);
}
_ => {
panic!("Unexpected candidate type");
}
}
}
assert!(candi_host.is_some(), "should not be nil");
assert_eq!("10.0.0.1", candi_host.unwrap().address(), "should match");
assert!(candi_srflx.is_some(), "should not be nil");
assert_eq!("1.2.3.4", candi_srflx.unwrap().address(), "should match");
a.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_with_interface_filter() -> Result<()> {
let r = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "1.2.3.0/24".to_owned(),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig::default())));
connect_net2router(&nw, &r).await?;
//"InterfaceFilter should exclude the interface"
{
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
interface_filter: Arc::new(Some(Box::new(|_: &str| -> bool {
//assert_eq!("eth0", interface_name);
false
}))),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert!(
local_ips.is_empty(),
"InterfaceFilter should have excluded everything"
);
a.close().await?;
}
//"InterfaceFilter should not exclude the interface"
{
let a = Agent::new(AgentConfig {
net: Some(Arc::clone(&nw)),
interface_filter: Arc::new(Some(Box::new(|interface_name: &str| -> bool {
"eth0" == interface_name
}))),
..Default::default()
})
.await?;
let local_ips =
local_interfaces(&nw, &a.interface_filter, &a.ip_filter, &[NetworkType::Udp4]).await;
assert_eq!(
local_ips.len(),
1,
"InterfaceFilter should not have excluded everything"
);
a.close().await?;
}
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_turn_connection_leak() -> Result<()> {
let turn_server_url = Url {
scheme: SchemeType::Turn,
host: VNET_STUN_SERVER_IP.to_owned(),
port: VNET_STUN_SERVER_PORT,
username: "user".to_owned(),
password: "pass".to_owned(),
proto: ProtoType::Udp,
};
// buildVNet with a Symmetric NATs for both LANs
let nat_type = nat::NatType {
mapping_behavior: nat::EndpointDependencyType::EndpointAddrPortDependent,
filtering_behavior: nat::EndpointDependencyType::EndpointAddrPortDependent,
..Default::default()
};
let v = build_vnet(nat_type, nat_type).await?;
let cfg0 = AgentConfig {
urls: vec![turn_server_url.clone()],
network_types: supported_network_types(),
multicast_dns_mode: MulticastDnsMode::Disabled,
nat_1to1_ips: vec![VNET_GLOBAL_IPA.to_owned()],
net: Some(Arc::clone(&v.net0)),
..Default::default()
};
let a_agent = Agent::new(cfg0).await?;
{
let agent_internal = Arc::clone(&a_agent.internal);
Agent::gather_candidates_relay(
vec![turn_server_url.clone()],
Arc::clone(&v.net0),
agent_internal,
)
.await;
}
// Assert relay conn leak on close.
a_agent.close().await?;
v.close().await?;
Ok(())
}
#[tokio::test]
async fn test_vnet_gather_muxed_udp() -> Result<()> {
let udp_socket = UdpSocket::bind("0.0.0.0:0").await?;
let udp_mux = UDPMuxDefault::new(UDPMuxParams::new(udp_socket));
let lan = Arc::new(Mutex::new(router::Router::new(router::RouterConfig {
cidr: "10.0.0.0/24".to_owned(),
nat_type: Some(nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
}),
..Default::default()
})?));
let nw = Arc::new(net::Net::new(Some(net::NetConfig {
static_ips: vec!["10.0.0.1".to_owned()],
..Default::default()
})));
connect_net2router(&nw, &lan).await?;
let a = Agent::new(AgentConfig {
network_types: vec![NetworkType::Udp4],
nat_1to1_ips: vec!["1.2.3.4".to_owned()],
net: Some(nw),
udp_network: UDPNetwork::Muxed(udp_mux),
..Default::default()
})
.await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
let candidates = a.get_local_candidates().await?;
assert_eq!(candidates.len(), 1, "There must be a single candidate");
let candi = &candidates[0];
let laddr = candi.get_conn().unwrap().local_addr()?;
assert_eq!(candi.address(), "1.2.3.4");
assert_eq!(
candi.port(),
laddr.port(),
"Unexpected candidate port: {}",
candi.port()
);
Ok(())
}
File diff suppressed because it is too large. Load diff
+545
View File
@@ -0,0 +1,545 @@
use std::net::SocketAddr;
use std::sync::atomic::Ordering;
use std::sync::Arc;
use async_trait::async_trait;
use stun::agent::*;
use stun::attributes::*;
use stun::fingerprint::*;
use stun::integrity::*;
use stun::message::*;
use stun::textattrs::*;
use tokio::time::{Duration, Instant};
use crate::agent::agent_internal::*;
use crate::candidate::*;
use crate::control::*;
use crate::priority::*;
use crate::use_candidate::*;
#[async_trait]
trait ControllingSelector {
async fn start(&self);
async fn contact_candidates(&self);
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
);
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
}
#[async_trait]
trait ControlledSelector {
async fn start(&self);
async fn contact_candidates(&self);
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
);
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
);
}
impl AgentInternal {
fn is_nominatable(&self, c: &Arc<dyn Candidate + Send + Sync>) -> bool {
let start_time = *self.start_time.lock();
match c.candidate_type() {
CandidateType::Host => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.host_acceptance_min_wait.as_nanos()
}
CandidateType::ServerReflexive => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.srflx_acceptance_min_wait.as_nanos()
}
CandidateType::PeerReflexive => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.prflx_acceptance_min_wait.as_nanos()
}
CandidateType::Relay => {
Instant::now()
.checked_duration_since(start_time)
.unwrap_or_else(|| Duration::from_secs(0))
.as_nanos()
> self.relay_acceptance_min_wait.as_nanos()
}
CandidateType::Unspecified => {
log::error!(
"is_nominatable invalid candidate type {}",
c.candidate_type()
);
false
}
}
}
async fn nominate_pair(&self) {
let result = {
let nominated_pair = self.nominated_pair.lock().await;
if let Some(pair) = &*nominated_pair {
// The controlling agent MUST include the USE-CANDIDATE attribute in
// order to nominate a candidate pair (Section 8.1.1). The controlled
// agent MUST NOT include the USE-CANDIDATE attribute in a Binding
// request.
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username =
ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::<UseCandidateAttr>::default(),
Box::new(AttrControlling(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(pair.local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
None
} else {
log::trace!(
"ping STUN (nominate candidate pair from {} to {}",
pair.local,
pair.remote
);
let local = pair.local.clone();
let remote = pair.remote.clone();
Some((msg, local, remote))
}
} else {
None
}
};
if let Some((msg, local, remote)) = result {
self.send_binding_request(&msg, &local, &remote).await;
}
}
pub(crate) async fn start(&self) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::start(self).await;
} else {
ControlledSelector::start(self).await;
}
}
pub(crate) async fn contact_candidates(&self) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::contact_candidates(self).await;
} else {
ControlledSelector::contact_candidates(self).await;
}
}
pub(crate) async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::ping_candidate(self, local, remote).await;
} else {
ControlledSelector::ping_candidate(self, local, remote).await;
}
}
pub(crate) async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::handle_success_response(self, m, local, remote, remote_addr).await;
} else {
ControlledSelector::handle_success_response(self, m, local, remote, remote_addr).await;
}
}
pub(crate) async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.is_controlling.load(Ordering::SeqCst) {
ControllingSelector::handle_binding_request(self, m, local, remote).await;
} else {
ControlledSelector::handle_binding_request(self, m, local, remote).await;
}
}
}
#[async_trait]
impl ControllingSelector for AgentInternal {
async fn start(&self) {
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = None;
}
*self.start_time.lock() = Instant::now();
}
async fn contact_candidates(&self) {
// A lite selector should not contact candidates
if self.lite.load(Ordering::SeqCst) {
// This only happens if both peers are lite. See RFC 8445 S6.1.1 and S6.2
log::trace!("now falling back to full agent");
}
let nominated_pair_is_some = {
let nominated_pair = self.nominated_pair.lock().await;
nominated_pair.is_some()
};
if self.agent_conn.get_selected_pair().is_some() {
if self.validate_selected_pair().await {
log::trace!("[{}]: checking keepalive", self.get_name());
self.check_keepalive().await;
}
} else if nominated_pair_is_some {
self.nominate_pair().await;
} else {
let has_nominated_pair =
if let Some(p) = self.agent_conn.get_best_valid_candidate_pair().await {
self.is_nominatable(&p.local) && self.is_nominatable(&p.remote)
} else {
false
};
if has_nominated_pair {
if let Some(p) = self.agent_conn.get_best_valid_candidate_pair().await {
log::trace!(
"Nominatable pair found, nominating ({}, {})",
p.local.to_string(),
p.remote.to_string()
);
p.nominated.store(true, Ordering::SeqCst);
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = Some(p);
}
}
self.nominate_pair().await;
} else {
self.ping_all_candidates().await;
}
}
}
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username = ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::new(AttrControlling(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
} else {
self.send_binding_request(&msg, local, remote).await;
}
}
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
if let Some(pending_request) = self.handle_inbound_binding_success(m.transaction_id).await {
let transaction_addr = pending_request.destination;
// Assert that NAT is not symmetric
// https://tools.ietf.org/html/rfc8445#section-7.2.5.2.1
if transaction_addr != remote_addr {
log::debug!("discard message: transaction source and destination does not match expected({}), actual({})", transaction_addr, remote);
return;
}
log::trace!(
"inbound STUN (SuccessResponse) from {} to {}",
remote,
local
);
let selected_pair_is_none = self.agent_conn.get_selected_pair().is_none();
if let Some(p) = self.find_pair(local, remote).await {
p.state
.store(CandidatePairState::Succeeded as u8, Ordering::SeqCst);
log::trace!(
"Found valid candidate pair: {}, p.state: {}, isUseCandidate: {}, {}",
p,
p.state.load(Ordering::SeqCst),
pending_request.is_use_candidate,
selected_pair_is_none
);
if pending_request.is_use_candidate && selected_pair_is_none {
self.set_selected_pair(Some(Arc::clone(&p))).await;
}
} else {
// This shouldn't happen
log::error!("Success response from invalid candidate pair");
}
} else {
log::warn!(
"discard message from ({}), unknown TransactionID 0x{:?}",
remote,
m.transaction_id
);
}
}
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
self.send_binding_success(m, local, remote).await;
log::trace!("controllingSelector: sendBindingSuccess");
if let Some(p) = self.find_pair(local, remote).await {
let nominated_pair_is_none = {
let nominated_pair = self.nominated_pair.lock().await;
nominated_pair.is_none()
};
log::trace!(
"controllingSelector: after findPair {}, p.state: {}, {}",
p,
p.state.load(Ordering::SeqCst),
nominated_pair_is_none,
//self.agent_conn.get_selected_pair().await.is_none() //, {}
);
if p.state.load(Ordering::SeqCst) == CandidatePairState::Succeeded as u8
&& nominated_pair_is_none
&& self.agent_conn.get_selected_pair().is_none()
{
if let Some(best_pair) = self.agent_conn.get_best_available_candidate_pair().await {
log::trace!(
"controllingSelector: getBestAvailableCandidatePair {}",
best_pair
);
if best_pair == p
&& self.is_nominatable(&p.local)
&& self.is_nominatable(&p.remote)
{
log::trace!("The candidate ({}, {}) is the best candidate available, marking it as nominated",
p.local, p.remote);
{
let mut nominated_pair = self.nominated_pair.lock().await;
*nominated_pair = Some(p);
}
self.nominate_pair().await;
}
} else {
log::trace!("No best pair available");
}
}
} else {
log::trace!("controllingSelector: addPair");
self.add_pair(local.clone(), remote.clone()).await;
}
}
}
#[async_trait]
impl ControlledSelector for AgentInternal {
async fn start(&self) {}
async fn contact_candidates(&self) {
// A lite selector should not contact candidates
if self.lite.load(Ordering::SeqCst) {
self.validate_selected_pair().await;
} else if self.agent_conn.get_selected_pair().is_some() {
if self.validate_selected_pair().await {
log::trace!("[{}]: checking keepalive", self.get_name());
self.check_keepalive().await;
}
} else {
self.ping_all_candidates().await;
}
}
async fn ping_candidate(
&self,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
let (msg, result) = {
let ufrag_pwd = self.ufrag_pwd.lock().await;
let username = ufrag_pwd.remote_ufrag.clone() + ":" + ufrag_pwd.local_ufrag.as_str();
let mut msg = Message::new();
let result = msg.build(&[
Box::new(BINDING_REQUEST),
Box::new(TransactionId::new()),
Box::new(Username::new(ATTR_USERNAME, username)),
Box::new(AttrControlled(self.tie_breaker.load(Ordering::SeqCst))),
Box::new(PriorityAttr(local.priority())),
Box::new(MessageIntegrity::new_short_term_integrity(
ufrag_pwd.remote_pwd.clone(),
)),
Box::new(FINGERPRINT),
]);
(msg, result)
};
if let Err(err) = result {
log::error!("{}", err);
} else {
self.send_binding_request(&msg, local, remote).await;
}
}
async fn handle_success_response(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
remote_addr: SocketAddr,
) {
// https://tools.ietf.org/html/rfc8445#section-7.3.1.5
// If the controlled agent does not accept the request from the
// controlling agent, the controlled agent MUST reject the nomination
// request with an appropriate error code response (e.g., 400)
// [RFC5389].
if let Some(pending_request) = self.handle_inbound_binding_success(m.transaction_id).await {
let transaction_addr = pending_request.destination;
// Assert that NAT is not symmetric
// https://tools.ietf.org/html/rfc8445#section-7.2.5.2.1
if transaction_addr != remote_addr {
log::debug!("discard message: transaction source and destination does not match expected({}), actual({})", transaction_addr, remote);
return;
}
log::trace!(
"inbound STUN (SuccessResponse) from {} to {}",
remote,
local
);
if let Some(p) = self.find_pair(local, remote).await {
p.state
.store(CandidatePairState::Succeeded as u8, Ordering::SeqCst);
log::trace!("Found valid candidate pair: {}", p);
} else {
// This shouldn't happen
log::error!("Success response from invalid candidate pair");
}
} else {
log::warn!(
"discard message from ({}), unknown TransactionID 0x{:?}",
remote,
m.transaction_id
);
}
}
async fn handle_binding_request(
&self,
m: &Message,
local: &Arc<dyn Candidate + Send + Sync>,
remote: &Arc<dyn Candidate + Send + Sync>,
) {
if self.find_pair(local, remote).await.is_none() {
self.add_pair(local.clone(), remote.clone()).await;
}
if let Some(p) = self.find_pair(local, remote).await {
let use_candidate = m.contains(ATTR_USE_CANDIDATE);
if use_candidate {
// https://tools.ietf.org/html/rfc8445#section-7.3.1.5
if p.state.load(Ordering::SeqCst) == CandidatePairState::Succeeded as u8 {
// If the state of this pair is Succeeded, it means that the check
// previously sent by this pair produced a successful response and
// generated a valid pair (Section 7.2.5.3.2). The agent sets the
// nominated flag value of the valid pair to true.
if self.agent_conn.get_selected_pair().is_none() {
self.set_selected_pair(Some(Arc::clone(&p))).await;
}
self.send_binding_success(m, local, remote).await;
} else {
// If the received Binding request triggered a new check to be
// enqueued in the triggered-check queue (Section 7.3.1.4), once the
// check is sent and if it generates a successful response, and
// generates a valid pair, the agent sets the nominated flag of the
// pair to true. If the request fails (Section 7.2.5.2), the agent
// MUST remove the candidate pair from the valid list, set the
// candidate pair state to Failed, and set the checklist state to
// Failed.
self.ping_candidate(local, remote).await;
}
} else {
self.send_binding_success(m, local, remote).await;
self.ping_candidate(local, remote).await;
}
}
}
}
+283
View File
@@ -0,0 +1,283 @@
use std::sync::atomic::Ordering;
use tokio::time::Instant;
use crate::agent::agent_internal::AgentInternal;
use crate::candidate::{CandidatePairState, CandidateType};
use crate::network_type::NetworkType;
/// Contains ICE candidate pair statistics.
pub struct CandidatePairStats {
/// The timestamp associated with this struct.
pub timestamp: Instant,
/// The id of the local candidate.
pub local_candidate_id: String,
/// The id of the remote candidate.
pub remote_candidate_id: String,
/// The state of the checklist for the local and remote candidates in a pair.
pub state: CandidatePairState,
/// It is true when this valid pair that should be used for media,
/// if it is the highest-priority one amongst those whose nominated flag is set.
pub nominated: bool,
/// The total number of packets sent on this candidate pair.
pub packets_sent: u32,
/// The total number of packets received on this candidate pair.
pub packets_received: u32,
/// The total number of payload bytes sent on this candidate pair not including headers or
/// padding.
pub bytes_sent: u64,
/// The total number of payload bytes received on this candidate pair not including headers or
/// padding.
pub bytes_received: u64,
/// The timestamp at which the last packet was sent on this particular candidate pair, excluding
/// STUN packets.
pub last_packet_sent_timestamp: Instant,
/// The timestamp at which the last packet was received on this particular candidate pair,
/// excluding STUN packets.
pub last_packet_received_timestamp: Instant,
/// The timestamp at which the first STUN request was sent on this particular candidate pair.
pub first_request_timestamp: Instant,
/// The timestamp at which the last STUN request was sent on this particular candidate pair.
/// The average interval between two consecutive connectivity checks sent can be calculated with
/// (last_request_timestamp - first_request_timestamp) / requests_sent.
pub last_request_timestamp: Instant,
/// Timestamp at which the last STUN response was received on this particular candidate pair.
pub last_response_timestamp: Instant,
/// The sum of all round trip time measurements in seconds since the beginning of the session,
/// based on STUN connectivity check responses (responses_received), including those that reply
/// to requests that are sent in order to verify consent. The average round trip time can be
/// computed from total_round_trip_time by dividing it by responses_received.
pub total_round_trip_time: f64,
/// The latest round trip time measured in seconds, computed from both STUN connectivity checks,
/// including those that are sent for consent verification.
pub current_round_trip_time: f64,
/// It is calculated by the underlying congestion control by combining the available bitrate for
/// all the outgoing RTP streams using this candidate pair. The bitrate measurement does not
/// count the size of the IP or other transport layers like TCP or UDP. It is similar to the
/// TIAS defined in RFC 3890, i.e., it is measured in bits per second and the bitrate is
/// calculated over a 1 second window.
pub available_outgoing_bitrate: f64,
/// It is calculated by the underlying congestion control by combining the available bitrate for
/// all the incoming RTP streams using this candidate pair. The bitrate measurement does not
/// count the size of the IP or other transport layers like TCP or UDP. It is similar to the
/// TIAS defined in RFC 3890, i.e., it is measured in bits per second and the bitrate is
/// calculated over a 1 second window.
pub available_incoming_bitrate: f64,
/// The number of times the circuit breaker is triggered for this particular 5-tuple,
/// ceasing transmission.
pub circuit_breaker_trigger_count: u32,
/// The total number of connectivity check requests received (including retransmissions).
/// It is impossible for the receiver to tell whether the request was sent in order to check
/// connectivity or check consent, so all connectivity checks requests are counted here.
pub requests_received: u64,
/// The total number of connectivity check requests sent (not including retransmissions).
pub requests_sent: u64,
/// The total number of connectivity check responses received.
pub responses_received: u64,
/// The total number of connectivity check responses sent. Since we cannot distinguish
/// connectivity check requests and consent requests, all responses are counted.
pub responses_sent: u64,
/// The total number of connectivity check request retransmissions received.
pub retransmissions_received: u64,
/// The total number of connectivity check request retransmissions sent.
pub retransmissions_sent: u64,
/// The total number of consent requests sent.
pub consent_requests_sent: u64,
/// The timestamp at which the latest valid STUN binding response expired.
pub consent_expired_timestamp: Instant,
}
impl Default for CandidatePairStats {
fn default() -> Self {
Self {
timestamp: Instant::now(),
local_candidate_id: String::new(),
remote_candidate_id: String::new(),
state: CandidatePairState::default(),
nominated: false,
packets_sent: 0,
packets_received: 0,
bytes_sent: 0,
bytes_received: 0,
last_packet_sent_timestamp: Instant::now(),
last_packet_received_timestamp: Instant::now(),
first_request_timestamp: Instant::now(),
last_request_timestamp: Instant::now(),
last_response_timestamp: Instant::now(),
total_round_trip_time: 0.0,
current_round_trip_time: 0.0,
available_outgoing_bitrate: 0.0,
available_incoming_bitrate: 0.0,
circuit_breaker_trigger_count: 0,
requests_received: 0,
requests_sent: 0,
responses_received: 0,
responses_sent: 0,
retransmissions_received: 0,
retransmissions_sent: 0,
consent_requests_sent: 0,
consent_expired_timestamp: Instant::now(),
}
}
}
/// Contains ICE candidate statistics related to the `ICETransport` objects.
#[derive(Debug, Clone)]
pub struct CandidateStats {
// The timestamp associated with this struct.
pub timestamp: Instant,
/// The candidate id.
pub id: String,
/// The type of network interface used by the base of a local candidate (the address the ICE
/// agent sends from). Only present for local candidates; it's not possible to know what type of
/// network interface a remote candidate is using.
///
/// Note: This stat only tells you about the network interface used by the first "hop"; it's
/// possible that a connection will be bottlenecked by another type of network. For example,
/// when using Wi-Fi tethering, the networkType of the relevant candidate would be "wifi", even
/// when the next hop is over a cellular connection.
pub network_type: NetworkType,
/// The IP address of the candidate, allowing for IPv4 addresses and IPv6 addresses, but fully
/// qualified domain names (FQDNs) are not allowed.
pub ip: String,
/// The port number of the candidate.
pub port: u16,
/// The `Type` field of the ICECandidate.
pub candidate_type: CandidateType,
/// The `priority` field of the ICECandidate.
pub priority: u32,
/// The url of the TURN or STUN server indicated in the that translated this IP address.
/// It is the url address surfaced in an PeerConnectionICEEvent.
pub url: String,
/// The protocol used by the endpoint to communicate with the TURN server. This is only present
/// for local candidates. Valid values for the TURN url protocol is one of udp, tcp, or tls.
pub relay_protocol: String,
/// It is true if the candidate has been deleted/freed. For host candidates, this means that any
/// network resources (typically a socket) associated with the candidate have been released. For
/// TURN candidates, this means the TURN allocation is no longer active.
///
/// Only defined for local candidates. For remote candidates, this property is not applicable.
pub deleted: bool,
}
impl Default for CandidateStats {
fn default() -> Self {
Self {
timestamp: Instant::now(),
id: String::new(),
network_type: NetworkType::default(),
ip: String::new(),
port: 0,
candidate_type: CandidateType::default(),
priority: 0,
url: String::new(),
relay_protocol: String::new(),
deleted: false,
}
}
}
impl AgentInternal {
/// Returns a list of candidate pair stats.
pub(crate) async fn get_candidate_pairs_stats(&self) -> Vec<CandidatePairStats> {
let checklist = self.agent_conn.checklist.lock().await;
let mut res = Vec::with_capacity(checklist.len());
for cp in &*checklist {
let stat = CandidatePairStats {
timestamp: Instant::now(),
local_candidate_id: cp.local.id(),
remote_candidate_id: cp.remote.id(),
state: cp.state.load(Ordering::SeqCst).into(),
nominated: cp.nominated.load(Ordering::SeqCst),
..CandidatePairStats::default()
};
res.push(stat);
}
res
}
/// Returns a list of local candidates stats.
pub(crate) async fn get_local_candidates_stats(&self) -> Vec<CandidateStats> {
let local_candidates = self.local_candidates.lock().await;
let mut res = Vec::with_capacity(local_candidates.len());
for (network_type, local_candidates) in &*local_candidates {
for c in local_candidates {
let stat = CandidateStats {
timestamp: Instant::now(),
id: c.id(),
network_type: *network_type,
ip: c.address(),
port: c.port(),
candidate_type: c.candidate_type(),
priority: c.priority(),
// URL string
relay_protocol: "udp".to_owned(),
// Deleted bool
..CandidateStats::default()
};
res.push(stat);
}
}
res
}
/// Returns a list of remote candidates stats.
pub(crate) async fn get_remote_candidates_stats(&self) -> Vec<CandidateStats> {
let remote_candidates = self.remote_candidates.lock().await;
let mut res = Vec::with_capacity(remote_candidates.len());
for (network_type, remote_candidates) in &*remote_candidates {
for c in remote_candidates {
let stat = CandidateStats {
timestamp: Instant::now(),
id: c.id(),
network_type: *network_type,
ip: c.address(),
port: c.port(),
candidate_type: c.candidate_type(),
priority: c.priority(),
// URL string
relay_protocol: "udp".to_owned(),
// Deleted bool
..CandidateStats::default()
};
res.push(stat);
}
}
res
}
}
File diff suppressed because it is too large. Load diff
+246
View File
@@ -0,0 +1,246 @@
use std::io;
use std::sync::atomic::{AtomicBool, Ordering};
use arc_swap::ArcSwapOption;
use async_trait::async_trait;
use util::Conn;
use super::*;
use crate::error::*;
impl Agent {
/// Connects to the remote agent, acting as the controlling ice agent.
/// The method blocks until at least one ice candidate pair has successfully connected.
///
/// The operation will be cancelled if `cancel_rx` either receives a message or its channel
/// closes.
pub async fn dial(
&self,
mut cancel_rx: mpsc::Receiver<()>,
remote_ufrag: String,
remote_pwd: String,
) -> Result<Arc<impl Conn>> {
let (on_connected_rx, agent_conn) = {
self.internal
.start_connectivity_checks(true, remote_ufrag, remote_pwd)
.await?;
let mut on_connected_rx = self.internal.on_connected_rx.lock().await;
(
on_connected_rx.take(),
Arc::clone(&self.internal.agent_conn),
)
};
if let Some(mut on_connected_rx) = on_connected_rx {
// block until pair selected
tokio::select! {
_ = on_connected_rx.recv() => {},
_ = cancel_rx.recv() => {
return Err(Error::ErrCanceledByCaller);
}
}
}
Ok(agent_conn)
}
/// Connects to the remote agent, acting as the controlled ice agent.
/// The method blocks until at least one ice candidate pair has successfully connected.
///
/// The operation will be cancelled if `cancel_rx` either receives a message or its channel
/// closes.
pub async fn accept(
&self,
mut cancel_rx: mpsc::Receiver<()>,
remote_ufrag: String,
remote_pwd: String,
) -> Result<Arc<impl Conn>> {
let (on_connected_rx, agent_conn) = {
self.internal
.start_connectivity_checks(false, remote_ufrag, remote_pwd)
.await?;
let mut on_connected_rx = self.internal.on_connected_rx.lock().await;
(
on_connected_rx.take(),
Arc::clone(&self.internal.agent_conn),
)
};
if let Some(mut on_connected_rx) = on_connected_rx {
// block until pair selected
tokio::select! {
_ = on_connected_rx.recv() => {},
_ = cancel_rx.recv() => {
return Err(Error::ErrCanceledByCaller);
}
}
}
Ok(agent_conn)
}
}
pub(crate) struct AgentConn {
pub(crate) selected_pair: ArcSwapOption<CandidatePair>,
pub(crate) checklist: Mutex<Vec<Arc<CandidatePair>>>,
pub(crate) buffer: Buffer,
pub(crate) bytes_received: AtomicUsize,
pub(crate) bytes_sent: AtomicUsize,
pub(crate) done: AtomicBool,
}
impl AgentConn {
pub(crate) fn new() -> Self {
Self {
selected_pair: ArcSwapOption::empty(),
checklist: Mutex::new(vec![]),
// Make sure the buffer doesn't grow indefinitely.
// NOTE: We actually won't get anywhere close to this limit.
// SRTP will constantly read from the endpoint and drop packets if it's full.
buffer: Buffer::new(0, MAX_BUFFER_SIZE),
bytes_received: AtomicUsize::new(0),
bytes_sent: AtomicUsize::new(0),
done: AtomicBool::new(false),
}
}
pub(crate) fn get_selected_pair(&self) -> Option<Arc<CandidatePair>> {
self.selected_pair.load().clone()
}
pub(crate) async fn get_best_available_candidate_pair(&self) -> Option<Arc<CandidatePair>> {
let mut best: Option<&Arc<CandidatePair>> = None;
let checklist = self.checklist.lock().await;
for p in &*checklist {
if p.state.load(Ordering::SeqCst) == CandidatePairState::Failed as u8 {
continue;
}
if let Some(b) = &mut best {
if b.priority() < p.priority() {
*b = p;
}
} else {
best = Some(p);
}
}
best.cloned()
}
pub(crate) async fn get_best_valid_candidate_pair(&self) -> Option<Arc<CandidatePair>> {
let mut best: Option<&Arc<CandidatePair>> = None;
let checklist = self.checklist.lock().await;
for p in &*checklist {
if p.state.load(Ordering::SeqCst) != CandidatePairState::Succeeded as u8 {
continue;
}
if let Some(b) = &mut best {
if b.priority() < p.priority() {
*b = p;
}
} else {
best = Some(p);
}
}
best.cloned()
}
/// Returns the number of bytes sent.
pub fn bytes_sent(&self) -> usize {
self.bytes_sent.load(Ordering::SeqCst)
}
/// Returns the number of bytes received.
pub fn bytes_received(&self) -> usize {
self.bytes_received.load(Ordering::SeqCst)
}
}
#[async_trait]
impl Conn for AgentConn {
async fn connect(&self, _addr: SocketAddr) -> std::result::Result<(), util::Error> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
async fn recv(&self, buf: &mut [u8]) -> std::result::Result<usize, util::Error> {
if self.done.load(Ordering::SeqCst) {
return Err(io::Error::new(io::ErrorKind::Other, "Conn is closed").into());
}
let n = match self.buffer.read(buf, None).await {
Ok(n) => n,
Err(err) => return Err(io::Error::new(io::ErrorKind::Other, err.to_string()).into()),
};
self.bytes_received.fetch_add(n, Ordering::SeqCst);
Ok(n)
}
async fn recv_from(
&self,
buf: &mut [u8],
) -> std::result::Result<(usize, SocketAddr), util::Error> {
if let Some(raddr) = self.remote_addr() {
let n = self.recv(buf).await?;
Ok((n, raddr))
} else {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
}
async fn send(&self, buf: &[u8]) -> std::result::Result<usize, util::Error> {
if self.done.load(Ordering::SeqCst) {
return Err(io::Error::new(io::ErrorKind::Other, "Conn is closed").into());
}
if is_message(buf) {
return Err(util::Error::Other("ErrIceWriteStunMessage".into()));
}
let result = if let Some(pair) = self.get_selected_pair() {
pair.write(buf).await
} else if let Some(pair) = self.get_best_available_candidate_pair().await {
pair.write(buf).await
} else {
Ok(0)
};
match result {
Ok(n) => {
self.bytes_sent.fetch_add(buf.len(), Ordering::SeqCst);
Ok(n)
}
Err(err) => Err(io::Error::new(io::ErrorKind::Other, err.to_string()).into()),
}
}
async fn send_to(
&self,
_buf: &[u8],
_target: SocketAddr,
) -> std::result::Result<usize, util::Error> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
fn local_addr(&self) -> std::result::Result<SocketAddr, util::Error> {
if let Some(pair) = self.get_selected_pair() {
Ok(pair.local.addr())
} else {
Err(io::Error::new(io::ErrorKind::AddrNotAvailable, "Addr Not Available").into())
}
}
fn remote_addr(&self) -> Option<SocketAddr> {
self.get_selected_pair().map(|pair| pair.remote.addr())
}
async fn close(&self) -> std::result::Result<(), util::Error> {
Ok(())
}
}
+133
View File
@@ -0,0 +1,133 @@
use util::vnet::*;
use util::Conn;
use waitgroup::WaitGroup;
use super::agent_vnet_test::*;
use super::*;
use crate::agent::agent_transport::AgentConn;
pub(crate) async fn pipe(
default_config0: Option<AgentConfig>,
default_config1: Option<AgentConfig>,
) -> Result<(Arc<impl Conn>, Arc<impl Conn>, Arc<Agent>, Arc<Agent>)> {
let (a_notifier, mut a_connected) = on_connected();
let (b_notifier, mut b_connected) = on_connected();
let mut cfg0 = if let Some(cfg) = default_config0 {
cfg
} else {
AgentConfig::default()
};
cfg0.urls = vec![];
cfg0.network_types = supported_network_types();
let a_agent = Arc::new(Agent::new(cfg0).await?);
a_agent.on_connection_state_change(a_notifier);
let mut cfg1 = if let Some(cfg) = default_config1 {
cfg
} else {
AgentConfig::default()
};
cfg1.urls = vec![];
cfg1.network_types = supported_network_types();
let b_agent = Arc::new(Agent::new(cfg1).await?);
b_agent.on_connection_state_change(b_notifier);
let (a_conn, b_conn) = connect_with_vnet(&a_agent, &b_agent).await?;
// Ensure pair selected
// Note: this assumes ConnectionStateConnected is thrown after selecting the final pair
let _ = a_connected.recv().await;
let _ = b_connected.recv().await;
Ok((a_conn, b_conn, a_agent, b_agent))
}
#[tokio::test]
async fn test_remote_local_addr() -> Result<()> {
// Agent0 is behind 1:1 NAT
let nat_type0 = nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
};
// Agent1 is behind 1:1 NAT
let nat_type1 = nat::NatType {
mode: nat::NatMode::Nat1To1,
..Default::default()
};
let v = build_vnet(nat_type0, nat_type1).await?;
let stun_server_url = Url {
scheme: SchemeType::Stun,
host: VNET_STUN_SERVER_IP.to_owned(),
port: VNET_STUN_SERVER_PORT,
proto: ProtoType::Udp,
..Default::default()
};
//"Disconnected Returns nil"
{
let disconnected_conn = AgentConn::new();
let result = disconnected_conn.local_addr();
assert!(result.is_err(), "Disconnected Returns nil");
}
//"Remote/Local Pair Match between Agents"
{
let (ca, cb) = pipe_with_vnet(
&v,
AgentTestConfig {
urls: vec![stun_server_url.clone()],
..Default::default()
},
AgentTestConfig {
urls: vec![stun_server_url],
..Default::default()
},
)
.await?;
let a_laddr = ca.local_addr()?;
let b_laddr = cb.local_addr()?;
// Assert addresses
assert_eq!(a_laddr.ip().to_string(), VNET_LOCAL_IPA.to_string());
assert_eq!(b_laddr.ip().to_string(), VNET_LOCAL_IPB.to_string());
// Close
//ca.close().await?;
//cb.close().await?;
}
v.close().await?;
Ok(())
}
#[tokio::test]
async fn test_conn_stats() -> Result<()> {
let (ca, cb, _, _) = pipe(None, None).await?;
let na = ca.send(&[0u8; 10]).await?;
let wg = WaitGroup::new();
let w = wg.worker();
tokio::spawn(async move {
let _d = w;
let mut buf = vec![0u8; 10];
let nb = cb.recv(&mut buf).await?;
assert_eq!(nb, 10, "bytes received don't match");
Result::<()>::Ok(())
});
wg.wait().await;
assert_eq!(na, 10, "bytes sent don't match");
Ok(())
}
File diff suppressed because it is too large. Load diff
+517
View File
@@ -0,0 +1,517 @@
#[cfg(test)]
mod agent_gather_test;
#[cfg(test)]
mod agent_test;
#[cfg(test)]
mod agent_transport_test;
#[cfg(test)]
pub(crate) mod agent_vnet_test;
pub mod agent_config;
pub mod agent_gather;
pub(crate) mod agent_internal;
pub mod agent_selector;
pub mod agent_stats;
pub mod agent_transport;
pub mod turn_tcp;
use std::collections::HashMap;
use std::future::Future;
use std::net::{Ipv4Addr, SocketAddr};
use std::pin::Pin;
use std::sync::atomic::{AtomicU8, AtomicUsize, Ordering};
use std::sync::Arc;
use std::time::SystemTime;
use agent_config::*;
use agent_internal::*;
use agent_stats::*;
use mdns::conn::*;
use stun::agent::*;
use stun::attributes::*;
use stun::fingerprint::*;
use stun::integrity::*;
use stun::message::*;
use stun::xoraddr::*;
use tokio::sync::{broadcast, mpsc, Mutex};
use tokio::time::{Duration, Instant};
use util::vnet::net::*;
use util::Buffer;
use crate::agent::agent_gather::GatherCandidatesInternalParams;
use crate::candidate::*;
use crate::error::*;
use crate::external_ip_mapper::*;
use crate::mdns::*;
use crate::network_type::*;
use crate::rand::*;
use crate::state::*;
use crate::tcp_type::TcpType;
use crate::udp_mux::UDPMux;
use crate::udp_network::UDPNetwork;
use crate::url::*;
#[derive(Debug, Clone)]
pub(crate) struct BindingRequest {
pub(crate) timestamp: Instant,
pub(crate) transaction_id: TransactionId,
pub(crate) destination: SocketAddr,
pub(crate) is_use_candidate: bool,
}
impl Default for BindingRequest {
fn default() -> Self {
Self {
timestamp: Instant::now(),
transaction_id: TransactionId::default(),
destination: SocketAddr::new(Ipv4Addr::new(0, 0, 0, 0).into(), 0),
is_use_candidate: false,
}
}
}
pub type OnConnectionStateChangeHdlrFn = Box<
dyn (FnMut(ConnectionState) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>)
+ Send
+ Sync,
>;
pub type OnSelectedCandidatePairChangeHdlrFn = Box<
dyn (FnMut(
&Arc<dyn Candidate + Send + Sync>,
&Arc<dyn Candidate + Send + Sync>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>)
+ Send
+ Sync,
>;
pub type OnCandidateHdlrFn = Box<
dyn (FnMut(
Option<Arc<dyn Candidate + Send + Sync>>,
) -> Pin<Box<dyn Future<Output = ()> + Send + 'static>>)
+ Send
+ Sync,
>;
pub type GatherCandidateCancelFn = Box<dyn Fn() + Send + Sync>;
struct ChanReceivers {
chan_state_rx: mpsc::Receiver<ConnectionState>,
chan_candidate_rx: mpsc::Receiver<Option<Arc<dyn Candidate + Send + Sync>>>,
chan_candidate_pair_rx: mpsc::Receiver<()>,
}
/// Represents the ICE agent.
pub struct Agent {
pub(crate) internal: Arc<AgentInternal>,
pub(crate) udp_network: UDPNetwork,
pub(crate) interface_filter: Arc<Option<InterfaceFilterFn>>,
pub(crate) ip_filter: Arc<Option<IpFilterFn>>,
pub(crate) mdns_mode: MulticastDnsMode,
pub(crate) mdns_name: String,
pub(crate) mdns_conn: Option<Arc<DnsConn>>,
pub(crate) net: Arc<Net>,
// 1:1 D-NAT IP address mapping
pub(crate) ext_ip_mapper: Arc<Option<ExternalIpMapper>>,
pub(crate) gathering_state: Arc<AtomicU8>, //GatheringState,
pub(crate) candidate_types: Vec<CandidateType>,
pub(crate) urls: Vec<Url>,
pub(crate) network_types: Vec<NetworkType>,
pub(crate) gather_candidate_cancel: Option<GatherCandidateCancelFn>,
}
impl Agent {
/// Creates a new Agent.
pub async fn new(config: AgentConfig) -> Result<Self> {
let mut mdns_name = config.multicast_dns_host_name.clone();
if mdns_name.is_empty() {
mdns_name = generate_multicast_dns_name();
}
if !mdns_name.ends_with(".local") || mdns_name.split('.').count() != 2 {
return Err(Error::ErrInvalidMulticastDnshostName);
}
let mdns_mode = config.multicast_dns_mode;
let mdns_conn =
match create_multicast_dns(mdns_mode, &mdns_name, &config.multicast_dns_dest_addr) {
Ok(c) => c,
Err(err) => {
// Opportunistic mDNS: If we can't open the connection, that's ok: we
// can continue without it.
log::warn!("Failed to initialize mDNS {}: {}", mdns_name, err);
None
}
};
let (mut ai, chan_receivers) = AgentInternal::new(&config);
let (chan_state_rx, chan_candidate_rx, chan_candidate_pair_rx) = (
chan_receivers.chan_state_rx,
chan_receivers.chan_candidate_rx,
chan_receivers.chan_candidate_pair_rx,
);
config.init_with_defaults(&mut ai);
let candidate_types = if config.candidate_types.is_empty() {
default_candidate_types()
} else {
config.candidate_types.clone()
};
if ai.lite.load(Ordering::SeqCst)
&& (candidate_types.len() != 1 || candidate_types[0] != CandidateType::Host)
{
Self::close_multicast_conn(&mdns_conn).await;
return Err(Error::ErrLiteUsingNonHostCandidates);
}
if !config.urls.is_empty()
&& !contains_candidate_type(CandidateType::ServerReflexive, &candidate_types)
&& !contains_candidate_type(CandidateType::Relay, &candidate_types)
{
Self::close_multicast_conn(&mdns_conn).await;
return Err(Error::ErrUselessUrlsProvided);
}
let ext_ip_mapper = match config.init_ext_ip_mapping(mdns_mode, &candidate_types) {
Ok(ext_ip_mapper) => ext_ip_mapper,
Err(err) => {
Self::close_multicast_conn(&mdns_conn).await;
return Err(err);
}
};
let net = if let Some(net) = config.net {
if net.is_virtual() {
log::warn!("vnet is enabled");
if mdns_mode != MulticastDnsMode::Disabled {
log::warn!("vnet does not support mDNS yet");
}
}
net
} else {
Arc::new(Net::new(None))
};
let agent = Self {
udp_network: config.udp_network,
internal: Arc::new(ai),
interface_filter: Arc::clone(&config.interface_filter),
ip_filter: Arc::clone(&config.ip_filter),
mdns_mode,
mdns_name,
mdns_conn,
net,
ext_ip_mapper: Arc::new(ext_ip_mapper),
gathering_state: Arc::new(AtomicU8::new(0)), //GatheringState::New,
candidate_types,
urls: config.urls.clone(),
network_types: config.network_types.clone(),
gather_candidate_cancel: None, //TODO: add cancel
};
agent.internal.start_on_connection_state_change_routine(
chan_state_rx,
chan_candidate_rx,
chan_candidate_pair_rx,
);
// Restart is also used to initialize the agent for the first time
if let Err(err) = agent.restart(config.local_ufrag, config.local_pwd).await {
Self::close_multicast_conn(&agent.mdns_conn).await;
let _ = agent.close().await;
return Err(err);
}
Ok(agent)
}
pub fn get_bytes_received(&self) -> usize {
self.internal.agent_conn.bytes_received()
}
pub fn get_bytes_sent(&self) -> usize {
self.internal.agent_conn.bytes_sent()
}
/// Sets a handler that is fired when the connection state changes.
pub fn on_connection_state_change(&self, f: OnConnectionStateChangeHdlrFn) {
self.internal
.on_connection_state_change_hdlr
.store(Some(Arc::new(Mutex::new(f))))
}
/// Sets a handler that is fired when the final candidate pair is selected.
pub fn on_selected_candidate_pair_change(&self, f: OnSelectedCandidatePairChangeHdlrFn) {
self.internal
.on_selected_candidate_pair_change_hdlr
.store(Some(Arc::new(Mutex::new(f))))
}
/// Sets a handler that is fired when new candidates gathered. When the gathering process
/// complete the last candidate is nil.
pub fn on_candidate(&self, f: OnCandidateHdlrFn) {
self.internal
.on_candidate_hdlr
.store(Some(Arc::new(Mutex::new(f))));
}
/// Adds a new remote candidate.
pub fn add_remote_candidate(&self, c: &Arc<dyn Candidate + Send + Sync>) -> Result<()> {
// cannot check for network yet because it might not be applied
// when mDNS hostame is used.
if c.tcp_type() == TcpType::Active {
// TCP Candidates with tcptype active will probe server passive ones, so
// no need to do anything with them.
log::info!("Ignoring remote candidate with tcpType active: {}", c);
return Ok(());
}
// If we have a mDNS Candidate lets fully resolve it before adding it locally
if c.candidate_type() == CandidateType::Host && c.address().ends_with(".local") {
if self.mdns_mode == MulticastDnsMode::Disabled {
log::warn!(
"remote mDNS candidate added, but mDNS is disabled: ({})",
c.address()
);
return Ok(());
}
if c.candidate_type() != CandidateType::Host {
return Err(Error::ErrAddressParseFailed);
}
let ai = Arc::clone(&self.internal);
let host_candidate = Arc::clone(c);
let mdns_conn = self.mdns_conn.clone();
tokio::spawn(async move {
if let Some(mdns_conn) = mdns_conn {
if let Ok(candidate) =
Self::resolve_and_add_multicast_candidate(mdns_conn, host_candidate).await
{
ai.add_remote_candidate(&candidate).await;
}
}
});
} else {
let ai = Arc::clone(&self.internal);
let candidate = Arc::clone(c);
tokio::spawn(async move {
ai.add_remote_candidate(&candidate).await;
});
}
Ok(())
}
/// Returns the local candidates.
pub async fn get_local_candidates(&self) -> Result<Vec<Arc<dyn Candidate + Send + Sync>>> {
let mut res = vec![];
{
let local_candidates = self.internal.local_candidates.lock().await;
for candidates in local_candidates.values() {
for candidate in candidates {
res.push(Arc::clone(candidate));
}
}
}
Ok(res)
}
/// Returns the local user credentials.
pub async fn get_local_user_credentials(&self) -> (String, String) {
let ufrag_pwd = self.internal.ufrag_pwd.lock().await;
(ufrag_pwd.local_ufrag.clone(), ufrag_pwd.local_pwd.clone())
}
/// Returns the remote user credentials.
pub async fn get_remote_user_credentials(&self) -> (String, String) {
let ufrag_pwd = self.internal.ufrag_pwd.lock().await;
(ufrag_pwd.remote_ufrag.clone(), ufrag_pwd.remote_pwd.clone())
}
/// Cleans up the Agent.
pub async fn close(&self) -> Result<()> {
if let Some(gather_candidate_cancel) = &self.gather_candidate_cancel {
gather_candidate_cancel();
}
if let UDPNetwork::Muxed(ref udp_mux) = self.udp_network {
let (ufrag, _) = self.get_local_user_credentials().await;
udp_mux.remove_conn_by_ufrag(&ufrag).await;
}
//FIXME: deadlock here
self.internal.close().await
}
/// Returns the selected pair or nil if there is none
pub fn get_selected_candidate_pair(&self) -> Option<Arc<CandidatePair>> {
self.internal.agent_conn.get_selected_pair()
}
/// Sets the credentials of the remote agent.
pub async fn set_remote_credentials(
&self,
remote_ufrag: String,
remote_pwd: String,
) -> Result<()> {
self.internal
.set_remote_credentials(remote_ufrag, remote_pwd)
.await
}
/// Restarts the ICE Agent with the provided ufrag/pwd
/// If no ufrag/pwd is provided the Agent will generate one itself.
///
/// Restart must only be called when `GatheringState` is `GatheringStateComplete`
/// a user must then call `GatherCandidates` explicitly to start generating new ones.
pub async fn restart(&self, mut ufrag: String, mut pwd: String) -> Result<()> {
if ufrag.is_empty() {
ufrag = generate_ufrag();
}
if pwd.is_empty() {
pwd = generate_pwd();
}
if ufrag.len() * 8 < 24 {
return Err(Error::ErrLocalUfragInsufficientBits);
}
if pwd.len() * 8 < 128 {
return Err(Error::ErrLocalPwdInsufficientBits);
}
if GatheringState::from(self.gathering_state.load(Ordering::SeqCst))
== GatheringState::Gathering
{
return Err(Error::ErrRestartWhenGathering);
}
self.gathering_state
.store(GatheringState::New as u8, Ordering::SeqCst);
{
let done_tx = self.internal.done_tx.lock().await;
if done_tx.is_none() {
return Err(Error::ErrClosed);
}
}
// Clear all agent needed to take back to fresh state
{
let mut ufrag_pwd = self.internal.ufrag_pwd.lock().await;
ufrag_pwd.local_ufrag = ufrag;
ufrag_pwd.local_pwd = pwd;
ufrag_pwd.remote_ufrag = String::new();
ufrag_pwd.remote_pwd = String::new();
}
{
let mut pending_binding_requests = self.internal.pending_binding_requests.lock().await;
*pending_binding_requests = vec![];
}
{
let mut checklist = self.internal.agent_conn.checklist.lock().await;
*checklist = vec![];
}
self.internal.set_selected_pair(None).await;
self.internal.delete_all_candidates().await;
self.internal.start().await;
// Restart is used by NewAgent. Accept/Connect should be used to move to checking
// for new Agents
if self.internal.connection_state.load(Ordering::SeqCst) != ConnectionState::New as u8 {
self.internal
.update_connection_state(ConnectionState::Checking)
.await;
}
Ok(())
}
/// Initiates the trickle based gathering process.
pub fn gather_candidates(&self) -> Result<()> {
if self.gathering_state.load(Ordering::SeqCst) != GatheringState::New as u8 {
return Err(Error::ErrMultipleGatherAttempted);
}
if self.internal.on_candidate_hdlr.load().is_none() {
return Err(Error::ErrNoOnCandidateHandler);
}
if let Some(gather_candidate_cancel) = &self.gather_candidate_cancel {
gather_candidate_cancel(); // Cancel previous gathering routine
}
//TODO: a.gatherCandidateCancel = cancel
let params = GatherCandidatesInternalParams {
udp_network: self.udp_network.clone(),
candidate_types: self.candidate_types.clone(),
urls: self.urls.clone(),
network_types: self.network_types.clone(),
mdns_mode: self.mdns_mode,
mdns_name: self.mdns_name.clone(),
net: Arc::clone(&self.net),
interface_filter: self.interface_filter.clone(),
ip_filter: self.ip_filter.clone(),
ext_ip_mapper: Arc::clone(&self.ext_ip_mapper),
agent_internal: Arc::clone(&self.internal),
gathering_state: Arc::clone(&self.gathering_state),
chan_candidate_tx: Arc::clone(&self.internal.chan_candidate_tx),
};
tokio::spawn(async move {
Self::gather_candidates_internal(params).await;
});
Ok(())
}
/// Returns a list of candidate pair stats.
pub async fn get_candidate_pairs_stats(&self) -> Vec<CandidatePairStats> {
self.internal.get_candidate_pairs_stats().await
}
/// Returns a list of local candidates stats.
pub async fn get_local_candidates_stats(&self) -> Vec<CandidateStats> {
self.internal.get_local_candidates_stats().await
}
/// Returns a list of remote candidates stats.
pub async fn get_remote_candidates_stats(&self) -> Vec<CandidateStats> {
self.internal.get_remote_candidates_stats().await
}
async fn resolve_and_add_multicast_candidate(
mdns_conn: Arc<DnsConn>,
c: Arc<dyn Candidate + Send + Sync>,
) -> Result<Arc<dyn Candidate + Send + Sync>> {
//TODO: hook up _close_query_signal_tx to Agent or Candidate's Close signal?
let (_close_query_signal_tx, close_query_signal_rx) = mpsc::channel(1);
let src = match mdns_conn.query(&c.address(), close_query_signal_rx).await {
Ok((_, src)) => src,
Err(err) => {
log::warn!("Failed to discover mDNS candidate {}: {}", c.address(), err);
return Err(err.into());
}
};
c.set_ip(&src.ip())?;
Ok(c)
}
async fn close_multicast_conn(mdns_conn: &Option<Arc<DnsConn>>) {
if let Some(conn) = mdns_conn {
if let Err(err) = conn.close().await {
log::warn!("failed to close mDNS Conn: {}", err);
}
}
}
}
+194
View File
@@ -0,0 +1,194 @@
//! TURN over TCP/TLS (RFC 6062 framing as used by RFC 5766 §2.1), optionally through an HTTP
//! CONNECT proxy. Local patch for uu-remote-linux: upstream only gathers relays over UDP.
use std::net::{IpAddr, SocketAddr};
use std::sync::{Arc, RwLock};
use async_trait::async_trait;
use tokio::io::{AsyncRead, AsyncReadExt, AsyncWrite, AsyncWriteExt, ReadHalf, WriteHalf};
use tokio::net::TcpStream;
use tokio::sync::Mutex;
use util::Conn;
/// How relay connections over TCP reach the TURN server. Set once by the application.
#[derive(Clone, Debug, Default)]
pub struct RelayTransport {
/// HTTP proxy `host:port` for CONNECT; None dials the TURN server directly.
pub http_proxy: Option<String>,
}
static TRANSPORT: RwLock<Option<RelayTransport>> = RwLock::new(None);
pub fn set_relay_transport(transport: RelayTransport) {
*TRANSPORT.write().unwrap() = Some(transport);
}
fn transport() -> RelayTransport {
TRANSPORT.read().unwrap().clone().unwrap_or_default()
}
/// TCP/TLS relays are gathered only after the application opts in; UDP-only by default.
pub fn enabled() -> bool {
TRANSPORT.read().unwrap().is_some()
}
trait Stream: AsyncRead + AsyncWrite + Send + Unpin {}
impl<T: AsyncRead + AsyncWrite + Send + Unpin> Stream for T {}
/// Datagram view of a framed TURN stream: one STUN message or ChannelData per read.
pub struct FramedConn {
reader: Mutex<ReadHalf<Box<dyn Stream>>>,
writer: Mutex<WriteHalf<Box<dyn Stream>>>,
local: SocketAddr,
server: SocketAddr,
}
/// Opens TCP (optionally through the proxy) and TLS when `tls`, then frames it.
pub async fn dial(host: &str, port: u16, server: SocketAddr, tls: bool) -> Result<FramedConn, String> {
let settings = transport();
let target = format!("{host}:{port}");
let tcp = match &settings.http_proxy {
Some(proxy) => connect_via_proxy(proxy, &target).await?,
None => TcpStream::connect(server).await.map_err(|e| format!("TURN TCP connect: {e}"))?,
};
let local = tcp.local_addr().map_err(|e| format!("TURN TCP local address: {e}"))?;
let stream: Box<dyn Stream> = if tls {
Box::new(tls_connect(tcp, host).await?)
} else {
Box::new(tcp)
};
let (reader, writer) = tokio::io::split(stream);
Ok(FramedConn { reader: Mutex::new(reader), writer: Mutex::new(writer), local, server })
}
async fn connect_via_proxy(proxy: &str, target: &str) -> Result<TcpStream, String> {
let mut tcp = TcpStream::connect(proxy).await.map_err(|e| format!("TURN proxy connect: {e}"))?;
let request = format!("CONNECT {target} HTTP/1.1\r\nHost: {target}\r\n\r\n");
tcp.write_all(request.as_bytes()).await.map_err(|e| format!("TURN proxy write: {e}"))?;
// Read byte by byte up to the blank line so no tunnelled bytes are consumed.
let mut head = Vec::new();
while !head.ends_with(b"\r\n\r\n") {
if head.len() > 8192 { return Err("TURN proxy response too large".into()); }
let mut byte = [0u8; 1];
if tcp.read(&mut byte).await.map_err(|e| format!("TURN proxy read: {e}"))? == 0 {
return Err("TURN proxy closed the connection".into());
}
head.push(byte[0]);
}
let status = String::from_utf8_lossy(&head).lines().next().unwrap_or("").to_owned();
match status.split_whitespace().nth(1) {
Some("200") => Ok(tcp),
code => Err(format!("TURN proxy CONNECT refused: status={}", code.unwrap_or("none"))),
}
}
async fn tls_connect(tcp: TcpStream, host: &str)
-> Result<tokio_rustls::client::TlsStream<TcpStream>, String> {
use tokio_rustls::rustls::{self, client::WebPkiServerVerifier, pki_types::ServerName};
let provider = Arc::new(rustls::crypto::ring::default_provider());
// System store first (it holds any CA the host's administrator added, e.g. for a TLS-inspecting
// proxy, as OpenSSL would use), then the bundled Mozilla roots.
let mut roots = rustls::RootCertStore::empty();
roots.add_parsable_certificates(rustls_native_certs::load_native_certs().certs);
roots.extend(webpki_roots::TLS_SERVER_ROOTS.iter().cloned());
let inner = WebPkiServerVerifier::builder_with_provider(Arc::new(roots), provider.clone()).build()
.map_err(|e| format!("TURN TLS setup: {e}"))?;
let config = rustls::ClientConfig::builder_with_provider(provider)
.with_safe_default_protocol_versions().map_err(|e| format!("TURN TLS setup: {e}"))?
.dangerous().with_custom_certificate_verifier(Arc::new(IpTolerant(inner))).with_no_client_auth();
let name = match host.parse::<IpAddr>() {
Ok(ip) => ServerName::IpAddress(ip.into()),
Err(_) => ServerName::try_from(host.to_owned()).map_err(|_| "TURN TLS: invalid server name".to_owned())?,
};
tokio_rustls::TlsConnector::from(Arc::new(config)).connect(name, tcp).await
.map_err(|e| format!("TURN TLS handshake: {e}"))
}
/// Full chain verification; only a name mismatch is accepted, and only when the TURN URL is an
/// IP literal (cloud TURN URLs are IPs while certificates name the service). Media is protected
/// end to end by DTLS-SRTP with signalled fingerprints, not by this hop.
#[derive(Debug)]
struct IpTolerant(Arc<tokio_rustls::rustls::client::WebPkiServerVerifier>);
impl tokio_rustls::rustls::client::danger::ServerCertVerifier for IpTolerant {
fn verify_server_cert(&self, end_entity: &tokio_rustls::rustls::pki_types::CertificateDer<'_>,
intermediates: &[tokio_rustls::rustls::pki_types::CertificateDer<'_>],
server_name: &tokio_rustls::rustls::pki_types::ServerName<'_>, ocsp: &[u8],
now: tokio_rustls::rustls::pki_types::UnixTime)
-> Result<tokio_rustls::rustls::client::danger::ServerCertVerified, tokio_rustls::rustls::Error> {
use tokio_rustls::rustls::{CertificateError, Error, pki_types::ServerName};
match self.0.verify_server_cert(end_entity, intermediates, server_name, ocsp, now) {
Err(Error::InvalidCertificate(CertificateError::NotValidForName | CertificateError::NotValidForNameContext { .. }))
if matches!(server_name, ServerName::IpAddress(_)) =>
Ok(tokio_rustls::rustls::client::danger::ServerCertVerified::assertion()),
other => other,
}
}
fn verify_tls12_signature(&self, message: &[u8], cert: &tokio_rustls::rustls::pki_types::CertificateDer<'_>,
dss: &tokio_rustls::rustls::DigitallySignedStruct)
-> Result<tokio_rustls::rustls::client::danger::HandshakeSignatureValid, tokio_rustls::rustls::Error> {
self.0.verify_tls12_signature(message, cert, dss)
}
fn verify_tls13_signature(&self, message: &[u8], cert: &tokio_rustls::rustls::pki_types::CertificateDer<'_>,
dss: &tokio_rustls::rustls::DigitallySignedStruct)
-> Result<tokio_rustls::rustls::client::danger::HandshakeSignatureValid, tokio_rustls::rustls::Error> {
self.0.verify_tls13_signature(message, cert, dss)
}
fn supported_verify_schemes(&self) -> Vec<tokio_rustls::rustls::SignatureScheme> {
self.0.supported_verify_schemes()
}
}
/// Total on-the-wire length of the frame starting with `header` (4 bytes), including
/// ChannelData padding to 4 bytes, which TCP carries (RFC 5766 §11.5).
pub fn frame_len(header: [u8; 4]) -> Option<usize> {
let length = u16::from_be_bytes([header[2], header[3]]) as usize;
match header[0] >> 6 {
0 => Some(20 + length), // STUN: 20-byte header + attributes
1 => Some(4 + (length + 3) / 4 * 4), // ChannelData 0x4000..0x7FFF
_ => None,
}
}
#[async_trait]
impl Conn for FramedConn {
async fn connect(&self, _: SocketAddr) -> util::Result<()> {
Err(util::Error::Other("TURN TCP connection is already connected".into()))
}
async fn recv(&self, buf: &mut [u8]) -> util::Result<usize> {
self.recv_from(buf).await.map(|(n, _)| n)
}
async fn recv_from(&self, buf: &mut [u8]) -> util::Result<(usize, SocketAddr)> {
let mut reader = self.reader.lock().await;
let mut header = [0u8; 4];
reader.read_exact(&mut header).await?;
let total = frame_len(header).ok_or_else(|| util::Error::Other("TURN TCP: unknown frame type".into()))?;
let mut frame = vec![0u8; total];
frame[..4].copy_from_slice(&header);
reader.read_exact(&mut frame[4..]).await?;
if frame.len() > buf.len() {
return Err(util::Error::Other("TURN TCP: frame larger than the read buffer".into()));
}
buf[..frame.len()].copy_from_slice(&frame);
Ok((frame.len(), self.server))
}
async fn send(&self, buf: &[u8]) -> util::Result<usize> {
let mut writer = self.writer.lock().await;
writer.write_all(buf).await?;
writer.flush().await?;
Ok(buf.len())
}
async fn send_to(&self, buf: &[u8], _: SocketAddr) -> util::Result<usize> {
self.send(buf).await
}
fn local_addr(&self) -> util::Result<SocketAddr> {
Ok(self.local)
}
fn remote_addr(&self) -> Option<SocketAddr> {
Some(self.server)
}
async fn close(&self) -> util::Result<()> {
let _ = self.writer.lock().await.shutdown().await;
Ok(())
}
}
+524
View File
@@ -0,0 +1,524 @@
use std::fmt;
use std::ops::Add;
use std::sync::atomic::{AtomicU16, AtomicU64, AtomicU8, Ordering};
use std::sync::Arc;
use std::time::{Duration, SystemTime, UNIX_EPOCH};
use async_trait::async_trait;
use crc::{Crc, CRC_32_ISCSI};
use tokio::sync::{broadcast, Mutex};
use util::sync::Mutex as SyncMutex;
use super::*;
use crate::candidate::candidate_host::CandidateHostConfig;
use crate::candidate::candidate_peer_reflexive::CandidatePeerReflexiveConfig;
use crate::candidate::candidate_relay::CandidateRelayConfig;
use crate::candidate::candidate_server_reflexive::CandidateServerReflexiveConfig;
use crate::error::*;
use crate::util::*;
#[derive(Default)]
pub struct CandidateBaseConfig {
pub candidate_id: String,
pub network: String,
pub address: String,
pub port: u16,
pub component: u16,
pub priority: u32,
pub foundation: String,
pub conn: Option<Arc<dyn util::Conn + Send + Sync>>,
pub initialized_ch: Option<broadcast::Receiver<()>>,
}
pub struct CandidateBase {
pub(crate) id: String,
pub(crate) network_type: AtomicU8,
pub(crate) candidate_type: CandidateType,
pub(crate) component: AtomicU16,
pub(crate) address: String,
pub(crate) port: u16,
pub(crate) related_address: Option<CandidateRelatedAddress>,
pub(crate) tcp_type: TcpType,
pub(crate) resolved_addr: SyncMutex<SocketAddr>,
pub(crate) last_sent: AtomicU64,
pub(crate) last_received: AtomicU64,
pub(crate) conn: Option<Arc<dyn util::Conn + Send + Sync>>,
pub(crate) closed_ch: Arc<Mutex<Option<broadcast::Sender<()>>>>,
pub(crate) foundation_override: String,
pub(crate) priority_override: u32,
//CandidateHost
pub(crate) network: String,
//CandidateRelay
pub(crate) relay_client: Option<Arc<turn::client::Client>>,
}
impl Default for CandidateBase {
fn default() -> Self {
Self {
id: String::new(),
network_type: AtomicU8::new(0),
candidate_type: CandidateType::default(),
component: AtomicU16::new(0),
address: String::new(),
port: 0,
related_address: None,
tcp_type: TcpType::default(),
resolved_addr: SyncMutex::new(SocketAddr::new(IpAddr::from([0, 0, 0, 0]), 0)),
last_sent: AtomicU64::new(0),
last_received: AtomicU64::new(0),
conn: None,
closed_ch: Arc::new(Mutex::new(None)),
foundation_override: String::new(),
priority_override: 0,
network: String::new(),
relay_client: None,
}
}
}
// String makes the candidateBase printable
impl fmt::Display for CandidateBase {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
if let Some(related_address) = self.related_address() {
write!(
f,
"{} {} {}:{}{}",
self.network_type(),
self.candidate_type(),
self.address(),
self.port(),
related_address,
)
} else {
write!(
f,
"{} {} {}:{}",
self.network_type(),
self.candidate_type(),
self.address(),
self.port(),
)
}
}
}
#[async_trait]
impl Candidate for CandidateBase {
fn foundation(&self) -> String {
if !self.foundation_override.is_empty() {
return self.foundation_override.clone();
}
let mut buf = vec![];
buf.extend_from_slice(self.candidate_type().to_string().as_bytes());
buf.extend_from_slice(self.address.as_bytes());
buf.extend_from_slice(self.network_type().to_string().as_bytes());
let checksum = Crc::<u32>::new(&CRC_32_ISCSI).checksum(&buf);
format!("{checksum}")
}
/// Returns Candidate ID.
fn id(&self) -> String {
self.id.clone()
}
/// Returns candidate component.
fn component(&self) -> u16 {
self.component.load(Ordering::SeqCst)
}
fn set_component(&self, component: u16) {
self.component.store(component, Ordering::SeqCst);
}
/// Returns a time indicating the last time this candidate was received.
fn last_received(&self) -> SystemTime {
UNIX_EPOCH.add(Duration::from_nanos(
self.last_received.load(Ordering::SeqCst),
))
}
/// Returns a time indicating the last time this candidate was sent.
fn last_sent(&self) -> SystemTime {
UNIX_EPOCH.add(Duration::from_nanos(self.last_sent.load(Ordering::SeqCst)))
}
/// Returns candidate NetworkType.
fn network_type(&self) -> NetworkType {
NetworkType::from(self.network_type.load(Ordering::SeqCst))
}
/// Returns Candidate Address.
fn address(&self) -> String {
self.address.clone()
}
/// Returns Candidate Port.
fn port(&self) -> u16 {
self.port
}
/// Computes the priority for this ICE Candidate.
fn priority(&self) -> u32 {
if self.priority_override != 0 {
return self.priority_override;
}
// The local preference MUST be an integer from 0 (lowest preference) to
// 65535 (highest preference) inclusive. When there is only a single IP
// address, this value SHOULD be set to 65535. If there are multiple
// candidates for a particular component for a particular data stream
// that have the same type, the local preference MUST be unique for each
// one.
(1 << 24) * u32::from(self.candidate_type().preference())
+ (1 << 8) * u32::from(self.local_preference())
+ (256 - u32::from(self.component()))
}
/// Returns `Option<CandidateRelatedAddress>`.
fn related_address(&self) -> Option<CandidateRelatedAddress> {
self.related_address.as_ref().cloned()
}
/// Returns candidate type.
fn candidate_type(&self) -> CandidateType {
self.candidate_type
}
fn tcp_type(&self) -> TcpType {
self.tcp_type
}
/// Returns the string representation of the ICECandidate.
fn marshal(&self) -> String {
let mut val = format!(
"{} {} {} {} {} {} typ {}",
self.foundation(),
self.component(),
self.network_type().network_short(),
self.priority(),
self.address(),
self.port(),
self.candidate_type()
);
if self.tcp_type != TcpType::Unspecified {
val += format!(" tcptype {}", self.tcp_type()).as_str();
}
if let Some(related_address) = self.related_address() {
val += format!(
" raddr {} rport {}",
related_address.address, related_address.port,
)
.as_str();
}
val
}
fn addr(&self) -> SocketAddr {
*self.resolved_addr.lock()
}
/// Stops the recvLoop.
async fn close(&self) -> Result<()> {
{
let mut closed_ch = self.closed_ch.lock().await;
if closed_ch.is_none() {
return Err(Error::ErrClosed);
}
closed_ch.take();
}
if let Some(relay_client) = &self.relay_client {
let _ = relay_client.close().await;
}
if let Some(conn) = &self.conn {
let _ = conn.close().await;
}
Ok(())
}
fn seen(&self, outbound: bool) {
let d = SystemTime::now()
.duration_since(UNIX_EPOCH)
.unwrap_or_else(|_| Duration::from_secs(0));
if outbound {
self.set_last_sent(d);
} else {
self.set_last_received(d);
}
}
async fn write_to(&self, raw: &[u8], dst: &(dyn Candidate + Send + Sync)) -> Result<usize> {
let n = if let Some(conn) = &self.conn {
let addr = dst.addr();
conn.send_to(raw, addr).await?
} else {
0
};
self.seen(true);
Ok(n)
}
/// Used to compare two candidateBases.
fn equal(&self, other: &dyn Candidate) -> bool {
self.network_type() == other.network_type()
&& self.candidate_type() == other.candidate_type()
&& self.address() == other.address()
&& self.port() == other.port()
&& self.tcp_type() == other.tcp_type()
&& self.related_address() == other.related_address()
}
fn set_ip(&self, ip: &IpAddr) -> Result<()> {
let network_type = determine_network_type(&self.network, ip)?;
self.network_type
.store(network_type as u8, Ordering::SeqCst);
let addr = create_addr(network_type, *ip, self.port);
*self.resolved_addr.lock() = addr;
Ok(())
}
fn get_conn(&self) -> Option<&Arc<dyn util::Conn + Send + Sync>> {
self.conn.as_ref()
}
fn get_closed_ch(&self) -> Arc<Mutex<Option<broadcast::Sender<()>>>> {
self.closed_ch.clone()
}
}
impl CandidateBase {
pub fn set_last_received(&self, d: Duration) {
#[allow(clippy::cast_possible_truncation)]
self.last_received
.store(d.as_nanos() as u64, Ordering::SeqCst);
}
pub fn set_last_sent(&self, d: Duration) {
#[allow(clippy::cast_possible_truncation)]
self.last_sent.store(d.as_nanos() as u64, Ordering::SeqCst);
}
/// Returns the local preference for this candidate.
pub fn local_preference(&self) -> u16 {
if self.network_type().is_tcp() {
// RFC 6544, section 4.2
//
// In Section 4.1.2.1 of [RFC5245], a recommended formula for UDP ICE
// candidate prioritization is defined. For TCP candidates, the same
// formula and candidate type preferences SHOULD be used, and the
// RECOMMENDED type preferences for the new candidate types defined in
// this document (see Section 5) are 105 for NAT-assisted candidates and
// 75 for UDP-tunneled candidates.
//
// (...)
//
// With TCP candidates, the local preference part of the recommended
// priority formula is updated to also include the directionality
// (active, passive, or simultaneous-open) of the TCP connection. The
// RECOMMENDED local preference is then defined as:
//
// local preference = (2^13) * direction-pref + other-pref
//
// The direction-pref MUST be between 0 and 7 (both inclusive), with 7
// being the most preferred. The other-pref MUST be between 0 and 8191
// (both inclusive), with 8191 being the most preferred. It is
// RECOMMENDED that the host, UDP-tunneled, and relayed TCP candidates
// have the direction-pref assigned as follows: 6 for active, 4 for
// passive, and 2 for S-O. For the NAT-assisted and server reflexive
// candidates, the RECOMMENDED values are: 6 for S-O, 4 for active, and
// 2 for passive.
//
// (...)
//
// If any two candidates have the same type-preference and direction-
// pref, they MUST have a unique other-pref. With this specification,
// this usually only happens with multi-homed hosts, in which case
// other-pref is the preference for the particular IP address from which
// the candidate was obtained. When there is only a single IP address,
// this value SHOULD be set to the maximum allowed value (8191).
let other_pref: u16 = 8191;
let direction_pref: u16 = match self.candidate_type() {
CandidateType::Host | CandidateType::Relay => match self.tcp_type() {
TcpType::Active => 6,
TcpType::Passive => 4,
TcpType::SimultaneousOpen => 2,
TcpType::Unspecified => 0,
},
CandidateType::PeerReflexive | CandidateType::ServerReflexive => {
match self.tcp_type() {
TcpType::SimultaneousOpen => 6,
TcpType::Active => 4,
TcpType::Passive => 2,
TcpType::Unspecified => 0,
}
}
CandidateType::Unspecified => 0,
};
(1 << 13) * direction_pref + other_pref
} else {
DEFAULT_LOCAL_PREFERENCE
}
}
}
/// Creates a Candidate from its string representation.
pub fn unmarshal_candidate(raw: &str) -> Result<impl Candidate> {
let split: Vec<&str> = raw.split_whitespace().collect();
if split.len() < 8 {
return Err(Error::Other(format!(
"{:?} ({})",
Error::ErrAttributeTooShortIceCandidate,
split.len()
)));
}
// Foundation
let foundation = split[0].to_owned();
// Component
let component: u16 = split[1].parse()?;
// Network
let network = split[2].to_owned();
// Priority
let priority: u32 = split[3].parse()?;
// Address
let address = split[4].to_owned();
// Port
let port: u16 = split[5].parse()?;
let typ = split[7];
let mut rel_addr = String::new();
let mut rel_port = 0;
let mut tcp_type = TcpType::Unspecified;
if split.len() > 8 {
let split2 = &split[8..];
if split2[0] == "raddr" {
if split2.len() < 4 {
return Err(Error::Other(format!(
"{:?}: incorrect length",
Error::ErrParseRelatedAddr
)));
}
// RelatedAddress
rel_addr = split2[1].to_owned();
// RelatedPort
rel_port = split2[3].parse()?;
} else if split2[0] == "tcptype" {
if split2.len() < 2 {
return Err(Error::Other(format!(
"{:?}: incorrect length",
Error::ErrParseType
)));
}
tcp_type = TcpType::from(split2[1]);
}
}
match typ {
"host" => {
let config = CandidateHostConfig {
base_config: CandidateBaseConfig {
network,
address,
port,
component,
priority,
foundation,
..CandidateBaseConfig::default()
},
tcp_type,
};
config.new_candidate_host()
}
"srflx" => {
let config = CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network,
address,
port,
component,
priority,
foundation,
..CandidateBaseConfig::default()
},
rel_addr,
rel_port,
};
config.new_candidate_server_reflexive()
}
"prflx" => {
let config = CandidatePeerReflexiveConfig {
base_config: CandidateBaseConfig {
network,
address,
port,
component,
priority,
foundation,
..CandidateBaseConfig::default()
},
rel_addr,
rel_port,
};
config.new_candidate_peer_reflexive()
}
"relay" => {
let config = CandidateRelayConfig {
base_config: CandidateBaseConfig {
network,
address,
port,
component,
priority,
foundation,
..CandidateBaseConfig::default()
},
rel_addr,
rel_port,
..CandidateRelayConfig::default()
};
config.new_candidate_relay()
}
_ => Err(Error::Other(format!(
"{:?} ({})",
Error::ErrUnknownCandidateType,
typ
))),
}
}
+45
View File
@@ -0,0 +1,45 @@
use std::sync::atomic::{AtomicU16, AtomicU8};
use super::candidate_base::*;
use super::*;
use crate::rand::generate_cand_id;
/// The config required to create a new `CandidateHost`.
#[derive(Default)]
pub struct CandidateHostConfig {
pub base_config: CandidateBaseConfig,
pub tcp_type: TcpType,
}
impl CandidateHostConfig {
/// Creates a new host candidate.
pub fn new_candidate_host(self) -> Result<CandidateBase> {
let mut candidate_id = self.base_config.candidate_id;
if candidate_id.is_empty() {
candidate_id = generate_cand_id();
}
let c = CandidateBase {
id: candidate_id,
address: self.base_config.address.clone(),
candidate_type: CandidateType::Host,
component: AtomicU16::new(self.base_config.component),
port: self.base_config.port,
tcp_type: self.tcp_type,
foundation_override: self.base_config.foundation,
priority_override: self.base_config.priority,
network: self.base_config.network,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
conn: self.base_config.conn,
..CandidateBase::default()
};
if !self.base_config.address.ends_with(".local") {
let ip = self.base_config.address.parse()?;
c.set_ip(&ip)?;
};
Ok(c)
}
}
+155
View File
@@ -0,0 +1,155 @@
use super::*;
use crate::candidate::candidate_host::CandidateHostConfig;
use crate::candidate::candidate_peer_reflexive::CandidatePeerReflexiveConfig;
use crate::candidate::candidate_relay::CandidateRelayConfig;
use crate::candidate::candidate_server_reflexive::CandidateServerReflexiveConfig;
pub(crate) fn host_candidate() -> Result<CandidateBase> {
CandidateHostConfig {
base_config: CandidateBaseConfig {
network: "udp".to_owned(),
address: "0.0.0.0".to_owned(),
component: COMPONENT_RTP,
..Default::default()
},
..Default::default()
}
.new_candidate_host()
}
pub(crate) fn prflx_candidate() -> Result<CandidateBase> {
CandidatePeerReflexiveConfig {
base_config: CandidateBaseConfig {
network: "udp".to_owned(),
address: "0.0.0.0".to_owned(),
component: COMPONENT_RTP,
..Default::default()
},
..Default::default()
}
.new_candidate_peer_reflexive()
}
pub(crate) fn srflx_candidate() -> Result<CandidateBase> {
CandidateServerReflexiveConfig {
base_config: CandidateBaseConfig {
network: "udp".to_owned(),
address: "0.0.0.0".to_owned(),
component: COMPONENT_RTP,
..Default::default()
},
..Default::default()
}
.new_candidate_server_reflexive()
}
pub(crate) fn relay_candidate() -> Result<CandidateBase> {
CandidateRelayConfig {
base_config: CandidateBaseConfig {
network: "udp".to_owned(),
address: "0.0.0.0".to_owned(),
component: COMPONENT_RTP,
..Default::default()
},
..Default::default()
}
.new_candidate_relay()
}
#[test]
fn test_candidate_pair_priority() -> Result<()> {
let tests = vec![
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(host_candidate()?),
false,
),
9151314440652587007,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(host_candidate()?),
true,
),
9151314440652587007,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(prflx_candidate()?),
true,
),
7998392936314175488,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(prflx_candidate()?),
false,
),
7998392936314175487,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(srflx_candidate()?),
true,
),
7277816996102668288,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(srflx_candidate()?),
false,
),
7277816996102668287,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(relay_candidate()?),
true,
),
72057593987596288,
),
(
CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(relay_candidate()?),
false,
),
72057593987596287,
),
];
for (pair, want) in tests {
let got = pair.priority();
assert_eq!(
got, want,
"CandidatePair({pair}).Priority() = {got}, want {want}"
);
}
Ok(())
}
#[test]
fn test_candidate_pair_equality() -> Result<()> {
let pair_a = CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(srflx_candidate()?),
true,
);
let pair_b = CandidatePair::new(
Arc::new(host_candidate()?),
Arc::new(srflx_candidate()?),
false,
);
assert_eq!(pair_a, pair_b, "Expected {pair_a} to equal {pair_b}");
Ok(())
}
@@ -0,0 +1,54 @@
use std::sync::atomic::{AtomicU16, AtomicU8};
use util::sync::Mutex as SyncMutex;
use super::candidate_base::*;
use super::*;
use crate::error::*;
use crate::rand::generate_cand_id;
use crate::util::*;
/// The config required to create a new `CandidatePeerReflexive`.
#[derive(Default)]
pub struct CandidatePeerReflexiveConfig {
pub base_config: CandidateBaseConfig,
pub rel_addr: String,
pub rel_port: u16,
}
impl CandidatePeerReflexiveConfig {
/// Creates a new peer reflective candidate.
pub fn new_candidate_peer_reflexive(self) -> Result<CandidateBase> {
let ip: IpAddr = match self.base_config.address.parse() {
Ok(ip) => ip,
Err(_) => return Err(Error::ErrAddressParseFailed),
};
let network_type = determine_network_type(&self.base_config.network, &ip)?;
let mut candidate_id = self.base_config.candidate_id;
if candidate_id.is_empty() {
candidate_id = generate_cand_id();
}
let c = CandidateBase {
id: candidate_id,
network_type: AtomicU8::new(network_type as u8),
candidate_type: CandidateType::PeerReflexive,
address: self.base_config.address,
port: self.base_config.port,
resolved_addr: SyncMutex::new(create_addr(network_type, ip, self.base_config.port)),
component: AtomicU16::new(self.base_config.component),
foundation_override: self.base_config.foundation,
priority_override: self.base_config.priority,
related_address: Some(CandidateRelatedAddress {
address: self.rel_addr,
port: self.rel_port,
}),
conn: self.base_config.conn,
..CandidateBase::default()
};
Ok(c)
}
}
+57
View File
@@ -0,0 +1,57 @@
use std::sync::atomic::{AtomicU16, AtomicU8};
use std::sync::Arc;
use util::sync::Mutex as SyncMutex;
use super::candidate_base::*;
use super::*;
use crate::error::*;
use crate::rand::generate_cand_id;
use crate::util::*;
/// The config required to create a new `CandidateRelay`.
#[derive(Default)]
pub struct CandidateRelayConfig {
pub base_config: CandidateBaseConfig,
pub rel_addr: String,
pub rel_port: u16,
pub relay_client: Option<Arc<turn::client::Client>>,
}
impl CandidateRelayConfig {
/// Creates a new relay candidate.
pub fn new_candidate_relay(self) -> Result<CandidateBase> {
let mut candidate_id = self.base_config.candidate_id;
if candidate_id.is_empty() {
candidate_id = generate_cand_id();
}
let ip: IpAddr = match self.base_config.address.parse() {
Ok(ip) => ip,
Err(_) => return Err(Error::ErrAddressParseFailed),
};
let network_type = determine_network_type(&self.base_config.network, &ip)?;
let c = CandidateBase {
id: candidate_id,
network_type: AtomicU8::new(network_type as u8),
candidate_type: CandidateType::Relay,
address: self.base_config.address,
port: self.base_config.port,
resolved_addr: SyncMutex::new(create_addr(network_type, ip, self.base_config.port)),
component: AtomicU16::new(self.base_config.component),
foundation_override: self.base_config.foundation,
priority_override: self.base_config.priority,
related_address: Some(CandidateRelatedAddress {
address: self.rel_addr,
port: self.rel_port,
}),
conn: self.base_config.conn,
relay_client: self.relay_client.clone(),
..CandidateBase::default()
};
Ok(c)
}
}
+114
View File
@@ -0,0 +1,114 @@
use std::result::Result;
use std::time::Duration;
use tokio::net::UdpSocket;
use turn::auth::AuthHandler;
use super::*;
use crate::agent::agent_config::AgentConfig;
use crate::agent::agent_vnet_test::{connect_with_vnet, on_connected};
use crate::agent::Agent;
use crate::error::Error;
use crate::url::{ProtoType, SchemeType, Url};
pub(crate) struct OptimisticAuthHandler;
impl AuthHandler for OptimisticAuthHandler {
fn auth_handle(
&self,
_username: &str,
_realm: &str,
_src_addr: SocketAddr,
) -> Result<Vec<u8>, turn::Error> {
Ok(turn::auth::generate_auth_key(
"username",
"webrtc.rs",
"password",
))
}
}
//use std::io::Write;
#[tokio::test]
async fn test_relay_only_connection() -> Result<(), Error> {
/*env_logger::Builder::new()
.format(|buf, record| {
writeln!(
buf,
"{}:{} [{}] {} - {}",
record.file().unwrap_or("unknown"),
record.line().unwrap_or(0),
record.level(),
chrono::Local::now().format("%H:%M:%S.%6f"),
record.args()
)
})
.filter(None, log::LevelFilter::Trace)
.init();*/
let server_listener = Arc::new(UdpSocket::bind("127.0.0.1:0").await?);
let server_port = server_listener.local_addr()?.port();
let server = turn::server::Server::new(turn::server::config::ServerConfig {
realm: "webrtc.rs".to_owned(),
auth_handler: Arc::new(OptimisticAuthHandler {}),
conn_configs: vec![turn::server::config::ConnConfig {
conn: server_listener,
relay_addr_generator: Box::new(turn::relay::relay_none::RelayAddressGeneratorNone {
address: "127.0.0.1".to_owned(),
net: Arc::new(util::vnet::net::Net::new(None)),
}),
}],
channel_bind_timeout: Duration::from_secs(0),
alloc_close_notify: None,
})
.await?;
let cfg0 = AgentConfig {
network_types: supported_network_types(),
urls: vec![Url {
scheme: SchemeType::Turn,
host: "127.0.0.1".to_owned(),
username: "username".to_owned(),
password: "password".to_owned(),
port: server_port,
proto: ProtoType::Udp,
}],
candidate_types: vec![CandidateType::Relay],
..Default::default()
};
let a_agent = Arc::new(Agent::new(cfg0).await?);
let (a_notifier, mut a_connected) = on_connected();
a_agent.on_connection_state_change(a_notifier);
let cfg1 = AgentConfig {
network_types: supported_network_types(),
urls: vec![Url {
scheme: SchemeType::Turn,
host: "127.0.0.1".to_owned(),
username: "username".to_owned(),
password: "password".to_owned(),
port: server_port,
proto: ProtoType::Udp,
}],
candidate_types: vec![CandidateType::Relay],
..Default::default()
};
let b_agent = Arc::new(Agent::new(cfg1).await?);
let (b_notifier, mut b_connected) = on_connected();
b_agent.on_connection_state_change(b_notifier);
connect_with_vnet(&a_agent, &b_agent).await?;
let _ = a_connected.recv().await;
let _ = b_connected.recv().await;
a_agent.close().await?;
b_agent.close().await?;
server.close().await?;
Ok(())
}
@@ -0,0 +1,54 @@
use std::sync::atomic::{AtomicU16, AtomicU8};
use util::sync::Mutex as SyncMutex;
use super::candidate_base::*;
use super::*;
use crate::error::*;
use crate::rand::generate_cand_id;
use crate::util::*;
/// The config required to create a new `CandidateServerReflexive`.
#[derive(Default)]
pub struct CandidateServerReflexiveConfig {
pub base_config: CandidateBaseConfig,
pub rel_addr: String,
pub rel_port: u16,
}
impl CandidateServerReflexiveConfig {
/// Creates a new server reflective candidate.
pub fn new_candidate_server_reflexive(self) -> Result<CandidateBase> {
let ip: IpAddr = match self.base_config.address.parse() {
Ok(ip) => ip,
Err(_) => return Err(Error::ErrAddressParseFailed),
};
let network_type = determine_network_type(&self.base_config.network, &ip)?;
let mut candidate_id = self.base_config.candidate_id;
if candidate_id.is_empty() {
candidate_id = generate_cand_id();
}
let c = CandidateBase {
id: candidate_id,
network_type: AtomicU8::new(network_type as u8),
candidate_type: CandidateType::ServerReflexive,
address: self.base_config.address,
port: self.base_config.port,
resolved_addr: SyncMutex::new(create_addr(network_type, ip, self.base_config.port)),
component: AtomicU16::new(self.base_config.component),
foundation_override: self.base_config.foundation,
priority_override: self.base_config.priority,
related_address: Some(CandidateRelatedAddress {
address: self.rel_addr,
port: self.rel_port,
}),
conn: self.base_config.conn,
..CandidateBase::default()
};
Ok(c)
}
}
@@ -0,0 +1,91 @@
use std::time::Duration;
use tokio::net::UdpSocket;
use super::candidate_relay_test::OptimisticAuthHandler;
use super::*;
use crate::agent::agent_config::AgentConfig;
use crate::agent::agent_vnet_test::{connect_with_vnet, on_connected};
use crate::agent::Agent;
use crate::url::{SchemeType, Url};
//use std::io::Write;
#[tokio::test]
async fn test_server_reflexive_only_connection() -> Result<()> {
/*env_logger::Builder::new()
.format(|buf, record| {
writeln!(
buf,
"{}:{} [{}] {} - {}",
record.file().unwrap_or("unknown"),
record.line().unwrap_or(0),
record.level(),
chrono::Local::now().format("%H:%M:%S.%6f"),
record.args()
)
})
.filter(None, log::LevelFilter::Trace)
.init();*/
let server_listener = Arc::new(UdpSocket::bind("127.0.0.1:0").await?);
let server_port = server_listener.local_addr()?.port();
let server = turn::server::Server::new(turn::server::config::ServerConfig {
realm: "webrtc.rs".to_owned(),
auth_handler: Arc::new(OptimisticAuthHandler {}),
conn_configs: vec![turn::server::config::ConnConfig {
conn: server_listener,
relay_addr_generator: Box::new(turn::relay::relay_none::RelayAddressGeneratorNone {
address: "127.0.0.1".to_owned(),
net: Arc::new(util::vnet::net::Net::new(None)),
}),
}],
channel_bind_timeout: Duration::from_secs(0),
alloc_close_notify: None,
})
.await?;
let cfg0 = AgentConfig {
network_types: vec![NetworkType::Udp4],
urls: vec![Url {
scheme: SchemeType::Stun,
host: "127.0.0.1".to_owned(),
port: server_port,
..Default::default()
}],
candidate_types: vec![CandidateType::ServerReflexive],
..Default::default()
};
let a_agent = Arc::new(Agent::new(cfg0).await?);
let (a_notifier, mut a_connected) = on_connected();
a_agent.on_connection_state_change(a_notifier);
let cfg1 = AgentConfig {
network_types: vec![NetworkType::Udp4],
urls: vec![Url {
scheme: SchemeType::Stun,
host: "127.0.0.1".to_owned(),
port: server_port,
..Default::default()
}],
candidate_types: vec![CandidateType::ServerReflexive],
..Default::default()
};
let b_agent = Arc::new(Agent::new(cfg1).await?);
let (b_notifier, mut b_connected) = on_connected();
b_agent.on_connection_state_change(b_notifier);
connect_with_vnet(&a_agent, &b_agent).await?;
let _ = a_connected.recv().await;
let _ = b_connected.recv().await;
a_agent.close().await?;
b_agent.close().await?;
server.close().await?;
Ok(())
}
+411
View File
@@ -0,0 +1,411 @@
use std::time::UNIX_EPOCH;
use super::*;
#[test]
fn test_candidate_priority() -> Result<()> {
let tests = vec![
(
CandidateBase {
candidate_type: CandidateType::Host,
component: AtomicU16::new(COMPONENT_RTP),
..Default::default()
},
2130706431,
),
(
CandidateBase {
candidate_type: CandidateType::Host,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp4 as u8),
tcp_type: TcpType::Active,
..Default::default()
},
2128609279,
),
(
CandidateBase {
candidate_type: CandidateType::Host,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp4 as u8),
tcp_type: TcpType::Passive,
..Default::default()
},
2124414975,
),
(
CandidateBase {
candidate_type: CandidateType::Host,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp4 as u8),
tcp_type: TcpType::SimultaneousOpen,
..Default::default()
},
2120220671,
),
(
CandidateBase {
candidate_type: CandidateType::PeerReflexive,
component: AtomicU16::new(COMPONENT_RTP),
..Default::default()
},
1862270975,
),
(
CandidateBase {
candidate_type: CandidateType::PeerReflexive,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp6 as u8),
tcp_type: TcpType::SimultaneousOpen,
..Default::default()
},
1860173823,
),
(
CandidateBase {
candidate_type: CandidateType::PeerReflexive,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp6 as u8),
tcp_type: TcpType::Active,
..Default::default()
},
1855979519,
),
(
CandidateBase {
candidate_type: CandidateType::PeerReflexive,
component: AtomicU16::new(COMPONENT_RTP),
network_type: AtomicU8::new(NetworkType::Tcp6 as u8),
tcp_type: TcpType::Passive,
..Default::default()
},
1851785215,
),
(
CandidateBase {
candidate_type: CandidateType::ServerReflexive,
component: AtomicU16::new(COMPONENT_RTP),
..Default::default()
},
1694498815,
),
(
CandidateBase {
candidate_type: CandidateType::Relay,
component: AtomicU16::new(COMPONENT_RTP),
..Default::default()
},
16777215,
),
];
for (candidate, want) in tests {
let got = candidate.priority();
assert_eq!(
got, want,
"Candidate({candidate}).Priority() = {got}, want {want}"
);
}
Ok(())
}
#[test]
fn test_candidate_last_sent() -> Result<()> {
let candidate = CandidateBase::default();
assert_eq!(candidate.last_sent(), UNIX_EPOCH);
let now = SystemTime::now();
let d = now.duration_since(UNIX_EPOCH)?;
candidate.set_last_sent(d);
assert_eq!(candidate.last_sent(), now);
Ok(())
}
#[test]
fn test_candidate_last_received() -> Result<()> {
let candidate = CandidateBase::default();
assert_eq!(candidate.last_received(), UNIX_EPOCH);
let now = SystemTime::now();
let d = now.duration_since(UNIX_EPOCH)?;
candidate.set_last_received(d);
assert_eq!(candidate.last_received(), now);
Ok(())
}
#[test]
fn test_candidate_foundation() -> Result<()> {
// All fields are the same
assert_eq!(
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation()
);
// Different Address
assert_ne!(
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "B".to_owned(),
..Default::default()
})
.foundation(),
);
// Different networkType
assert_ne!(
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp6 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
);
// Different candidateType
assert_ne!(
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
(CandidateBase {
candidate_type: CandidateType::PeerReflexive,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
..Default::default()
})
.foundation(),
);
// Port has no effect
assert_eq!(
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
port: 8080,
..Default::default()
})
.foundation(),
(CandidateBase {
candidate_type: CandidateType::Host,
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
address: "A".to_owned(),
port: 80,
..Default::default()
})
.foundation()
);
Ok(())
}
#[test]
fn test_candidate_pair_state_serialization() {
let tests = vec![
(CandidatePairState::Unspecified, "\"unspecified\""),
(CandidatePairState::Waiting, "\"waiting\""),
(CandidatePairState::InProgress, "\"in-progress\""),
(CandidatePairState::Failed, "\"failed\""),
(CandidatePairState::Succeeded, "\"succeeded\""),
];
for (candidate_pair_state, expected_string) in tests {
assert_eq!(
expected_string.to_string(),
serde_json::to_string(&candidate_pair_state).unwrap()
);
}
}
#[test]
fn test_candidate_pair_state_to_string() {
let tests = vec![
(CandidatePairState::Unspecified, "unspecified"),
(CandidatePairState::Waiting, "waiting"),
(CandidatePairState::InProgress, "in-progress"),
(CandidatePairState::Failed, "failed"),
(CandidatePairState::Succeeded, "succeeded"),
];
for (candidate_pair_state, expected_string) in tests {
assert_eq!(candidate_pair_state.to_string(), expected_string);
}
}
#[test]
fn test_candidate_type_serialization() {
let tests = vec![
(CandidateType::Unspecified, "\"unspecified\""),
(CandidateType::Host, "\"host\""),
(CandidateType::ServerReflexive, "\"srflx\""),
(CandidateType::PeerReflexive, "\"prflx\""),
(CandidateType::Relay, "\"relay\""),
];
for (candidate_type, expected_string) in tests {
assert_eq!(
serde_json::to_string(&candidate_type).unwrap(),
expected_string.to_string()
);
}
}
#[test]
fn test_candidate_type_to_string() {
let tests = vec![
(CandidateType::Unspecified, "Unknown candidate type"),
(CandidateType::Host, "host"),
(CandidateType::ServerReflexive, "srflx"),
(CandidateType::PeerReflexive, "prflx"),
(CandidateType::Relay, "relay"),
];
for (candidate_type, expected_string) in tests {
assert_eq!(candidate_type.to_string(), expected_string);
}
}
#[test]
fn test_candidate_marshal() -> Result<()> {
let tests = vec![
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Udp6 as u8),
candidate_type: CandidateType::Host,
address: "fcd9:e3b8:12ce:9fc5:74a5:c6bb:d8b:e08a".to_owned(),
port: 53987,
priority_override: 500,
foundation_override: "750".to_owned(),
..Default::default()
}),
"750 1 udp 500 fcd9:e3b8:12ce:9fc5:74a5:c6bb:d8b:e08a 53987 typ host",
),
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
candidate_type: CandidateType::Host,
address: "10.0.75.1".to_owned(),
port: 53634,
..Default::default()
}),
"4273957277 1 udp 2130706431 10.0.75.1 53634 typ host",
),
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
candidate_type: CandidateType::ServerReflexive,
address: "191.228.238.68".to_owned(),
port: 53991,
related_address: Some(CandidateRelatedAddress{
address: "192.168.0.274".to_owned(),
port:53991
}),
..Default::default()
}),
"647372371 1 udp 1694498815 191.228.238.68 53991 typ srflx raddr 192.168.0.274 rport 53991",
),
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
candidate_type: CandidateType::Relay,
address: "50.0.0.1".to_owned(),
port: 5000,
related_address: Some(
CandidateRelatedAddress{
address: "192.168.0.1".to_owned(),
port:5001}
),
..Default::default()
}),
"848194626 1 udp 16777215 50.0.0.1 5000 typ relay raddr 192.168.0.1 rport 5001",
),
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Tcp4 as u8),
candidate_type: CandidateType::Host,
address: "192.168.0.196".to_owned(),
port: 0,
tcp_type: TcpType::Active,
..Default::default()
}),
"1052353102 1 tcp 2128609279 192.168.0.196 0 typ host tcptype active",
),
(
Some(CandidateBase{
network_type: AtomicU8::new(NetworkType::Udp4 as u8),
candidate_type: CandidateType::Host,
address: "e2494022-4d9a-4c1e-a750-cc48d4f8d6ee.local".to_owned(),
port: 60542,
..Default::default()
}),
"1380287402 1 udp 2130706431 e2494022-4d9a-4c1e-a750-cc48d4f8d6ee.local 60542 typ host",
),
// Invalid candidates
(None, ""),
(None, "1938809241"),
(None, "1986380506 99999999 udp 2122063615 10.0.75.1 53634 typ host generation 0 network-id 2"),
(None, "1986380506 1 udp 99999999999 10.0.75.1 53634 typ host"),
(None, "4207374051 1 udp 1685790463 191.228.238.68 99999999 typ srflx raddr 192.168.0.278 rport 53991 generation 0 network-id 3"),
(None, "4207374051 1 udp 1685790463 191.228.238.68 53991 typ srflx raddr"),
(None, "4207374051 1 udp 1685790463 191.228.238.68 53991 typ srflx raddr 192.168.0.278 rport 99999999 generation 0 network-id 3"),
(None, "4207374051 INVALID udp 2130706431 10.0.75.1 53634 typ host"),
(None, "4207374051 1 udp INVALID 10.0.75.1 53634 typ host"),
(None, "4207374051 INVALID udp 2130706431 10.0.75.1 INVALID typ host"),
(None, "4207374051 1 udp 2130706431 10.0.75.1 53634 typ INVALID"),
];
for (candidate, marshaled) in tests {
let actual_candidate = unmarshal_candidate(marshaled);
if let Some(candidate) = candidate {
if let Ok(actual_candidate) = actual_candidate {
assert!(
candidate.equal(&actual_candidate),
"{} vs {}",
candidate.marshal(),
marshaled
);
assert_eq!(marshaled, actual_candidate.marshal());
} else {
panic!("expected ok");
}
} else {
assert!(actual_candidate.is_err(), "expected error");
}
}
Ok(())
}
+324
View File
@@ -0,0 +1,324 @@
#[cfg(test)]
mod candidate_pair_test;
#[cfg(test)]
mod candidate_relay_test;
#[cfg(test)]
mod candidate_server_reflexive_test;
#[cfg(test)]
mod candidate_test;
pub mod candidate_base;
pub mod candidate_host;
pub mod candidate_peer_reflexive;
pub mod candidate_relay;
pub mod candidate_server_reflexive;
use std::fmt;
use std::net::{IpAddr, SocketAddr};
use std::sync::atomic::{AtomicBool, AtomicU16, AtomicU8, Ordering};
use std::sync::Arc;
use std::time::SystemTime;
use async_trait::async_trait;
use candidate_base::*;
use serde::Serialize;
use tokio::sync::{broadcast, Mutex};
use crate::error::Result;
use crate::network_type::*;
use crate::tcp_type::*;
pub(crate) const RECEIVE_MTU: usize = 8192;
pub(crate) const DEFAULT_LOCAL_PREFERENCE: u16 = 65535;
/// Indicates that the candidate is used for RTP.
pub(crate) const COMPONENT_RTP: u16 = 1;
/// Indicates that the candidate is used for RTCP.
pub(crate) const COMPONENT_RTCP: u16 = 0;
/// Candidate represents an ICE candidate
#[async_trait]
pub trait Candidate: fmt::Display {
/// An arbitrary string used in the freezing algorithm to
/// group similar candidates. It is the same for two candidates that
/// have the same type, base IP address, protocol (UDP, TCP, etc.),
/// and STUN or TURN server.
fn foundation(&self) -> String;
/// A unique identifier for just this candidate
/// Unlike the foundation this is different for each candidate.
fn id(&self) -> String;
/// A component is a piece of a data stream.
/// An example is one for RTP, and one for RTCP
fn component(&self) -> u16;
fn set_component(&self, c: u16);
/// The last time this candidate received traffic
fn last_received(&self) -> SystemTime;
/// The last time this candidate sent traffic
fn last_sent(&self) -> SystemTime;
fn network_type(&self) -> NetworkType;
fn address(&self) -> String;
fn port(&self) -> u16;
fn priority(&self) -> u32;
/// A transport address related to candidate,
/// which is useful for diagnostics and other purposes.
fn related_address(&self) -> Option<CandidateRelatedAddress>;
fn candidate_type(&self) -> CandidateType;
fn tcp_type(&self) -> TcpType;
fn marshal(&self) -> String;
fn addr(&self) -> SocketAddr;
async fn close(&self) -> Result<()>;
fn seen(&self, outbound: bool);
async fn write_to(&self, raw: &[u8], dst: &(dyn Candidate + Send + Sync)) -> Result<usize>;
fn equal(&self, other: &dyn Candidate) -> bool;
fn set_ip(&self, ip: &IpAddr) -> Result<()>;
fn get_conn(&self) -> Option<&Arc<dyn util::Conn + Send + Sync>>;
fn get_closed_ch(&self) -> Arc<Mutex<Option<broadcast::Sender<()>>>>;
}
/// Represents the type of candidate `CandidateType` enum.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
pub enum CandidateType {
#[serde(rename = "unspecified")]
Unspecified,
#[serde(rename = "host")]
Host,
#[serde(rename = "srflx")]
ServerReflexive,
#[serde(rename = "prflx")]
PeerReflexive,
#[serde(rename = "relay")]
Relay,
}
// String makes CandidateType printable
impl fmt::Display for CandidateType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
CandidateType::Host => "host",
CandidateType::ServerReflexive => "srflx",
CandidateType::PeerReflexive => "prflx",
CandidateType::Relay => "relay",
CandidateType::Unspecified => "Unknown candidate type",
};
write!(f, "{s}")
}
}
impl Default for CandidateType {
fn default() -> Self {
Self::Unspecified
}
}
impl CandidateType {
/// Returns the preference weight of a `CandidateType`.
///
/// 4.1.2.2. Guidelines for Choosing Type and Local Preferences
/// The RECOMMENDED values are 126 for host candidates, 100
/// for server reflexive candidates, 110 for peer reflexive candidates,
/// and 0 for relayed candidates.
#[must_use]
pub const fn preference(self) -> u16 {
match self {
Self::Host => 126,
Self::PeerReflexive => 110,
Self::ServerReflexive => 100,
Self::Relay | CandidateType::Unspecified => 0,
}
}
}
pub(crate) fn contains_candidate_type(
candidate_type: CandidateType,
candidate_type_list: &[CandidateType],
) -> bool {
if candidate_type_list.is_empty() {
return false;
}
for ct in candidate_type_list {
if *ct == candidate_type {
return true;
}
}
false
}
/// Convey transport addresses related to the candidate, useful for diagnostics and other purposes.
#[derive(PartialEq, Eq, Debug, Clone)]
pub struct CandidateRelatedAddress {
pub address: String,
pub port: u16,
}
// String makes CandidateRelatedAddress printable
impl fmt::Display for CandidateRelatedAddress {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(f, " related {}:{}", self.address, self.port)
}
}
/// Represent the ICE candidate pair state.
#[derive(Clone, Copy, Debug, PartialEq, Eq, Serialize)]
pub enum CandidatePairState {
#[serde(rename = "unspecified")]
Unspecified = 0,
/// Means a check has not been performed for this pair.
#[serde(rename = "waiting")]
Waiting = 1,
/// Means a check has been sent for this pair, but the transaction is in progress.
#[serde(rename = "in-progress")]
InProgress = 2,
/// Means a check for this pair was already done and failed, either never producing any response
/// or producing an unrecoverable failure response.
#[serde(rename = "failed")]
Failed = 3,
/// Means a check for this pair was already done and produced a successful result.
#[serde(rename = "succeeded")]
Succeeded = 4,
}
impl From<u8> for CandidatePairState {
fn from(v: u8) -> Self {
match v {
1 => Self::Waiting,
2 => Self::InProgress,
3 => Self::Failed,
4 => Self::Succeeded,
_ => Self::Unspecified,
}
}
}
impl Default for CandidatePairState {
fn default() -> Self {
Self::Unspecified
}
}
impl fmt::Display for CandidatePairState {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Waiting => "waiting",
Self::InProgress => "in-progress",
Self::Failed => "failed",
Self::Succeeded => "succeeded",
Self::Unspecified => "unspecified",
};
write!(f, "{s}")
}
}
/// Represents a combination of a local and remote candidate.
pub struct CandidatePair {
pub(crate) ice_role_controlling: AtomicBool,
pub remote: Arc<dyn Candidate + Send + Sync>,
pub local: Arc<dyn Candidate + Send + Sync>,
pub(crate) binding_request_count: AtomicU16,
pub(crate) state: AtomicU8, // convert it to CandidatePairState,
pub(crate) nominated: AtomicBool,
}
impl Default for CandidatePair {
fn default() -> Self {
Self {
ice_role_controlling: AtomicBool::new(false),
remote: Arc::new(CandidateBase::default()),
local: Arc::new(CandidateBase::default()),
state: AtomicU8::new(CandidatePairState::Waiting as u8),
binding_request_count: AtomicU16::new(0),
nominated: AtomicBool::new(false),
}
}
}
impl fmt::Debug for CandidatePair {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"prio {} (local, prio {}) {} <-> {} (remote, prio {})",
self.priority(),
self.local.priority(),
self.local,
self.remote,
self.remote.priority()
)
}
}
impl fmt::Display for CandidatePair {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
write!(
f,
"prio {} (local, prio {}) {} <-> {} (remote, prio {})",
self.priority(),
self.local.priority(),
self.local,
self.remote,
self.remote.priority()
)
}
}
impl PartialEq for CandidatePair {
fn eq(&self, other: &Self) -> bool {
self.local.equal(&*other.local) && self.remote.equal(&*other.remote)
}
}
impl CandidatePair {
#[must_use]
pub fn new(
local: Arc<dyn Candidate + Send + Sync>,
remote: Arc<dyn Candidate + Send + Sync>,
controlling: bool,
) -> Self {
Self {
ice_role_controlling: AtomicBool::new(controlling),
remote,
local,
state: AtomicU8::new(CandidatePairState::Waiting as u8),
binding_request_count: AtomicU16::new(0),
nominated: AtomicBool::new(false),
}
}
/// RFC 5245 - 5.7.2. Computing Pair Priority and Ordering Pairs
/// Let G be the priority for the candidate provided by the controlling
/// agent. Let D be the priority for the candidate provided by the
/// controlled agent.
/// pair priority = 2^32*MIN(G,D) + 2*MAX(G,D) + (G>D?1:0)
pub fn priority(&self) -> u64 {
let (g, d) = if self.ice_role_controlling.load(Ordering::SeqCst) {
(self.local.priority(), self.remote.priority())
} else {
(self.remote.priority(), self.local.priority())
};
// 1<<32 overflows uint32; and if both g && d are
// maxUint32, this result would overflow uint64
((1 << 32_u64) - 1) * u64::from(std::cmp::min(g, d))
+ 2 * u64::from(std::cmp::max(g, d))
+ u64::from(g > d)
}
pub async fn write(&self, b: &[u8]) -> Result<usize> {
self.local.write_to(b, &*self.remote).await
}
}
+168
View File
@@ -0,0 +1,168 @@
use super::*;
use crate::error::Result;
#[test]
fn test_controlled_get_from() -> Result<()> {
let mut m = Message::new();
let mut c = AttrControlled(4321);
let result = c.get_from(&m);
if let Err(err) = result {
assert_eq!(stun::Error::ErrAttributeNotFound, err, "unexpected error");
} else {
panic!("expected error, but got ok");
}
m.build(&[Box::new(BINDING_REQUEST), Box::new(c)])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
let mut c1 = AttrControlled::default();
c1.get_from(&m1)?;
assert_eq!(c1, c, "not equal");
//"IncorrectSize"
{
let mut m3 = Message::new();
m3.add(ATTR_ICE_CONTROLLED, &[0; 100]);
let mut c2 = AttrControlled::default();
let result = c2.get_from(&m3);
if let Err(err) = result {
assert!(is_attr_size_invalid(&err), "should error");
} else {
panic!("expected error, but got ok");
}
}
Ok(())
}
#[test]
fn test_controlling_get_from() -> Result<()> {
let mut m = Message::new();
let mut c = AttrControlling(4321);
let result = c.get_from(&m);
if let Err(err) = result {
assert_eq!(stun::Error::ErrAttributeNotFound, err, "unexpected error");
} else {
panic!("expected error, but got ok");
}
m.build(&[Box::new(BINDING_REQUEST), Box::new(c)])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
let mut c1 = AttrControlling::default();
c1.get_from(&m1)?;
assert_eq!(c1, c, "not equal");
//"IncorrectSize"
{
let mut m3 = Message::new();
m3.add(ATTR_ICE_CONTROLLING, &[0; 100]);
let mut c2 = AttrControlling::default();
let result = c2.get_from(&m3);
if let Err(err) = result {
assert!(is_attr_size_invalid(&err), "should error");
} else {
panic!("expected error, but got ok");
}
}
Ok(())
}
#[test]
fn test_control_get_from() -> Result<()> {
//"Blank"
{
let m = Message::new();
let mut c = AttrControl::default();
let result = c.get_from(&m);
if let Err(err) = result {
assert_eq!(stun::Error::ErrAttributeNotFound, err, "unexpected error");
} else {
panic!("expected error, but got ok");
}
}
//"Controlling"
{
let mut m = Message::new();
let mut c = AttrControl::default();
let result = c.get_from(&m);
if let Err(err) = result {
assert_eq!(stun::Error::ErrAttributeNotFound, err, "unexpected error");
} else {
panic!("expected error, but got ok");
}
c.role = Role::Controlling;
c.tie_breaker = TieBreaker(4321);
m.build(&[Box::new(BINDING_REQUEST), Box::new(c)])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
let mut c1 = AttrControl::default();
c1.get_from(&m1)?;
assert_eq!(c1, c, "not equal");
//"IncorrectSize"
{
let mut m3 = Message::new();
m3.add(ATTR_ICE_CONTROLLING, &[0; 100]);
let mut c2 = AttrControl::default();
let result = c2.get_from(&m3);
if let Err(err) = result {
assert!(is_attr_size_invalid(&err), "should error");
} else {
panic!("expected error, but got ok");
}
}
}
//"Controlled"
{
let mut m = Message::new();
let mut c = AttrControl::default();
let result = c.get_from(&m);
if let Err(err) = result {
assert_eq!(stun::Error::ErrAttributeNotFound, err, "unexpected error");
} else {
panic!("expected error, but got ok");
}
c.role = Role::Controlled;
c.tie_breaker = TieBreaker(1234);
m.build(&[Box::new(BINDING_REQUEST), Box::new(c)])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
let mut c1 = AttrControl::default();
c1.get_from(&m1)?;
assert_eq!(c1, c, "not equal");
//"IncorrectSize"
{
let mut m3 = Message::new();
m3.add(ATTR_ICE_CONTROLLING, &[0; 100]);
let mut c2 = AttrControl::default();
let result = c2.get_from(&m3);
if let Err(err) = result {
assert!(is_attr_size_invalid(&err), "should error");
} else {
panic!("expected error, but got ok");
}
}
}
Ok(())
}
+143
View File
@@ -0,0 +1,143 @@
#[cfg(test)]
mod control_test;
use std::fmt;
use stun::attributes::*;
use stun::checks::*;
use stun::message::*;
/// Common helper for ICE-{CONTROLLED,CONTROLLING} and represents the so-called Tiebreaker number.
#[derive(Default, PartialEq, Eq, Debug, Copy, Clone)]
pub struct TieBreaker(pub u64);
pub(crate) const TIE_BREAKER_SIZE: usize = 8; // 64 bit
impl TieBreaker {
/// Adds Tiebreaker value to m as t attribute.
pub fn add_to_as(self, m: &mut Message, t: AttrType) -> Result<(), stun::Error> {
let mut v = vec![0; TIE_BREAKER_SIZE];
v.copy_from_slice(&self.0.to_be_bytes());
m.add(t, &v);
Ok(())
}
/// Decodes Tiebreaker value in message getting it as for t type.
pub fn get_from_as(&mut self, m: &Message, t: AttrType) -> Result<(), stun::Error> {
let v = m.get(t)?;
check_size(t, v.len(), TIE_BREAKER_SIZE)?;
self.0 = u64::from_be_bytes([v[0], v[1], v[2], v[3], v[4], v[5], v[6], v[7]]);
Ok(())
}
}
/// Represents ICE-CONTROLLED attribute.
#[derive(Default, PartialEq, Eq, Debug, Copy, Clone)]
pub struct AttrControlled(pub u64);
impl Setter for AttrControlled {
/// Adds ICE-CONTROLLED to message.
fn add_to(&self, m: &mut Message) -> Result<(), stun::Error> {
TieBreaker(self.0).add_to_as(m, ATTR_ICE_CONTROLLED)
}
}
impl Getter for AttrControlled {
/// Decodes ICE-CONTROLLED from message.
fn get_from(&mut self, m: &Message) -> Result<(), stun::Error> {
let mut t = TieBreaker::default();
t.get_from_as(m, ATTR_ICE_CONTROLLED)?;
self.0 = t.0;
Ok(())
}
}
/// Represents ICE-CONTROLLING attribute.
#[derive(Default, PartialEq, Eq, Debug, Copy, Clone)]
pub struct AttrControlling(pub u64);
impl Setter for AttrControlling {
// add_to adds ICE-CONTROLLING to message.
fn add_to(&self, m: &mut Message) -> Result<(), stun::Error> {
TieBreaker(self.0).add_to_as(m, ATTR_ICE_CONTROLLING)
}
}
impl Getter for AttrControlling {
// get_from decodes ICE-CONTROLLING from message.
fn get_from(&mut self, m: &Message) -> Result<(), stun::Error> {
let mut t = TieBreaker::default();
t.get_from_as(m, ATTR_ICE_CONTROLLING)?;
self.0 = t.0;
Ok(())
}
}
/// Helper that wraps ICE-{CONTROLLED,CONTROLLING}.
#[derive(Default, PartialEq, Eq, Debug, Copy, Clone)]
pub struct AttrControl {
role: Role,
tie_breaker: TieBreaker,
}
impl Setter for AttrControl {
// add_to adds ICE-CONTROLLED or ICE-CONTROLLING attribute depending on Role.
fn add_to(&self, m: &mut Message) -> Result<(), stun::Error> {
if self.role == Role::Controlling {
self.tie_breaker.add_to_as(m, ATTR_ICE_CONTROLLING)
} else {
self.tie_breaker.add_to_as(m, ATTR_ICE_CONTROLLED)
}
}
}
impl Getter for AttrControl {
// get_from decodes Role and Tiebreaker value from message.
fn get_from(&mut self, m: &Message) -> Result<(), stun::Error> {
if m.contains(ATTR_ICE_CONTROLLING) {
self.role = Role::Controlling;
return self.tie_breaker.get_from_as(m, ATTR_ICE_CONTROLLING);
}
if m.contains(ATTR_ICE_CONTROLLED) {
self.role = Role::Controlled;
return self.tie_breaker.get_from_as(m, ATTR_ICE_CONTROLLED);
}
Err(stun::Error::ErrAttributeNotFound)
}
}
/// Represents ICE agent role, which can be controlling or controlled.
/// Possible ICE agent roles.
#[derive(PartialEq, Eq, Copy, Clone, Debug)]
pub enum Role {
Controlling,
Controlled,
Unspecified,
}
impl Default for Role {
fn default() -> Self {
Self::Controlling
}
}
impl From<&str> for Role {
fn from(raw: &str) -> Self {
match raw {
"controlling" => Self::Controlling,
"controlled" => Self::Controlled,
_ => Self::Unspecified,
}
}
}
impl fmt::Display for Role {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Controlling => "controlling",
Self::Controlled => "controlled",
Self::Unspecified => "unspecified",
};
write!(f, "{s}")
}
}
+238
View File
@@ -0,0 +1,238 @@
use std::num::ParseIntError;
use std::time::SystemTimeError;
use std::{io, net};
use thiserror::Error;
pub type Result<T> = std::result::Result<T, Error>;
#[derive(Debug, Error, PartialEq)]
#[non_exhaustive]
pub enum Error {
/// Indicates an error with Unknown info.
#[error("Unknown type")]
ErrUnknownType,
/// Indicates the scheme type could not be parsed.
#[error("unknown scheme type")]
ErrSchemeType,
/// Indicates query arguments are provided in a STUN URL.
#[error("queries not supported in stun address")]
ErrStunQuery,
/// Indicates an malformed query is provided.
#[error("invalid query")]
ErrInvalidQuery,
/// Indicates malformed hostname is provided.
#[error("invalid hostname")]
ErrHost,
/// Indicates malformed port is provided.
#[error("invalid port number")]
ErrPort,
/// Indicates local username fragment insufficient bits are provided.
/// Have to be at least 24 bits long.
#[error("local username fragment is less than 24 bits long")]
ErrLocalUfragInsufficientBits,
/// Indicates local passoword insufficient bits are provided.
/// Have to be at least 128 bits long.
#[error("local password is less than 128 bits long")]
ErrLocalPwdInsufficientBits,
/// Indicates an unsupported transport type was provided.
#[error("invalid transport protocol type")]
ErrProtoType,
/// Indicates the agent is closed.
#[error("the agent is closed")]
ErrClosed,
/// Indicates agent does not have a valid candidate pair.
#[error("no candidate pairs available")]
ErrNoCandidatePairs,
/// Indicates agent connection was canceled by the caller.
#[error("connecting canceled by caller")]
ErrCanceledByCaller,
/// Indicates agent was started twice.
#[error("attempted to start agent twice")]
ErrMultipleStart,
/// Indicates agent was started with an empty remote ufrag.
#[error("remote ufrag is empty")]
ErrRemoteUfragEmpty,
/// Indicates agent was started with an empty remote pwd.
#[error("remote pwd is empty")]
ErrRemotePwdEmpty,
/// Indicates agent was started without on_candidate.
#[error("no on_candidate provided")]
ErrNoOnCandidateHandler,
/// Indicates GatherCandidates has been called multiple times.
#[error("attempting to gather candidates during gathering state")]
ErrMultipleGatherAttempted,
/// Indicates agent was give TURN URL with an empty Username.
#[error("username is empty")]
ErrUsernameEmpty,
/// Indicates agent was give TURN URL with an empty Password.
#[error("password is empty")]
ErrPasswordEmpty,
/// Indicates we were unable to parse a candidate address.
#[error("failed to parse address")]
ErrAddressParseFailed,
/// Indicates that non host candidates were selected for a lite agent.
#[error("lite agents must only use host candidates")]
ErrLiteUsingNonHostCandidates,
/// Indicates that one or more URL was provided to the agent but no host candidate required them.
#[error("agent does not need URL with selected candidate types")]
ErrUselessUrlsProvided,
/// Indicates that the specified NAT1To1IPCandidateType is unsupported.
#[error("unsupported 1:1 NAT IP candidate type")]
ErrUnsupportedNat1to1IpCandidateType,
/// Indicates that the given 1:1 NAT IP mapping is invalid.
#[error("invalid 1:1 NAT IP mapping")]
ErrInvalidNat1to1IpMapping,
/// IPNotFound in NAT1To1IPMapping.
#[error("external mapped IP not found")]
ErrExternalMappedIpNotFound,
/// Indicates that the mDNS gathering cannot be used along with 1:1 NAT IP mapping for host
/// candidate.
#[error("mDNS gathering cannot be used with 1:1 NAT IP mapping for host candidate")]
ErrMulticastDnsWithNat1to1IpMapping,
/// Indicates that 1:1 NAT IP mapping for host candidate is requested, but the host candidate
/// type is disabled.
#[error("1:1 NAT IP mapping for host candidate ineffective")]
ErrIneffectiveNat1to1IpMappingHost,
/// Indicates that 1:1 NAT IP mapping for srflx candidate is requested, but the srflx candidate
/// type is disabled.
#[error("1:1 NAT IP mapping for srflx candidate ineffective")]
ErrIneffectiveNat1to1IpMappingSrflx,
/// Indicates an invalid MulticastDNSHostName.
#[error("invalid mDNS HostName, must end with .local and can only contain a single '.'")]
ErrInvalidMulticastDnshostName,
/// Indicates Restart was called when Agent is in GatheringStateGathering.
#[error("ICE Agent can not be restarted when gathering")]
ErrRestartWhenGathering,
/// Indicates a run operation was canceled by its individual done.
#[error("run was canceled by done")]
ErrRunCanceled,
/// Initialized Indicates TCPMux is not initialized and that invalidTCPMux is used.
#[error("TCPMux is not initialized")]
ErrTcpMuxNotInitialized,
/// Indicates we already have the connection with same remote addr.
#[error("conn with same remote addr already exists")]
ErrTcpRemoteAddrAlreadyExists,
#[error("failed to send packet")]
ErrSendPacket,
#[error("attribute not long enough to be ICE candidate")]
ErrAttributeTooShortIceCandidate,
#[error("could not parse component")]
ErrParseComponent,
#[error("could not parse priority")]
ErrParsePriority,
#[error("could not parse port")]
ErrParsePort,
#[error("could not parse related addresses")]
ErrParseRelatedAddr,
#[error("could not parse type")]
ErrParseType,
#[error("unknown candidate type")]
ErrUnknownCandidateType,
#[error("failed to get XOR-MAPPED-ADDRESS response")]
ErrGetXorMappedAddrResponse,
#[error("connection with same remote address already exists")]
ErrConnectionAddrAlreadyExist,
#[error("error reading streaming packet")]
ErrReadingStreamingPacket,
#[error("error writing to")]
ErrWriting,
#[error("error closing connection")]
ErrClosingConnection,
#[error("unable to determine networkType")]
ErrDetermineNetworkType,
#[error("missing protocol scheme")]
ErrMissingProtocolScheme,
#[error("too many colons in address")]
ErrTooManyColonsAddr,
#[error("unexpected error trying to read")]
ErrRead,
#[error("unknown role")]
ErrUnknownRole,
#[error("username mismatch")]
ErrMismatchUsername,
#[error("the ICE conn can't write STUN messages")]
ErrIceWriteStunMessage,
#[error("invalid url")]
ErrInvalidUrl,
#[error("relative URL without a base")]
ErrUrlParse,
#[error("Candidate IP could not be found")]
ErrCandidateIpNotFound,
#[error("parse int: {0}")]
ParseInt(#[from] ParseIntError),
#[error("parse addr: {0}")]
ParseIp(#[from] net::AddrParseError),
#[error("{0}")]
Io(#[source] IoError),
#[error("{0}")]
Util(#[from] util::Error),
#[error("{0}")]
Stun(#[from] stun::Error),
#[error("{0}")]
ParseUrl(#[from] url::ParseError),
#[error("{0}")]
Mdns(#[from] mdns::Error),
#[error("{0}")]
Turn(#[from] turn::Error),
#[error("{0}")]
Other(String),
}
#[derive(Debug, Error)]
#[error("io error: {0}")]
pub struct IoError(#[from] pub io::Error);
// Workaround for wanting PartialEq for io::Error.
impl PartialEq for IoError {
fn eq(&self, other: &Self) -> bool {
self.0.kind() == other.0.kind()
}
}
impl From<io::Error> for Error {
fn from(e: io::Error) -> Self {
Error::Io(IoError(e))
}
}
impl From<SystemTimeError> for Error {
fn from(e: SystemTimeError) -> Self {
Error::Other(e.to_string())
}
}
@@ -0,0 +1,251 @@
use super::*;
#[test]
fn test_external_ip_mapper_validate_ip_string() -> Result<()> {
let ip = validate_ip_string("1.2.3.4")?;
assert!(ip.is_ipv4(), "should be true");
assert_eq!("1.2.3.4", ip.to_string(), "should be true");
let ip = validate_ip_string("2601:4567::5678")?;
assert!(!ip.is_ipv4(), "should be false");
assert_eq!("2601:4567::5678", ip.to_string(), "should be true");
let result = validate_ip_string("bad.6.6.6");
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_new_external_ip_mapper() -> Result<()> {
// ips being empty should succeed but mapper will still be nil
let m = ExternalIpMapper::new(CandidateType::Unspecified, &[])?;
assert!(m.is_none(), "should be none");
// IPv4 with no explicit local IP, defaults to CandidateTypeHost
let m = ExternalIpMapper::new(CandidateType::Unspecified, &["1.2.3.4".to_owned()])?.unwrap();
assert_eq!(m.candidate_type, CandidateType::Host, "should match");
assert!(m.ipv4_mapping.ip_sole.is_some());
assert!(m.ipv6_mapping.ip_sole.is_none());
assert_eq!(m.ipv4_mapping.ip_map.len(), 0, "should match");
assert_eq!(m.ipv6_mapping.ip_map.len(), 0, "should match");
// IPv4 with no explicit local IP, using CandidateTypeServerReflexive
let m =
ExternalIpMapper::new(CandidateType::ServerReflexive, &["1.2.3.4".to_owned()])?.unwrap();
assert_eq!(
CandidateType::ServerReflexive,
m.candidate_type,
"should match"
);
assert!(m.ipv4_mapping.ip_sole.is_some());
assert!(m.ipv6_mapping.ip_sole.is_none());
assert_eq!(m.ipv4_mapping.ip_map.len(), 0, "should match");
assert_eq!(m.ipv6_mapping.ip_map.len(), 0, "should match");
// IPv4 with no explicit local IP, defaults to CandidateTypeHost
let m = ExternalIpMapper::new(CandidateType::Unspecified, &["2601:4567::5678".to_owned()])?
.unwrap();
assert_eq!(m.candidate_type, CandidateType::Host, "should match");
assert!(m.ipv4_mapping.ip_sole.is_none());
assert!(m.ipv6_mapping.ip_sole.is_some());
assert_eq!(m.ipv4_mapping.ip_map.len(), 0, "should match");
assert_eq!(m.ipv6_mapping.ip_map.len(), 0, "should match");
// IPv4 and IPv6 in the mix
let m = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.4".to_owned(), "2601:4567::5678".to_owned()],
)?
.unwrap();
assert_eq!(m.candidate_type, CandidateType::Host, "should match");
assert!(m.ipv4_mapping.ip_sole.is_some());
assert!(m.ipv6_mapping.ip_sole.is_some());
assert_eq!(m.ipv4_mapping.ip_map.len(), 0, "should match");
assert_eq!(m.ipv6_mapping.ip_map.len(), 0, "should match");
// Unsupported candidate type - CandidateTypePeerReflexive
let result = ExternalIpMapper::new(CandidateType::PeerReflexive, &["1.2.3.4".to_owned()]);
assert!(result.is_err(), "should fail");
// Unsupported candidate type - CandidateTypeRelay
let result = ExternalIpMapper::new(CandidateType::PeerReflexive, &["1.2.3.4".to_owned()]);
assert!(result.is_err(), "should fail");
// Cannot duplicate mapping IPv4 family
let result = ExternalIpMapper::new(
CandidateType::ServerReflexive,
&["1.2.3.4".to_owned(), "5.6.7.8".to_owned()],
);
assert!(result.is_err(), "should fail");
// Cannot duplicate mapping IPv6 family
let result = ExternalIpMapper::new(
CandidateType::ServerReflexive,
&["2201::1".to_owned(), "2201::0002".to_owned()],
);
assert!(result.is_err(), "should fail");
// Invalid external IP string
let result = ExternalIpMapper::new(CandidateType::ServerReflexive, &["bad.2.3.4".to_owned()]);
assert!(result.is_err(), "should fail");
// Invalid local IP string
let result = ExternalIpMapper::new(
CandidateType::ServerReflexive,
&["1.2.3.4/10.0.0.bad".to_owned()],
);
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_new_external_ip_mapper_with_explicit_local_ip() -> Result<()> {
// IPv4 with explicit local IP, defaults to CandidateTypeHost
let m = ExternalIpMapper::new(CandidateType::Unspecified, &["1.2.3.4/10.0.0.1".to_owned()])?
.unwrap();
assert_eq!(m.candidate_type, CandidateType::Host, "should match");
assert!(m.ipv4_mapping.ip_sole.is_none());
assert!(m.ipv6_mapping.ip_sole.is_none());
assert_eq!(m.ipv4_mapping.ip_map.len(), 1, "should match");
assert_eq!(m.ipv6_mapping.ip_map.len(), 0, "should match");
// Cannot assign two ext IPs for one local IPv4
let result = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.4/10.0.0.1".to_owned(), "1.2.3.5/10.0.0.1".to_owned()],
);
assert!(result.is_err(), "should fail");
// Cannot assign two ext IPs for one local IPv6
let result = ExternalIpMapper::new(
CandidateType::Unspecified,
&[
"2200::1/fe80::1".to_owned(),
"2200::0002/fe80::1".to_owned(),
],
);
assert!(result.is_err(), "should fail");
// Cannot mix different IP family in a pair (1)
let result =
ExternalIpMapper::new(CandidateType::Unspecified, &["2200::1/10.0.0.1".to_owned()]);
assert!(result.is_err(), "should fail");
// Cannot mix different IP family in a pair (2)
let result = ExternalIpMapper::new(CandidateType::Unspecified, &["1.2.3.4/fe80::1".to_owned()]);
assert!(result.is_err(), "should fail");
// Invalid pair
let result = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.4/192.168.0.2/10.0.0.1".to_owned()],
);
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_new_external_ip_mapper_with_implicit_local_ip() -> Result<()> {
// Mixing inpicit and explicit local IPs not allowed
let result = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.4".to_owned(), "1.2.3.5/10.0.0.1".to_owned()],
);
assert!(result.is_err(), "should fail");
// Mixing inpicit and explicit local IPs not allowed
let result = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.5/10.0.0.1".to_owned(), "1.2.3.4".to_owned()],
);
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_find_external_ip_without_explicit_local_ip() -> Result<()> {
// IPv4 with explicit local IP, defaults to CandidateTypeHost
let m = ExternalIpMapper::new(
CandidateType::Unspecified,
&["1.2.3.4".to_owned(), "2200::1".to_owned()],
)?
.unwrap();
assert!(m.ipv4_mapping.ip_sole.is_some());
assert!(m.ipv6_mapping.ip_sole.is_some());
// find external IPv4
let ext_ip = m.find_external_ip("10.0.0.1")?;
assert_eq!(ext_ip.to_string(), "1.2.3.4", "should match");
// find external IPv6
let ext_ip = m.find_external_ip("fe80::0001")?; // use '0001' instead of '1' on purpose
assert_eq!(ext_ip.to_string(), "2200::1", "should match");
// Bad local IP string
let result = m.find_external_ip("really.bad");
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_find_external_ip_with_explicit_local_ip() -> Result<()> {
// IPv4 with explicit local IP, defaults to CandidateTypeHost
let m = ExternalIpMapper::new(
CandidateType::Unspecified,
&[
"1.2.3.4/10.0.0.1".to_owned(),
"1.2.3.5/10.0.0.2".to_owned(),
"2200::1/fe80::1".to_owned(),
"2200::2/fe80::2".to_owned(),
],
)?
.unwrap();
// find external IPv4
let ext_ip = m.find_external_ip("10.0.0.1")?;
assert_eq!(ext_ip.to_string(), "1.2.3.4", "should match");
let ext_ip = m.find_external_ip("10.0.0.2")?;
assert_eq!(ext_ip.to_string(), "1.2.3.5", "should match");
let result = m.find_external_ip("10.0.0.3");
assert!(result.is_err(), "should fail");
// find external IPv6
let ext_ip = m.find_external_ip("fe80::0001")?; // use '0001' instead of '1' on purpose
assert_eq!(ext_ip.to_string(), "2200::1", "should match");
let ext_ip = m.find_external_ip("fe80::0002")?; // use '0002' instead of '2' on purpose
assert_eq!(ext_ip.to_string(), "2200::2", "should match");
let result = m.find_external_ip("fe80::3");
assert!(result.is_err(), "should fail");
// Bad local IP string
let result = m.find_external_ip("really.bad");
assert!(result.is_err(), "should fail");
Ok(())
}
#[test]
fn test_external_ip_mapper_find_external_ip_with_empty_map() -> Result<()> {
let m = ExternalIpMapper::new(CandidateType::Unspecified, &["1.2.3.4".to_owned()])?.unwrap();
// attempt to find IPv6 that does not exist in the map
let result = m.find_external_ip("fe80::1");
assert!(result.is_err(), "should fail");
let m = ExternalIpMapper::new(CandidateType::Unspecified, &["2200::1".to_owned()])?.unwrap();
// attempt to find IPv4 that does not exist in the map
let result = m.find_external_ip("10.0.0.1");
assert!(result.is_err(), "should fail");
Ok(())
}
+133
View File
@@ -0,0 +1,133 @@
#[cfg(test)]
mod external_ip_mapper_test;
use std::collections::HashMap;
use std::net::IpAddr;
use crate::candidate::*;
use crate::error::*;
pub(crate) fn validate_ip_string(ip_str: &str) -> Result<IpAddr> {
match ip_str.parse() {
Ok(ip) => Ok(ip),
Err(_) => Err(Error::ErrInvalidNat1to1IpMapping),
}
}
/// Holds the mapping of local and external IP address for a particular IP family.
#[derive(Default, PartialEq, Debug)]
pub(crate) struct IpMapping {
ip_sole: Option<IpAddr>, // when non-nil, this is the sole external IP for one local IP assumed
ip_map: HashMap<String, IpAddr>, // local-to-external IP mapping (k: local, v: external)
}
impl IpMapping {
pub(crate) fn set_sole_ip(&mut self, ip: IpAddr) -> Result<()> {
if self.ip_sole.is_some() || !self.ip_map.is_empty() {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
self.ip_sole = Some(ip);
Ok(())
}
pub(crate) fn add_ip_mapping(&mut self, loc_ip: IpAddr, ext_ip: IpAddr) -> Result<()> {
if self.ip_sole.is_some() {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
let loc_ip_str = loc_ip.to_string();
// check if dup of local IP
if self.ip_map.contains_key(&loc_ip_str) {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
self.ip_map.insert(loc_ip_str, ext_ip);
Ok(())
}
pub(crate) fn find_external_ip(&self, loc_ip: IpAddr) -> Result<IpAddr> {
if let Some(ip_sole) = &self.ip_sole {
return Ok(*ip_sole);
}
self.ip_map.get(&loc_ip.to_string()).map_or_else(
|| Err(Error::ErrExternalMappedIpNotFound),
|ext_ip| Ok(*ext_ip),
)
}
}
#[derive(Default)]
pub(crate) struct ExternalIpMapper {
pub(crate) ipv4_mapping: IpMapping,
pub(crate) ipv6_mapping: IpMapping,
pub(crate) candidate_type: CandidateType,
}
impl ExternalIpMapper {
pub(crate) fn new(mut candidate_type: CandidateType, ips: &[String]) -> Result<Option<Self>> {
if ips.is_empty() {
return Ok(None);
}
if candidate_type == CandidateType::Unspecified {
candidate_type = CandidateType::Host; // defaults to host
} else if candidate_type != CandidateType::Host
&& candidate_type != CandidateType::ServerReflexive
{
return Err(Error::ErrUnsupportedNat1to1IpCandidateType);
}
let mut m = Self {
ipv4_mapping: IpMapping::default(),
ipv6_mapping: IpMapping::default(),
candidate_type,
};
for ext_ip_str in ips {
let ip_pair: Vec<&str> = ext_ip_str.split('/').collect();
if ip_pair.is_empty() || ip_pair.len() > 2 {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
let ext_ip = validate_ip_string(ip_pair[0])?;
if ip_pair.len() == 1 {
if ext_ip.is_ipv4() {
m.ipv4_mapping.set_sole_ip(ext_ip)?;
} else {
m.ipv6_mapping.set_sole_ip(ext_ip)?;
}
} else {
let loc_ip = validate_ip_string(ip_pair[1])?;
if ext_ip.is_ipv4() {
if !loc_ip.is_ipv4() {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
m.ipv4_mapping.add_ip_mapping(loc_ip, ext_ip)?;
} else {
if loc_ip.is_ipv4() {
return Err(Error::ErrInvalidNat1to1IpMapping);
}
m.ipv6_mapping.add_ip_mapping(loc_ip, ext_ip)?;
}
}
}
Ok(Some(m))
}
pub(crate) fn find_external_ip(&self, local_ip_str: &str) -> Result<IpAddr> {
let loc_ip = validate_ip_string(local_ip_str)?;
if loc_ip.is_ipv4() {
self.ipv4_mapping.find_external_ip(loc_ip)
} else {
self.ipv6_mapping.find_external_ip(loc_ip)
}
}
}
+22
View File
@@ -0,0 +1,22 @@
#![warn(rust_2018_idioms)]
#![allow(dead_code)]
pub mod agent;
pub mod candidate;
pub mod control;
mod error;
pub mod external_ip_mapper;
pub mod mdns;
pub mod network_type;
pub mod priority;
pub mod rand;
pub mod state;
pub mod stats;
pub mod tcp_type;
pub mod udp_mux;
pub mod udp_network;
pub mod url;
pub mod use_candidate;
pub mod util;
pub use error::Error;
+151
View File
@@ -0,0 +1,151 @@
use regex::Regex;
use tokio::sync::{mpsc, Mutex};
use super::*;
use crate::agent::agent_config::*;
use crate::agent::agent_vnet_test::*;
use crate::agent::*;
use crate::candidate::*;
use crate::error::Error;
use crate::network_type::*;
#[tokio::test]
// This test is disabled on Windows for now because it gets stuck and never finishes.
// This does not seem to have happened due to a code change. It started happening with
// `ce55c3a066ab461c3e74f0d5ac6f1209205e79bc` but was verified as happening on
// `92cc698a3dc6da459f3bf3789fd046c2dffdf107` too.
#[cfg(not(windows))]
async fn test_multicast_dns_only_connection() -> Result<()> {
let cfg0 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryAndGather,
..Default::default()
};
let a_agent = Arc::new(Agent::new(cfg0).await?);
let (a_notifier, mut a_connected) = on_connected();
a_agent.on_connection_state_change(a_notifier);
let cfg1 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryAndGather,
..Default::default()
};
let b_agent = Arc::new(Agent::new(cfg1).await?);
let (b_notifier, mut b_connected) = on_connected();
b_agent.on_connection_state_change(b_notifier);
connect_with_vnet(&a_agent, &b_agent).await?;
let _ = a_connected.recv().await;
let _ = b_connected.recv().await;
a_agent.close().await?;
b_agent.close().await?;
Ok(())
}
#[tokio::test]
async fn test_multicast_dns_mixed_connection() -> Result<()> {
let cfg0 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryAndGather,
..Default::default()
};
let a_agent = Arc::new(Agent::new(cfg0).await?);
let (a_notifier, mut a_connected) = on_connected();
a_agent.on_connection_state_change(a_notifier);
let cfg1 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryOnly,
..Default::default()
};
let b_agent = Arc::new(Agent::new(cfg1).await?);
let (b_notifier, mut b_connected) = on_connected();
b_agent.on_connection_state_change(b_notifier);
connect_with_vnet(&a_agent, &b_agent).await?;
let _ = a_connected.recv().await;
let _ = b_connected.recv().await;
a_agent.close().await?;
b_agent.close().await?;
Ok(())
}
#[tokio::test]
async fn test_multicast_dns_static_host_name() -> Result<()> {
let cfg0 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryAndGather,
multicast_dns_host_name: "invalidHostName".to_owned(),
..Default::default()
};
if let Err(err) = Agent::new(cfg0).await {
assert_eq!(err, Error::ErrInvalidMulticastDnshostName);
} else {
panic!("expected error, but got ok");
}
let cfg1 = AgentConfig {
network_types: vec![NetworkType::Udp4],
candidate_types: vec![CandidateType::Host],
multicast_dns_mode: MulticastDnsMode::QueryAndGather,
multicast_dns_host_name: "validName.local".to_owned(),
..Default::default()
};
let a = Agent::new(cfg1).await?;
let (done_tx, mut done_rx) = mpsc::channel::<()>(1);
let done_tx = Arc::new(Mutex::new(Some(done_tx)));
a.on_candidate(Box::new(
move |c: Option<Arc<dyn Candidate + Send + Sync>>| {
let done_tx_clone = Arc::clone(&done_tx);
Box::pin(async move {
if c.is_none() {
let mut tx = done_tx_clone.lock().await;
tx.take();
}
})
},
));
a.gather_candidates()?;
log::debug!("wait for gathering is done...");
let _ = done_rx.recv().await;
log::debug!("gathering is done");
Ok(())
}
#[test]
fn test_generate_multicast_dnsname() -> Result<()> {
let name = generate_multicast_dns_name();
let re = Regex::new(
r"^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-4[0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}.local+$",
);
if let Ok(re) = re {
assert!(
re.is_match(&name),
"mDNS name must be UUID v4 + \".local\" suffix, got {name}"
);
} else {
panic!("expected ok, but got err");
}
Ok(())
}
+71
View File
@@ -0,0 +1,71 @@
#[cfg(test)]
mod mdns_test;
use std::net::SocketAddr;
use std::str::FromStr;
use std::sync::Arc;
use mdns::config::*;
use mdns::conn::*;
use uuid::Uuid;
use crate::error::Result;
/// Represents the different Multicast modes that ICE can run.
#[derive(PartialEq, Eq, Debug, Copy, Clone)]
pub enum MulticastDnsMode {
/// Means remote mDNS candidates will be discarded, and local host candidates will use IPs.
Disabled,
/// Means remote mDNS candidates will be accepted, and local host candidates will use IPs.
QueryOnly,
/// Means remote mDNS candidates will be accepted, and local host candidates will use mDNS.
QueryAndGather,
}
impl Default for MulticastDnsMode {
fn default() -> Self {
Self::QueryOnly
}
}
pub(crate) fn generate_multicast_dns_name() -> String {
// https://tools.ietf.org/id/draft-ietf-rtcweb-mdns-ice-candidates-02.html#gathering
// The unique name MUST consist of a version 4 UUID as defined in [RFC4122], followed by “.local”.
let u = Uuid::new_v4();
format!("{u}.local")
}
pub(crate) fn create_multicast_dns(
mdns_mode: MulticastDnsMode,
mdns_name: &str,
dest_addr: &str,
) -> Result<Option<Arc<DnsConn>>> {
let local_names = match mdns_mode {
MulticastDnsMode::QueryOnly => vec![],
MulticastDnsMode::QueryAndGather => vec![mdns_name.to_owned()],
MulticastDnsMode::Disabled => return Ok(None),
};
let addr = if dest_addr.is_empty() {
//TODO: why DEFAULT_DEST_ADDR doesn't work on Mac/Win?
if cfg!(target_os = "linux") {
SocketAddr::from_str(DEFAULT_DEST_ADDR)?
} else {
SocketAddr::from_str("0.0.0.0:5353")?
}
} else {
SocketAddr::from_str(dest_addr)?
};
log::info!("mDNS is using {} as dest_addr", addr);
let conn = DnsConn::server(
addr,
Config {
local_names,
..Config::default()
},
)?;
Ok(Some(Arc::new(conn)))
}
+148
View File
@@ -0,0 +1,148 @@
#[cfg(test)]
mod network_type_test;
use std::fmt;
use std::net::IpAddr;
use serde::{Deserialize, Serialize};
use crate::error::*;
pub(crate) const UDP: &str = "udp";
pub(crate) const TCP: &str = "tcp";
#[must_use]
pub fn supported_network_types() -> Vec<NetworkType> {
vec![
NetworkType::Udp4,
NetworkType::Udp6,
//NetworkType::TCP4,
//NetworkType::TCP6,
]
}
/// Represents the type of network.
#[derive(PartialEq, Debug, Copy, Clone, Eq, Hash, Serialize, Deserialize)]
pub enum NetworkType {
#[serde(rename = "unspecified")]
Unspecified,
/// Indicates UDP over IPv4.
#[serde(rename = "udp4")]
Udp4,
/// Indicates UDP over IPv6.
#[serde(rename = "udp6")]
Udp6,
/// Indicates TCP over IPv4.
#[serde(rename = "tcp4")]
Tcp4,
/// Indicates TCP over IPv6.
#[serde(rename = "tcp6")]
Tcp6,
}
impl From<u8> for NetworkType {
fn from(v: u8) -> Self {
match v {
1 => Self::Udp4,
2 => Self::Udp6,
3 => Self::Tcp4,
4 => Self::Tcp6,
_ => Self::Unspecified,
}
}
}
impl fmt::Display for NetworkType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Udp4 => "udp4",
Self::Udp6 => "udp6",
Self::Tcp4 => "tcp4",
Self::Tcp6 => "tcp6",
Self::Unspecified => "unspecified",
};
write!(f, "{s}")
}
}
impl Default for NetworkType {
fn default() -> Self {
Self::Unspecified
}
}
impl NetworkType {
/// Returns true when network is UDP4 or UDP6.
#[must_use]
pub fn is_udp(self) -> bool {
self == Self::Udp4 || self == Self::Udp6
}
/// Returns true when network is TCP4 or TCP6.
#[must_use]
pub fn is_tcp(self) -> bool {
self == Self::Tcp4 || self == Self::Tcp6
}
/// Returns the short network description.
#[must_use]
pub fn network_short(self) -> String {
match self {
Self::Udp4 | Self::Udp6 => UDP.to_owned(),
Self::Tcp4 | Self::Tcp6 => TCP.to_owned(),
Self::Unspecified => "Unspecified".to_owned(),
}
}
/// Returns true if the network is reliable.
#[must_use]
pub const fn is_reliable(self) -> bool {
match self {
Self::Tcp4 | Self::Tcp6 => true,
Self::Udp4 | Self::Udp6 | Self::Unspecified => false,
}
}
/// Returns whether the network type is IPv4 or not.
#[must_use]
pub const fn is_ipv4(self) -> bool {
match self {
Self::Udp4 | Self::Tcp4 => true,
Self::Udp6 | Self::Tcp6 | Self::Unspecified => false,
}
}
/// Returns whether the network type is IPv6 or not.
#[must_use]
pub const fn is_ipv6(self) -> bool {
match self {
Self::Udp6 | Self::Tcp6 => true,
Self::Udp4 | Self::Tcp4 | Self::Unspecified => false,
}
}
}
/// Determines the type of network based on the short network string and an IP address.
pub(crate) fn determine_network_type(network: &str, ip: &IpAddr) -> Result<NetworkType> {
let ipv4 = ip.is_ipv4();
let net = network.to_lowercase();
if net.starts_with(UDP) {
if ipv4 {
Ok(NetworkType::Udp4)
} else {
Ok(NetworkType::Udp6)
}
} else if net.starts_with(TCP) {
if ipv4 {
Ok(NetworkType::Tcp4)
} else {
Ok(NetworkType::Tcp6)
}
} else {
Err(Error::ErrDetermineNetworkType)
}
}
+95
View File
@@ -0,0 +1,95 @@
use super::*;
use crate::error::Result;
#[test]
fn test_network_type_parsing_success() -> Result<()> {
let ipv4: IpAddr = "192.168.0.1".parse().unwrap();
let ipv6: IpAddr = "fe80::a3:6ff:fec4:5454".parse().unwrap();
let tests = vec![
("lowercase UDP4", "udp", ipv4, NetworkType::Udp4),
("uppercase UDP4", "UDP", ipv4, NetworkType::Udp4),
("lowercase UDP6", "udp", ipv6, NetworkType::Udp6),
("uppercase UDP6", "UDP", ipv6, NetworkType::Udp6),
];
for (name, in_network, in_ip, expected) in tests {
let actual = determine_network_type(in_network, &in_ip)?;
assert_eq!(
actual, expected,
"NetworkTypeParsing: '{name}' -- input:{in_network} expected:{expected} actual:{actual}"
);
}
Ok(())
}
#[test]
fn test_network_type_parsing_failure() -> Result<()> {
let ipv6: IpAddr = "fe80::a3:6ff:fec4:5454".parse().unwrap();
let tests = vec![("invalid network", "junkNetwork", ipv6)];
for (name, in_network, in_ip) in tests {
let result = determine_network_type(in_network, &in_ip);
assert!(
result.is_err(),
"NetworkTypeParsing should fail: '{name}' -- input:{in_network}",
);
}
Ok(())
}
#[test]
fn test_network_type_is_udp() -> Result<()> {
assert!(NetworkType::Udp4.is_udp());
assert!(NetworkType::Udp6.is_udp());
assert!(!NetworkType::Udp4.is_tcp());
assert!(!NetworkType::Udp6.is_tcp());
Ok(())
}
#[test]
fn test_network_type_is_tcp() -> Result<()> {
assert!(NetworkType::Tcp4.is_tcp());
assert!(NetworkType::Tcp6.is_tcp());
assert!(!NetworkType::Tcp4.is_udp());
assert!(!NetworkType::Tcp6.is_udp());
Ok(())
}
#[test]
fn test_network_type_serialization() {
let tests = vec![
(NetworkType::Tcp4, "\"tcp4\""),
(NetworkType::Tcp6, "\"tcp6\""),
(NetworkType::Udp4, "\"udp4\""),
(NetworkType::Udp6, "\"udp6\""),
(NetworkType::Unspecified, "\"unspecified\""),
];
for (network_type, expected_string) in tests {
assert_eq!(
expected_string.to_string(),
serde_json::to_string(&network_type).unwrap()
);
}
}
#[test]
fn test_network_type_to_string() {
let tests = vec![
(NetworkType::Tcp4, "tcp4"),
(NetworkType::Tcp6, "tcp6"),
(NetworkType::Udp4, "udp4"),
(NetworkType::Udp6, "udp6"),
(NetworkType::Unspecified, "unspecified"),
];
for (network_type, expected_string) in tests {
assert_eq!(network_type.to_string(), expected_string);
}
}
+36
View File
@@ -0,0 +1,36 @@
#[cfg(test)]
mod priority_test;
use stun::attributes::ATTR_PRIORITY;
use stun::checks::*;
use stun::message::*;
/// Represents PRIORITY attribute.
#[derive(Default, PartialEq, Eq, Debug, Copy, Clone)]
pub struct PriorityAttr(pub u32);
const PRIORITY_SIZE: usize = 4; // 32 bit
impl Setter for PriorityAttr {
// add_to adds PRIORITY attribute to message.
fn add_to(&self, m: &mut Message) -> Result<(), stun::Error> {
let mut v = vec![0_u8; PRIORITY_SIZE];
v.copy_from_slice(&self.0.to_be_bytes());
m.add(ATTR_PRIORITY, &v);
Ok(())
}
}
impl PriorityAttr {
/// Decodes PRIORITY attribute from message.
pub fn get_from(&mut self, m: &Message) -> Result<(), stun::Error> {
let v = m.get(ATTR_PRIORITY)?;
check_size(ATTR_PRIORITY, v.len(), PRIORITY_SIZE)?;
let p = u32::from_be_bytes([v[0], v[1], v[2], v[3]]);
self.0 = p;
Ok(())
}
}
+39
View File
@@ -0,0 +1,39 @@
use super::*;
use crate::error::Result;
#[test]
fn test_priority_get_from() -> Result<()> {
let mut m = Message::new();
let mut p = PriorityAttr::default();
let result = p.get_from(&m);
if let Err(err) = result {
assert_eq!(err, stun::Error::ErrAttributeNotFound, "unexpected error");
} else {
panic!("expected error, but got ok");
}
m.build(&[Box::new(BINDING_REQUEST), Box::new(p)])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
let mut p1 = PriorityAttr::default();
p1.get_from(&m1)?;
assert_eq!(p1, p, "not equal");
//"IncorrectSize"
{
let mut m3 = Message::new();
m3.add(ATTR_PRIORITY, &[0; 100]);
let mut p2 = PriorityAttr::default();
let result = p2.get_from(&m3);
if let Err(err) = result {
assert!(is_attr_size_invalid(&err), "should error");
} else {
panic!("expected error, but got ok");
}
}
Ok(())
}
+48
View File
@@ -0,0 +1,48 @@
#[cfg(test)]
mod rand_test;
use rand::{thread_rng, Rng};
const RUNES_ALPHA: &[u8] = b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ";
const RUNES_CANDIDATE_ID_FOUNDATION: &[u8] =
b"abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789/+";
const LEN_UFRAG: usize = 16;
const LEN_PWD: usize = 32;
//TODO: generates a random string for cryptographic usage.
pub fn generate_crypto_random_string(n: usize, runes: &[u8]) -> String {
let mut rng = thread_rng();
let rand_string: String = (0..n)
.map(|_| {
let idx = rng.gen_range(0..runes.len());
runes[idx] as char
})
.collect();
rand_string
}
/// https://tools.ietf.org/html/rfc5245#section-15.1
/// candidate-id = "candidate" ":" foundation
/// foundation = 1*32ice-char
/// ice-char = ALPHA / DIGIT / "+" / "/"
pub fn generate_cand_id() -> String {
format!(
"candidate:{}",
generate_crypto_random_string(32, RUNES_CANDIDATE_ID_FOUNDATION)
)
}
/// Generates ICE pwd.
/// This internally uses `generate_crypto_random_string`.
pub fn generate_pwd() -> String {
generate_crypto_random_string(LEN_PWD, RUNES_ALPHA)
}
/// ICE user fragment.
/// This internally uses `generate_crypto_random_string`.
pub fn generate_ufrag() -> String {
generate_crypto_random_string(LEN_UFRAG, RUNES_ALPHA)
}
+77
View File
@@ -0,0 +1,77 @@
use std::sync::Arc;
use tokio::sync::Mutex;
use waitgroup::WaitGroup;
use super::*;
use crate::error::Result;
#[tokio::test]
async fn test_random_generator_collision() -> Result<()> {
let test_cases = vec![
(
"CandidateID",
0, /*||-> String {
generate_cand_id()
},*/
),
(
"PWD", 1, /*||-> String {
generate_pwd()
},*/
),
(
"Ufrag", 2, /*|| ->String {
generate_ufrag()
},*/
),
];
const N: usize = 10;
const ITERATION: usize = 10;
for (name, test_case) in test_cases {
for _ in 0..ITERATION {
let rands = Arc::new(Mutex::new(vec![]));
// Create a new wait group.
let wg = WaitGroup::new();
for _ in 0..N {
let w = wg.worker();
let rs = Arc::clone(&rands);
tokio::spawn(async move {
let _d = w;
let s = if test_case == 0 {
generate_cand_id()
} else if test_case == 1 {
generate_pwd()
} else {
generate_ufrag()
};
let mut r = rs.lock().await;
r.push(s);
});
}
wg.wait().await;
let rs = rands.lock().await;
assert_eq!(rs.len(), N, "{name} Failed to generate randoms");
for i in 0..N {
for j in i + 1..N {
assert_ne!(
rs[i], rs[j],
"{}: generateRandString caused collision: {} == {}",
name, rs[i], rs[j],
);
}
}
}
}
Ok(())
}
+112
View File
@@ -0,0 +1,112 @@
#[cfg(test)]
mod state_test;
use std::fmt;
/// An enum showing the state of a ICE Connection List of supported States.
#[derive(Debug, Copy, Clone, PartialEq, Eq)]
pub enum ConnectionState {
Unspecified,
/// ICE agent is gathering addresses.
New,
/// ICE agent has been given local and remote candidates, and is attempting to find a match.
Checking,
/// ICE agent has a pairing, but is still checking other pairs.
Connected,
/// ICE agent has finished.
Completed,
/// ICE agent never could successfully connect.
Failed,
/// ICE agent connected successfully, but has entered a failed state.
Disconnected,
/// ICE agent has finished and is no longer handling requests.
Closed,
}
impl Default for ConnectionState {
fn default() -> Self {
Self::Unspecified
}
}
impl fmt::Display for ConnectionState {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Unspecified => "Unspecified",
Self::New => "New",
Self::Checking => "Checking",
Self::Connected => "Connected",
Self::Completed => "Completed",
Self::Failed => "Failed",
Self::Disconnected => "Disconnected",
Self::Closed => "Closed",
};
write!(f, "{s}")
}
}
impl From<u8> for ConnectionState {
fn from(v: u8) -> Self {
match v {
1 => Self::New,
2 => Self::Checking,
3 => Self::Connected,
4 => Self::Completed,
5 => Self::Failed,
6 => Self::Disconnected,
7 => Self::Closed,
_ => Self::Unspecified,
}
}
}
/// Describes the state of the candidate gathering process.
#[derive(PartialEq, Eq, Copy, Clone)]
pub enum GatheringState {
Unspecified,
/// Indicates candidate gathering is not yet started.
New,
/// Indicates candidate gathering is ongoing.
Gathering,
/// Indicates candidate gathering has been completed.
Complete,
}
impl From<u8> for GatheringState {
fn from(v: u8) -> Self {
match v {
1 => Self::New,
2 => Self::Gathering,
3 => Self::Complete,
_ => Self::Unspecified,
}
}
}
impl Default for GatheringState {
fn default() -> Self {
Self::Unspecified
}
}
impl fmt::Display for GatheringState {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::New => "new",
Self::Gathering => "gathering",
Self::Complete => "complete",
Self::Unspecified => "unspecified",
};
write!(f, "{s}")
}
}
+46
View File
@@ -0,0 +1,46 @@
use super::*;
use crate::error::Result;
#[test]
fn test_connected_state_string() -> Result<()> {
let tests = vec![
(ConnectionState::Unspecified, "Unspecified"),
(ConnectionState::New, "New"),
(ConnectionState::Checking, "Checking"),
(ConnectionState::Connected, "Connected"),
(ConnectionState::Completed, "Completed"),
(ConnectionState::Failed, "Failed"),
(ConnectionState::Disconnected, "Disconnected"),
(ConnectionState::Closed, "Closed"),
];
for (connection_state, expected_string) in tests {
assert_eq!(
connection_state.to_string(),
expected_string,
"testCase: {expected_string} vs {connection_state}",
)
}
Ok(())
}
#[test]
fn test_gathering_state_string() -> Result<()> {
let tests = vec![
(GatheringState::Unspecified, "unspecified"),
(GatheringState::New, "new"),
(GatheringState::Gathering, "gathering"),
(GatheringState::Complete, "complete"),
];
for (gathering_state, expected_string) in tests {
assert_eq!(
gathering_state.to_string(),
expected_string,
"testCase: {expected_string} vs {gathering_state}",
)
}
Ok(())
}
+178
View File
@@ -0,0 +1,178 @@
use tokio::time::Instant;
use crate::candidate::*;
use crate::network_type::*;
// CandidatePairStats contains ICE candidate pair statistics
#[derive(Debug, Clone)]
pub struct CandidatePairStats {
// timestamp is the timestamp associated with this object.
pub timestamp: Instant,
// local_candidate_id is the id of the local candidate
pub local_candidate_id: String,
// remote_candidate_id is the id of the remote candidate
pub remote_candidate_id: String,
// state represents the state of the checklist for the local and remote
// candidates in a pair.
pub state: CandidatePairState,
// nominated is true when this valid pair that should be used for media
// if it is the highest-priority one amongst those whose nominated flag is set
pub nominated: bool,
// packets_sent represents the total number of packets sent on this candidate pair.
pub packets_sent: u32,
// packets_received represents the total number of packets received on this candidate pair.
pub packets_received: u32,
// bytes_sent represents the total number of payload bytes sent on this candidate pair
// not including headers or padding.
pub bytes_sent: u64,
// bytes_received represents the total number of payload bytes received on this candidate pair
// not including headers or padding.
pub bytes_received: u64,
// last_packet_sent_timestamp represents the timestamp at which the last packet was
// sent on this particular candidate pair, excluding STUN packets.
pub last_packet_sent_timestamp: Instant,
// last_packet_received_timestamp represents the timestamp at which the last packet
// was received on this particular candidate pair, excluding STUN packets.
pub last_packet_received_timestamp: Instant,
// first_request_timestamp represents the timestamp at which the first STUN request
// was sent on this particular candidate pair.
pub first_request_timestamp: Instant,
// last_request_timestamp represents the timestamp at which the last STUN request
// was sent on this particular candidate pair. The average interval between two
// consecutive connectivity checks sent can be calculated with
// (last_request_timestamp - first_request_timestamp) / requests_sent.
pub last_request_timestamp: Instant,
// last_response_timestamp represents the timestamp at which the last STUN response
// was received on this particular candidate pair.
pub last_response_timestamp: Instant,
// total_round_trip_time represents the sum of all round trip time measurements
// in seconds since the beginning of the session, based on STUN connectivity
// check responses (responses_received), including those that reply to requests
// that are sent in order to verify consent. The average round trip time can
// be computed from total_round_trip_time by dividing it by responses_received.
pub total_round_trip_time: f64,
// current_round_trip_time represents the latest round trip time measured in seconds,
// computed from both STUN connectivity checks, including those that are sent
// for consent verification.
pub current_round_trip_time: f64,
// available_outgoing_bitrate is calculated by the underlying congestion control
// by combining the available bitrate for all the outgoing RTP streams using
// this candidate pair. The bitrate measurement does not count the size of the
// ip or other transport layers like TCP or UDP. It is similar to the TIAS defined
// in RFC 3890, i.e., it is measured in bits per second and the bitrate is calculated
// over a 1 second window.
pub available_outgoing_bitrate: f64,
// available_incoming_bitrate is calculated by the underlying congestion control
// by combining the available bitrate for all the incoming RTP streams using
// this candidate pair. The bitrate measurement does not count the size of the
// ip or other transport layers like TCP or UDP. It is similar to the TIAS defined
// in RFC 3890, i.e., it is measured in bits per second and the bitrate is
// calculated over a 1 second window.
pub available_incoming_bitrate: f64,
// circuit_breaker_trigger_count represents the number of times the circuit breaker
// is triggered for this particular 5-tuple, ceasing transmission.
pub circuit_breaker_trigger_count: u32,
// requests_received represents the total number of connectivity check requests
// received (including retransmissions). It is impossible for the receiver to
// tell whether the request was sent in order to check connectivity or check
// consent, so all connectivity checks requests are counted here.
pub requests_received: u64,
// requests_sent represents the total number of connectivity check requests
// sent (not including retransmissions).
pub requests_sent: u64,
// responses_received represents the total number of connectivity check responses received.
pub responses_received: u64,
// responses_sent epresents the total number of connectivity check responses sent.
// Since we cannot distinguish connectivity check requests and consent requests,
// all responses are counted.
pub responses_sent: u64,
// retransmissions_received represents the total number of connectivity check
// request retransmissions received.
pub retransmissions_received: u64,
// retransmissions_sent represents the total number of connectivity check
// request retransmissions sent.
pub retransmissions_sent: u64,
// consent_requests_sent represents the total number of consent requests sent.
pub consent_requests_sent: u64,
// consent_expired_timestamp represents the timestamp at which the latest valid
// STUN binding response expired.
pub consent_expired_timestamp: Instant,
}
// CandidateStats contains ICE candidate statistics related to the ICETransport objects.
#[derive(Debug, Clone)]
pub struct CandidateStats {
// timestamp is the timestamp associated with this object.
pub timestamp: Instant,
// id is the candidate id
pub id: String,
// network_type represents the type of network interface used by the base of a
// local candidate (the address the ICE agent sends from). Only present for
// local candidates; it's not possible to know what type of network interface
// a remote candidate is using.
//
// Note:
// This stat only tells you about the network interface used by the first "hop";
// it's possible that a connection will be bottlenecked by another type of network.
// For example, when using Wi-Fi tethering, the networkType of the relevant candidate
// would be "wifi", even when the next hop is over a cellular connection.
pub network_type: NetworkType,
// ip is the ip address of the candidate, allowing for IPv4 addresses and
// IPv6 addresses, but fully qualified domain names (FQDNs) are not allowed.
pub ip: String,
// port is the port number of the candidate.
pub port: u16,
// candidate_type is the "Type" field of the ICECandidate.
pub candidate_type: CandidateType,
// priority is the "priority" field of the ICECandidate.
pub priority: u32,
// url is the url of the TURN or STUN server indicated in the that translated
// this ip address. It is the url address surfaced in an PeerConnectionICEEvent.
pub url: String,
// relay_protocol is the protocol used by the endpoint to communicate with the
// TURN server. This is only present for local candidates. Valid values for
// the TURN url protocol is one of udp, tcp, or tls.
pub relay_protocol: String,
// deleted is true if the candidate has been deleted/freed. For host candidates,
// this means that any network resources (typically a socket) associated with the
// candidate have been released. For TURN candidates, this means the TURN allocation
// is no longer active.
//
// Only defined for local candidates. For remote candidates, this property is not applicable.
pub deleted: bool,
}
+48
View File
@@ -0,0 +1,48 @@
#[cfg(test)]
mod tcp_type_test;
use std::fmt;
// TCPType is the type of ICE TCP candidate as described in
// ttps://tools.ietf.org/html/rfc6544#section-4.5
#[derive(PartialEq, Eq, Debug, Copy, Clone)]
pub enum TcpType {
/// The default value. For example UDP candidates do not need this field.
Unspecified,
/// Active TCP candidate, which initiates TCP connections.
Active,
/// Passive TCP candidate, only accepts TCP connections.
Passive,
/// Like `Active` and `Passive` at the same time.
SimultaneousOpen,
}
// from creates a new TCPType from string.
impl From<&str> for TcpType {
fn from(raw: &str) -> Self {
match raw {
"active" => Self::Active,
"passive" => Self::Passive,
"so" => Self::SimultaneousOpen,
_ => Self::Unspecified,
}
}
}
impl fmt::Display for TcpType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Active => "active",
Self::Passive => "passive",
Self::SimultaneousOpen => "so",
Self::Unspecified => "unspecified",
};
write!(f, "{s}")
}
}
impl Default for TcpType {
fn default() -> Self {
Self::Unspecified
}
}
+18
View File
@@ -0,0 +1,18 @@
use super::*;
use crate::error::Result;
#[test]
fn test_tcp_type() -> Result<()> {
//assert_eq!(tcpType, TCPType::Unspecified)
assert_eq!(TcpType::from("active"), TcpType::Active);
assert_eq!(TcpType::from("passive"), TcpType::Passive);
assert_eq!(TcpType::from("so"), TcpType::SimultaneousOpen);
assert_eq!(TcpType::from("something else"), TcpType::Unspecified);
assert_eq!(TcpType::Unspecified.to_string(), "unspecified");
assert_eq!(TcpType::Active.to_string(), "active");
assert_eq!(TcpType::Passive.to_string(), "passive");
assert_eq!(TcpType::SimultaneousOpen.to_string(), "so");
Ok(())
}
+338
View File
@@ -0,0 +1,338 @@
use std::collections::HashMap;
use std::io::ErrorKind;
use std::net::SocketAddr;
use std::sync::{Arc, Weak};
use async_trait::async_trait;
use tokio::sync::{watch, Mutex};
use util::sync::RwLock;
use util::{Conn, Error};
mod udp_mux_conn;
pub use udp_mux_conn::{UDPMuxConn, UDPMuxConnParams, UDPMuxWriter};
#[cfg(test)]
mod udp_mux_test;
mod socket_addr_ext;
use stun::attributes::ATTR_USERNAME;
use stun::message::{is_message as is_stun_message, Message as STUNMessage};
use crate::candidate::RECEIVE_MTU;
/// Normalize a target socket addr for sending over a given local socket addr. This is useful when
/// a dual stack socket is used, in which case an IPv4 target needs to be mapped to an IPv6
/// address.
fn normalize_socket_addr(target: &SocketAddr, socket_addr: &SocketAddr) -> SocketAddr {
match (target, socket_addr) {
(SocketAddr::V4(target_ipv4), SocketAddr::V6(_)) => {
let ipv6_mapped = target_ipv4.ip().to_ipv6_mapped();
SocketAddr::new(std::net::IpAddr::V6(ipv6_mapped), target_ipv4.port())
}
// This will fail later if target is IPv6 and socket is IPv4, we ignore it here
(_, _) => *target,
}
}
#[async_trait]
pub trait UDPMux {
/// Close the muxing.
async fn close(&self) -> Result<(), Error>;
/// Get the underlying connection for a given ufrag.
async fn get_conn(self: Arc<Self>, ufrag: &str) -> Result<Arc<dyn Conn + Send + Sync>, Error>;
/// Remove the underlying connection for a given ufrag.
async fn remove_conn_by_ufrag(&self, ufrag: &str);
}
pub struct UDPMuxParams {
conn: Box<dyn Conn + Send + Sync>,
}
impl UDPMuxParams {
pub fn new<C>(conn: C) -> Self
where
C: Conn + Send + Sync + 'static,
{
Self {
conn: Box::new(conn),
}
}
}
pub struct UDPMuxDefault {
/// The params this instance is configured with.
/// Contains the underlying UDP socket in use
params: UDPMuxParams,
/// Maps from ufrag to the underlying connection.
conns: Mutex<HashMap<String, UDPMuxConn>>,
/// Maps from ip address to the underlying connection.
address_map: RwLock<HashMap<SocketAddr, UDPMuxConn>>,
// Close sender
closed_watch_tx: Mutex<Option<watch::Sender<()>>>,
/// Close receiver
closed_watch_rx: watch::Receiver<()>,
}
impl UDPMuxDefault {
pub fn new(params: UDPMuxParams) -> Arc<Self> {
let (closed_watch_tx, closed_watch_rx) = watch::channel(());
let mux = Arc::new(Self {
params,
conns: Mutex::default(),
address_map: RwLock::default(),
closed_watch_tx: Mutex::new(Some(closed_watch_tx)),
closed_watch_rx: closed_watch_rx.clone(),
});
let cloned_mux = Arc::clone(&mux);
cloned_mux.start_conn_worker(closed_watch_rx);
mux
}
pub async fn is_closed(&self) -> bool {
self.closed_watch_tx.lock().await.is_none()
}
/// Create a muxed connection for a given ufrag.
fn create_muxed_conn(self: &Arc<Self>, ufrag: &str) -> Result<UDPMuxConn, Error> {
let local_addr = self.params.conn.local_addr()?;
let params = UDPMuxConnParams {
local_addr,
key: ufrag.into(),
udp_mux: Arc::downgrade(self) as Weak<dyn UDPMuxWriter + Send + Sync>,
};
Ok(UDPMuxConn::new(params))
}
async fn conn_from_stun_message(&self, buffer: &[u8], addr: &SocketAddr) -> Option<UDPMuxConn> {
let (result, message) = {
let mut m = STUNMessage::new();
(m.unmarshal_binary(buffer), m)
};
match result {
Err(err) => {
log::warn!("Failed to handle decode ICE from {}: {}", addr, err);
None
}
Ok(_) => {
let (attr, found) = message.attributes.get(ATTR_USERNAME);
if !found {
log::warn!("No username attribute in STUN message from {}", &addr);
return None;
}
let s = match String::from_utf8(attr.value) {
// Per the RFC this shouldn't happen
// https://datatracker.ietf.org/doc/html/rfc5389#section-15.3
Err(err) => {
log::warn!(
"Failed to decode USERNAME from STUN message as UTF-8: {}",
err
);
return None;
}
Ok(s) => s,
};
let conns = self.conns.lock().await;
let conn = s
.split(':')
.next()
.and_then(|ufrag| conns.get(ufrag))
.map(Clone::clone);
conn
}
}
}
fn start_conn_worker(self: Arc<Self>, mut closed_watch_rx: watch::Receiver<()>) {
tokio::spawn(async move {
let mut buffer = [0u8; RECEIVE_MTU];
loop {
let loop_self = Arc::clone(&self);
let conn = &loop_self.params.conn;
tokio::select! {
res = conn.recv_from(&mut buffer) => {
match res {
Ok((len, addr)) => {
// Find connection based on previously having seen this source address
let conn = {
let address_map = loop_self
.address_map
.read();
address_map.get(&addr).map(Clone::clone)
};
let conn = match conn {
// If we couldn't find the connection based on source address, see if
// this is a STUN message and if so if we can find the connection based on ufrag.
None if is_stun_message(&buffer) => {
loop_self.conn_from_stun_message(&buffer, &addr).await
}
s @ Some(_) => s,
_ => None,
};
match conn {
None => {
log::trace!("Dropping packet from {}", &addr);
}
Some(conn) => {
if let Err(err) = conn.write_packet(&buffer[..len], addr).await {
log::error!("Failed to write packet: {}", err);
}
}
}
}
Err(Error::Io(err)) if err.0.kind() == ErrorKind::TimedOut => continue,
Err(err) => {
log::error!("Could not read udp packet: {}", err);
break;
}
}
}
_ = closed_watch_rx.changed() => {
return;
}
}
}
});
}
}
#[async_trait]
impl UDPMux for UDPMuxDefault {
async fn close(&self) -> Result<(), Error> {
if self.is_closed().await {
return Err(Error::ErrAlreadyClosed);
}
let mut closed_tx = self.closed_watch_tx.lock().await;
if let Some(tx) = closed_tx.take() {
let _ = tx.send(());
drop(closed_tx);
let old_conns = {
let mut conns = self.conns.lock().await;
std::mem::take(&mut (*conns))
};
// NOTE: We don't wait for these closure to complete
for (_, conn) in old_conns {
conn.close();
}
{
let mut address_map = self.address_map.write();
// NOTE: This is important, we need to drop all instances of `UDPMuxConn` to
// avoid a retain cycle due to the use of [`std::sync::Arc`] on both sides.
let _ = std::mem::take(&mut (*address_map));
}
}
Ok(())
}
async fn get_conn(self: Arc<Self>, ufrag: &str) -> Result<Arc<dyn Conn + Send + Sync>, Error> {
if self.is_closed().await {
return Err(Error::ErrUseClosedNetworkConn);
}
{
let mut conns = self.conns.lock().await;
if let Some(conn) = conns.get(ufrag) {
// UDPMuxConn uses `Arc` internally so it's cheap to clone, but because
// we implement `Conn` we need to further wrap it in an `Arc` here.
return Ok(Arc::new(conn.clone()) as Arc<dyn Conn + Send + Sync>);
}
let muxed_conn = self.create_muxed_conn(ufrag)?;
let mut close_rx = muxed_conn.close_rx();
let cloned_self = Arc::clone(&self);
let cloned_ufrag = ufrag.to_string();
tokio::spawn(async move {
let _ = close_rx.changed().await;
// Arc needed
cloned_self.remove_conn_by_ufrag(&cloned_ufrag).await;
});
conns.insert(ufrag.into(), muxed_conn.clone());
Ok(Arc::new(muxed_conn) as Arc<dyn Conn + Send + Sync>)
}
}
async fn remove_conn_by_ufrag(&self, ufrag: &str) {
// Pion's ice implementation has both `RemoveConnByFrag` and `RemoveConn`, but since `conns`
// is keyed on `ufrag` their implementation is equivalent.
let removed_conn = {
let mut conns = self.conns.lock().await;
conns.remove(ufrag)
};
if let Some(conn) = removed_conn {
let mut address_map = self.address_map.write();
for address in conn.get_addresses() {
address_map.remove(&address);
}
}
}
}
#[async_trait]
impl UDPMuxWriter for UDPMuxDefault {
async fn register_conn_for_address(&self, conn: &UDPMuxConn, addr: SocketAddr) {
if self.is_closed().await {
return;
}
let key = conn.key();
{
let mut addresses = self.address_map.write();
addresses
.entry(addr)
.and_modify(|e| {
if e.key() != key {
e.remove_address(&addr);
*e = conn.clone();
}
})
.or_insert_with(|| conn.clone());
}
log::debug!("Registered {} for {}", addr, key);
}
async fn send_to(&self, buf: &[u8], target: &SocketAddr) -> Result<usize, Error> {
self.params
.conn
.send_to(buf, *target)
.await
.map_err(Into::into)
}
}
+246
View File
@@ -0,0 +1,246 @@
use std::array::TryFromSliceError;
use std::convert::TryInto;
use std::net::SocketAddr;
use util::Error;
pub(super) trait SocketAddrExt {
///Encode a representation of `self` into the buffer and return the length of this encoded
///version.
///
/// The buffer needs to be at least 27 bytes in length.
fn encode(&self, buffer: &mut [u8]) -> Result<usize, Error>;
/// Decode a `SocketAddr` from a buffer. The encoding should have previously been done with
/// [`SocketAddrExt::encode`].
fn decode(buffer: &[u8]) -> Result<SocketAddr, Error>;
}
const IPV4_MARKER: u8 = 4;
const IPV4_ADDRESS_SIZE: usize = 7;
const IPV6_MARKER: u8 = 6;
const IPV6_ADDRESS_SIZE: usize = 27;
pub(super) const MAX_ADDR_SIZE: usize = IPV6_ADDRESS_SIZE;
impl SocketAddrExt for SocketAddr {
fn encode(&self, buffer: &mut [u8]) -> Result<usize, Error> {
use std::net::SocketAddr::{V4, V6};
if buffer.len() < MAX_ADDR_SIZE {
return Err(Error::ErrBufferShort);
}
match self {
V4(addr) => {
let marker = IPV4_MARKER;
let ip: [u8; 4] = addr.ip().octets();
let port: u16 = addr.port();
buffer[0] = marker;
buffer[1..5].copy_from_slice(&ip);
buffer[5..7].copy_from_slice(&port.to_le_bytes());
Ok(7)
}
V6(addr) => {
let marker = IPV6_MARKER;
let ip: [u8; 16] = addr.ip().octets();
let port: u16 = addr.port();
let flowinfo = addr.flowinfo();
let scope_id = addr.scope_id();
buffer[0] = marker;
buffer[1..17].copy_from_slice(&ip);
buffer[17..19].copy_from_slice(&port.to_le_bytes());
buffer[19..23].copy_from_slice(&flowinfo.to_le_bytes());
buffer[23..27].copy_from_slice(&scope_id.to_le_bytes());
Ok(MAX_ADDR_SIZE)
}
}
}
fn decode(buffer: &[u8]) -> Result<SocketAddr, Error> {
use std::net::{Ipv4Addr, Ipv6Addr, SocketAddrV4, SocketAddrV6};
match buffer[0] {
IPV4_MARKER => {
if buffer.len() < IPV4_ADDRESS_SIZE {
return Err(Error::ErrBufferShort);
}
let ip_parts = &buffer[1..5];
let port = match &buffer[5..7].try_into() {
Err(_) => return Err(Error::ErrFailedToParseIpaddr),
Ok(input) => u16::from_le_bytes(*input),
};
let ip = Ipv4Addr::new(ip_parts[0], ip_parts[1], ip_parts[2], ip_parts[3]);
Ok(SocketAddr::V4(SocketAddrV4::new(ip, port)))
}
IPV6_MARKER => {
if buffer.len() < IPV6_ADDRESS_SIZE {
return Err(Error::ErrBufferShort);
}
// Just to help the type system infer correctly
fn helper(b: &[u8]) -> Result<&[u8; 16], TryFromSliceError> {
b.try_into()
}
let ip = match helper(&buffer[1..17]) {
Err(_) => return Err(Error::ErrFailedToParseIpaddr),
Ok(input) => Ipv6Addr::from(*input),
};
let port = match &buffer[17..19].try_into() {
Err(_) => return Err(Error::ErrFailedToParseIpaddr),
Ok(input) => u16::from_le_bytes(*input),
};
let flowinfo = match &buffer[19..23].try_into() {
Err(_) => return Err(Error::ErrFailedToParseIpaddr),
Ok(input) => u32::from_le_bytes(*input),
};
let scope_id = match &buffer[23..27].try_into() {
Err(_) => return Err(Error::ErrFailedToParseIpaddr),
Ok(input) => u32::from_le_bytes(*input),
};
Ok(SocketAddr::V6(SocketAddrV6::new(
ip, port, flowinfo, scope_id,
)))
}
_ => Err(Error::ErrFailedToParseIpaddr),
}
}
}
#[cfg(test)]
mod test {
use std::net::{Ipv4Addr, Ipv6Addr, SocketAddrV4, SocketAddrV6};
use super::*;
#[test]
fn test_ipv4() {
let ip = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::from([56, 128, 35, 5]), 0x1234));
let mut buffer = [0_u8; MAX_ADDR_SIZE];
let encoded_len = ip.encode(&mut buffer);
assert_eq!(encoded_len, Ok(7));
assert_eq!(
&buffer[0..7],
&[IPV4_MARKER, 56, 128, 35, 5, 0x34, 0x12][..]
);
let decoded = SocketAddr::decode(&buffer);
assert_eq!(decoded, Ok(ip));
}
#[test]
fn test_ipv6() {
let ip = SocketAddr::V6(SocketAddrV6::new(
Ipv6Addr::from([
92, 114, 235, 3, 244, 64, 38, 111, 20, 100, 199, 241, 19, 174, 220, 123,
]),
0x1234,
0x12345678,
0x87654321,
));
let mut buffer = [0_u8; MAX_ADDR_SIZE];
let encoded_len = ip.encode(&mut buffer);
assert_eq!(encoded_len, Ok(27));
assert_eq!(
&buffer[0..27],
&[
IPV6_MARKER, // marker
// Start of ipv6 address
92,
114,
235,
3,
244,
64,
38,
111,
20,
100,
199,
241,
19,
174,
220,
123,
// LE port
0x34,
0x12,
// LE flowinfo
0x78,
0x56,
0x34,
0x12,
// LE scope_id
0x21,
0x43,
0x65,
0x87,
][..]
);
let decoded = SocketAddr::decode(&buffer);
assert_eq!(decoded, Ok(ip));
}
#[test]
fn test_encode_ipv4_with_short_buffer() {
let mut buffer = vec![0u8; IPV4_ADDRESS_SIZE - 1];
let ip = SocketAddr::V4(SocketAddrV4::new(Ipv4Addr::from([56, 128, 35, 5]), 0x1234));
let result = ip.encode(&mut buffer);
assert_eq!(result, Err(Error::ErrBufferShort));
}
#[test]
fn test_encode_ipv6_with_short_buffer() {
let mut buffer = vec![0u8; MAX_ADDR_SIZE - 1];
let ip = SocketAddr::V6(SocketAddrV6::new(
Ipv6Addr::from([
92, 114, 235, 3, 244, 64, 38, 111, 20, 100, 199, 241, 19, 174, 220, 123,
]),
0x1234,
0x12345678,
0x87654321,
));
let result = ip.encode(&mut buffer);
assert_eq!(result, Err(Error::ErrBufferShort));
}
#[test]
fn test_decode_ipv4_with_short_buffer() {
let buffer = vec![IPV4_MARKER, 0];
let result = SocketAddr::decode(&buffer);
assert_eq!(result, Err(Error::ErrBufferShort));
}
#[test]
fn test_decode_ipv6_with_short_buffer() {
let buffer = vec![IPV6_MARKER, 0];
let result = SocketAddr::decode(&buffer);
assert_eq!(result, Err(Error::ErrBufferShort));
}
}
+316
View File
@@ -0,0 +1,316 @@
use std::collections::HashSet;
use std::convert::TryInto;
use std::io;
use std::net::SocketAddr;
use std::sync::{Arc, Weak};
use async_trait::async_trait;
use tokio::sync::watch;
use util::sync::Mutex;
use util::{Buffer, Conn, Error};
use super::socket_addr_ext::{SocketAddrExt, MAX_ADDR_SIZE};
use super::{normalize_socket_addr, RECEIVE_MTU};
/// A trait for a [`UDPMuxConn`] to communicate with an UDP mux.
#[async_trait]
pub trait UDPMuxWriter {
/// Registers an address for the given connection.
async fn register_conn_for_address(&self, conn: &UDPMuxConn, addr: SocketAddr);
/// Sends the content of the buffer to the given target.
///
/// Returns the number of bytes sent or an error, if any.
async fn send_to(&self, buf: &[u8], target: &SocketAddr) -> Result<usize, Error>;
}
/// Parameters for a [`UDPMuxConn`].
pub struct UDPMuxConnParams {
/// Local socket address.
pub local_addr: SocketAddr,
/// Static key identifying the connection.
pub key: String,
/// A `std::sync::Weak` reference to the UDP mux.
///
/// NOTE: a non-owning reference should be used to prevent possible cycles.
pub udp_mux: Weak<dyn UDPMuxWriter + Send + Sync>,
}
type ConnResult<T> = Result<T, util::Error>;
/// A UDP mux connection.
#[derive(Clone)]
pub struct UDPMuxConn {
/// Close Receiver. A copy of this can be obtained via [`close_tx`].
closed_watch_rx: watch::Receiver<bool>,
inner: Arc<UDPMuxConnInner>,
}
impl UDPMuxConn {
/// Creates a new [`UDPMuxConn`].
pub fn new(params: UDPMuxConnParams) -> Self {
let (closed_watch_tx, closed_watch_rx) = watch::channel(false);
Self {
closed_watch_rx,
inner: Arc::new(UDPMuxConnInner {
params,
closed_watch_tx: Mutex::new(Some(closed_watch_tx)),
addresses: Default::default(),
buffer: Buffer::new(0, 0),
}),
}
}
/// Returns a key identifying this connection.
pub fn key(&self) -> &str {
&self.inner.params.key
}
/// Writes data to the given address. Returns an error if the buffer is too short or there's an
/// encoding error.
pub async fn write_packet(&self, data: &[u8], addr: SocketAddr) -> ConnResult<()> {
// NOTE: Pion/ice uses Sync.Pool to optimise this.
let mut buffer = make_buffer();
let mut offset = 0;
if (data.len() + MAX_ADDR_SIZE) > (RECEIVE_MTU + MAX_ADDR_SIZE) {
return Err(Error::ErrBufferShort);
}
// Format of buffer: | data len(2) | data bytes(dn) | addr len(2) | addr bytes(an) |
// Where the number in parenthesis indicate the number of bytes used
// `dn` and `an` are the length in bytes of data and addr respectively.
// SAFETY: `data.len()` is at most RECEIVE_MTU(8192) - MAX_ADDR_SIZE(27)
buffer[0..2].copy_from_slice(&(data.len() as u16).to_le_bytes()[..]);
offset += 2;
buffer[offset..offset + data.len()].copy_from_slice(data);
offset += data.len();
let len = addr.encode(&mut buffer[offset + 2..])?;
buffer[offset..offset + 2].copy_from_slice(&(len as u16).to_le_bytes()[..]);
offset += 2 + len;
self.inner.buffer.write(&buffer[..offset]).await?;
Ok(())
}
/// Returns true if this connection is closed.
pub fn is_closed(&self) -> bool {
self.inner.is_closed()
}
/// Gets a copy of the close [`tokio::sync::watch::Receiver`] that fires when this
/// connection is closed.
pub fn close_rx(&self) -> watch::Receiver<bool> {
self.closed_watch_rx.clone()
}
/// Closes this connection.
pub fn close(&self) {
self.inner.close();
}
/// Gets the list of the addresses associated with this connection.
pub fn get_addresses(&self) -> Vec<SocketAddr> {
self.inner.get_addresses()
}
/// Registers a new address for this connection.
pub async fn add_address(&self, addr: SocketAddr) {
self.inner.add_address(addr);
if let Some(mux) = self.inner.params.udp_mux.upgrade() {
mux.register_conn_for_address(self, addr).await;
}
}
/// Deregisters an address.
pub fn remove_address(&self, addr: &SocketAddr) {
self.inner.remove_address(addr)
}
/// Returns true if the given address is associated with this connection.
pub fn contains_address(&self, addr: &SocketAddr) -> bool {
self.inner.contains_address(addr)
}
}
struct UDPMuxConnInner {
params: UDPMuxConnParams,
/// Close Sender. We'll send a value on this channel when we close
closed_watch_tx: Mutex<Option<watch::Sender<bool>>>,
/// Remote addresses we've seen on this connection.
addresses: Mutex<HashSet<SocketAddr>>,
buffer: Buffer,
}
impl UDPMuxConnInner {
// Sending/Recieving
async fn recv_from(&self, buf: &mut [u8]) -> ConnResult<(usize, SocketAddr)> {
// NOTE: Pion/ice uses Sync.Pool to optimise this.
let mut buffer = make_buffer();
let mut offset = 0;
let len = self.buffer.read(&mut buffer, None).await?;
// We always have at least.
//
// * 2 bytes for data len
// * 2 bytes for addr len
// * 7 bytes for an Ipv4 addr
if len < 11 {
return Err(Error::ErrBufferShort);
}
let data_len: usize = buffer[..2]
.try_into()
.map(u16::from_le_bytes)
.map(From::from)
.unwrap();
offset += 2;
let total = 2 + data_len + 2 + 7;
if data_len > buf.len() || total > len {
return Err(Error::ErrBufferShort);
}
buf[..data_len].copy_from_slice(&buffer[offset..offset + data_len]);
offset += data_len;
let address_len: usize = buffer[offset..offset + 2]
.try_into()
.map(u16::from_le_bytes)
.map(From::from)
.unwrap();
offset += 2;
let addr = SocketAddr::decode(&buffer[offset..offset + address_len])?;
Ok((data_len, addr))
}
async fn send_to(&self, buf: &[u8], target: &SocketAddr) -> ConnResult<usize> {
if let Some(mux) = self.params.udp_mux.upgrade() {
mux.send_to(buf, target).await
} else {
Err(Error::Other(format!(
"wanted to send {} bytes to {}, but UDP mux is gone",
buf.len(),
target
)))
}
}
fn is_closed(&self) -> bool {
self.closed_watch_tx.lock().is_none()
}
fn close(self: &Arc<Self>) {
let mut closed_tx = self.closed_watch_tx.lock();
if let Some(tx) = closed_tx.take() {
let _ = tx.send(true);
drop(closed_tx);
let cloned_self = Arc::clone(self);
{
let mut addresses = self.addresses.lock();
*addresses = Default::default();
}
// NOTE: Alternatively we could wait on the buffer closing here so that
// our caller can wait for things to fully settle down
tokio::spawn(async move {
cloned_self.buffer.close().await;
});
}
}
fn local_addr(&self) -> SocketAddr {
self.params.local_addr
}
// Address related methods
pub(super) fn get_addresses(&self) -> Vec<SocketAddr> {
let addresses = self.addresses.lock();
addresses.iter().copied().collect()
}
pub(super) fn add_address(self: &Arc<Self>, addr: SocketAddr) {
{
let mut addresses = self.addresses.lock();
addresses.insert(addr);
}
}
pub(super) fn remove_address(&self, addr: &SocketAddr) {
{
let mut addresses = self.addresses.lock();
addresses.remove(addr);
}
}
pub(super) fn contains_address(&self, addr: &SocketAddr) -> bool {
let addresses = self.addresses.lock();
addresses.contains(addr)
}
}
#[async_trait]
impl Conn for UDPMuxConn {
async fn connect(&self, _addr: SocketAddr) -> ConnResult<()> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
async fn recv(&self, _buf: &mut [u8]) -> ConnResult<usize> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
async fn recv_from(&self, buf: &mut [u8]) -> ConnResult<(usize, SocketAddr)> {
self.inner.recv_from(buf).await
}
async fn send(&self, _buf: &[u8]) -> ConnResult<usize> {
Err(io::Error::new(io::ErrorKind::Other, "Not applicable").into())
}
async fn send_to(&self, buf: &[u8], target: SocketAddr) -> ConnResult<usize> {
let normalized_target = normalize_socket_addr(&target, &self.inner.params.local_addr);
if !self.contains_address(&normalized_target) {
self.add_address(normalized_target).await;
}
self.inner.send_to(buf, &normalized_target).await
}
fn local_addr(&self) -> ConnResult<SocketAddr> {
Ok(self.inner.local_addr())
}
fn remote_addr(&self) -> Option<SocketAddr> {
None
}
async fn close(&self) -> ConnResult<()> {
self.inner.close();
Ok(())
}
}
#[inline(always)]
/// Create a buffer of appropriate size to fit both a packet with max RECEIVE_MTU and the
/// additional metadata used for muxing.
fn make_buffer() -> Vec<u8> {
// The 4 extra bytes are used to encode the length of the data and address respectively.
// See [`write_packet`] for details.
vec![0u8; RECEIVE_MTU + MAX_ADDR_SIZE + 2 + 2]
}
+292
View File
@@ -0,0 +1,292 @@
use std::convert::TryInto;
use std::io;
use std::time::Duration;
use rand::{thread_rng, Rng};
use sha1::{Digest, Sha1};
use stun::message::{Message, BINDING_REQUEST};
use tokio::net::UdpSocket;
use tokio::time::{sleep, timeout};
use super::*;
use crate::error::Result;
#[derive(Debug, Copy, Clone)]
enum Network {
Ipv4,
Ipv6,
}
impl Network {
/// Bind the UDP socket for the "remote".
async fn bind(self) -> io::Result<UdpSocket> {
match self {
Network::Ipv4 => UdpSocket::bind("0.0.0.0:0").await,
Network::Ipv6 => UdpSocket::bind("[::]:0").await,
}
}
/// Connect ip from the "remote".
fn connect_ip(self, port: u16) -> String {
match self {
Network::Ipv4 => format!("127.0.0.1:{port}"),
Network::Ipv6 => format!("[::1]:{port}"),
}
}
}
const TIMEOUT: Duration = Duration::from_secs(60);
#[tokio::test]
async fn test_udp_mux() -> Result<()> {
use std::io::Write;
env_logger::Builder::from_default_env()
.format(|buf, record| {
writeln!(
buf,
"{}:{} [{}] {} - {}",
record.file().unwrap_or("unknown"),
record.line().unwrap_or(0),
record.level(),
chrono::Local::now().format("%H:%M:%S.%6f"),
record.args()
)
})
.init();
// TODO: Support IPv6 dual stack. This works Linux and macOS, but not Windows.
#[cfg(all(unix, target_pointer_width = "64"))]
let udp_socket = UdpSocket::bind((std::net::Ipv6Addr::UNSPECIFIED, 0)).await?;
#[cfg(any(not(unix), not(target_pointer_width = "64")))]
let udp_socket = UdpSocket::bind((std::net::Ipv4Addr::UNSPECIFIED, 0)).await?;
let addr = udp_socket.local_addr()?;
log::info!("Listening on {}", addr);
let udp_mux = UDPMuxDefault::new(UDPMuxParams::new(udp_socket));
let udp_mux_dyn = Arc::clone(&udp_mux) as Arc<dyn UDPMux + Send + Sync>;
let udp_mux_dyn_1 = Arc::clone(&udp_mux_dyn);
let h1 = tokio::spawn(async move {
timeout(
TIMEOUT,
test_mux_connection(Arc::clone(&udp_mux_dyn_1), "ufrag1", addr, Network::Ipv4),
)
.await
});
let udp_mux_dyn_2 = Arc::clone(&udp_mux_dyn);
let h2 = tokio::spawn(async move {
timeout(
TIMEOUT,
test_mux_connection(Arc::clone(&udp_mux_dyn_2), "ufrag2", addr, Network::Ipv4),
)
.await
});
let all_results;
#[cfg(all(unix, target_pointer_width = "64"))]
{
// TODO: Support IPv6 dual stack. This works Linux and macOS, but not Windows.
let udp_mux_dyn_3 = Arc::clone(&udp_mux_dyn);
let h3 = tokio::spawn(async move {
timeout(
TIMEOUT,
test_mux_connection(Arc::clone(&udp_mux_dyn_3), "ufrag3", addr, Network::Ipv6),
)
.await
});
let (r1, r2, r3) = tokio::join!(h1, h2, h3);
all_results = [r1, r2, r3];
}
#[cfg(any(not(unix), not(target_pointer_width = "64")))]
{
let (r1, r2) = tokio::join!(h1, h2);
all_results = [r1, r2];
}
for timeout_result in &all_results {
// Timeout error
match timeout_result {
Err(timeout_err) => {
panic!("Mux test timedout: {timeout_err:?}");
}
// Join error
Ok(join_result) => match join_result {
Err(err) => {
panic!("Mux test failed with join error: {err:?}");
}
// Actual error
Ok(mux_result) => {
if let Err(err) = mux_result {
panic!("Mux test failed with error: {err:?}");
}
}
},
}
}
let timeout = all_results.iter().find_map(|r| r.as_ref().err());
assert!(
timeout.is_none(),
"At least one of the muxed tasks timedout {all_results:?}"
);
let res = udp_mux.close().await;
assert!(res.is_ok());
let res = udp_mux.get_conn("failurefrag").await;
assert!(
res.is_err(),
"Getting connections after UDPMuxDefault is closed should fail"
);
Ok(())
}
async fn test_mux_connection(
mux: Arc<dyn UDPMux + Send + Sync>,
ufrag: &str,
listener_addr: SocketAddr,
network: Network,
) -> Result<()> {
let conn = mux.get_conn(ufrag).await?;
// FIXME: Cleanup
let connect_addr = network
.connect_ip(listener_addr.port())
.parse::<SocketAddr>()
.unwrap();
let remote_connection = Arc::new(network.bind().await?);
log::info!("Bound for ufrag: {}", ufrag);
remote_connection.connect(connect_addr).await?;
log::info!("Connected to {} for ufrag: {}", connect_addr, ufrag);
log::info!(
"Testing muxing from {} over {}",
remote_connection.local_addr().unwrap(),
listener_addr
);
// These bytes should be dropped
remote_connection.send("Dropped bytes".as_bytes()).await?;
sleep(Duration::from_millis(1)).await;
let stun_msg = {
let mut m = Message {
typ: BINDING_REQUEST,
..Message::default()
};
m.add(ATTR_USERNAME, format!("{ufrag}:otherufrag").as_bytes());
m.marshal_binary().unwrap()
};
let remote_connection_addr = remote_connection.local_addr()?;
conn.send_to(&stun_msg, remote_connection_addr).await?;
let mut buffer = vec![0u8; RECEIVE_MTU];
let len = remote_connection.recv(&mut buffer).await?;
assert_eq!(buffer[..len], stun_msg);
const TARGET_SIZE: usize = 1024 * 1024;
// Read on the muxed side
let conn_2 = Arc::clone(&conn);
let mux_handle = tokio::spawn(async move {
let conn = conn_2;
let mut buffer = vec![0u8; RECEIVE_MTU];
let mut next_sequence = 0;
let mut read = 0;
while read < TARGET_SIZE {
let (n, _) = conn
.recv_from(&mut buffer)
.await
.expect("recv_from should not error");
assert_eq!(n, RECEIVE_MTU);
verify_packet(&buffer[..n], next_sequence);
conn.send_to(&buffer[..n], remote_connection_addr)
.await
.expect("Failed to write to muxxed connection");
read += n;
log::debug!("Muxxed read {}, sequence: {}", read, next_sequence);
next_sequence += 1;
}
});
let remote_connection_2 = Arc::clone(&remote_connection);
let remote_handle = tokio::spawn(async move {
let remote_connection = remote_connection_2;
let mut buffer = vec![0u8; RECEIVE_MTU];
let mut next_sequence = 0;
let mut read = 0;
while read < TARGET_SIZE {
let n = remote_connection
.recv(&mut buffer)
.await
.expect("recv_from should not error");
assert_eq!(n, RECEIVE_MTU);
verify_packet(&buffer[..n], next_sequence);
read += n;
log::debug!("Remote read {}, sequence: {}", read, next_sequence);
next_sequence += 1;
}
});
let mut sequence: u32 = 0;
let mut written = 0;
let mut buffer = vec![0u8; RECEIVE_MTU];
while written < TARGET_SIZE {
thread_rng().fill(&mut buffer[24..]);
let hash = sha1_hash(&buffer[24..]);
buffer[4..24].copy_from_slice(&hash);
buffer[0..4].copy_from_slice(&sequence.to_le_bytes());
let len = remote_connection.send(&buffer).await?;
written += len;
log::debug!("Data written {}, sequence: {}", written, sequence);
sequence += 1;
sleep(Duration::from_millis(1)).await;
}
let (r1, r2) = tokio::join!(mux_handle, remote_handle);
assert!(r1.is_ok() && r2.is_ok());
let res = conn.close().await;
assert!(res.is_ok(), "Failed to close Conn: {res:?}");
Ok(())
}
fn verify_packet(buffer: &[u8], next_sequence: u32) {
let read_sequence = u32::from_le_bytes(buffer[0..4].try_into().unwrap());
assert_eq!(read_sequence, next_sequence);
let hash = sha1_hash(&buffer[24..]);
assert_eq!(hash, buffer[4..24]);
}
fn sha1_hash(buffer: &[u8]) -> Vec<u8> {
let mut hasher = Sha1::new();
hasher.update(&buffer[24..]);
hasher.finalize().to_vec()
}
+116
View File
@@ -0,0 +1,116 @@
use std::sync::Arc;
use super::udp_mux::UDPMux;
use super::Error;
#[derive(Default, Clone)]
pub struct EphemeralUDP {
port_min: u16,
port_max: u16,
}
impl EphemeralUDP {
pub fn new(port_min: u16, port_max: u16) -> Result<Self, Error> {
let mut s = Self::default();
s.set_ports(port_min, port_max)?;
Ok(s)
}
pub fn port_min(&self) -> u16 {
self.port_min
}
pub fn port_max(&self) -> u16 {
self.port_max
}
pub fn set_ports(&mut self, port_min: u16, port_max: u16) -> Result<(), Error> {
if port_max < port_min {
return Err(Error::ErrPort);
}
self.port_min = port_min;
self.port_max = port_max;
Ok(())
}
}
/// Configuration for the underlying UDP network stack.
/// There are two ways to configure this Ephemeral and Muxed.
///
/// **Ephemeral mode**
///
/// In Ephemeral mode sockets are created and bound to random ports during ICE
/// gathering. The ports to use can be restricted by setting [`EphemeralUDP::port_min`] and
/// [`EphemeralEphemeralUDP::port_max`] in which case only ports in this range will be used.
///
/// **Muxed**
///
/// In muxed mode a single UDP socket is used and all connections are muxed over this single socket.
///
#[derive(Clone)]
pub enum UDPNetwork {
Ephemeral(EphemeralUDP),
Muxed(Arc<dyn UDPMux + Send + Sync>),
}
impl Default for UDPNetwork {
fn default() -> Self {
Self::Ephemeral(Default::default())
}
}
impl UDPNetwork {
fn is_ephemeral(&self) -> bool {
matches!(self, Self::Ephemeral(_))
}
fn is_muxed(&self) -> bool {
matches!(self, Self::Muxed(_))
}
}
#[cfg(test)]
mod test {
use super::EphemeralUDP;
#[test]
fn test_ephemeral_udp_constructor() {
assert!(
EphemeralUDP::new(3000, 2999).is_err(),
"EphemeralUDP should not allow invalid port range"
);
let e = EphemeralUDP::default();
assert_eq!(e.port_min(), 0, "EphemeralUDP should default port_min to 0");
assert_eq!(e.port_max(), 0, "EphemeralUDP should default port_max to 0");
}
#[test]
fn test_ephemeral_udp_set_ports() {
let mut e = EphemeralUDP::default();
assert!(
e.set_ports(3000, 2999).is_err(),
"EphemeralUDP should not allow invalid port range"
);
assert!(
e.set_ports(6000, 6001).is_ok(),
"EphemeralUDP::set_ports should allow valid port range"
);
assert_eq!(
e.port_min(),
6000,
"Ports set with `EphemeralUDP::set_ports` should be reflected"
);
assert_eq!(
e.port_max(),
6001,
"Ports set with `EphemeralUDP::set_ports` should be reflected"
);
}
}
+266
View File
@@ -0,0 +1,266 @@
#[cfg(test)]
mod url_test;
use std::borrow::Cow;
use std::convert::From;
use std::fmt;
use crate::error::*;
/// The type of server used in the ice.URL structure.
#[derive(PartialEq, Eq, Debug, Copy, Clone)]
pub enum SchemeType {
/// The URL represents a STUN server.
Stun,
/// The URL represents a STUNS (secure) server.
Stuns,
/// The URL represents a TURN server.
Turn,
/// The URL represents a TURNS (secure) server.
Turns,
/// Default public constant to use for "enum" like struct comparisons when no value was defined.
Unknown,
}
impl Default for SchemeType {
fn default() -> Self {
Self::Unknown
}
}
impl From<&str> for SchemeType {
/// Defines a procedure for creating a new `SchemeType` from a raw
/// string naming the scheme type.
fn from(raw: &str) -> Self {
match raw {
"stun" => Self::Stun,
"stuns" => Self::Stuns,
"turn" => Self::Turn,
"turns" => Self::Turns,
_ => Self::Unknown,
}
}
}
impl fmt::Display for SchemeType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
SchemeType::Stun => "stun",
SchemeType::Stuns => "stuns",
SchemeType::Turn => "turn",
SchemeType::Turns => "turns",
SchemeType::Unknown => "unknown",
};
write!(f, "{s}")
}
}
/// The transport protocol type that is used in the `ice::url::Url` structure.
#[derive(PartialEq, Eq, Debug, Copy, Clone)]
pub enum ProtoType {
/// The URL uses a UDP transport.
Udp,
/// The URL uses a TCP transport.
Tcp,
Unknown,
}
impl Default for ProtoType {
fn default() -> Self {
Self::Udp
}
}
// defines a procedure for creating a new ProtoType from a raw
// string naming the transport protocol type.
impl From<&str> for ProtoType {
// NewSchemeType defines a procedure for creating a new SchemeType from a raw
// string naming the scheme type.
fn from(raw: &str) -> Self {
match raw {
"udp" => Self::Udp,
"tcp" => Self::Tcp,
_ => Self::Unknown,
}
}
}
impl fmt::Display for ProtoType {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let s = match *self {
Self::Udp => "udp",
Self::Tcp => "tcp",
Self::Unknown => "unknown",
};
write!(f, "{s}")
}
}
/// Represents a STUN (rfc7064) or TURN (rfc7065) URL.
#[derive(Debug, Clone, Default)]
pub struct Url {
pub scheme: SchemeType,
pub host: String,
pub port: u16,
pub username: String,
pub password: String,
pub proto: ProtoType,
}
impl fmt::Display for Url {
fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
let host = if self.host.contains("::") {
"[".to_owned() + self.host.as_str() + "]"
} else {
self.host.clone()
};
if self.scheme == SchemeType::Turn || self.scheme == SchemeType::Turns {
write!(
f,
"{}:{}:{}?transport={}",
self.scheme, host, self.port, self.proto
)
} else {
write!(f, "{}:{}:{}", self.scheme, host, self.port)
}
}
}
impl Url {
/// Parses a STUN or TURN urls following the ABNF syntax described in
/// [IETF rfc-7064](https://tools.ietf.org/html/rfc7064) and
/// [IETF rfc-7065](https://tools.ietf.org/html/rfc7065) respectively.
pub fn parse_url(raw: &str) -> Result<Self> {
// work around for url crate
if raw.contains("//") {
return Err(Error::ErrInvalidUrl);
}
let mut s = raw.to_string();
let pos = raw.find(':');
if let Some(p) = pos {
s.replace_range(p..=p, "://");
} else {
return Err(Error::ErrSchemeType);
}
let raw_parts = url::Url::parse(&s)?;
let scheme = raw_parts.scheme().into();
let host = if let Some(host) = raw_parts.host_str() {
host.trim()
.trim_start_matches('[')
.trim_end_matches(']')
.to_owned()
} else {
return Err(Error::ErrHost);
};
let port = if let Some(port) = raw_parts.port() {
port
} else if scheme == SchemeType::Stun || scheme == SchemeType::Turn {
3478
} else {
5349
};
let mut q_args = raw_parts.query_pairs();
let proto = match scheme {
SchemeType::Stun => {
if q_args.count() > 0 {
return Err(Error::ErrStunQuery);
}
ProtoType::Udp
}
SchemeType::Stuns => {
if q_args.count() > 0 {
return Err(Error::ErrStunQuery);
}
ProtoType::Tcp
}
SchemeType::Turn => {
if q_args.count() > 1 {
return Err(Error::ErrInvalidQuery);
}
if let Some((key, value)) = q_args.next() {
if key == Cow::Borrowed("transport") {
let proto: ProtoType = value.as_ref().into();
if proto == ProtoType::Unknown {
return Err(Error::ErrProtoType);
}
proto
} else {
return Err(Error::ErrInvalidQuery);
}
} else {
ProtoType::Udp
}
}
SchemeType::Turns => {
if q_args.count() > 1 {
return Err(Error::ErrInvalidQuery);
}
if let Some((key, value)) = q_args.next() {
if key == Cow::Borrowed("transport") {
let proto: ProtoType = value.as_ref().into();
if proto == ProtoType::Unknown {
return Err(Error::ErrProtoType);
}
proto
} else {
return Err(Error::ErrInvalidQuery);
}
} else {
ProtoType::Tcp
}
}
SchemeType::Unknown => {
return Err(Error::ErrSchemeType);
}
};
Ok(Self {
scheme,
host,
port,
username: "".to_owned(),
password: "".to_owned(),
proto,
})
}
/*
fn parse_proto(raw:&str) ->Result<ProtoType> {
let qArgs= raw.split('=');
if qArgs.len() != 2 {
return Err(Error::ErrInvalidQuery.into());
}
var proto ProtoType
if rawProto := qArgs.Get("transport"); rawProto != "" {
if proto = NewProtoType(rawProto); proto == ProtoType(0) {
return ProtoType(Unknown), ErrProtoType
}
return proto, nil
}
if len(qArgs) > 0 {
return ProtoType(Unknown), ErrInvalidQuery
}
return proto, nil
}*/
/// Returns whether the this URL's scheme describes secure scheme or not.
#[must_use]
pub fn is_secure(&self) -> bool {
self.scheme == SchemeType::Stuns || self.scheme == SchemeType::Turns
}
}
+142
View File
@@ -0,0 +1,142 @@
use super::*;
#[test]
fn test_parse_url_success() -> Result<()> {
let tests = vec![
(
"stun:google.de",
"stun:google.de:3478",
SchemeType::Stun,
false,
"google.de",
3478,
ProtoType::Udp,
),
(
"stun:google.de:1234",
"stun:google.de:1234",
SchemeType::Stun,
false,
"google.de",
1234,
ProtoType::Udp,
),
(
"stuns:google.de",
"stuns:google.de:5349",
SchemeType::Stuns,
true,
"google.de",
5349,
ProtoType::Tcp,
),
(
"stun:[::1]:123",
"stun:[::1]:123",
SchemeType::Stun,
false,
"::1",
123,
ProtoType::Udp,
),
(
"turn:google.de",
"turn:google.de:3478?transport=udp",
SchemeType::Turn,
false,
"google.de",
3478,
ProtoType::Udp,
),
(
"turns:google.de",
"turns:google.de:5349?transport=tcp",
SchemeType::Turns,
true,
"google.de",
5349,
ProtoType::Tcp,
),
(
"turn:google.de?transport=udp",
"turn:google.de:3478?transport=udp",
SchemeType::Turn,
false,
"google.de",
3478,
ProtoType::Udp,
),
(
"turns:google.de?transport=tcp",
"turns:google.de:5349?transport=tcp",
SchemeType::Turns,
true,
"google.de",
5349,
ProtoType::Tcp,
),
];
for (
raw_url,
expected_url_string,
expected_scheme,
expected_secure,
expected_host,
expected_port,
expected_proto,
) in tests
{
let url = Url::parse_url(raw_url)?;
assert_eq!(url.scheme, expected_scheme, "testCase: {raw_url:?}");
assert_eq!(
expected_url_string,
url.to_string(),
"testCase: {raw_url:?}"
);
assert_eq!(url.is_secure(), expected_secure, "testCase: {raw_url:?}");
assert_eq!(url.host, expected_host, "testCase: {raw_url:?}");
assert_eq!(url.port, expected_port, "testCase: {raw_url:?}");
assert_eq!(url.proto, expected_proto, "testCase: {raw_url:?}");
}
Ok(())
}
#[test]
fn test_parse_url_failure() -> Result<()> {
let tests = vec![
("", Error::ErrSchemeType),
(":::", Error::ErrUrlParse),
("stun:[::1]:123:", Error::ErrPort),
("stun:[::1]:123a", Error::ErrPort),
("google.de", Error::ErrSchemeType),
("stun:", Error::ErrHost),
("stun:google.de:abc", Error::ErrPort),
("stun:google.de?transport=udp", Error::ErrStunQuery),
("stuns:google.de?transport=udp", Error::ErrStunQuery),
("turn:google.de?trans=udp", Error::ErrInvalidQuery),
("turns:google.de?trans=udp", Error::ErrInvalidQuery),
(
"turns:google.de?transport=udp&another=1",
Error::ErrInvalidQuery,
),
("turn:google.de?transport=ip", Error::ErrProtoType),
];
for (raw_url, expected_err) in tests {
let result = Url::parse_url(raw_url);
if let Err(err) = result {
assert_eq!(
err.to_string(),
expected_err.to_string(),
"testCase: '{raw_url}', expected err '{expected_err}', but got err '{err}'"
);
} else {
panic!("expected error, but got ok");
}
}
Ok(())
}
+31
View File
@@ -0,0 +1,31 @@
#[cfg(test)]
mod use_candidate_test;
use stun::attributes::ATTR_USE_CANDIDATE;
use stun::message::*;
/// Represents USE-CANDIDATE attribute.
#[derive(Default)]
pub struct UseCandidateAttr;
impl Setter for UseCandidateAttr {
/// Adds USE-CANDIDATE attribute to message.
fn add_to(&self, m: &mut Message) -> Result<(), stun::Error> {
m.add(ATTR_USE_CANDIDATE, &[]);
Ok(())
}
}
impl UseCandidateAttr {
#[must_use]
pub const fn new() -> Self {
Self
}
/// Returns true if USE-CANDIDATE attribute is set.
#[must_use]
pub fn is_set(m: &Message) -> bool {
let result = m.get(ATTR_USE_CANDIDATE);
result.is_ok()
}
}
@@ -0,0 +1,19 @@
use stun::message::BINDING_REQUEST;
use super::*;
use crate::error::Result;
#[test]
fn test_use_candidate_attr_add_to() -> Result<()> {
let mut m = Message::new();
assert!(!UseCandidateAttr::is_set(&m), "should not be set");
m.build(&[Box::new(BINDING_REQUEST), Box::new(UseCandidateAttr::new())])?;
let mut m1 = Message::new();
m1.write(&m.raw)?;
assert!(UseCandidateAttr::is_set(&m1), "should be set");
Ok(())
}
+175
View File
@@ -0,0 +1,175 @@
#[cfg(test)]
mod util_test;
use std::collections::HashSet;
use std::net::{IpAddr, SocketAddr};
use std::sync::Arc;
use stun::agent::*;
use stun::attributes::*;
use stun::integrity::*;
use stun::message::*;
use stun::textattrs::*;
use stun::xoraddr::*;
use tokio::time::Duration;
use util::vnet::net::*;
use util::Conn;
use crate::agent::agent_config::{InterfaceFilterFn, IpFilterFn};
use crate::error::*;
use crate::network_type::*;
pub fn create_addr(_network: NetworkType, ip: IpAddr, port: u16) -> SocketAddr {
/*if network.is_tcp(){
return &net.TCPAddr{IP: ip, Port: port}
default:
return &net.UDPAddr{IP: ip, Port: port}
}*/
SocketAddr::new(ip, port)
}
pub fn assert_inbound_username(m: &Message, expected_username: &str) -> Result<()> {
let mut username = Username::new(ATTR_USERNAME, String::new());
username.get_from(m)?;
if username.to_string() != expected_username {
return Err(Error::Other(format!(
"{:?} expected({}) actual({})",
Error::ErrMismatchUsername,
expected_username,
username,
)));
}
Ok(())
}
pub fn assert_inbound_message_integrity(m: &mut Message, key: &[u8]) -> Result<()> {
let message_integrity_attr = MessageIntegrity(key.to_vec());
Ok(message_integrity_attr.check(m)?)
}
/// Initiates a stun requests to `server_addr` using conn, reads the response and returns the
/// `XORMappedAddress` returned by the stun server.
/// Adapted from stun v0.2.
pub async fn get_xormapped_addr(
conn: &Arc<dyn Conn + Send + Sync>,
server_addr: SocketAddr,
deadline: Duration,
) -> Result<XorMappedAddress> {
let resp = stun_request(conn, server_addr, deadline).await?;
let mut addr = XorMappedAddress::default();
addr.get_from(&resp)?;
Ok(addr)
}
const MAX_MESSAGE_SIZE: usize = 1280;
pub async fn stun_request(
conn: &Arc<dyn Conn + Send + Sync>,
server_addr: SocketAddr,
deadline: Duration,
) -> Result<Message> {
let mut request = Message::new();
request.build(&[Box::new(BINDING_REQUEST), Box::new(TransactionId::new())])?;
conn.send_to(&request.raw, server_addr).await?;
let mut bs = vec![0_u8; MAX_MESSAGE_SIZE];
let (n, _) = if deadline > Duration::from_secs(0) {
match tokio::time::timeout(deadline, conn.recv_from(&mut bs)).await {
Ok(result) => match result {
Ok((n, addr)) => (n, addr),
Err(err) => return Err(Error::Other(err.to_string())),
},
Err(err) => return Err(Error::Other(err.to_string())),
}
} else {
conn.recv_from(&mut bs).await?
};
let mut res = Message::new();
res.raw = bs[..n].to_vec();
res.decode()?;
Ok(res)
}
pub async fn local_interfaces(
vnet: &Arc<Net>,
interface_filter: &Option<InterfaceFilterFn>,
ip_filter: &Option<IpFilterFn>,
network_types: &[NetworkType],
) -> HashSet<IpAddr> {
let mut ips = HashSet::new();
let interfaces = vnet.get_interfaces().await;
let (mut ipv4requested, mut ipv6requested) = (false, false);
for typ in network_types {
if typ.is_ipv4() {
ipv4requested = true;
}
if typ.is_ipv6() {
ipv6requested = true;
}
}
for iface in interfaces {
if let Some(filter) = interface_filter {
if !filter(iface.name()) {
continue;
}
}
for ipnet in iface.addrs() {
let ipaddr = ipnet.addr();
if !ipaddr.is_loopback()
&& ((ipv4requested && ipaddr.is_ipv4()) || (ipv6requested && ipaddr.is_ipv6()))
&& ip_filter
.as_ref()
.map(|filter| filter(ipaddr))
.unwrap_or(true)
{
ips.insert(ipaddr);
}
}
}
ips
}
pub async fn listen_udp_in_port_range(
vnet: &Arc<Net>,
port_max: u16,
port_min: u16,
laddr: SocketAddr,
) -> Result<Arc<dyn Conn + Send + Sync>> {
if laddr.port() != 0 || (port_min == 0 && port_max == 0) {
return Ok(vnet.bind(laddr).await?);
}
let i = if port_min == 0 { 1 } else { port_min };
let j = if port_max == 0 { 0xFFFF } else { port_max };
if i > j {
return Err(Error::ErrPort);
}
let port_start = rand::random::<u16>() % (j - i + 1) + i;
let mut port_current = port_start;
loop {
let laddr = SocketAddr::new(laddr.ip(), port_current);
match vnet.bind(laddr).await {
Ok(c) => return Ok(c),
Err(err) => log::debug!("failed to listen {}: {}", laddr, err),
};
port_current += 1;
if port_current > j {
port_current = i;
}
if port_current == port_start {
break;
}
}
Err(Error::ErrPort)
}
+10
View File
@@ -0,0 +1,10 @@
use super::*;
#[tokio::test]
async fn test_local_interfaces() -> Result<()> {
let vnet = Arc::new(Net::new(None));
let interfaces = vnet.get_interfaces().await;
let ips = local_interfaces(&vnet, &None, &None, &[NetworkType::Udp4, NetworkType::Udp6]).await;
log::info!("interfaces: {:?}, ips: {:?}", interfaces, ips);
Ok(())
}