#!/usr/bin/env bash # BSD 3-Clause License # Author @sonique6784 # Copyright (c) 2020, sonique6784 function showPiSCSILogo(){ logo="""     .~~.   .~~.\n   '. \ ' ' / .'\n    .╔═══════╗.\n   : ║|¯¯¯¯¯|║ :\n  ~ (║|_____|║) ~\n ( : ║ .  __ ║ : )\n  ~ .╚╦═════╦╝. ~\n   (  ¯¯¯¯¯¯¯  ) PiSCSI Assistant\n    '~ .~~~. ~'\n        '~'\n """ echo -e $logo } function showMacNetworkWired(){ logo="""                               .-~-.-~~~-.~-.\n  ╔═══════╗                  .(              )\n  ║|¯¯¯¯¯|║                 /               \`.\n  ║|_____|║>--------------<~               .   )\n  ║ .  __ ║                 (              :'-'\n  ╚╦═════╦╝                  ~-.________.:'\n   ¯¯¯¯¯¯¯\n """ echo -e $logo } function showMacNetworkWireless(){ logo="""                               .-~-.-~~~-.~-.\n  ╔═══════╗        .(       .(              )\n  ║|¯¯¯¯¯|║  .(  .(        /               \`.\n  ║|_____|║ .o    o       ~               .   )\n  ║ .  __ ║  '(  '(        (              :'-'\n  ╚╦═════╦╝        '(       ~-.________.:'\n   ¯¯¯¯¯¯¯\n """ echo -e $logo } CONNECT_TYPE="FULLSPEC" COMPILER="clang++" MEM=$(grep MemTotal /proc/meminfo | awk '{print $2}') CORES=`expr $MEM / 450000` if [ $CORES -gt $(nproc) ]; then CORES=$(nproc) elif [ $CORES -lt 1 ]; then CORES=1 fi USER=$(whoami) BASE=$(dirname "$(readlink -f "${0}")") CPP_PATH="$BASE/cpp" VIRTUAL_DRIVER_PATH="$HOME/images" CFG_PATH="$HOME/.config/piscsi" WEB_INSTALL_PATH="$BASE/python/web" OLED_INSTALL_PATH="$BASE/python/oled" CTRLBOARD_INSTALL_PATH="$BASE/python/ctrlboard" PYTHON_COMMON_PATH="$BASE/python/common" SYSTEMD_PATH="/etc/systemd/system" SSL_CERTS_PATH="/etc/ssl/certs" SSL_KEYS_PATH="/etc/ssl/private" HFDISK_BIN=/usr/bin/hfdisk GIT_BRANCH=$(git rev-parse --abbrev-ref HEAD) GIT_REMOTE=${GIT_REMOTE:-origin} TOKEN="" AUTH_GROUP="piscsi" SECRET_FILE="$HOME/.config/piscsi/secret" FILE_SHARE_PATH="$HOME/shared_files" FILE_SHARE_NAME="Pi File Server" APT_PACKAGES_COMMON="build-essential git protobuf-compiler bridge-utils dhcpcd" APT_PACKAGES_BACKEND="libspdlog-dev libpcap-dev libprotobuf-dev protobuf-compiler libgmock-dev clang" APT_PACKAGES_PYTHON="python3 python3-dev python3-pip python3-venv python3-setuptools python3-wheel libev-dev libevdev2" APT_PACKAGES_WEB="nginx-light genisoimage man2html hfsutils dosfstools kpartx unzip unar disktype gettext" set -e # checks to run before entering the script main menu function initialChecks() { if [ "root" == "$USER" ]; then echo "Do not run this script as $USER or with 'sudo'." exit 1 fi } # Only to be used for pi-gen automated install function cacheSudo() { echo "Caching sudo password" echo raspberry | sudo -v -S } # checks that the current user has sudoers privileges function sudoCheck() { if [[ $HEADLESS ]]; then echo "Skipping password check in headless mode" return 0 fi echo "Input your password to allow this script to make the above changes." sudo -v } # Delete file if it exists function deleteFile() { if sudo test -f "$1/$2"; then sudo rm "$1/$2" || exit 1 echo "Deleted file $1/$2" fi } # Delete dir if it exists function deleteDir() { if sudo test -d "$1"; then sudo rm -rf "$1" || exit 1 echo "Deleted directory $1" fi } # install all dependency packages for PiSCSI Service function installPackages() { if [[ $SKIP_PACKAGES ]]; then echo "Skipping package installation" return 0 fi sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends --assume-yes -qq \ $APT_PACKAGES_COMMON \ $APT_PACKAGES_BACKEND \ $APT_PACKAGES_PYTHON \ $APT_PACKAGES_WEB } # install Debian packages for PiSCSI standalone function installPackagesStandalone() { if [[ $SKIP_PACKAGES ]]; then echo "Skipping package installation" return 0 fi sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends --assume-yes -qq \ $APT_PACKAGES_COMMON \ $APT_PACKAGES_BACKEND } # install Debian packages for PiSCSI web UI standalone function installPackagesWeb() { if [[ $SKIP_PACKAGES ]]; then echo "Skipping package installation" return 0 fi sudo apt-get update && sudo DEBIAN_FRONTEND=noninteractive apt-get install --no-install-recommends --assume-yes -qq \ $APT_PACKAGES_COMMON \ $APT_PACKAGES_PYTHON \ $APT_PACKAGES_WEB } # cache the pip packages function cachePipPackages(){ pushd $WEB_INSTALL_PATH sudo pip3 install -r ./requirements.txt popd } # compile the PiSCSI binaries function compilePiscsi() { cd "$CPP_PATH" || exit 1 echo "Compiling $CONNECT_TYPE with $COMPILER on $CORES simultaneous cores..." if [[ $SKIP_MAKE_CLEAN ]]; then echo "Skipping 'make clean'" else make clean /dev/null if [[ $? -ge 1 ]]; then echo "Warning: This does not seem to be a valid clone of a git repository. I will not be able to pull the latest code." return 0 fi set -e stashed=0 if [[ $(git diff --stat) != '' ]]; then echo "There are local changes to the PiSCSI code; we will stash and reapply them." git -c user.name="${GIT_COMMITTER_NAME-piscsi}" -c user.email="${GIT_COMMITTER_EMAIL-piscsi@piscsi.com}" stash stashed=1 fi if [[ `git for-each-ref --format='%(upstream:short)' "$(git symbolic-ref -q HEAD)"` != "" ]]; then echo "Updating checked out git branch $GIT_REMOTE/$GIT_BRANCH" git pull --ff-only else echo "Detected a local git working branch; skipping the remote update step." fi if [ $stashed -eq 1 ]; then echo "Reapplying local changes..." git stash apply fi } # Takes a backup copy of the piscsi.service file if it exists function backupPiscsiService() { if [ -f "$SYSTEMD_PATH/piscsi.service" ]; then sudo mv "$SYSTEMD_PATH/piscsi.service" "$SYSTEMD_PATH/piscsi.service.old" SYSTEMD_BACKUP=true echo "Existing version of piscsi.service detected; Backing up to piscsi.service.old" else SYSTEMD_BACKUP=false fi } # Offers the choice of enabling token-based authentication for PiSCSI, or disables it if enabled function configureTokenAuth() { if [[ -f "$HOME/.rascsi_secret" ]]; then sudo mv "$HOME/.rascsi_secret" "$SECRET_FILE" echo "Renamed legacy RaSCSI token file for use with PiSCSI" return fi if [[ -f "$CFG_PATH/rascsi_secret" ]]; then sudo mv "$CFG_PATH/rascsi_secret" "$SECRET_FILE" echo "Renamed legacy RaSCSI token file for use with PiSCSI" return fi if [[ -f $SECRET_FILE ]]; then sudo rm "$SECRET_FILE" echo "PiSCSI token file $SECRET_FILE already exists. Do you want to disable authentication? (y/N)" read REPLY if [[ $REPLY =~ ^[Yy]$ ]]; then sudo sed -i 's@-P '"$SECRET_FILE"'@@' "$SYSTEMD_PATH/piscsi.service" return fi fi echo -n "Enter the token password for protecting PiSCSI: " read -r TOKEN echo "$TOKEN" > "$SECRET_FILE" # Make the secret file owned and only readable by root sudo chown root:root "$SECRET_FILE" sudo chmod 600 "$SECRET_FILE" sudo sed -i "s@^ExecStart.*@& -P $SECRET_FILE@" "$SYSTEMD_PATH/piscsi.service" echo "" echo "Configured PiSCSI to use $SECRET_FILE for authentication. This file is readable by root only." echo "Make note of your password: you will need it to use scsictl and other PiSCSI clients." echo "If you have PiSCSI clients installed, please re-run the installation scripts, or update the systemd config manually." } # Enables and starts the piscsi service function enablePiscsiService() { sudo systemctl daemon-reload sudo systemctl restart rsyslog sudo systemctl enable piscsi # start piscsi at boot sudo systemctl start piscsi } # Modifies and installs the piscsi-web service function installWebInterfaceService() { if [[ -f "$SECRET_FILE" && -z "$TOKEN" ]] ; then echo "" echo "Secret token file $SECRET_FILE detected. You must enter the password, or press Ctrl+C to cancel installation." read -r TOKEN fi echo "Installing the piscsi-web.service configuration..." sudo cp -f "$WEB_INSTALL_PATH/service-infra/piscsi-web.service" "$SYSTEMD_PATH/piscsi-web.service" sudo sed -i /^ExecStart=/d "$SYSTEMD_PATH/piscsi-web.service" if [ ! -z "$TOKEN" ]; then sudo sed -i "8 i ExecStart=$WEB_INSTALL_PATH/start.sh --password=$TOKEN" "$SYSTEMD_PATH/piscsi-web.service" # Make the service file readable by root only, to protect the token string sudo chmod 600 "$SYSTEMD_PATH/piscsi-web.service" echo "Granted access to the Web Interface with the token password that you configured for PiSCSI." else sudo sed -i "8 i ExecStart=$WEB_INSTALL_PATH/start.sh" "$SYSTEMD_PATH/piscsi-web.service" fi sudo systemctl daemon-reload sudo systemctl enable piscsi-web sudo systemctl start piscsi-web } # Checks for and disables legacy systemd services function migrateLegacyData() { if [[ -f "$SYSTEMD_PATH/rascsi.service" ]]; then stopService "rascsi" disableService "rascsi" sudo mv "$SYSTEMD_PATH/rascsi.service" "$SYSTEMD_PATH/piscsi.service" echo "Renamed rascsi.service to piscsi.service" fi if [[ -f "$SYSTEMD_PATH/rascsi-web.service" ]]; then stopService "rascsi-web" disableService "rascsi-web" sudo mv "$SYSTEMD_PATH/rascsi-web.service" "$SYSTEMD_PATH/piscsi-web.service" echo "Renamed rascsi-web.service to piscsi-web.service" fi if [[ -f "$SYSTEMD_PATH/rascsi-oled.service" ]]; then stopService "rascsi-oled" disableService "rascsi-oled" sudo mv "$SYSTEMD_PATH/rascsi-oled.service" "$SYSTEMD_PATH/piscsi-oled.service" echo "Renamed rascsi-oled.service to piscsi-oled.service" elif [[ -f "$SYSTEMD_PATH/monitor_rascsi.service" ]]; then stopService "monitor_rascsi" disableService "monitor_rascsi" sudo mv "$SYSTEMD_PATH/monitor_rascsi.service" "$SYSTEMD_PATH/piscsi-oled.service" echo "Renamed monitor_rascsi.service to piscsi-oled.service" fi if [[ -f "$SYSTEMD_PATH/rascsi-ctrlboard.service" ]]; then stopService "rascsi-ctrlboard" disableService "rascsi-ctrlboard" sudo mv "$SYSTEMD_PATH/rascsi-ctrlboard.service" "$SYSTEMD_PATH/piscsi-ctrlboard.service" echo "Renamed rascsi-ctrlboard.service to piscsi-ctrlboard.service" fi if [[ -f "/etc/rsyslog.d/rascsi.conf" ]]; then sudo rm "/etc/rsyslog.d/rascsi.conf" sudo cp "$BASE/os_integration/piscsi.conf" "/etc/rsyslog.d" echo "Replaced rascsi.conf with piscsi.conf" fi if [[ -f "/etc/network/interfaces.d/rascsi_bridge" ]]; then sudo rm "/etc/network/interfaces.d/rascsi_bridge" sudo cp "$BASE/os_integration/piscsi_bridge" "/etc/network/interfaces.d" echo "Replaced rascsi_bridge with piscsi_bridge" fi if [[ $(getent group rascsi) && $(getent group "$AUTH_GROUP") ]]; then sudo groupdel rascsi echo "Deleted the rascsi group in favor of the existing piscsi group" elif [ $(getent group rascsi) ]; then sudo groupmod --new-name piscsi rascsi echo "Renamed the rascsi group to piscsi" fi } # Stops a service if it is running function stopService() { if [[ -f "$SYSTEMD_PATH/$1.service" ]]; then SERVICE_RUNNING=0 sudo systemctl is-active --quiet "$1.service" >/dev/null 2>&1 || SERVICE_RUNNING=$? if [[ $SERVICE_RUNNING -eq 0 ]]; then sudo systemctl stop "$1.service" fi fi } # disables a service if it is enabled function disableService() { if [ -f "$SYSTEMD_PATH/$1.service" ]; then SERVICE_ENABLED=0 sudo systemctl is-enabled --quiet "$1.service" >/dev/null 2>&1 || SERVICE_ENABLED=$? if [[ $SERVICE_ENABLED -eq 0 ]]; then sudo systemctl disable "$1.service" fi fi } # Checks whether the piscsi-oled service is installed function isPiscsiScreenInstalled() { SERVICE_PISCSI_OLED_ENABLED=0 if [[ -f "$SYSTEMD_PATH/piscsi-oled.service" ]]; then sudo systemctl is-enabled --quiet piscsi-oled.service >/dev/null 2>&1 || SERVICE_PISCSI_OLED_ENABLED=$? else SERVICE_PISCSI_OLED_ENABLED=1 fi echo $SERVICE_PISCSI_OLED_ENABLED } # Checks whether the piscsi-ctrlboard service is installed function isPiscsiCtrlBoardInstalled() { SERVICE_PISCSI_CTRLBOARD_ENABLED=0 if [[ -f "$SYSTEMD_PATH/piscsi-ctrlboard.service" ]]; then sudo systemctl is-enabled --quiet piscsi-ctrlboard.service >/dev/null 2>&1 || SERVICE_PISCSI_CTRLBOARD_ENABLED=$? else SERVICE_PISCSI_CTRLBOARD_ENABLED=1 fi echo $SERVICE_PISCSI_CTRLBOARD_ENABLED } # Checks whether the piscsi-oled service is running function isPiscsiScreenRunning() { SERVICE_PISCSI_OLED_RUNNING=0 if [[ -f "$SYSTEMD_PATH/piscsi-oled.service" ]]; then sudo systemctl is-active --quiet piscsi-oled.service >/dev/null 2>&1 || SERVICE_PISCSI_OLED_RUNNING=$? else SERVICE_PISCSI_OLED_RUNNING=1 fi echo $SERVICE_PISCSI_OLED_RUNNING } # Checks whether the piscsi-oled service is running function isPiscsiCtrlBoardRunning() { SERVICE_PISCSI_CTRLBOARD_RUNNING=0 if [[ -f "$SYSTEMD_PATH/piscsi-ctrlboard.service" ]]; then sudo systemctl is-active --quiet piscsi-ctrlboard.service >/dev/null 2>&1 || SERVICE_PISCSI_CTRLBOARD_RUNNING=$? else SERVICE_PISCSI_CTRLBOARD_RUNNING=1 fi echo $SERVICE_PISCSI_CTRLBOARD_RUNNING } # Starts the piscsi-oled service if installed function startPiscsiScreen() { if [[ $(isPiscsiScreenInstalled) -eq 0 ]] && [[ $(isPiscsiScreenRunning) -ne 1 ]]; then sudo systemctl start piscsi-oled.service showServiceStatus "piscsi-oled" fi } # Starts the piscsi-ctrlboard service if installed function startPiscsiCtrlBoard() { if [[ $(isPiscsiCtrlBoardInstalled) -eq 0 ]] && [[ $(isPiscsiCtrlBoardRunning) -ne 1 ]]; then sudo systemctl start piscsi-ctrlboard.service showServiceStatus "piscsi-ctrlboard" fi } # Starts the macproxy service if installed function startMacproxy() { if [ -f "$SYSTEMD_PATH/macproxy.service" ]; then sudo systemctl start macproxy.service showServiceStatus "macproxy" fi } # Shows status for the piscsi service function showServiceStatus() { systemctl status "$1.service" | tee } # Clone, compile and install 'hfdisk', partition tool function installHfdisk() { HFDISK_VERSION="2022.11" if [ ! -x "$HFDISK_BIN" ]; then cd "$BASE" || exit 1 wget -O "hfdisk-$HFDISK_VERSION.tar.gz" "https://github.com/rdmark/hfdisk/archive/refs/tags/$HFDISK_VERSION.tar.gz" > /etc/dhcpcd.conf' echo "Modified /etc/dhcpcd.conf" # default config file is made for eth0, this will set the right net interface sudo bash -c 'sed s/eth0/'"$LAN_INTERFACE"'/g '"$BASE"'/os_integration/piscsi_bridge > /etc/network/interfaces.d/piscsi_bridge' echo "Modified /etc/network/interfaces.d/piscsi_bridge" echo "Configuration completed!" echo "Please make sure you attach a DaynaPORT network adapter to your PiSCSI configuration." echo "Either use the Web UI, or do this on the command line (assuming SCSI ID 6):" echo "scsictl -i 6 -c attach -t scdp -f $LAN_INTERFACE" echo "" if [[ $HEADLESS ]]; then echo "Skipping reboot in headless mode" return 0 fi echo "We need to reboot your Pi" echo "Press Enter to reboot or CTRL-C to exit" read echo "Rebooting..." sleep 3 sudo reboot } # Modifies system configurations for a wireless network bridge with NAT function setupWirelessNetworking() { NETWORK="10.10.20" IP=$NETWORK.2 # Macintosh or Device IP NETWORK_MASK="255.255.255.0" CIDR="24" ROUTER_IP=$NETWORK.1 ROUTING_ADDRESS=$NETWORK.0/$CIDR if [[ -z $HEADLESS ]]; then WLAN_INTERFACE=`ip -o addr show scope link | awk '{split($0, a); print $2}' | grep 'wlan\|wlx' | head -n 1` else WLAN_INTERFACE="wlan0" fi if [[ -z "$WLAN_INTERFACE" ]]; then echo "No usable wireless network interfaces detected. Have you already enabled the bridge? Aborting..." return 1 fi echo "Network interface '$WLAN_INTERFACE' will be configured for network forwarding with static IP assignment." echo "Configure your Macintosh or other device with the following:" echo "IP Address (static): $IP" echo "Router Address: $ROUTER_IP" echo "Subnet Mask: $NETWORK_MASK" echo "DNS Server: Any public DNS server" echo "" echo "Do you want to proceed with network configuration using the default settings? [Y/n]" read REPLY if [ "$REPLY" == "N" ] || [ "$REPLY" == "n" ]; then echo "Available wireless interfaces on this system:" echo `ip -o addr show scope link | awk '{split($0, a); print $2}' | grep 'wlan\|wlx'` echo "Please type the wireless interface you want to use and press Enter:" read -r WLAN_INTERFACE echo "Base IP address (ex. 10.10.20):" read -r NETWORK echo "CIDR for Subnet Mask (ex. '24' for 255.255.255.0):" read -r CIDR ROUTER_IP=$NETWORK.1 ROUTING_ADDRESS=$NETWORK.0/$CIDR fi if [ "$(grep -c "^net.ipv4.ip_forward=1" /etc/sysctl.conf)" -ge 1 ]; then echo "WARNING: Network forwarding may already have been configured. Proceeding will overwrite the configuration." echo "Press enter to continue or CTRL-C to exit" read REPLY else sudo bash -c 'echo "net.ipv4.ip_forward=1" >> /etc/sysctl.conf' echo "Modified /etc/sysctl.conf" fi # Check if iptables is installed if [ `apt-cache policy iptables | grep Installed | grep -c "(none)"` -eq 0 ]; then echo "iptables is already installed" else sudo apt-get install iptables --assume-yes --no-install-recommends /dev/null || true wget -O netatalk2-wbm.tgz "https://github.com/Netatalk/netatalk-webmin/releases/download/netatalk2-$WEBMIN_MODULE_VERSION/netatalk2-wbm-$WEBMIN_MODULE_VERSION.tgz"