Rkvm Save

Virtual KVM switch for Linux machines

Project README

rkvm

rkvm is a tool for sharing keyboard and mouse across multiple Linux and Windows machines. It is based on a client/server architecture, where server is the machine controlling mouse and keyboard and relays events (mouse move, key presses, ...) to clients.

Switching between different clients is done by a configurable keyboard shortcut.

Features

  • TLS encrypted by default, backed by OpenSSL on Linux and SChannel on Windows (should be already installed on your machine by default)
  • Display server agnostic
  • Low overhead

Requirements

  • Rust 1.48 and higher

Linux requirements

  • The uinput Linux kernel module, enabled by default in most distros
  • libevdev
  • OpenSSL

Building

Run cargo build --release. Note that you need to have libevdev installed on your system, otherwise the build will fail.

Generating certificates

The repo contains a simple Rust program, certificate-gen, to aid certificate generation. Run cargo run --bin certificate-gen -- --help to see and usage.

Setting up

First, build the project and generate certificates. Client accepts certificates both in PEM and DER formats. On Linux, you either need to run either of the programs as root or make /dev/uinput accessible by the user it runs as.

By default, the programs reads their config files from /etc/rkvm/{server,client}.toml on Linux and C:/rkvm/{server,client}.toml on Windows, this can be changed by passing the path as the first command line parameter.

The example directory contains example configurations and systemd service files.

Why rkvm and not Barrier/Synergy?

The author of this program had a lot of problems with said programs, namely his keyboard layout (Czech) not being supported properly, which stems from the fact that the programs send characters which it then attempts to translate back into keycodes. rkvm takes a different approach to solving this problem and doesn't assume anything about your keyboard layout -- it sends raw keycodes only.

Additionally, rkvm doesn't even know or care about X, Wayland or any display server that might be in use, because it uses the uinput API with libevdev to read and generate input events.

Regardless, if you want a working and stable solution for crossplatform keyboard and mouse sharing, you should probably use either of the above mentioned programs for the time being.

Limitations

  • Only keyboard and relative mouse events work (that is, can be forwarded to clients)
  • Clients only are supported on Windows, however, server support will be added in the future

Project structure

  • server - server application code
  • client - client application code
  • input - handles reading from and writing to input devices
  • net - network protocol encoding and decoding
  • certificate-gen - certificate generation tool

Bincode is used for encoding of messages on the network and Tokio as an asynchronous runtime.

Contributions

All contributions, that includes both PRs and issues, are very welcome.

License

MIT

Open Source Agenda is not affiliated with "Rkvm" Project. README Source: htrefil/rkvm
Stars
191
Open Issues
21
Last Commit
2 weeks ago
Repository
License
MIT

Open Source Agenda Badge

Open Source Agenda Rating