avm/hassio-addons
1
0
Fork 0
mirror of https://github.com/alexbelgium/hassio-addons.git synced 2026-06-26 01:06:04 +02:00
Code Issues Packages Projects Releases Wiki Activity

Rewrite the mount code to add NFS

Browse Source 
https://github.com/alexbelgium/hassio-addons/issues/1987
This commit is contained in:
Alexandre
2025-07-31 14:18:30 +02:00
committed by GitHub
parent 0874effa71
commit 2cbde1519e
1 changed files with 158 additions and 106 deletions
Download Patch File Download Diff File Expand all files Collapse all files

264
.templates/00-smb_mounts.sh
View File

@@ -27,7 +27,9 @@ test_mount() {
[[ -e "/mnt/$diskname/testaze" ]] && rm -r "/mnt/$diskname/testaze" [[ -e "/mnt/$diskname/testaze" ]] && rm -r "/mnt/$diskname/testaze"
# shellcheck disable=SC2015 # shellcheck disable=SC2015
mkdir "/mnt/$diskname/testaze" && touch "/mnt/$diskname/testaze/testaze" && rm -r "/mnt/$diskname/testaze" || ERROR_MOUNT=true mkdir "/mnt/$diskname/testaze" && touch "/mnt/$diskname/testaze/testaze" && rm -r "/mnt/$diskname/testaze" || ERROR_MOUNT=true
if [[ "$ERROR_MOUNT" == "true" ]]; then
# Only CIFS has the noserverino fallback
if [[ "$ERROR_MOUNT" == "true" && "$FSTYPE" == "cifs" ]]; then
# Test write permissions # Test write permissions
if [[ "$MOUNTOPTIONS" == *"noserverino"* ]]; then 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" 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"
@@ -51,10 +53,14 @@ mount_drive() {
MOUNTED=true MOUNTED=true
MOUNTOPTIONS="$1" MOUNTOPTIONS="$1"
# Try mounting # Try mounting (type depends on detected FSTYPE)
mount -t cifs -o "$MOUNTOPTIONS" "$disk" /mnt/"$diskname" 2> ERRORCODE || MOUNTED=false 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 succesful # Test if successful
if [[ "$MOUNTED" == "true" ]]; then if [[ "$MOUNTED" == "true" ]]; then
# shellcheck disable=SC2015 # shellcheck disable=SC2015
test_mount test_mount
@@ -63,7 +69,7 @@ mount_drive() {
} }
#################### ####################
# MOUNT SMB SHARES # # MOUNT NETWORK SHARES #
#################### ####################
if bashio::config.has_value 'networkdisks'; then if bashio::config.has_value 'networkdisks'; then
@@ -75,7 +81,7 @@ if bashio::config.has_value 'networkdisks'; then
bashio::log.warning "------------------------" bashio::log.warning "------------------------"
fi fi
echo 'Mounting smb share(s)...' echo 'Mounting network share(s)...'
#################### ####################
# Define variables # # Define variables #
@@ -89,12 +95,12 @@ if bashio::config.has_value 'networkdisks'; then
SECVERS="" SECVERS=""
CHARSET=",iocharset=utf8" CHARSET=",iocharset=utf8"
# Clean data # Clean data (keeps NFS entries intact)
MOREDISKS=${MOREDISKS// \/\//,\/\/} MOREDISKS=${MOREDISKS// \/\//,\/\/}
MOREDISKS=${MOREDISKS//, /,} MOREDISKS=${MOREDISKS//, /,}
MOREDISKS=${MOREDISKS// /"\040"} MOREDISKS=${MOREDISKS// /"\040"}
# Is domain set # Is domain set (CIFS only)
DOMAIN="" DOMAIN=""
DOMAINCLIENT="" DOMAINCLIENT=""
if bashio::config.has_value 'cifsdomain'; then if bashio::config.has_value 'cifsdomain'; then
@@ -103,7 +109,7 @@ if bashio::config.has_value 'networkdisks'; then
DOMAINCLIENT="--workgroup=$(bashio::config 'cifsdomain')" DOMAINCLIENT="--workgroup=$(bashio::config 'cifsdomain')"
fi fi
# Is UID/GID set # Is UID/GID set (used for CIFS mount options)
PUID=",uid=$(id -u)" PUID=",uid=$(id -u)"
PGID=",gid=$(id -g)" PGID=",gid=$(id -g)"
if bashio::config.has_value 'PUID' && bashio::config.has_value 'PGID'; then if bashio::config.has_value 'PUID' && bashio::config.has_value 'PGID'; then
@@ -122,19 +128,45 @@ if bashio::config.has_value 'networkdisks'; then
# Clean name of network share # Clean name of network share
# shellcheck disable=SC2116,SC2001 # shellcheck disable=SC2116,SC2001
disk=$(echo $disk | sed "s,/$,,") # Remove / at end of name disk=$(echo $disk | sed "s,/$,,") # Remove / at end of name
disk="${disk//"\040"/ }" #replace \040 with disk="${disk//"\040"/ }" # replace \040 with space
diskname="${disk//\\//}" #replace \ with /
# 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 diskname="${diskname##*/}" # Get only last part of the name
MOUNTED=false MOUNTED=false
# Start # Start
echo "... mounting $disk" echo "... mounting ($FSTYPE) $disk"
# Data validation # Data validation
if [[ ! "$disk" =~ ^.*+[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[/]+.*+$ ]]; then if [[ "$FSTYPE" == "cifs" ]]; 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." if [[ ! "$disk" =~ ^.*+[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+[/]+.*+$ ]]; then
touch ERRORCODE 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."
continue 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 fi
# Prepare mount point # Prepare mount point
@@ -142,97 +174,114 @@ if bashio::config.has_value 'networkdisks'; then
chown root:root /mnt/"$diskname" chown root:root /mnt/"$diskname"
# Quickly try to mount with defaults # Quickly try to mount with defaults
mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}" 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 # Deeper analysis if failed
if [ "$MOUNTED" = false ]; then if [ "$MOUNTED" = false ]; then
# Extract ip part of server for further manipulation if [[ "$FSTYPE" == "cifs" ]]; then
server="$(echo "$disk" | grep -E -o "[0-9]+\.[0-9]+\.[0-9]+\.[0-9]+")"
# Does server exists # Does server exist (SMB port 445)
output="$(nmap -F $server -T5 -oG -)" output="$(nmap -F $server -T5 -oG -)"
if ! echo "$output" | grep 445/open &> /dev/null; then if ! echo "$output" | grep 445/open &> /dev/null; then
if echo "$output" | grep /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" bashio::log.fatal "...... $server is reachable but SMB port not opened, stopping script"
touch ERRORCODE touch ERRORCODE
continue continue
else
bashio::log.fatal "...... fatal : $server not reachable, is it correct"
touch ERRORCODE
continue
fi
else else
bashio::log.fatal "...... fatal : $server not reachable, is it correct" 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 "... testing path"
bashio::log.fatal "...... invalid or inaccessible SMB path. Script will stop."
touch ERRORCODE touch ERRORCODE
continue continue
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 fi
else
echo "...... $server is confirmed reachable"
fi
# Are credentials correct # Extracting SMB versions and normalize output
OUTPUT="$(smbclient -t 2 -L "$disk" -U "$USERNAME"%"$PASSWORD" -c "exit" $DOMAINCLIENT 2>&1 || true)" # shellcheck disable=SC2210,SC2094
if echo "$OUTPUT" | grep -q "LOGON_FAILURE"; then 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)"
bashio::log.fatal "...... incorrect Username, Password, or Domain! Script will stop." # Avoid :
touch ERRORCODE SMBVERS="${SMBVERS/:/.}"
# Should there be a workgroup # Manage output
if ! smbclient -t 2 -L $disk -N $DOMAINCLIENT -c "exit" &> /dev/null; then if [ -n "$SMBVERS" ]; then
bashio::log.fatal "...... perhaps a workgroup must be specified" case $SMBVERS in
touch ERRORCODE "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 fi
continue
elif echo "$OUTPUT" | grep -q "tree connect failed" || echo "$OUTPUT" | grep -q "NT_STATUS_CONNECTION_DISCONNECTED"; then
echo "... testing path"
bashio::log.fatal "...... invalid or inaccessible SMB path. Script will stop."
touch ERRORCODE
continue
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 # Test with different security versions
# 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)" for SECVERS in "$SECVERS" ",sec=ntlmv2" ",sec=ntlmssp" ",sec=ntlmsspi" ",sec=krb5i" ",sec=krb5" ",sec=ntlm" ",sec=ntlmv2i"; do
# Avoid : if [ "$MOUNTED" = false ]; then
SMBVERS="${SMBVERS/:/.}" mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}"
# Manage output fi
if [ -n "$SMBVERS" ]; then done
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
# Test with different security versions elif [[ "$FSTYPE" == "nfs" ]]; then
####################################### # Add NFS-specific port check (2049) similar to SMB (445)
for SECVERS in "$SECVERS" ",sec=ntlmv2" ",sec=ntlmssp" ",sec=ntlmsspi" ",sec=krb5i" ",sec=krb5" ",sec=ntlm" ",sec=ntlmv2i"; do output="$(nmap -F $server -T5 -oG -)"
if [ "$MOUNTED" = false ]; then if ! echo "$output" | grep -E '(2049|111)/open' &> /dev/null; then
mount_drive "rw,file_mode=0775,dir_mode=0775,username=${USERNAME},password=${PASSWORD},nobrl${SMBVERS}${SECVERS}${PUID}${PGID}${CHARSET}${DOMAIN}" bashio::log.fatal "...... $server is reachable but NFS ports not open"
continue
fi fi
done # 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 fi
# Messages # Messages
@@ -245,7 +294,7 @@ if bashio::config.has_value 'networkdisks'; then
fi fi
# Alert if smbv1 # Alert if smbv1
if [[ "$MOUNTOPTIONS" == *"1.0"* ]]; then if [[ "$FSTYPE" == "cifs" && "$MOUNTOPTIONS" == *"1.0"* ]]; then
bashio::log.warning "" 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 "Your smb system requires smbv1. This is an obsolete protocol. Please correct this to prevent issues."
bashio::log.warning "" bashio::log.warning ""
@@ -253,19 +302,22 @@ if bashio::config.has_value 'networkdisks'; then
else else
# Mounting failed messages # Mounting failed messages
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" if [[ "$FSTYPE" == "cifs" ]]; then
bashio::log.fatal "Here is some debugging info :" 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
# Provide debugging info
smbclient -t 2 -L $disk -U "$USERNAME%$PASSWORD" -c "exit"
# Error code
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}"
bashio::log.fatal "Error read : $(< ERRORCODE), addon will stop in 1 min" bashio::log.fatal "Error read : $(< ERRORCODE), addon will stop in 1 min"
# clean folder # clean folder