Let room users manage their own return routes
This commit is contained in:
1 parent
5cb8367d12
commit
0eb1d03a16
15 files changed
+1098
-54
No files matched your search
@@ -193,8 +193,8 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Routing | [`get/set/del flood.channel.scope.require*`](cli_commands.md#require-valid-incoming-scopes-only-on-selected-channels) | Repeater | Yes | Yes | Yes |
|
||||
| Routing | [`get/set/del flood.rule*`; `get/set/del flood.filter*`; `get/set/del flood.filter.blacklist*`](cli_commands.md#change-persistent-flood-rules-in-the-field) | Repeater; `flood.rule`/`flood.filter` also on FULL ESP32 room server (no blacklist) | Yes | Yes | Yes |
|
||||
| Routing | [`get/set/del flood.moderation*`](cli_commands.md#moderate-flood-group-text-by-channel-sender-and-source-path) | Repeater | Yes | Yes | Yes |
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes |
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater or [room user](room_services.md#your-own-return-routes), own remote-client context | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater or [room user](room_services.md#your-own-return-routes), own remote-client context | Yes | Yes | Yes |
|
||||
| ACL | [`setperm <pubkey> <permissions>`](cli_commands.md#add-update-or-remove-permissions-for-a-companion) | Repeater, room server, or sensor | Yes | Yes | Yes |
|
||||
| ACL | [`get acl [page]`](cli_commands.md#view-the-current-acl) | Repeater, room server, or sensor; admin over LoRa | Yes | Yes | Yes |
|
||||
| ACL | [`get/set allow.read.only`](cli_commands.md#view-or-change-this-room-servers-read-only-flag) | Room server | Yes | Yes | No |
|
||||
@@ -369,8 +369,8 @@ should use command `0x42`. See [Companion radio binary protocol](companion_proto
|
||||
| Routing | [`get/set/del flood.channel.scope.require*`](cli_commands.md#require-valid-incoming-scopes-only-on-selected-channels) | Repeater role handler | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set/del flood.rule*`; `get/set/del flood.filter*`; `get/set/del flood.filter.blacklist*`](cli_commands.md#change-persistent-flood-rules-in-the-field) | Repeater role handler; `flood.rule`/`flood.filter` also on FULL ESP32 room server (no blacklist) | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set/del flood.moderation*`](cli_commands.md#moderate-flood-group-text-by-channel-sender-and-source-path) | Repeater role handler | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set outpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater or [room user](room_services.md#your-own-return-routes), own remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| Routing | [`get/set altpath`](halo_keymind_settings.md#direct-path-overrides) | Repeater or [room user](room_services.md#your-own-return-routes), own remote-client context | Yes | Yes | Yes | Yes | Yes |
|
||||
| ACL | [`setperm <pubkey> <permissions>`](cli_commands.md#add-update-or-remove-permissions-for-a-companion) | Repeater, room server, or sensor | Yes | Yes | Yes | Yes | Yes |
|
||||
| ACL | [`get acl [page]`](cli_commands.md#view-the-current-acl) | Repeater, room server, or sensor; admin over LoRa | Yes | Yes | Yes | Yes | Yes |
|
||||
| ACL | [`get/set allow.read.only`](cli_commands.md#view-or-change-this-room-servers-read-only-flag) | Room server | Yes | Yes | No | Yes | Yes |
|
||||
|
||||
@@ -2452,6 +2452,9 @@ The pin number is the Arduino pin number used by that target (the normal GPIO nu
|
||||
|
||||
**Notes:**
|
||||
- These commands require remote client context and update the caller's ACL entry.
|
||||
- Room Server readers and writers may manage their own `outpath` and `altpath`
|
||||
without administrator permission. See [room return routes](room_services.md#your-own-return-routes)
|
||||
for the command list, session persistence and alternate delivery behavior.
|
||||
- `get outpath path` reports the reciprocal `PAYLOAD_TYPE_PATH` received after
|
||||
the caller's latest flood login without changing the selected output route.
|
||||
Because that packet is asynchronous, an immediate query can report
|
||||
|
||||
@@ -203,6 +203,10 @@ rows; an unpaged local serial query prints the full table.
|
||||
`outpath` and `altpath` apply to the current remote client ACL entry. They need
|
||||
remote client context, so they are not useful from the local serial CLI.
|
||||
|
||||
Room Server also supports these commands for readers and writers, restricted
|
||||
to the caller's own routes. See [room return routes](room_services.md#your-own-return-routes)
|
||||
for session persistence, alternate chat delivery and client requirements.
|
||||
|
||||
Set paths with comma-separated hop hashes. Each hop must be `2`, `4`, or `6`
|
||||
hex characters, and all hops in one path must use the same width. Hex input is
|
||||
case-insensitive. Replies use uppercase hex and retain the commas, so the value
|
||||
|
||||
@@ -101,6 +101,65 @@ Rejected posts do not enter the retry cache.
|
||||
Changing to a different identity creates a different user. These controls
|
||||
complement forwarding and airtime policies.
|
||||
|
||||
## Your own return routes
|
||||
|
||||
Room readers, writers and administrators can use a private CLI request to
|
||||
inspect or change the room's route back to their own radio:
|
||||
|
||||
~~~text
|
||||
get outpath
|
||||
get outpath path
|
||||
set outpath A1B2C3,D4E5F6
|
||||
set outpath path
|
||||
set outpath direct
|
||||
set outpath clear
|
||||
set outpath flood
|
||||
get altpath
|
||||
set altpath 71CE82,BA09F0
|
||||
set altpath direct
|
||||
set altpath clear
|
||||
~~~
|
||||
|
||||
Each hop is 2, 4 or 6 hexadecimal characters; all hops in a path use the same
|
||||
width. `direct` means zero repeaters. `clear` enables normal discovery again.
|
||||
`outpath flood` forces flood replies until you change that selection. The
|
||||
first command word is case-insensitive, and an optional Companion CLI prefix
|
||||
is preserved in the reply.
|
||||
|
||||
These commands always affect the authenticated requesting identity. They
|
||||
cannot select another user's public key, change room settings, grant roles,
|
||||
read passwords or run other administrative commands. Active public read-only
|
||||
sessions can manage their own routes too. Bans still block access, and management
|
||||
roles alone do not grant room-user command access.
|
||||
|
||||
Commands require encrypted CLI message framing. Typing them as ordinary room
|
||||
chat posts sends chat text instead. Use a CLI-capable client; this feature does
|
||||
not grant administrator status or add a non-admin command screen to the mobile
|
||||
app. No new protocol message type is required.
|
||||
|
||||
`get outpath path` reports the reciprocal route observed after the most recent
|
||||
flood login. It can return `> path pending` during its one-minute observation
|
||||
window. The read does not change the selected route; ordinary room discovery
|
||||
still learns a live route automatically. A route explicitly selected while
|
||||
waiting is protected from the delayed login PATH. `set outpath path` selects
|
||||
the observed route, or leaves the selection unchanged if none is available.
|
||||
|
||||
When the primary and alternate routes are valid and different, chat, topic
|
||||
updates and CLI/data replies send one encrypted copy along each route. The
|
||||
primary owns ACK tracking, catch-up and retries; the alternate has no separate
|
||||
retry loop. Identical routes send one copy. A missing packet for the alternate
|
||||
does not prevent primary delivery. A flood primary does not send an alternate
|
||||
copy; `altpath flood` also disables that secondary copy, so prefer
|
||||
`set altpath clear` when removing it. Keep-alive and post ACKs retain their
|
||||
existing primary-route behavior.
|
||||
|
||||
Routes are saved for already-retained ACL entries, including explicit readers
|
||||
and writers and password-created administrators. Ordinary guest-password and
|
||||
public-reader sessions keep route selections only for the current session;
|
||||
changing a route never makes their permissions permanent. Failed saves restore
|
||||
the previous route and report an error. Repeating an unchanged selection or an
|
||||
exact request retry does not cause another settings write.
|
||||
|
||||
## Local Wi-Fi chat on ESP32
|
||||
|
||||
ESP32 Room Server images with WebConfig have an offline browser room page.
|
||||
|
||||
Reference in new issue
Block a user