GINI Toolkit Version 5.0.0

The GINI Toolkit is free software. Please see the file COPYING for copyright information.

Basic Installation - Ubuntu 18.04 LTS

GINI runs on Python2.7, so you may need to install if it does not come with your distribution. On Ubuntu 18.04, run the following command:

sudo apt-get install python-minimal

• Cloning the repository
• Installing dependencies
• Docker installation
• Setting up SSH
• Plugins
  • Wireshark
  • Open vSwitch
• Building Gini components
• Post-installation

Cloning the repository

Run these commands to clone the repository and set up your environment variable to run Gini components:

git clone --recursive https://github.com/citelab/gini5

# cd into directory where you cloned Gini
# Add an environment variable called "GINI_HOME" which link to that directory
# Append $GINI_HOME/bin to your PATH environment variable and apply the change
cd gini5
echo "export GINI_HOME=$PWD" >> ~/.bashrc
echo 'export PATH=$PATH:$GINI_HOME/bin' >> ~/.bashrc
source $HOME/.bashrc

Installing dependencies

To install GINI, you need the following libraries and applications:

sudo apt-get install -y	libreadline-dev \
			python-lxml \
			python-qt4 \
			scons \
			screen \
			g++ \
			docker.io \
			openssh-server \
			build-essential \
			xterm \
			libcanberra-gtk-module \
			libcanberra-gtk3-module \
			iproute2 \
			bridge-utils

python -m pip install ipaddress

# Run these commands to download and compile libslack from source
wget http://libslack.org/download/libslack-0.6.tar.gz
tar xzf libslack-0.6.tar.gz
cd libslack-0.6
make
sudo make install

# Allow non-root users to use `ip` and `brctl` commands:
sudo chmod a+s /sbin/brctl
sudo chmod a+s /sbin/ip

Docker installation

Consult the official Docker documentation on how to install Docker on your machine: https://docs.docker.com/install/

Gini is running Docker containers under the hood with the assumption that your user account has enough permission to use Docker. After installing, run the command docker run hello-world, if there is an error message saying that you don't have permission to run Docker, please follow the instructions here: https://docs.docker.com/install/linux/linux-postinstall/, or run these two commands:

sudo groupadd docker
sudo usermod -aG docker $USER

The first command was creating a docker group assuming that it did not exist before. The second command was adding your account to the docker group. After running this command, you may need to log out of your account and log back in (or reboot).

To pull the Docker images that Gini uses, run the script available under scripts:

./scripts/setup_docker.sh

Setting up SSH

Change directory to $HOME/.ssh and run ssh-keygen -t rsa in that directory. When prompted, keep pressing ENTER to select the default options. Finally, run cat id_rsa.pub >> authorized_keys

Plugins

Wireshark

Please follow the instruction in https://www.wireshark.org/docs/wsug_html_chunked/ChapterBuildInstall.html. In the best case, you only need to run:

sudo add-apt-repository ppa:wireshark-dev/stable
sudo apt-get update
sudo apt-get install -y wireshark

To use wireshark to capture packets as a normal user, you need to add yourself to wireshark group on your machine, similar to Docker. Run these commands:

sudo dpkg-reconfigure wireshark-common
sudo usermod -a -G wireshark $USER

then try to log out and re-login for the change to take effect.

You can refer to this page for more information: https://wiki.wireshark.org/CaptureSetup/CapturePrivileges

Open vSwitch

Reference : http://docs.openvswitch.org/en/latest/intro/install/

If you want to try out Software Defined Networking (SDN) feature of Gini, first install two packages openvswitch-switch and openvswitch-common:

sudo apt-get install -y openvswitch-switch \
			openvswitch-common

# And add setuid bit to the programs that Gini uses:
sudo chmod a+s /usr/bin/ovs-vsctl
sudo chmod a+s /usr/bin/ovs-ofctl
sudo chmod a+s /usr/bin/ovs-docker

Building Gini components

In the Gini directory, run the following commands:

scons
scons install

This should install GINI unless you get some errors in one or more of the above steps. Once installed, issue the gbuilder command to start the graphical interface.

Post-installation

• Check docker is properly installed by running docker ps. You will see a listing of docker containers that are running for that command. Because there are none running at this time, you will see an empty list with a header.
• Check the ssh passwordless login by running ssh localhost. You should be able to login without password with the proper key setup. If not, check the SSH key configuration.
• Optionally, if you want to enable mouse scrollwheel when using the devices' terminal in GBuilder, add this line to ~/.screenrc:

termcapinfo xterm* ti@:te@

Notes

GINI should work on all Linux distributions with the required dependencies installed. If you have any problems on any distribution and/or release, please e-mail [email protected], or open an issue on this repository.