358 lines
14 KiB
Bash
358 lines
14 KiB
Bash
#!/usr/bin/with-contenv bashio
|
|
# shellcheck shell=bash
|
|
# shellcheck disable=
|
|
set -e
|
|
|
|
if ! bashio::supervisor.ping 2> /dev/null; then
|
|
bashio::log.blue "Disabled : please use another method"
|
|
exit 0
|
|
fi
|
|
|
|
bashio::log.notice "This script is used to mount remote smb/cifs/nfs shares. Instructions here : https://github.com/alexbelgium/hassio-addons/wiki/Mounting-remote-shares-in-Addons"
|
|
|
|
####################
|
|
# DEFINE FUNCTIONS #
|
|
####################
|
|
|
|
test_mount() {
|
|
|
|
# Set initial test
|
|
MOUNTED=false
|
|
ERROR_MOUNT=false
|
|
|
|
# Exit if not mounted
|
|
if ! mountpoint -q /mnt/"$diskname"; then
|
|
return 0
|
|
fi
|
|
|
|
# Exit if can't write
|
|
[[ -e "/mnt/$diskname/testaze" ]] && rm -r "/mnt/$diskname/testaze"
|
|
# shellcheck disable=SC2015
|
|
mkdir "/mnt/$diskname/testaze" && touch "/mnt/$diskname/testaze/testaze" && rm -r "/mnt/$diskname/testaze" || ERROR_MOUNT=true
|
|
|
|
# Only CIFS has the noserverino fallback
|
|
if [[ "$ERROR_MOUNT" == "true" && "$FSTYPE" == "cifs" ]]; then
|
|
# Test write permissions
|
|
if [[ "$MOUNTOPTIONS" == *"noserverino"* ]]; then
|
|
bashio::log.fatal "Disk is mounted, however unable to write in the shared disk. Please check UID/GID for permissions, and if the share is rw"
|
|
else
|
|
MOUNTOPTIONS="$MOUNTOPTIONS,noserverino"
|
|
echo "... testing with noserverino"
|
|
mount_drive "$MOUNTOPTIONS"
|
|
return 0
|
|
fi
|
|
fi
|
|
|
|
# Set correctly mounted bit
|
|
MOUNTED=true
|
|
return 0
|
|
|
|
}
|
|
|
|
mount_drive() {
|
|
|
|
# Define options
|
|
MOUNTED=true
|
|
MOUNTOPTIONS="$1"
|
|
|
|
# Try mounting (type depends on detected FSTYPE)
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
mount -t cifs -o "$MOUNTOPTIONS" "$disk" /mnt/"$diskname" 2> ERRORCODE || MOUNTED=false
|
|
elif [[ "$FSTYPE" == "nfs" ]]; then
|
|
mount -t nfs -o "$MOUNTOPTIONS" "$disk" /mnt/"$diskname" 2> ERRORCODE || MOUNTED=false
|
|
fi
|
|
|
|
# Test if successful
|
|
if [[ "$MOUNTED" == "true" ]]; then
|
|
# shellcheck disable=SC2015
|
|
test_mount
|
|
fi
|
|
|
|
}
|
|
|
|
####################
|
|
# MOUNT NETWORK SHARES #
|
|
####################
|
|
|
|
if bashio::config.has_value 'networkdisks'; then
|
|
|
|
# Alert message that it is a new code
|
|
if [[ "$(date +"%Y%m%d")" -lt "20240201" ]]; then
|
|
bashio::log.warning "------------------------"
|
|
bashio::log.warning "This is a new code, please report any issues on https://github.com/alexbelgium/hassio-addons"
|
|
bashio::log.warning "------------------------"
|
|
fi
|
|
|
|
echo 'Mounting network share(s)...'
|
|
|
|
####################
|
|
# Define variables #
|
|
####################
|
|
|
|
# Set variables
|
|
MOREDISKS=$(bashio::config 'networkdisks')
|
|
USERNAME=$(bashio::config 'cifsusername')
|
|
PASSWORD=$(bashio::config 'cifspassword')
|
|
SMBVERS=""
|
|
SECVERS=""
|
|
CHARSET=",iocharset=utf8"
|
|
|
|
# Clean data (keeps NFS entries intact)
|
|
MOREDISKS=${MOREDISKS// \/\//,\/\/}
|
|
MOREDISKS=${MOREDISKS//, /,}
|
|
MOREDISKS=${MOREDISKS// /"\040"}
|
|
|
|
# Is domain set (CIFS only)
|
|
DOMAIN=""
|
|
DOMAINCLIENT=""
|
|
if bashio::config.has_value 'cifsdomain'; then
|
|
echo "... using domain $(bashio::config 'cifsdomain')"
|
|
DOMAIN=",domain=$(bashio::config 'cifsdomain')"
|
|
DOMAINCLIENT="--workgroup=$(bashio::config 'cifsdomain')"
|
|
fi
|
|
|
|
# Is UID/GID set (used for CIFS mount options)
|
|
PUID=",uid=$(id -u)"
|
|
PGID=",gid=$(id -g)"
|
|
if bashio::config.has_value 'PUID' && bashio::config.has_value 'PGID'; then
|
|
echo "... using PUID $(bashio::config 'PUID') and PGID $(bashio::config 'PGID')"
|
|
PUID=",uid=$(bashio::config 'PUID')"
|
|
PGID=",gid=$(bashio::config 'PGID')"
|
|
fi
|
|
|
|
##################
|
|
# Mounting disks #
|
|
##################
|
|
|
|
# shellcheck disable=SC2086
|
|
for disk in ${MOREDISKS//,/ }; do # Separate comma separated values
|
|
|
|
# Clean name of network share
|
|
# shellcheck disable=SC2116,SC2001
|
|
disk=$(echo $disk | sed "s,/$,,") # Remove / at end of name
|
|
disk="${disk//"\040"/ }" # replace \040 with space
|
|
|
|
# Detect filesystem type by pattern (CIFS: //ip/share ; NFS: ip:/export[/path] or nfs://ip:/export[/path])
|
|
FSTYPE="cifs"
|
|
if [[ "$disk" =~ ^nfs:// ]]; then
|
|
FSTYPE="nfs"
|
|
disk="${disk#nfs://}"
|
|
elif [[ "$disk" =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+:/.+ ]]; then
|
|
FSTYPE="nfs"
|
|
fi
|
|
|
|
# Determine server for reachability checks
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
server="$(echo "$disk" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+")"
|
|
else
|
|
server="${disk%%:*}"
|
|
fi
|
|
|
|
diskname="$disk"
|
|
diskname="${diskname//\\//}" # replace \ with /
|
|
diskname="${diskname##*/}" # Get only last part of the name
|
|
MOUNTED=false
|
|
SMBVERS_FORCE=""
|
|
SECVERS_FORCE=""
|
|
|
|
# Start
|
|
echo "... mounting ($FSTYPE) $disk"
|
|
|
|
# Data validation
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
if [[ ! "$disk" =~ ^.*+[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[/]+.*+$ ]]; then
|
|
bashio::log.fatal "...... the structure of your \"networkdisks\" option : \"$disk\" doesn't seem correct, please use a structure like //123.12.12.12/sharedfolder,//123.12.12.12/sharedfolder2. If you don't use it, you can simply remove the text, this will avoid this error message in the future."
|
|
touch ERRORCODE
|
|
continue
|
|
fi
|
|
else
|
|
if [[ ! "$disk" =~ ^[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+:/.+ ]]; then
|
|
bashio::log.fatal "...... invalid NFS path \"$disk\". Use a structure like 123.12.12.12:/export/path"
|
|
touch ERRORCODE
|
|
continue
|
|
fi
|
|
fi
|
|
|
|
# Prepare mount point
|
|
mkdir -p /mnt/"$diskname"
|
|
chown root:root /mnt/"$diskname"
|
|
|
|
# Quickly try to mount with defaults
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}"
|
|
elif [[ "$FSTYPE" == "nfs" ]]; then
|
|
mount_drive "rw,nfsvers=4.2,proto=tcp,hard,timeo=600,retrans=2"
|
|
fi
|
|
|
|
# Deeper analysis if failed
|
|
if [ "$MOUNTED" = false ]; then
|
|
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
|
|
# Does server exist (SMB port 445)
|
|
output="$(nmap -F $server -T5 -oG -)"
|
|
if ! echo "$output" | grep 445/open &> /dev/null; then
|
|
if echo "$output" | grep /open &> /dev/null; then
|
|
bashio::log.fatal "...... $server is reachable but SMB port not opened, stopping script"
|
|
touch ERRORCODE
|
|
continue
|
|
else
|
|
bashio::log.fatal "...... fatal : $server not reachable, is it correct"
|
|
touch ERRORCODE
|
|
continue
|
|
fi
|
|
else
|
|
echo "...... $server is confirmed reachable"
|
|
fi
|
|
|
|
# Are credentials correct
|
|
OUTPUT="$(smbclient -t 2 -L "$disk" -U "$USERNAME"%"$PASSWORD" -c "exit" $DOMAINCLIENT 2>&1 || true)"
|
|
if echo "$OUTPUT" | grep -q "LOGON_FAILURE"; then
|
|
bashio::log.fatal "...... incorrect Username, Password, or Domain! Script will stop."
|
|
touch ERRORCODE
|
|
# Should there be a workgroup
|
|
if ! smbclient -t 2 -L $disk -N $DOMAINCLIENT -c "exit" &> /dev/null; then
|
|
bashio::log.fatal "...... perhaps a workgroup must be specified"
|
|
touch ERRORCODE
|
|
fi
|
|
continue
|
|
elif echo "$OUTPUT" | grep -q "tree connect failed" || echo "$OUTPUT" | grep -q "NT_STATUS_CONNECTION_DISCONNECTED"; then
|
|
echo "... using SMBv1"
|
|
bashio::log.warning "...... share reachable only with legacy SMBv1 (NT1) negotiation. Forcing SMBv1 options."
|
|
SMBVERS_FORCE=",vers=1.0"
|
|
SECVERS_FORCE=",sec=ntlm"
|
|
elif ! echo "$OUTPUT" | grep -q "Disk"; then
|
|
echo "... testing path"
|
|
bashio::log.fatal "...... no shares found. Invalid or inaccessible SMB path?"
|
|
else
|
|
echo "...... credentials are valid"
|
|
fi
|
|
|
|
# Extracting SMB versions and normalize output
|
|
# shellcheck disable=SC2210,SC2094
|
|
SMBVERS="$(nmap --script smb-protocols "$server" -p 445 2> 1 | awk '/ [0-9]/' | awk '{print $NF}' | cut -c -3 | sort -V | tail -n 1 || true)"
|
|
# Avoid :
|
|
SMBVERS="${SMBVERS/:/.}"
|
|
# Manage output
|
|
if [ -n "$SMBVERS" ]; then
|
|
case $SMBVERS in
|
|
"202" | "200" | "20")
|
|
SMBVERS="2.0"
|
|
;;
|
|
21)
|
|
SMBVERS="2.1"
|
|
;;
|
|
302)
|
|
SMBVERS="3.02"
|
|
;;
|
|
311)
|
|
SMBVERS="3.1.1"
|
|
;;
|
|
"3.1")
|
|
echo "SMB 3.1 detected, converting to 3.0"
|
|
SMBVERS="3.0"
|
|
;;
|
|
esac
|
|
echo "...... SMB version detected : $SMBVERS"
|
|
SMBVERS=",vers=$SMBVERS"
|
|
elif smbclient -t 2 -L "$server" -m NT1 -N $DOMAINCLIENT &> /dev/null; then
|
|
echo "...... SMB version : only SMBv1 is supported, this can lead to issues"
|
|
SECVERS=",sec=ntlm"
|
|
SMBVERS=",vers=1.0"
|
|
else
|
|
echo "...... SMB version : couldn't detect, default used"
|
|
SMBVERS=""
|
|
fi
|
|
|
|
# Apply forced SMBv1 options when initial connection required NT1 fallback
|
|
if [[ -n "$SMBVERS_FORCE" ]]; then
|
|
if [[ -z "$SMBVERS" ]]; then
|
|
SMBVERS="$SMBVERS_FORCE"
|
|
fi
|
|
if [[ -z "$SECVERS" ]]; then
|
|
SECVERS="$SECVERS_FORCE"
|
|
fi
|
|
fi
|
|
|
|
# Ensure the Samba client allows SMBv1 when those options are required
|
|
if [[ "${SMBVERS}${SMBVERS_FORCE}" == *"vers=1.0"* ]]; then
|
|
if [[ -f /etc/samba/smb.conf ]]; then
|
|
bashio::log.warning "...... enabling SMBv1 support in Samba client configuration"
|
|
sed -i '/\[global\]/!b;n;/client min protocol = NT1/!a\
|
|
client min protocol = NT1' /etc/samba/smb.conf
|
|
fi
|
|
fi
|
|
|
|
# Test with different security versions
|
|
#######################################
|
|
for SECVERS in "$SECVERS" ",sec=ntlmv2" ",sec=ntlmssp" ",sec=ntlmsspi" ",sec=krb5i" ",sec=krb5" ",sec=ntlm" ",sec=ntlmv2i"; do
|
|
if [ "$MOUNTED" = false ]; then
|
|
mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}"
|
|
fi
|
|
done
|
|
|
|
elif [[ "$FSTYPE" == "nfs" ]]; then
|
|
# Add NFS-specific port check (2049) similar to SMB (445)
|
|
output="$(nmap -F $server -T5 -oG -)"
|
|
if ! echo "$output" | grep -E '(2049|111)/open' &> /dev/null; then
|
|
bashio::log.fatal "...... $server is reachable but NFS ports not open"
|
|
continue
|
|
fi
|
|
# NFS fallback attempts: try common versions until one works
|
|
for NFVER in 4.2 4.1 4 3; do
|
|
if [ "$MOUNTED" = false ]; then
|
|
mount_drive "rw,nfsvers=${NFVER},proto=tcp"
|
|
fi
|
|
done
|
|
fi
|
|
fi
|
|
|
|
# Messages
|
|
if [ "$MOUNTED" = true ]; then
|
|
|
|
bashio::log.info "...... $disk successfully mounted to /mnt/$diskname with options ${MOUNTOPTIONS/$PASSWORD/XXXXXXXXXX}"
|
|
# Remove errorcode
|
|
if [ -f ERRORCODE ]; then
|
|
rm ERRORCODE
|
|
fi
|
|
|
|
# Alert if smbv1
|
|
if [[ "$FSTYPE" == "cifs" && "$MOUNTOPTIONS" == *"1.0"* ]]; then
|
|
bashio::log.warning ""
|
|
bashio::log.warning "Your smb system requires smbv1. This is an obsolete protocol. Please correct this to prevent issues."
|
|
bashio::log.warning ""
|
|
fi
|
|
|
|
else
|
|
# Mounting failed messages
|
|
if [[ "$FSTYPE" == "cifs" ]]; then
|
|
bashio::log.fatal "Error, unable to mount $disk to /mnt/$diskname with username $USERNAME, $PASSWORD. Please check your remote share path, username, password, domain, try putting 0 in UID and GID"
|
|
bashio::log.fatal "Here is some debugging info :"
|
|
smbclient -t 2 -L $disk -U "$USERNAME%$PASSWORD" -c "exit"
|
|
SMBVERS=""
|
|
SECVERS=""
|
|
PUID=""
|
|
PGID=""
|
|
CHARSET=""
|
|
mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}"
|
|
elif [[ "$FSTYPE" == "nfs" ]]; then
|
|
bashio::log.fatal "Error, unable to mount NFS share $disk to /mnt/$diskname. Please check the export path and that NFS server allows this client (and NFSv4)."
|
|
# last-ditch try with very basic options
|
|
mount_drive "rw"
|
|
fi
|
|
|
|
bashio::log.fatal "Error read : $(< ERRORCODE), addon will stop in 1 min"
|
|
|
|
# clean folder
|
|
umount "/mnt/$diskname" 2> /dev/null || true
|
|
rmdir "/mnt/$diskname" || true
|
|
|
|
# Stop addon
|
|
bashio::addon.stop
|
|
|
|
fi
|
|
|
|
done
|
|
|
|
fi
|