Skip to content

Commit

Permalink
update readme
Browse files Browse the repository at this point in the history
  • Loading branch information
akiroz committed Jan 28, 2024
1 parent 290a65b commit 935007d
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ IP Tunneling over MQTT

Designed to allow remote access for IoT/Edge devices connected to an existing MQTT network.

### Working Mechanism

IP packets are sent as MQTT payloads on 2 topics:
- Client -> Server: `<topic>` (payload prepended by tunnel ID)
- Server -> Client: `<topic>/<base64-tunnel-id>`
Expand All @@ -20,10 +22,18 @@ The MQTT connection is assumed to be secure & have authentication mechanisms in
Zika offers no extra layers of security on top of the MQTT connection,
it's possible capture/inject arbitrary IP packets to/from the target device if the MQTT connection/broker is compromised.

### Configuration
### Config & Run

See [zika_config.example.toml](zika_config.example.toml)

Copy `zika-client` and `zika_config.toml` to the same directory

Run `zika-client`

- Linux: `setcap cap_net_admin+eip zika-client`
- macOS: requires `sudo`
- Windows: run as Administrator, requires `wintun.dll` in same directory

### Building

```
Expand Down

0 comments on commit 935007d

Please sign in to comment.