-
-
Notifications
You must be signed in to change notification settings - Fork 493
Compilation
(tested on Debian Sid and Ubuntu 18 and 20. It may fail on other distributions.)
Make sure you have a correctly configured Go >= 1.16 environment and then:
# install dependencies
sudo apt-get install git libnetfilter-queue-dev libpcap-dev protobuf-compiler python3-pip pyqt5-dev-tools qttools5-dev-tools qtbase5-dev qtchooser qt5-qmake qtbase5-dev-tools python3-pyqt5.qtsql python3-notify2
go install google.golang.org/protobuf@latest
go install google.golang.org/protobuf/cmd/protoc-gen-go@latest
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@latest
export GOPATH=~/go #you may want to change this if your Go directory is different
export PATH=$PATH:$GOPATH/bin
# This step is optional if your distribution already packages these 2 libs.
# You can try to install them with: sudo apt install python3-grpcio python3-protobuf
python3 -m pip install --user grpcio-tools qt-material
# clone the repository
git clone https://github.com/evilsocket/opensnitch
cd opensnitch
# compile && install
make
sudo make install
# enable opensnitchd as a systemd service and start the UI
sudo systemctl enable --now opensnitchd
opensnitch-ui &
Note for Fedora users
There is no lrelease
binary on Fedora, which is needed to build the UI properly. There is a "lrelease-qt5
binary, which is part of the package "qt5-linguist".
To fix the UI not building properly on Fedora, symlink /usr/lib64/qt5/bin/lrelease-qt5 to /usr/local/bin/lrelease:
sudo ln -s /usr/lib64/qt5/bin/lrelease-qt5 /usr/local/bin/lrelease
Then it should build properly.
Note for Ubuntu 22.xx users
You may need to install qttools5-dev
package and set and environment variable:
#set env var for QT version
export QT_SELECT=qt5
#install qt tools which includes lrelease
sudo apt install qttools5-dev
More info: #773
Follow the instructions described here: https://github.com/evilsocket/opensnitch/tree/master/ebpf_prog
Additionally, you can use this script to easyly build the modules: https://github.com/evilsocket/opensnitch/blob/master/utils/packaging/build_modules.sh
Daemon
The daemon
is implemented in Go and needs to run as root in order to interact with the Netfilter packet queue, edit
iptables rules and so on, in order to compile it you will need to install the protobuf-compiler
, libpcap-dev
and libnetfilter-queue-dev
packages on your system, then just:
cd daemon
make
You can then install it as a systemd service by doing:
sudo make install
The new opensnitchd
service will log messages to /var/log/opensnitchd.log
, save the rules under /etc/opensnitchd/rules
and connect to the default UI service socket unix:///tmp/osui.sock
.
As of v1.0.0-rc2 version, it has been tested on Debian >= 8, Ubuntu >= 14, Fedora >= 23, MXLinux 19, Arch, and OpenSuse 15/Tumbleweed.
Note: If you run into troubles installing the UI from the sources, either use the deb/rpm packages to resolve the dependencies or install the needed packages from your distribution package manager (especially pyqt5).
The user interface is a Python 3 software running as a gRPC
server on a unix socket, in order to install its dependencies type the following:
cd ui
sudo pip3 install -r requirements.txt
Tip 1: If pip fails installing pyqt5, try changing the pyqt5 version in requirements.txt
to install pyqt5==5.10 or other version that work for you.
Tip 2: On newer distros, you may need to upgrade pip (python3 -m pip install --upgrade --user pip
) #305
The UI is pip installable itself:
sudo pip3 install .
This will install the opensnitch-ui
command on your system (you can auto startup it by cp opensnitch_ui.desktop ~/.config/autostart/
).
Tip 3: If you get errors about unicode-slugify, try these commands
sudo apt install locales
sudo locale-gen en_US.UTF-8
export LC_CTYPE=en_US.UTF-8
Once you installed both the daemon and the UI, you can enable the opensnitchd
service to run at boot time:
sudo systemctl enable opensnitchd
And run it with:
sudo service opensnitchd start
While the UI can be started just by executing the opensnitch-ui
command as your regular user.
Please help us make this wiki better.
How to submit changes: https://github.com/evilsocket/opensnitch/blob/wiki/README.md
- Installation
- Getting started
- Configuration
- Compilation
- GUI translations
- FAQs and common errors
- Examples OpenSnitch in action