Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/beac0n/ruroco

Ruroco is a tool that lets you execute commands on a server by sending UDP packets. The commands are configured on the server side, so the client does not define what is going to be executed, it only picks from existing commands.
https://github.com/beac0n/ruroco

Last synced: 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/beac0n/ruroco
Owner: beac0n
License: mit
Created: 2024-05-12T07:42:40.000Z (6 months ago)
Default Branch: master
Last Pushed: 2024-08-24T12:43:06.000Z (3 months ago)
Last Synced: 2024-08-24T17:26:42.909Z (3 months ago)
Language: Rust
Homepage:
Size: 207 KB
Stars: 241
Watchers: 3
Forks: 5
Open Issues: 3
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.md
- Security: SECURITY.md

Awesome Lists containing this project

awesome-repositories - beac0n/ruroco - Ruroco is a tool that lets you execute commands on a server by sending UDP packets. The commands are configured on the server side, so the client does not define what is going to be executed, it only (Rust)

README

[![build](https://github.com/beac0n/ruroco/actions/workflows/rust.yml/badge.svg)](https://github.com/beac0n/ruroco/actions)
[![release](https://img.shields.io/github/v/release/beac0n/ruroco?style=flat&labelColor=1C2C2E&color=C96329&logo=GitHub&logoColor=white)](https://github.com/beac0n/ruroco/releases)
[![codecov](https://codecov.io/gh/beac0n/ruroco/graph/badge.svg?token=H7ABBHYYWT)](https://codecov.io/gh/beac0n/ruroco)

# ruroco - RUn RemOte COmmand

ruroco is a tool that lets you execute commands on a server by sending UDP packets.

the tool consist of 3 binaries:

- `client`: runs on your notebook/computer and sends the UDP packets
- `server`: receives the UDP packets and makes sure that they are valid
- `commander`: runs the command encoded by the data of the UDP packet if it's valid

The commands are configured on the server side, so the client does not define what is going to be executed, it only
picks from existing commands.

## security

- client sends UDP packet to server, server never responds to it -> **port-scanning** does not help an adversary
- data sent from client to server is **encrypted** using **RSA**
- client only defines command to execute, **commands are saved on server** -> client can pick command but not define it
- run server software in such a way so that it uses **as little operating system rights** as possible
- **replay protection** by adding every packet that the server received to a blocklist
- (WIP) DoS protection

# use cases

## single packet authorization (SPA)

If you host a server on the web, you know that you'll get lots of brute-force attacks on (at least) the SSH port of your
server. While using good practices in securing your server will keep you safe from such attacks, these attacks are quite
annoying (filling up logs) and even if you secured your server correctly, you will still not be 100% safe, see
https://www.schneier.com/blog/archives/2024/04/xz-utils-backdoor.html or
https://www.qualys.com/2024/07/01/cve-2024-6387/regresshion.txt

Completely blocking all traffic to all ports that do not have to be open at all times can reduce the attack surface.
But blocking the SSH port completely will make SSH unusable for that server.

This is where ruroco comes in. Ruroco can execute a command that opens up the SSH port for just a short amount of time,
so that you can ssh into your server. Afterward ruruco closes the SSH port again. To implement this use case with
ruroco, you have to use a configuration similar to the one shown below:

```toml
address = "0.0.0.0:8080" # address the ruroco serer listens on, if systemd/ruroco.socket is not used
config_dir = "/etc/ruroco/" # path where the configuration files are saved

[commands]
# open ssh, but only for the IP address where the request came from
open_ssh = "ufw allow from $RUROCO_IP proto tcp to any port 22"
# close ssh, but only for the IP address where the request came from
close_ssh = "ufw delete allow from $RUROCO_IP proto tcp to any port 22"
```

If you have configured ruroco on server like that and execute the following client side command

```shell
ruroco-client send --address host.domain:8080 --private-pem-path /path/to/ruroco_private.pem --command open_ssh --deadline 5
```

the server will validate that the client is authorized to execute that command by using public-key cryptography (RSA)
and will then execute the command defined in the config above under "open_ssh". The `--deadline` argument means that the
command has to be started on the server within 5 seconds after executing the command.

This gives you the ability to effectively only allow access to the SSH port, for only the IP that the UDP packet was
sent from, if you want to connect to your server. Of course, you should also do all the other security hardening tasks
you would do if the SSH port would be exposed to the internet.

You can define any number of commands you wish, by adding more commands to configuration file.

## Enabling webservice

You may run a webservice like https://github.com/filebrowser/filebrowser on your server, which you do not want to
publicly expose. If you use nginx as a reverse proxy, you can use ruroco to enable or disable services:

```toml
address = "0.0.0.0:8080" # address the ruroco serer listens on, if systemd/ruroco.socket is not used
config_dir = "/etc/ruroco/" # path where the configuration files are saved

[commands]
# disable file browser nginx config file and reload nginx
disable_file_browser = "mv /etc/nginx/conf.d/https_file_browser.conf /etc/nginx/conf.d/https_file_browser.conf_disabled && nginx -s reload"
# enable file browser nginx config file and reload nginx
enable_file_browser = "mv /etc/nginx/conf.d/https_file_browser.conf_disabled /etc/nginx/conf.d/https_file_browser.conf && nginx -s reload"
```

If you have configured ruroco on server like that and execute the following client side command

```shell
ruroco-client send --address host.domain:8080 --private-pem-path /path/to/ruroco_private.pem --command enable_file_browser --deadline 5
```

the file browser nginx config will be enabled and nginx reloaded, effectively making the file browser accessible.

# setup

download binaries from the [releases page](https://github.com/beac0n/ruroco/releases) or build them yourself by running

```shell
make release
```

you can find the binaries in `target/release/client`, `target/release/server` and `target/release/commander`

## client

### self-build

See make goal `install_client`. This builds the project and copies the client binary to `/usr/local/bin/ruroco-client`

### pre-build

Download the `client-v..-x86_64-linux` binary from https://github.com/beac0n/ruroco/releases/latest
and move it to `/usr/local/bin/ruroco-client`

## server

### self-build

See make goal `install_server`, which

- Builds the project
- Copies the binaries to `/usr/local/bin/`
- Adds a `ruroco` user if it does not exist yet
- Copies the systemd service files and config files to the right places
- Assigns correct file permissions to the systemd and config files
- Enables and starts the systemd services
- After running the make goal, you have to
- generate a RSA key and copy it to the right place
- setup the `config.toml`

### pre-build

1. Download the `server-v..-x86_64-linux` and `commander-v..-x86_64-linux`
binaries from https://github.com/beac0n/ruroco/releases/latest and move them to
`/usr/local/bin/ruroco-server` and `/usr/local/bin/ruroco-commander`.
2. Make sure that the binaries have the minimal permission sets needed:
1. `sudo chmod 500 /usr/local/bin/ruroco-server`
2. `sudo chmod 100 /usr/local/bin/ruroco-commander`
3. `sudo chown ruroco:ruroco /usr/local/bin/ruroco-server`
3. Create the `ruroco` user: `sudo useradd --system ruroco --shell /bin/false`
4. Install the systemd service files from the `systemd` folder: `sudo cp ./systemd/* /etc/systemd/system`
5. Create `/etc/ruroco/config.toml` and define your config and commands, e.g.:
```toml
address = "127.0.0.1:8080" # address the ruroco serer listens on, if systemd/ruroco.socket is not used
config_dir = "/etc/ruroco/" # path where the configuration files are saved

[commands]
# commands will be added here - see configuration chapter
```
1. Make sure that the configuration file has the minimal permission set
needed: `sudo chmod 400 /etc/ruroco/config.toml`
2. N.B. If you edit the [commands] in `/etc/ruroco/config.toml` then restart ruroco-commander
6. Since new systemd files have been added, reload the daemon: `sudo systemctl daemon-reload`
7. Enable the systemd services:
1. `sudo systemctl enable ruroco.service`
2. `sudo systemctl enable ruroco-commander.service`
3. `sudo systemctl enable ruroco.socket`
8. Start the systemd services
1. `sudo systemctl start ruroco-commander.service`
2. `sudo systemctl start ruroco.socket`
3. `sudo systemctl start ruroco.service`

# configuration

## generate and deploy rsa key

- run `ruroco-client gen` to generate two files: `ruroco_private.pem` and `ruroco_public.pem`
- move `ruroco_public.pem` to `/etc/ruroco/ruroco_public.pem` on server
- save `ruroco_private.pem` to `~/.config/ruroco/ruroco_private.pem` on client

## update config

Add commands to config `/etc/ruroco/config.toml` on server. The new config file **could** look like this:

```toml
address = "127.0.0.1:8080" # address the ruroco serer listens on, if systemd/ruroco.socket is not used
config_dir = "/etc/ruroco/" # path where the configuration files are saved

# architecture

## overview

The service consists of three parts:

- `client`
- binary that is executed on your local host
- `server`
- service that runs on a remote host where you wish to execute the commands on
- exposed to the internet
- has minimal rights to receive and decrypt data and to communicate with the commander
- `commander`
- daemon service that runs on the same host as the server
- not exposed to the internet
- has all the rights it needs to run the commands that are passed to it

```text
┌────────────────┐ ┌────────────────┐
│ │ │ │
│ ┌────────┐ │ │ ┌────────────┐ │
│ │ Client ├───┼─┤►│ Server │ │
│ └────────┘ │ │ └─────┬──────┘ │
│ │ │ │ │
│ │ │ ┌─────▼──────┐ │
│ │ │ │ Commander │ │
│ │ │ └────────────┘ │
│ Local Host │ │ Remote Host │
└────────────────┘ └────────────────┘
```

## execution

Whenever a user sends a command via the client, the following steps are executed

1. client concatenates the current timestamp (in nanoseconds) with the command name (e.g. "default"), encrypts data with
the private key and sends the encrypted data via UDP to the server
2. server receives the UDP package (does **not** answer), decrypts it with the public key and validates its content
3. if the content is valid, the server sends the command name to the commander. If the content is invalid an error
message is logged
4. commander receives the command name and executes the command if the command is defined in the configuration

```text
┌───
│ Client │
└───
│

│
│
│
│
│
│
│
┌────
│alt │ │
├────┘
│if is │
│invalid │
│ │
│ │
├─
│else │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
│ │
└────
``` ──────┐ ┌─────────┐ ┌───────────┐ │ Server │ │ Commander │ ─┬────┘ └────┬────┘ └─────┬─────┘ │ │ │ Encrypt and send │ │ ├─────────────────────►│ │ │ data via UDP │ │ │ Decrypt and validate │ ├─────────────┐ data │ │ │ │ │◄────────────┘ │ │ │ │ │ │ │ ┬────┼──────────────────────┼─────────────────────────┼───────────────────┐ │ │ │ │ │ Log error │ │ ├─────────────┐ │ │ │ │ │ │ │◄────────────┘ │ │ │ │ │ ── ──┤ ── ── ── ── ── ─┤ ── ── ── ── ── ── ├── ── ── ── ── │ │ │ │ │ Send command name │ │ ├────────────────────────►│ │ │ │ │ │ │ Check if command │ │ │ is valid │ │ ├───────────────┐ │ │ │ │ │ │ │◄──────────────┘ │ │ │ │ ┌────┬────┼─────────────────────────┼───────────────────┤ │alt │ │ │ Execute command │ ├────┘ │ ├───────────────┐ │ │if is │ │ │ │ │valid │ │◄──────────────┘ │ │ │ │ │ ├─ ── ──┤ ── ── ── ── ── ── ├─ ── ── ── ── │ │else │ │Log Error │ │ │ ├───────────────┐ │ │ │ │ │ │ │ │ │◄──────────────┘ │ │ │ │ │ ─────┴────────────┴─────────┴─────────────────────────┴───────────────────┘