#!/bin/sh # travelmate, a wlan connection manager for travel router # written by Dirk Brenken (dev@brenken.org) # This is free software, licensed under the GNU General Public License v3. # You should have received a copy of the GNU General Public License # along with this program. If not, see . # set initial defaults # LC_ALL=C PATH="/usr/sbin:/usr/bin:/sbin:/bin" trm_ver="1.4.11" trm_sysver="unknown" trm_enabled=0 trm_debug=0 trm_iface="trm_wwan" trm_captive=1 trm_proactive=1 trm_netcheck=0 trm_captiveurl="http://captive.apple.com" trm_scanbuffer=1024 trm_minquality=35 trm_maxretry=5 trm_maxwait=30 trm_timeout=60 trm_listexpiry=0 trm_radio="" trm_connection="" trm_rtfile="/tmp/trm_runtime.json" trm_fetch="$(command -v uclient-fetch)" trm_iwinfo="$(command -v iwinfo)" trm_wpa="$(command -v wpa_supplicant)" trm_action="${1:-"start"}" trm_pidfile="/var/run/travelmate.pid" # trim leading and trailing whitespace characters # f_trim() { local IFS trim="${1}" trim="${trim#"${trim%%[![:space:]]*}"}" trim="${trim%"${trim##*[![:space:]]}"}" printf '%s' "${trim}" } # load travelmate environment # f_envload() { local IFS sys_call sys_desc sys_model # (re-)initialize global list variables # unset trm_devlist trm_stalist trm_radiolist trm_active_sta # get system information # sys_call="$(ubus -S call system board 2>/dev/null)" if [ -n "${sys_call}" ] then sys_desc="$(printf '%s' "${sys_call}" | jsonfilter -e '@.release.description')" sys_model="$(printf '%s' "${sys_call}" | jsonfilter -e '@.model')" trm_sysver="${sys_model}, ${sys_desc}" fi # get eap capabilities # trm_eap="$("${trm_wpa}" -veap >/dev/null 2>&1; printf "%u" ${?})" # load config and check 'enabled' option # config_cb() { local name="${1}" type="${2}" if [ "${name}" = "travelmate" ] && [ "${type}" = "global" ] then option_cb() { local option="${1}" value="${2}" eval "${option}=\"${value}\"" } else option_cb() { return 0 } fi } config_load travelmate if [ "${trm_enabled}" -ne 1 ] then f_log "info" "travelmate is currently disabled, please set 'trm_enabled' to '1' to use this service" exit 0 fi # validate input ranges # if [ "${trm_minquality}" -lt 20 ] || [ "${trm_minquality}" -gt 80 ] then trm_minquality=35 fi if [ "${trm_listexpiry}" -lt 0 ] || [ "${trm_listexpiry}" -gt 300 ] then trm_listexpiry=0 fi if [ "${trm_maxretry}" -lt 1 ] || [ "${trm_maxretry}" -gt 10 ] then trm_maxretry=5 fi if [ "${trm_maxwait}" -lt 20 ] || [ "${trm_maxwait}" -gt 40 ] || [ "${trm_maxwait}" -ge "${trm_timeout}" ] then trm_maxwait=30 fi if [ "${trm_timeout}" -lt 30 ] || [ "${trm_timeout}" -gt 300 ] || [ "${trm_timeout}" -le "${trm_maxwait}" ] then trm_timeout=60 fi # load json runtime file # json_load_file "${trm_rtfile}" >/dev/null 2>&1 json_select data >/dev/null 2>&1 if [ "${?}" -ne 0 ] then > "${trm_rtfile}" json_init json_add_object "data" fi } # gather radio information & bring down all STA interfaces # f_prep() { local IFS mode network radio disabled eaptype config="${1}" proactive="${2}" mode="$(uci_get wireless "${config}" mode)" network="$(uci_get wireless "${config}" network)" radio="$(uci_get wireless "${config}" device)" disabled="$(uci_get wireless "${config}" disabled)" eaptype="$(uci_get wireless "${config}" eap_type)" if [ -n "${config}" ] && [ -n "${radio}" ] && [ -n "${mode}" ] && [ -n "${network}" ] then if [ -z "${trm_radio}" ] && [ -z "$(printf "%s" "${trm_radiolist}" | grep -Fo "${radio}")" ] then trm_radiolist="$(f_trim "${trm_radiolist} ${radio}")" elif [ -n "${trm_radio}" ] && [ -z "${trm_radiolist}" ] then trm_radiolist="$(f_trim "$(printf "%s" "${trm_radio}" | \ awk '{while(match(tolower($0),/radio[0-9]/)){ORS=" ";print substr(tolower($0),RSTART,RLENGTH);$0=substr($0,RSTART+RLENGTH)}}')")" fi if [ "${mode}" = "sta" ] && [ "${network}" = "${trm_iface}" ] then if { [ -z "${disabled}" ] || [ "${disabled}" = "0" ]; } && { [ "${proactive}" -eq 0 ] || [ "${trm_ifstatus}" != "true" ]; } then uci_set wireless "${config}" disabled 1 elif [ "${disabled}" = "0" ] && [ "${trm_ifstatus}" = "true" ] && [ -z "${trm_active_sta}" ] && [ "${proactive}" -eq 1 ] then trm_active_sta="${config}" fi if [ -z "${eaptype}" ] || { [ -n "${eaptype}" ] && [ "${trm_eap:-1}" -eq 0 ]; } then trm_stalist="$(f_trim "${trm_stalist} ${config}-${radio}")" fi fi fi f_log "debug" "f_prep ::: config: ${config}, mode: ${mode}, network: ${network}, radio: ${radio}, trm_radio: ${trm_radio:-"-"}, trm_active_sta: ${trm_active_sta:-"-"}, proactive: ${proactive}, trm_eap: ${trm_eap:-"-"}, disabled: ${disabled}" } # check interface status # f_check() { local IFS ifname radio dev_status config sta_essid sta_bssid result uci_essid uci_bssid login_command bg_pid wait_time mode="${1}" status="${2:-"false"}" cp_domain="${3:-"false"}" if [ "${mode}" != "initial" ] && [ "${status}" = "false" ] then ubus call network reload wait_time=$((trm_maxwait/6)) sleep ${wait_time} fi wait_time=1 while [ "${wait_time}" -le "${trm_maxwait}" ] do dev_status="$(ubus -S call network.wireless status 2>/dev/null)" if [ -n "${dev_status}" ] then if [ "${mode}" = "dev" ] then if [ "${trm_ifstatus}" != "${status}" ] then trm_ifstatus="${status}" f_jsnup fi for radio in ${trm_radiolist} do result="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e "@.${radio}.up")" if [ "${result}" = "true" ] && [ -z "$(printf "%s" "${trm_devlist}" | grep -Fo "${radio}")" ] then trm_devlist="$(f_trim "${trm_devlist} ${radio}")" fi done if [ "${trm_devlist}" = "${trm_radiolist}" ] || [ "${wait_time}" -eq "${trm_maxwait}" ] then ifname="${trm_devlist}" break else unset trm_devlist fi elif [ "${mode}" = "rev" ] then break else ifname="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].ifname')" if [ -n "${ifname}" ] then trm_ifquality="$(${trm_iwinfo} "${ifname}" info 2>/dev/null | awk -F "[ ]" '/Link Quality:/{split($NF,var0,"/");printf "%i\n",(var0[1]*100/var0[2])}')" if [ "${mode}" = "initial" ] && [ "${trm_captive}" -eq 1 ] then result="$(${trm_fetch} --timeout=$((trm_maxwait/6)) "${trm_captiveurl}" -O /dev/null 2>&1 | \ awk '/^Failed to redirect|^Redirected/{printf "%s" "net cp \047"$NF"\047";exit}/^Download completed/{printf "%s" "net ok";exit}/^Failed|Connection error/{printf "%s" "net nok";exit}')" if [ "${cp_domain}" = "true" ] then cp_domain="$(printf "%s" "${result}" | awk -F "[\\'| ]" '/^net cp/{printf "%s" $4}')" uci_essid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].config.ssid')" uci_essid="$(printf "%s" "${uci_essid//[^[:alnum:]_]/_}" | awk '{print tolower($1)}')" uci_bssid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].config.bssid')" uci_bssid="${uci_bssid//[^[:alnum:]_]/_}" fi fi if [ "${trm_ifquality}" -ge "${trm_minquality}" ] && [ "${result}" != "net nok" ] then trm_ifstatus="$(ubus -S call network.interface dump 2>/dev/null | jsonfilter -l1 -e "@.interface[@.device=\"${ifname}\"].up")" if [ "${trm_ifstatus}" = "true" ] then if [ "${mode}" = "sta" ] && [ "${trm_captive}" -eq 1 ] then while true do result="$(${trm_fetch} --timeout=$((trm_maxwait/6)) "${trm_captiveurl}" -O /dev/null 2>&1 | \ awk '/^Failed to redirect|^Redirected/{printf "%s" "net cp \047"$NF"\047";exit}/^Download completed/{printf "%s" "net ok";exit}/^Failed|Connection error/{printf "%s" "net nok";exit}')" cp_domain="$(printf "%s" "${result}" | awk -F "[\\'| ]" '/^net cp/{printf "%s" $4}')" uci_essid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].config.ssid')" uci_essid="$(printf "%s" "${uci_essid//[^[:alnum:]_]/_}" | awk '{print tolower($1)}')" uci_bssid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].config.bssid')" uci_bssid="${uci_bssid//[^[:alnum:]_]/_}" if [ "${trm_netcheck}" -eq 1 ] && [ "${result}" = "net nok" ] then trm_ifstatus="${status}" f_jsnup break 2 fi if [ -z "${cp_domain}" ] || [ -n "$(uci_get dhcp "@dnsmasq[0]" rebind_domain | grep -Fo "${cp_domain}")" ] then break fi uci -q add_list dhcp.@dnsmasq[0].rebind_domain="${cp_domain}" f_log "info" "captive portal domain '${cp_domain}' added to to dhcp rebind whitelist" if [ -z "$(uci_get travelmate "${uci_essid}${uci_bssid}")" ] then uci_add travelmate "login" "${uci_essid}${uci_bssid}" uci_set travelmate "${uci_essid}${uci_bssid}" "command" "none" f_log "info" "captive portal login section '${uci_essid}${uci_bssid}' added to travelmate config section" fi done if [ -n "$(uci -q changes dhcp)" ] then uci_commit dhcp /etc/init.d/dnsmasq reload fi if [ -n "$(uci -q changes travelmate)" ] then uci_commit travelmate fi fi if [ -n "${cp_domain}" ] && [ "${cp_domain}" != "false" ] && [ -n "${uci_essid}" ] && [ "${trm_captive}" -eq 1 ] then trm_connection="${result:-"-"}/${trm_ifquality}" f_jsnup login_command="$(uci_get travelmate "${uci_essid}${uci_bssid}" command)" if [ -x "${login_command}" ] then "${login_command}" >/dev/null 2>&1 rc=${?} f_log "info" "captive portal login '${login_command:0:40}' for '${cp_domain}' has been executed with rc '${rc}'" if [ "${rc}" -eq 0 ] then result="$(${trm_fetch} --timeout=$((trm_maxwait/6)) "${trm_captiveurl}" -O /dev/null 2>&1 | \ awk '/^Failed to redirect|^Redirected/{printf "%s" "net cp \047"$NF"\047";exit}/^Download completed/{printf "%s" "net ok";exit}/^Failed|Connection error/{printf "%s" "net nok";exit}')" fi fi fi trm_connection="${result:-"-"}/${trm_ifquality}" f_jsnup break fi elif [ -n "${trm_connection}" ] then sta_essid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].*.ssid')" sta_bssid="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].*.bssid')" if [ "${trm_ifquality}" -lt "${trm_minquality}" ] then unset trm_connection trm_ifstatus="${status}" f_log "info" "uplink '${sta_essid:-"-"}/${sta_bssid:-"-"}' is out of range (${trm_ifquality}/${trm_minquality})" elif [ "${trm_netcheck}" -eq 1 ] && [ "${result}" = "net nok" ] then unset trm_connection trm_ifstatus="${status}" f_log "info" "uplink '${sta_essid:-"-"}/${sta_bssid:-"-"}' has no internet (${result})" fi f_jsnup break elif [ "${mode}" = "initial" ] then f_jsnup break fi elif [ -n "${trm_connection}" ] then unset trm_connection trm_ifstatus="${status}" f_jsnup break elif [ "${mode}" = "initial" ] then f_jsnup break fi fi fi wait_time=$((wait_time+1)) sleep 1 done f_log "debug" "f_check::: mode: ${mode}, name: ${ifname:-"-"}, status: ${trm_ifstatus}, connection: ${trm_connection:-"-"}, wait: ${wait_time}, max_wait: ${trm_maxwait}, min_quality: ${trm_minquality}, captive: ${trm_captive}, netcheck: ${trm_netcheck}" } # update runtime information # f_jsnup() { local IFS config d1 d2 d3 last_date last_station sta_iface sta_radio sta_essid sta_bssid last_status dev_status status="${trm_ifstatus}" faulty_list faulty_station="${1}" dev_status="$(ubus -S call network.wireless status 2>/dev/null)" if [ -n "${dev_status}" ] then config="$(printf "%s" "${dev_status}" | jsonfilter -l1 -e '@.*.interfaces[@.config.mode="sta"].section')" if [ -n "${config}" ] then sta_iface="$(uci_get wireless "${config}" network)" sta_radio="$(uci_get wireless "${config}" device)" sta_essid="$(uci_get wireless "${config}" ssid)" sta_bssid="$(uci_get wireless "${config}" bssid)" fi fi json_get_var last_date "last_rundate" json_get_var last_station "station_id" if [ "${status}" = "true" ] then status="connected (${trm_connection:-"-"})" json_get_var last_status "travelmate_status" if [ "${last_status}" = "running / not connected" ] || [ "${last_station}" != "${sta_radio:-"-"}/${sta_essid:-"-"}/${sta_bssid:-"-"}" ] then last_date="$(/bin/date "+%Y.%m.%d-%H:%M:%S")" fi elif [ "${status}" = "error" ] then unset trm_connection status="program error" else unset trm_connection status="running / not connected" fi if [ -z "${last_date}" ] then last_date="$(/bin/date "+%Y.%m.%d-%H:%M:%S")" fi json_get_var faulty_list "faulty_stations" if [ -n "${faulty_list}" ] && [ "${trm_listexpiry}" -gt 0 ] then d1="$(/bin/date -d "${last_date}" "+%s")" d2="$(/bin/date "+%s")" d3=$(((d2 - d1)/60)) if [ "${d3}" -ge "${trm_listexpiry}" ] then faulty_list="" fi fi if [ -n "${faulty_station}" ] then if [ -z "$(printf "%s" "${faulty_list}" | grep -Fo "${faulty_station}")" ] then faulty_list="$(f_trim "${faulty_list} ${faulty_station}")" last_date="$(/bin/date "+%Y.%m.%d-%H:%M:%S")" fi fi json_add_string "travelmate_status" "${status}" json_add_string "travelmate_version" "${trm_ver}" json_add_string "station_id" "${sta_radio:-"-"}/${sta_essid:-"-"}/${sta_bssid:-"-"}" json_add_string "station_interface" "${sta_iface:-"-"}" json_add_string "faulty_stations" "${faulty_list}" json_add_string "last_rundate" "${last_date}" json_add_string "system" "${trm_sysver}" json_dump > "${trm_rtfile}" f_log "debug" "f_jsnup::: config: ${config:-"-"}, status: ${status:-"-"}, sta_iface: ${sta_iface:-"-"}, sta_radio: ${sta_radio:-"-"}, sta_essid: ${sta_essid:-"-"}, sta_bssid: ${sta_bssid:-"-"}, faulty_list: ${faulty_list:-"-"}, list_expiry: ${trm_listexpiry}" } # write to syslog # f_log() { local IFS class="${1}" log_msg="${2}" if [ -n "${log_msg}" ] && { [ "${class}" != "debug" ] || [ "${trm_debug}" -eq 1 ]; } then logger -p "${class}" -t "travelmate-${trm_ver}[${$}]" "${log_msg}" if [ "${class}" = "err" ] then trm_ifstatus="error" f_jsnup logger -p "${class}" -t "travelmate-${trm_ver}[${$}]" "Please check 'https://github.com/openwrt/packages/blob/master/net/travelmate/files/README.md' (${trm_sysver})" exit 1 fi fi } # main function for connection handling # f_main() { local IFS cnt dev config spec scan_list scan_essid scan_bssid scan_quality faulty_list local station_id sta sta_essid sta_bssid sta_radio sta_iface active_essid active_bssid active_radio f_check "initial" "false" "true" f_log "debug" "f_main ::: status: ${trm_ifstatus}, proactive: ${trm_proactive}" if [ "${trm_ifstatus}" != "true" ] || [ "${trm_proactive}" -eq 1 ] then config_load wireless config_foreach f_prep wifi-iface ${trm_proactive} if [ "${trm_ifstatus}" = "true" ] && [ -n "${trm_active_sta}" ] && [ "${trm_proactive}" -eq 1 ] then json_get_var station_id "station_id" active_radio="${station_id%%/*}" active_essid="${station_id%/*}" active_essid="${active_essid#*/}" active_bssid="${station_id##*/}" f_check "dev" "true" f_log "debug" "f_main ::: active_radio: ${active_radio}, active_essid: \"${active_essid}\", active_bssid: ${active_bssid:-"-"}" else uci_commit wireless f_check "dev" fi json_get_var faulty_list "faulty_stations" f_log "debug" "f_main ::: iwinfo: ${trm_iwinfo:-"-"}, dev_list: ${trm_devlist:-"-"}, sta_list: ${trm_stalist:0:${trm_scanbuffer}}, faulty_list: ${faulty_list:-"-"}" # radio loop # for dev in ${trm_devlist} do if [ -z "$(printf "%s" "${trm_stalist}" | grep -o "\\-${dev}")" ] then f_log "debug" "f_main ::: no station on '${dev}' - continue" continue fi # station loop # for sta in ${trm_stalist} do config="${sta%%-*}" sta_radio="${sta##*-}" sta_essid="$(uci_get wireless "${config}" ssid)" sta_bssid="$(uci_get wireless "${config}" bssid)" sta_iface="$(uci_get wireless "${config}" network)" json_get_var faulty_list "faulty_stations" if [ -n "$(printf "%s" "${faulty_list}" | grep -Fo "${sta_radio}/${sta_essid}/${sta_bssid}")" ] then f_log "debug" "f_main ::: faulty station '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' - continue" continue fi if [ "${dev}" = "${active_radio}" ] && [ "${sta_essid}" = "${active_essid}" ] && [ "${sta_bssid:-"-"}" = "${active_bssid}" ] then f_log "debug" "f_main ::: active station prioritized '${active_radio}/${active_essid}/${active_bssid:-"-"}' - break" break 2 fi f_log "debug" "f_main ::: sta_radio: ${sta_radio}, sta_essid: \"${sta_essid}\", sta_bssid: ${sta_bssid:-"-"}" if [ -z "${scan_list}" ] then scan_list="$("${trm_iwinfo}" "${dev}" scan 2>/dev/null | \ awk 'BEGIN{FS="[ ]"}/Address:/{var1=$NF}/ESSID:/{var2="";for(i=12;i<=NF;i++)if(var2==""){var2=$i}else{var2=var2" "$i}; gsub(/,/,".",var2)}/Quality:/{split($NF,var0,"/");printf "%i,%s,%s\n",(var0[1]*100/var0[2]),var1,var2}' | \ sort -rn | awk -v buf="${trm_scanbuffer}" 'BEGIN{ORS=","}{print substr($0,1,buf)}')" f_log "debug" "f_main ::: scan_buffer: ${trm_scanbuffer}, scan_list: ${scan_list}" if [ -z "${scan_list}" ] then f_log "debug" "f_main ::: no scan results on '${dev}' - continue" continue 2 fi fi # scan loop # IFS="," for spec in ${scan_list} do if [ -z "${scan_quality}" ] then scan_quality="${spec}" elif [ -z "${scan_bssid}" ] then scan_bssid="${spec}" elif [ -z "${scan_essid}" ] then scan_essid="${spec}" fi if [ -n "${scan_quality}" ] && [ -n "${scan_bssid}" ] && [ -n "${scan_essid}" ] then if [ "${scan_quality}" -ge "${trm_minquality}" ] then if { { [ "${scan_essid}" = "\"${sta_essid//,/.}\"" ] && { [ -z "${sta_bssid}" ] || [ "${scan_bssid}" = "${sta_bssid}" ]; } } || \ { [ "${scan_bssid}" = "${sta_bssid}" ] && [ "${scan_essid}" = "unknown" ]; } } && [ "${dev}" = "${sta_radio}" ] then f_log "debug" "f_main ::: scan_quality: ${scan_quality}, scan_essid: ${scan_essid}, scan_bssid: ${scan_bssid:-"-"}" if [ "${dev}" = "${active_radio}" ] then unset trm_connection active_radio active_essid active_bssid uci_set wireless "${trm_active_sta}" disabled 1 uci_commit wireless fi # retry loop # cnt=1 while [ "${cnt}" -le "${trm_maxretry}" ] do uci_set wireless "${config}" disabled 0 f_check "sta" if [ "${trm_ifstatus}" = "true" ] then unset IFS scan_list uci_commit wireless f_log "info" "connected to uplink '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${cnt}/${trm_maxretry}, ${trm_sysver})" return 0 else uci -q revert wireless f_check "rev" if [ "${cnt}" -eq "${trm_maxretry}" ] then faulty_station="${sta_radio}/${sta_essid}/${sta_bssid:-"-"}" f_jsnup "${faulty_station}" f_log "info" "uplink disabled '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${cnt}/${trm_maxretry}, ${trm_sysver})" break 2 else f_jsnup f_log "info" "can't connect to uplink '${sta_radio}/${sta_essid}/${sta_bssid:-"-"}' (${cnt}/${trm_maxretry}, ${trm_sysver})" fi fi cnt=$((cnt+1)) sleep $((trm_maxwait/6)) done else unset scan_quality scan_bssid scan_essid continue fi else unset scan_quality scan_bssid scan_essid continue fi fi done unset IFS scan_quality scan_bssid scan_essid done unset scan_list done fi } # source required system libraries # if [ -r "/lib/functions.sh" ] && [ -r "/usr/share/libubox/jshn.sh" ] then . "/lib/functions.sh" . "/usr/share/libubox/jshn.sh" else f_log "err" "system libraries not found" fi # control travelmate actions # f_envload while true do if [ -z "${trm_action}" ] then rc=0 while true do if [ "${rc}" -eq 0 ] then f_check "initial" fi sleep ${trm_timeout} 0 rc=${?} if [ "${rc}" -ne 0 ] then f_check "initial" fi if [ "${rc}" -eq 0 ] || { [ "${rc}" -ne 0 ] && [ "${trm_ifstatus}" = "false" ]; } then break fi done elif [ "${trm_action}" = "stop" ] then > "${trm_rtfile}" f_log "info" "travelmate instance stopped ::: action: ${trm_action}, pid: $(cat ${trm_pidfile} 2>/dev/null)" exit 0 else f_log "info" "travelmate instance started ::: action: ${trm_action}, pid: ${$}" unset trm_action fi json_cleanup f_envload f_main done