mirror of https://github.com/infosecn1nja/HELK.git
Modified the script for HELK 6.3.0 & added available memory check
Dev Dua
parent
7277b9ee2c
commit
5a2a3911cf
129
helk_update.sh
129
helk_update.sh
|
|
@ -1,53 +1,39 @@
|
|||
#!/bin/bash
|
||||
|
||||
# HELK script: helk_update.sh
|
||||
# HELK script description: Update and Rebuild HELK
|
||||
# HELK build version: 0.9 (Alpha)
|
||||
# HELK ELK version: 6.3.0
|
||||
# Script Author: Dev Dua (@devdua)
|
||||
# License: BSD 3-Clause
|
||||
|
||||
if [[ $EUID -ne 0 ]]; then
|
||||
echo "[HELK-UPDATE-INFO] YOU MUST BE ROOT TO RUN THIS SCRIPT!!!"
|
||||
exit 1
|
||||
fi
|
||||
|
||||
LOGFILE="/var/log/helk-update.log"
|
||||
HELK_IMAGES=$(docker images --format "{{.Repository}}" | grep "cyb3rward0g/helk-")
|
||||
REBUILD_NEEDED=0
|
||||
check_min_requirements(){
|
||||
systemKernel="$(uname -s)"
|
||||
echo "[HELK-UPDATE-INFO] HELK being hosted on a $systemKernel box"
|
||||
if [ "$systemKernel" == "Linux" ]; then
|
||||
AVAILABLE_MEMORY=$(free -hm | awk 'NR==2{printf "%.f\t\t", $7 }')
|
||||
|
||||
echo -e "[HELK-UPDATE-INFO] CHECKING FOR UPDATES..."
|
||||
|
||||
if [ -x "$(command -v python)" ]; then
|
||||
echo "Python is available" >> $LOGFILE
|
||||
else
|
||||
echo "Python is not available" >> $LOGFILE
|
||||
apt-get update >> $LOGFILE 2>&1 && apt-get -qqy install python >> $LOGFILE 2>&1
|
||||
ERROR=$?
|
||||
if [ $ERROR -ne 0 ]; then
|
||||
echoerror "Could not install Python (Error Code: $ERROR)."
|
||||
exit 1
|
||||
fi
|
||||
echo "Python installed." >> $LOGFILE
|
||||
fi
|
||||
|
||||
for image in $HELK_IMAGES
|
||||
do
|
||||
TAG=$(sudo docker images | grep $image | awk '{print $2}')
|
||||
echo -e "Tag for $image --> $TAG" >> $LOGFILE 2>&1
|
||||
REMOTE_TAG="$(curl --silent "https://hub.docker.com/v2/repositories/$image/tags/" | python -c 'import sys, json; print (json.load(sys.stdin)["results"][0]["name"])')"
|
||||
[ "$TAG" = "$REMOTE_TAG" ] ; SHOULD_UPDATE=$?
|
||||
if [ $SHOULD_UPDATE == "0" ]; then
|
||||
echo "[+] $image is up to date"
|
||||
else
|
||||
REBUILD_NEEDED=1
|
||||
echo -e "[+] Newer tag for $image found --> $REMOTE_TAG (current: $TAG)."
|
||||
echo -e "[HELK-UPDATE-INFO] Stopping HELK and pulling new image for $image."
|
||||
sed -i "s|$image:$TAG|$image:$REMOTE_TAG|" docker-compose.yml
|
||||
ERROR=$?
|
||||
if [ $ERROR -ne 0 ]; then
|
||||
echo "Could not update the HELK (Error Code: $ERROR)."
|
||||
echo "This could happen if 2 or more images for $image with different tags exist together. Please delete the image not being used by a running HELK container and try again."
|
||||
# Only checking Available Memory requirements and not Disk, as old images are deleted and replaced with updated ones.
|
||||
if [ "${AVAILABLE_MEMORY}" -ge "12" ] ; then
|
||||
echo "[HELK-UPDATE-INFO] Available Memory: ${AVAILABLE_MEMORY}"
|
||||
else
|
||||
echo "[HELK-UPDATE-ERROR] YOU DO NOT HAVE ENOUGH AVAILABLE MEMORY"
|
||||
echo "[HELK-UPDATE-ERROR] Available Memory: ${AVAILABLE_MEMORY}"
|
||||
echo "[HELK-UPDATE-ERROR] Check the requirements section in our installation Wiki"
|
||||
echo "[HELK-UPDATE-ERROR] Installation Wiki: https://github.com/Cyb3rWard0g/HELK/wiki/Installation"
|
||||
mv docker-compose.yml.bak docker-compose.yml >> $LOGFILE 2>&1
|
||||
rm docker-compose.yml.bak >> $LOGFILE 2>&1
|
||||
exit 1
|
||||
fi
|
||||
docker-compose stop >> $LOGFILE 2>&1
|
||||
docker-compose down >> $LOGFILE 2>&1
|
||||
docker rmi -f "$image:$TAG" >> $LOGFILE 2>&1
|
||||
else
|
||||
echo "[HELK-UPDATE-INFO] Error retrieving memory info for $systemKernel. Make sure you have at least 12GB of available memory!"
|
||||
fi
|
||||
done
|
||||
}
|
||||
|
||||
get_jupyter_token(){
|
||||
echo "[HELK-UPDATE-INFO] Waiting for HELK services and Jupyter Server to start.."
|
||||
|
|
@ -58,26 +44,77 @@ get_jupyter_token(){
|
|||
echo "[HELK-UPDATE-INFO] New Jupyter token: $jupyter_token"
|
||||
}
|
||||
|
||||
if [ $REBUILD_NEEDED == 1 ]; then
|
||||
docker-compose build >> $LOGFILE 2>&1
|
||||
LOGFILE="/var/log/helk-update.log"
|
||||
HELK_IMAGES=$(docker images --format "{{.Repository}}" | grep "cyb3rward0g/helk-")
|
||||
# Extension images not hosted by cyb3rward0g
|
||||
EXTENSION_IMAGES=" thomaspatzke/helk-sigma"
|
||||
REBUILD_NEEDED=0
|
||||
|
||||
echo -e "[HELK-UPDATE-INFO] CHECKING FOR UPDATES..."
|
||||
|
||||
if [ -x "$(command -v python)" ]; then
|
||||
echo "Python is available" >> $LOGFILE
|
||||
else
|
||||
echo "Python is not available" >> $LOGFILE
|
||||
apt-get -qq update >> $LOGFILE 2>&1 && apt-get -qqy install python >> $LOGFILE 2>&1
|
||||
ERROR=$?
|
||||
if [ $ERROR -ne 0 ]; then
|
||||
echo "Could not build HELK via docker-compose (Error Code: $ERROR)."
|
||||
echo "Get more details in /var/log/helk-update.log"
|
||||
echoerror "Could not install Python (Error Code: $ERROR)."
|
||||
exit 1
|
||||
fi
|
||||
echo "Python installed." >> $LOGFILE
|
||||
fi
|
||||
|
||||
# ****** Running HELK ***********
|
||||
echo "[HELK-UPDATE-INFO] Running HELK via docker-compose"
|
||||
docker-compose up -d --force-recreate --always-recreate-deps >> $LOGFILE 2>&1
|
||||
for image in $HELK_IMAGES$EXTENSION_IMAGES
|
||||
do
|
||||
TAG=$(sudo docker images | grep $image | awk '{print $2}')
|
||||
SIZE=$(sudo docker images | grep $image | awk '{print $7}')
|
||||
echo -e "Local tag for $image --> $TAG | Size : $SIZE" >> $LOGFILE 2>&1
|
||||
REMOTE_TAG="$(curl --silent "https://hub.docker.com/v2/repositories/$image/tags/" | python -c 'import sys, json; print (json.load(sys.stdin)["results"][0]["name"])')"
|
||||
|
||||
REMOTE_FULLSIZE="$(curl --silent "https://hub.docker.com/v2/repositories/$image/tags/" | python -c 'import sys, json; print (json.load(sys.stdin)["results"][0]["full_size"])')"
|
||||
MB=$((1024*1024))
|
||||
REMOTE_FULLSIZE_MB=$(($REMOTE_FULLSIZE/$MB))
|
||||
echo -e "Remote tag for $image --> $REMOTE_TAG | Size : $REMOTE_FULLSIZE_MB MB\n" >> $LOGFILE 2>&1
|
||||
|
||||
[ "$TAG" = "$REMOTE_TAG" ] ; SHOULD_UPDATE=$?
|
||||
if [ $SHOULD_UPDATE == "0" ]; then
|
||||
echo "[+] $image is up to date"
|
||||
else
|
||||
REBUILD_NEEDED=1
|
||||
docker rmi -f "$image:$TAG" >> $LOGFILE 2>&1
|
||||
cp docker-compose.yml docker-compose.yml.bak
|
||||
sed -i "s|$image:$TAG|$image:$REMOTE_TAG|" docker-compose.yml >> $LOGFILE 2>&1
|
||||
ERROR=$?
|
||||
if [ $ERROR -ne 0 ]; then
|
||||
echo "[!] Could not update the HELK (Error Code: $ERROR)."
|
||||
echo "This could happen if 2 or more images for $image with different tags exist together. Please delete the image not being used by a running HELK container and try again."
|
||||
mv docker-compose.yml.bak docker-compose.yml >> $LOGFILE 2>&1
|
||||
rm docker-compose.yml.bak >> $LOGFILE 2>&1
|
||||
exit 1
|
||||
fi
|
||||
echo -e "[+] Newer tag for $image found --> $REMOTE_TAG (current: $TAG) | Size --> $REMOTE_FULLSIZE_MB MB (current expanded size: $SIZE)."
|
||||
fi
|
||||
done
|
||||
|
||||
if [ $REBUILD_NEEDED == 1 ]; then
|
||||
echo -e "[HELK-UPDATE-INFO] Stopping HELK and starting update..."
|
||||
docker-compose kill >> $LOGFILE 2>&1
|
||||
check_min_requirements
|
||||
|
||||
echo "[HELK-UPDATE-INFO] Rebuilding HELK via docker-compose"
|
||||
docker-compose up --build -d -V --force-recreate --always-recreate-deps >> $LOGFILE 2>&1
|
||||
ERROR=$?
|
||||
if [ $ERROR -ne 0 ]; then
|
||||
echo "Could not run HELK via docker-compose (Error Code: $ERROR)."
|
||||
exit 1
|
||||
fi
|
||||
|
||||
get_jupyter_token
|
||||
sleep 180
|
||||
echo -e "\n[HELK-UPDATE-INFO] YOUR HELK HAS BEEN UPDATED!"
|
||||
rm docker-compose.yml.bak >> $LOGFILE 2>&1
|
||||
else
|
||||
echo -e "\n[HELK-UPDATE-INFO] YOUR HELK IS ALREADY UP-TO-DATE."
|
||||
fi
|
||||
chmod 666 docker-compose.yml
|
||||
Loading…
Reference in New Issue