Monitor your Wireless Networks with nzyme
Detect and physically locate threats using an easy to build and deploy sensor system.
The goal of nzyme is to be accessible to as many people as possible by being easy to understand, no matter your level of experience.
Install nzyme with the v1 documentation – and loose
There are a few gotchas in the documentation to get nzyme up and running.
I would like the install and configuration of nzyme be as easy as it’s use. The original goal of nzyme is to be accessible to as many people as possible – install on a SoC, usb WiFi, and go. The install script below intends to fix that.
How did I get this working?
The saving grace seems to be the german libpcap version.
There is also the option to build from scratch (I was unable to get this version to work):
- https://github.com/nzymedefense/nzyme/discussions/339#discussioncomment-521229
Install Wizard for nzyme - script below
Setting up your system to be able to use nzyme
First you have to make sure to have a working WiFi USB card (read the requirements), and then pick how you’re deploying this:
Raspberry pi, AML-S905X-CC (Le Potato), Old Laptop
If you’re installing this on a SoC, it takes about 7min to load the card with a debian/raspbian distribution, uncompress the system, reboot, and load the new system.
After the script below runs for an additional 13min+, it should be a total of about 20min+
Nzyme Install Wizard
There are a few gotchas in the nzyme v1 documentation to get up and running.
I would like the install and configuration of nzyme be as easy as it’s use. This install script intends to fix that.
Install nzyme with this wizard
Use the install script to help guide you through the nzyme install process on Debian systems.
The goal of nzyme is to be accessible to as many people as possible by being easy to understand, no matter your level of experience.
Install with this command:
1
wget -O nzyme-install-wizard.sh https://raw.githubusercontent.com/MarcusHoltz/nzyme-install-wizard/main/nzyme-install-wizard.sh; chmod +x nzyme-install-wizard.sh; sudo bash nzyme-install-wizard.sh
nzyme v1 install script
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
#!/bin/bash
###
########################################################
##### What does this script do? #####
########################################################
## Uses: https://v1.nzyme.org/ ##
## Installs a copy of nzyme on a Debian distro ##
#######################################################
## This script requires sudo or root for use ##
#######################################################
## Setup dependencies for nzyme: ##
## postgresql wireless-tools python3 ##
## Install specific versions required for use: ##
## openjdk-11-jre-headless libpcap0.8_1.8.1-3+deb9u1 ##
#######################################################
#######################################################
###### B E G I N S C R I P T ######
#######################################################
### REQUIREMENTS: Check distro, version, and if ran as root
#######################################################
read -d . VERSION < /etc/debian_version
if [[ "${VERSION[0]}" == "11" || "${VERSION[0]}" == "12" ]]; then
if [ "$EUID" -ne 0 ]
then echo "Please run with sudo permissions or as root"
exit 1
fi
else
echo -e "Debian is not on one of the required versions: 11 (Bullseye) or 12 (Bookworm).\nExiting the script.\n\n"
exit 1
fi
###
#######################################################
### SET SYSTEM VALUES: Architecture, IP, first WiFi device found, if none found assign foo
#######################################################
export MY_SYS_PROC_TYPE=$(dpkg --print-architecture)
export MY_IP=$(ip a | grep 'inet ' | awk '{print $2;}' | tail -n +2 | cut -d/ -f1)
export MY_WIFI=$(ip -br l | awk '$1 !~ "lo|vir|eth|ens|enp" { print $1}')
[ -z "$MY_WIFI" ] && export MY_WIFI=wlan-card-not-found
###
#######################################################
### HELP SECTION: Check if config file exists, possibly previously run -- ask if they need help
#######################################################
if [ -f "/etc/nzyme/nzyme.conf" ]; then
echo -e "You've re-run this script.\nWhat do you want to do now that nzyme is installed?"
PS3='Please type one of the numbers above and hit enter: '
options=("Reinstall nzyme." "Uninstall nzyme." "I am having trouble. Please setup the nzyme-fix-it-on-reboot script." "Display what IP address nzyme is hosted at." "Read the nzyme logs." "Quit this laucher")
select opt in "${options[@]}"
do
case $opt in
"Reinstall nzyme.")
echo -e -n "\nOk then,\nREINSTALLING NZYME....";
for ((i=1; i<=18; i++)); do
echo -n "."
sleep 0.35
done
echo -e "\n\n"
break
;;
"Uninstall nzyme.")
echo -e "#####################################\nUNINSTALLING NZYME AND COMPONENTS\n#####################################"
sudo apt remove -y nzyme postgresql libpcap0.8 openjdk-11-jre-headless > /dev/null 2>&1
sudo rm -rf /etc/nzyme/* > /dev/null 2>&1
sudo rm /etc/apt/preferences.d/openjdk-pin /etc/apt/preferences.d/libpcap > /dev/null 2>&1
echo -e "\nUNINSTALL COMPLETE\nYou can re-run this script anytime to reinstall."
exit 0
break
;;
"I am having trouble. Please setup the nzyme-fix-it-on-reboot script.")
echo "Setting up the nzyme-fix-it-on-reboot script..."
sudo printf "sleep 20; sudo systemctl stop nzyme; sudo systemctl status nzyme; sudo systemctl daemon-reload; sudo ifconfig $MY_WIFI down; sudo iwconfig $MY_WIFI mode monitor; sudo ifconfig $MY_WIFI up; sudo setcap cap_net_raw,cap_net_admin=eip /usr/lib/jvm/java-1.11.0-openjdk-$MY_SYS_PROC_TYPE/bin/java; sudo systemctl start nzyme; sudo systemctl status nzyme;\n" | sudo tee -a /etc/nzyme/nzyme-reboot.sh > /dev/null 2>&1
sudo chmod 755 /etc/nzyme/nzyme-reboot.sh
crontab -l | { cat; echo "@reboot /etc/nzyme/nzyme-reboot.sh"; } | crontab -
echo -e "\nYou will need to add the following REBOOT crontab for the script to take effect on next reboot.\n"
echo "Copy and Paste this line:"
echo -e "crontab -l | { cat; echo "@reboot /etc/nzyme/nzyme-reboot.sh"; } | crontab -"
exit 0
break
;;
"Display what IP address nzyme is hosted at.")
echo -e "\nPlease remember, you can access the web interface at: http://$MY_IP"; sleep 2;
exit 0
break
;;
"Read the nzyme logs.")
tail -n 200 /var/log/nzyme/nzyme.log
exit 0
break
;;
"Quit this laucher")
exit 0
break
;;
*) echo "invalid option $REPLY";;
esac
done
fi
###
#######################################################
### USER INPUT: db password / web password
#######################################################
echo -e "**************************************************************************\n Welcome to nzyme installer, please follow instructions below\n**************************************************************************\nAnswer each prompt to generate the config.\n----------------------------------------------------"
sleep 1;
echo -e "Enter password for 'admin' on http web interface ($MY_IP):"
read -s data_admin_password
export data_admin_password_hash=$(echo -n $data_admin_password | sha256sum | cut -d ' ' -f1)
echo -e "\n(this next password can be anything you like, you wont need to enter it again)\nEnter password for backend postgresql database:"
read -s data_postgres_password
sleep .5;
echo -e "***********************************************************************************\n Begin Install -=Nzyme config questions complete=- Up to 15min wait \n***********************************************************************************"
sleep 1;
echo -e "##################################################\n## Once install is complete, reboot is needed ##\n##################################################"
###
#######################################################
### MAIN FUNCTION: Wrap this as a function so we can control output later
#######################################################
main_function() {
### Update and install requirements
sudo apt update && sudo apt upgrade -y && sudo apt install -y wireless-tools python3
sudo ln -s /usr/bin/python3 /usr/bin/python
sudo apt install -y postgresql libpcap0.8
### Install Java based on distro version
read -d . VERSION < /etc/debian_version
if [[ "${VERSION[0]}" == "12" ]]; then
printf "deb http://deb.debian.org/debian oldstable main" | sudo tee -a /etc/apt/sources.list
sudo apt update
sudo touch /etc/apt/preferences.d/openjdk-pin
printf "Package: openjdk-11-jre-headless\nPin: release n=oldstable\nPin-Priority: 1001" | sudo tee /etc/apt/preferences.d/openjdk-pin
sudo apt-cache policy openjdk-11-jre-headless
fi
sudo apt install -y openjdk-11-jre-headless
### Re-install this libpcap version that allows monitor mode to work
sudo apt purge -y libpcap0.8
wget https://ftp.uni-siegen.de/debian/debian-security/pool/updates/main/libp/libpcap/libpcap0.8_1.8.1-3%2Bdeb9u1_$MY_SYS_PROC_TYPE.deb
sudo dpkg -i libpcap0.8_*
sudo rm libpcap0.8_*
sudo touch /etc/apt/preferences.d/libpcap
printf "Package: libpcap0.8\nPin: version 1.8.1-3*\nPin-Priority: 999" | sudo tee /etc/apt/preferences.d/libpcap
sudo apt update && sudo apt upgrade -y && sudo apt autoremove -y
### Install and enable latest Version 1 release of nzyme
wget https://assets.nzyme.org/releases/nzyme-1.2.2.deb
sudo dpkg -i nzyme-1.2*.deb
sudo rm nzyme-1*.deb
sudo apt --fix-broken install
sudo systemctl enable nzyme
### Set up the database with the default db/user with user's password
sudo -u postgres psql -c "create database nzyme;"
sudo -u postgres psql -c "create user nzyme with encrypted password '$data_postgres_password';"
sudo -u postgres psql -c "grant all privileges on database nzyme to nzyme;"
sudo -u postgres psql -d nzyme -c "GRANT ALL ON schema public TO nzyme"
sudo -u postgres psql -d nzyme -c "GRANT ALL on all tables in schema public TO postgres;"
sudo -u postgres psql -d nzyme -c "GRANT ALL on all tables in schema public TO nzyme;"
sudo -u postgres psql -c "\c nzyme"
sudo -u postgres psql -c "GRANT ALL ON SCHEMA public TO nzyme;"
### Configure the required vaules in the .conf to work
sudo cp /etc/nzyme/nzyme.conf.example /etc/nzyme/nzyme.conf
sudo sed -i "s/admin_password_hash:.*/admin_password_hash: $data_admin_password_hash/" /etc/nzyme/nzyme.conf
sudo sed -i "s/YOUR_PASSWORD/$data_postgres_password/" /etc/nzyme/nzyme.conf
sudo sed -i 's/python3\.8/python/' /etc/nzyme/nzyme.conf
sudo sed -i "s/rest_listen_uri:.*/rest_listen_uri: \"http:\/\/$MY_IP:80\/\"/" /etc/nzyme/nzyme.conf
sudo sed -i "s/http_external_uri:.*/http_external_uri: \"http:\/\/$MY_IP:80\/\"/" /etc/nzyme/nzyme.conf
sudo sed -i "s/wlx00c0ca971201.*/$MY_WIFI/" /etc/nzyme/nzyme.conf
}
###
#######################################################
### MANAGE TERMINAL OUTPUT: Take the function's output and send it somewhere else
#######################################################
if [ -z $TERM ]; then
# if not run via terminal, log everything into a log file
main_function 2>&1 >> /var/log/nzyme/script_for_nzyme.log
else
# if run via terminal, DONT output to screen
main_function > /dev/null 2>&1
fi
###
#######################################################
### FIN: Congratulations, we're done!
#######################################################
echo -e "\nTest after reboot with: \ntail -n 200 /var/log/nzyme/nzyme.log"
echo -e "\n######################################\n## Install complete, reboot needed ##\n######################################"