TheLanc3/lan-mouse
1
0
Fork 0
mirror of https://github.com/feschber/lan-mouse.git synced 2026-04-04 09:21:27 +03:00
Code Issues Packages Projects Releases Wiki Activity

update README

Browse Source
This commit is contained in:
Ferdinand Schober
2024-11-09 12:35:45 +01:00
parent 682a7b65bd
commit 3913fa8a38
1 changed files with 8 additions and 16 deletions
Download Patch File Download Diff File Expand all files Collapse all files

18
README.md
View File

@@ -4,7 +4,7 @@ It allows for using multiple PCs via a single set of mouse and keyboard.
This is also known as a Software KVM switch. This is also known as a Software KVM switch.
Goal of this project is to be an open-source alternative to proprietary tools like [Synergy 2/3](https://symless.com/synergy), [Share Mouse](https://www.sharemouse.com/de/) Goal of this project is to be an open-source alternative to proprietary tools like [Synergy 2/3](https://symless.com/synergy), [Share Mouse](https://www.sharemouse.com/de/)
and an alternative to other open source tools like [Deskflow](https://github.com/deskflow/deskflow) or [Input Leap](https://github.com/input-leap) (Synergy fork). and other open source tools like [Deskflow](https://github.com/deskflow/deskflow) or [Input Leap](https://github.com/input-leap) (Synergy fork).
Focus lies on performance, ease of use and a maintainable implementation that can be expanded to support additional backends for e.g. Android, iOS, ... in the future. Focus lies on performance, ease of use and a maintainable implementation that can be expanded to support additional backends for e.g. Android, iOS, ... in the future.
@@ -19,15 +19,10 @@ Focus lies on performance, ease of use and a maintainable implementation that ca
</picture> </picture>
> [!WARNING] ## Encryption
> DISCLAIMER:
> Until [#200](https://github.com/feschber/lan-mouse/pull/200) is merged, all network traffic is **unencrypted** and sent in **plaintext**!
>
> A malicious actor with access to the network could read input data or send input events with spoofed IPs to take control over a device.
>
> Therefore you should only use this tool in your local network with trusted devices.
> I take no responsibility for any security breaches!
Lan Mouse encrypts all network traffic using the DTLS implementation provided by [WebRTC.rs](https://github.com/webrtc-rs/webrtc).
There are currently no mitigations in place for timing side-channel attacks.
## OS Support ## OS Support
@@ -356,7 +351,7 @@ Where `left` can be either `left`, `right`, `top` or `bottom`.
- [x] Libei Input Capture - [x] Libei Input Capture
- [x] MacOS Input Capture - [x] MacOS Input Capture
- [x] Windows Input Capture - [x] Windows Input Capture
- [ ] *Encryption* (WIP) - [x] Encryption
- [ ] X11 Input Capture - [ ] X11 Input Capture
- [ ] Latency measurement and visualization - [ ] Latency measurement and visualization
- [ ] Bandwidth usage measurement and visualization - [ ] Bandwidth usage measurement and visualization
@@ -408,6 +403,3 @@ The following sections detail the emulation and capture backends provided by lan
- `windows`: Backend for input capture on Windows. - `windows`: Backend for input capture on Windows.
- `macos`: Backend for input capture on MacOS. - `macos`: Backend for input capture on MacOS.
- `x11`: TODO (not yet supported) - `x11`: TODO (not yet supported)