Skip to content

Latest commit

 

History

History
72 lines (49 loc) · 2.36 KB

README.md

File metadata and controls

72 lines (49 loc) · 2.36 KB
Raw

RACTF Code Ingest server

This is the code ingest and execution server for RACTF.

This runs code in a time-limited, offline docker container and returns the results.

It's written to meet a specific set of requirements and work in conjunction with a webapp front end.

Prerequsites & Setup

  • Python 3.8 or above with pip
  • Pyenv installed (optional)
  • Poetry installed
  • Debian/Ubuntu Desktop/Server
  • Docker installed on host

If you don't have the required python version (3.9.7 as of writing), install pyenv with basic checkout. Then install the build dependencies, which is listed on the wiki

Add the following lines to your ~/.bashrc file (assuming you haven't done so from the pyenv guide):

# Pyenv installation

if [[ -z "$VIRTUAL_ENV" ]]; then
    export PYENV_ROOT="$HOME/.pyenv"
    export PATH="$PYENV_ROOT/bin:$PATH"
    eval "$(pyenv init --path)"
fi

If you have a different shell, follow the pyenv install guide. Pyenv isn't mandatory if you have the correct version.

Next, install poetry with their suggested way, as this is necessary for the installation.

curl -sSL https://raw.githubusercontent.com/python-poetry/poetry/master/get-poetry.py | python

Note: Poetry requires python so if you don't have python2 you can soft link python3: sudo ln -sf $(which python3) /usr/local/bin/python

Installation & Deployment

Clone the repo and change directory into it:

Builds are available from PyPi, just do python3 -m pip install code-ingest.

Deploy with ingest_server and run basic tests with ingest_tests.

Alternatively if you want to install inside an env:

git clone https://gitlab.com/ractf/code-ingest.git
cd code-ingest

# If you're deploying for real use.
poetry install --no-dev
poetry shell

# <Set your environment variables here>
# Remove the docker image every time you want it to be rebuilt.
docker rmi sh3llcod3/code-ingest
ingest_server

# If you're interested in editing the program
poetry install
poetry shell
python -m code_ingest

You should be able to use any virtualenv.

The full documentation of environment variables, endpoints, etc can be found in the docs