GitHub/pbot
3
0
Fork 0
mirror of https://github.com/pragma-/pbot.git synced 2024-11-22 03:49:29 +01:00
Code Issues Projects Releases Wiki Activity

Add doc/VirtualMachine.md framework [WIP]

Browse Source
This commit is contained in:
Pragmatic Software 2020-01-11 14:36:36 -08:00
parent d9fa465bb7
commit 06935a199a
1 changed files with 37 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

37
doc/VirtualMachine.md Normal file
View File

@ -0,0 +1,37 @@
# Virtual Machine
## About
PBot can interact with a virtual machine to safely execute arbitrary user-submitted
system commands and code.
This document will guide you through installing and configuration a virtual machine
by using the widely available [libvirt](https://libvirt.org) project tools, such as
`virt-install`, `virsh`, `virt-manager`, `virt-viewer`, etc.
Though there are many, many tutorials and walk-throughs available for these tools,
this guide will demonstrate the necessary `virt-install` and `virsh` commands to
configure the virtual machine.
You may install a guest Linux distribution of your choice. Any of the recent popular
Linux distributions should suffice. This guide will use Fedora Rawhide because
playing around with the latest bleeding-edge software is fun!
Then we will show you the necessary commands to configure the Linux guest system
to be able to communicate with PBot. Commands and code snippets are sent over a
virtual serial cable. We'll show you how to set that up.
We'll also show a few tips and tricks to help secure the virtual machine against
malicious user-submitted commands.
Let's get started.
## Creating a new virtual machine
## Configuring the virtual machine
## Installing Linux in the virtual machine
## Configuring Linux for PBot Communication
## Hardening the PBot virtual machine