TorchAPI.com is powered by Qonzer! Check them out for the ultimate game server hosting experience.

Author: lord_kesh

Latest Version: v1.0.8

Cumulative Downloads: 7

Bush Trimmer

A Bandaid Fix Plugin for Keen's Failures

Bush Trimmer is a ban enhancement plugin for Space Engineers Torch servers intended to improve ban security. Unfortunately, Keen's API contains a number of insecurities that have allowed individuals to un-ban themselves from dedicated servers. Most notable among these individuals was a player named "BushFiend".

During a series of repeated attacks across the SE multiplayer community, "BushFiend" was able to utilize a headless game client to un-ban himself from and disrupt multiple servers across the Space Engineers ecosystem. This plugin aims to prevent similar attacks by adding an additional layer of security around ban enforcement.

On top of the existing ban system, this plugin allows server owners to define a hard ban list. Steam IDs for players that are hard banned are populated within a file in the server instance. Whenever a player joins the server, the player's steam ID is checked against the hard bans. If a violation is found, the player is immediately kicked.

Installation

IMPORTANT, following install, start your torch server once. This will auto-generate an empty Bushtrimmer.cfg.

Normal Users

Follow the Torch Guide for installing plugins, located here: https://wiki.torchapi.com/en/plugin-development

Usage

Before configuring, install the plugin and one it once to auto-generate a template config. You should now be able to edit it from either the Torch GUI, or through any text editor.

Configuration

Sample Config

<?xml version="1.0" encoding="utf-8"?>
<BushtrimmerConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BannedPlayers>
    <BannedPlayer>
      <SteamId>[SteamID 64 here]</SteamId>
      <PlayerName>[Player Name Here]</PlayerName>
    </BannedPlayer>
  </BannedPlayers>
  <PluginEnabled>true</PluginEnabled>
  <CommandKey>your_custom_cmd_key</CommandKey>
</BushtrimmerConfig>

For each banned player you wish to add, add an addional <BannedPlayer></BannedPlayer> block. You can toggle the plugin on/off using the PluginEnabled field. Additionally, you can specify a CommandKey, which will add an additional layer of security around running plugin commands in the console.

Admin Commands

Bushtrimmer allows server admins to run a set of admin commands in the console, enabling hard bans to occur during server runtime.

Listing Active Bans

To list any active hard bans, run the following: !trimmer list [cmd_key from config, if set]

Adding a Ban

You can hard-ban a player by running the following: !trimmer add [SteamID64] [PlayerName] [cmd_key, if set]

Removing a ban

You can remove a ban by running the following: !trimmer remove [SteamID64] [cmd_key from config, if set]

# Bush Trimmer

## A Bandaid Fix Plugin for Keen's Failures

Bush Trimmer is a ban enhancement plugin for Space Engineers Torch servers intended to improve ban security.
Unfortunately, Keen's API contains a number of insecurities that have allowed individuals to un-ban themselves
from dedicated servers. Most notable among these individuals was a player named "BushFiend".

During a series of repeated attacks across the SE multiplayer community, "BushFiend" was able to utilize
a headless game client to un-ban himself from and disrupt multiple servers across the Space Engineers 
ecosystem. This plugin aims to prevent similar attacks by adding an additional layer of security around
ban enforcement.

On top of the existing ban system, this plugin allows server owners to define a hard ban list. Steam IDs for
players that are hard banned are populated within a file in the server instance. Whenever a player joins the
server, the player's steam ID is checked against the hard bans. If a violation is found, the player is 
immediately kicked.

# Installation

> **IMPORTANT**, following install, start your torch server once. This will auto-generate an empty `Bushtrimmer.cfg`.

## Normal Users

Follow the Torch Guide for installing plugins, located here: ```https://wiki.torchapi.com/en/plugin-development```

# Usage

Before configuring, install the plugin and one it once to auto-generate a template config. You should now be able to edit it from either the Torch GUI, or through any text editor.

## Configuration

Sample Config

```xml
<?xml version="1.0" encoding="utf-8"?>
<BushtrimmerConfig xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
  <BannedPlayers>
    <BannedPlayer>
      <SteamId>[SteamID 64 here]</SteamId>
      <PlayerName>[Player Name Here]</PlayerName>
    </BannedPlayer>
  </BannedPlayers>
  <PluginEnabled>true</PluginEnabled>
  <CommandKey>your_custom_cmd_key</CommandKey>
</BushtrimmerConfig>
```

For each banned player you wish to add, add an addional ```<BannedPlayer></BannedPlayer>``` block.
You can toggle the plugin on/off using the `PluginEnabled` field.
Additionally, you can specify a `CommandKey`, which will add an additional layer of security around running plugin commands
in the console.

## Admin Commands

Bushtrimmer allows server admins to run a set of admin commands in the console, enabling hard bans to occur during server runtime.

### Listing Active Bans

To list any active hard bans, run the following:
```!trimmer list [cmd_key from config, if set]```

### Adding a Ban

You can hard-ban a player by running the following:
```!trimmer add [SteamID64] [PlayerName] [cmd_key, if set]```

### Removing a ban

You can remove a ban by running the following:
```!trimmer remove [SteamID64] [cmd_key from config, if set]```

Ways to support the author directly