base-files: reject invalid uci keys in network_get_device() and related procedures...
[lede.git] / package / base-files / files / lib / functions / network.sh
index 9366e5937a71fc2c5a04702fc692923c0aba9e86..ead69aa626621f12e4614a5b6ff78e0c81b63152 100644 (file)
 . /usr/share/libubox/jshn.sh
 
-__network_switch_inactive()
+__network_set_cache()
 {
-       local __tmp
-
-       if [ "$1" = 0 ] || [ "$1" = false ]; then
-               return 1
-       fi
-
-       json_get_type __tmp "inactive"
-
-       if [ "$__tmp" = object ]; then
-               json_select "inactive"
+       if [ -n "$3" ]; then
+               eval "export -- __NETWORK_CV_$1='$3'"
+               __NETWORK_CACHE="${__NETWORK_CACHE:+$__NETWORK_CACHE }__NETWORK_CV_$1"
+       elif json_get_var "__NETWORK_CV_$1" "$2"; then
+               __NETWORK_CACHE="${__NETWORK_CACHE:+$__NETWORK_CACHE }__NETWORK_CV_$1"
        fi
 }
 
-__network_set_cache()
+__network_export()
 {
-       __NETWORK_CACHE="${__NETWORK_CACHE:+$__NETWORK_CACHE }__NETWORK_CV_$1"
-       eval "__NETWORK_CV_$1='\$$2'"
+       local __v="__NETWORK_CV_$2"
+       eval "export -- \"$1=\${$__v:+\${$__v$4}$3}\"; [ -n \"\${$__v+x}\" ]"
 }
 
-__network_get_cache()
+__network_parse_ifstatus()
 {
-       eval "[ -n \"\${__NETWORK_CV_$1+x}\" ] && export -- \"$2=\$__NETWORK_CV_$1\""
-}
+       local __iface="$1"
+       local __key="${__iface}"
+       local __tmp
+       local __idx
+       local __list
+       local __old_ns
 
-__network_ipaddr()
-{
-       local __var="$1"
-       local __iface="$2"
-       local __family="$3"
-       local __prefix="$4"
-       local __key="ipaddr_${2}_${3}_${4}"
+       case "$__iface" in
+               *[^a-zA-Z0-9_]*) return 1 ;;
+       esac
 
-       __network_get_cache "$__key" "$__var" && return 0
+       __network_export __tmp "${__key}__parsed" && return 0
+       __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
+       [ -n "$__tmp" ] || return 1
 
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
+       json_set_namespace "network" __old_ns
+       json_load "$__tmp"
 
-       json_load "${__tmp:-{}}"
-       json_get_type __tmp "ipv${__family}_address"
+       __network_set_cache "${__key}__parsed" "" "1"
 
-       if [ "$__tmp" = array ]; then
+       for __tmp in "" "_inactive"; do
 
-               json_select "ipv${__family}_address"
-               json_get_type __tmp 1
+               __key="${__key}${__tmp}"
 
-               if [ "$__tmp" = object ]; then
+               # parse addresses
+               local __family
+               for __family in 4 6; do
 
-                       json_select 1
-                       json_get_var $__var address
+                       __list=""
 
-                       [ $__prefix -gt 0 ] && {
-                               json_get_var __tmp mask
-                               eval "export -- \"$__var=\${$__var}/$__tmp\""
-                       }
+                       if json_is_a "ipv${__family}_address" array; then
 
-                       __network_set_cache "$__key" "$__var"
-                       return 0
-               fi
-       fi
+                               json_select "ipv${__family}_address"
 
-       return 1
-}
+                               __idx=1
 
-# determine IPv4 address of given logical interface
-# 1: destination variable
-# 2: interface
-network_get_ipaddr()  { __network_ipaddr "$1" "$2" 4 0; }
+                               while json_is_a "$__idx" object; do
 
-# determine IPv6 address of given logical interface
-# 1: destination variable
-# 2: interface
-network_get_ipaddr6() { __network_ipaddr "$1" "$2" 6 0; }
+                                       json_select "$((__idx++))"
+                                       json_get_var __tmp "address" && __list="${__list:+$__list }$__tmp"
+                                       json_get_var __tmp "mask"    && __list="${__list:+$__list/}$__tmp"
+                                       json_select ".."
 
-# determine IPv4 subnet of given logical interface
-# 1: destination variable
-# 2: interface
-network_get_subnet()  { __network_ipaddr "$1" "$2" 4 1; }
+                               done
 
-# determine IPv6 subnet of given logical interface
-# 1: destination variable
-# 2: interface
-network_get_subnet6() { __network_ipaddr "$1" "$2" 6 1; }
+                               json_select ".."
 
+                       fi
 
-__network_gateway()
-{
-       local __var="$1"
-       local __iface="$2"
-       local __family="$3"
-       local __key="gateway_${2}_${3}"
+                       if json_is_a "ipv${__family}_prefix_assignment" array; then
+
+                               json_select "ipv${__family}_prefix_assignment"
 
-       __network_get_cache "$__key" "$__var" && return 0
+                               __idx=1
 
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
+                               while json_is_a "$__idx" object; do
 
-       json_load "${__tmp:-{}}"
+                                       json_select "$((__idx++))"
+                                       json_get_var __tmp "address" && __list="${__list:+$__list }${__tmp}1"
+                                       json_get_var __tmp "mask"    && __list="${__list:+$__list/}$__tmp"
+                                       json_select ".."
 
-       for __tmp in 0 1; do
+                               done
+
+                               json_select ".."
 
-               if json_get_type __tmp route && [ "$__tmp" = array ]; then
+                       fi
 
-                       json_select route
+                       if [ -n "$__list" ]; then
+                               __network_set_cache "${__key}_address${__family}" "" "$__list"
+                       fi
+
+               done
+
+               # parse prefixes
+               if json_is_a "ipv6_prefix" array; then
+                       json_select "ipv6_prefix"
+
+                       __idx=1
+                       __list=""
+
+                       while json_is_a "$__idx" object; do
+
+                               json_select "$((__idx++))"
+                               json_get_var __tmp "address" && __list="${__list:+$__list }$__tmp"
+                               json_get_var __tmp "mask"    && __list="${__list:+$__list/}$__tmp"
+                               json_select ".."
+
+                       done
+
+                       json_select ".."
+
+
+                       if [ -n "$__list" ]; then
+                               __network_set_cache "${__key}_prefix6" "" "$__list"
+                       fi
+
+               fi
+
+               # parse routes
+               if json_is_a route array; then
+
+                       json_select "route"
 
                        local __idx=1
-                       while json_get_type __tmp "$__idx" && [ "$__tmp" = object ]; do
+                       while json_is_a "$__idx" object; do
 
                                json_select "$((__idx++))"
-                               json_get_var __tmp target
+                               json_get_var __tmp table
 
-                               case "${__family}/${__tmp}" in
-                                       4/0.0.0.0|6/::)
-                                               json_get_var "$__var" nexthop
-                                               __network_set_cache "$__key" "$__var"
-                                               return $?
-                                       ;;
-                               esac
+                               if [ -z "$__tmp" ]; then
+                                       json_get_var __tmp target
+
+                                       case "${__tmp}" in
+                                               0.0.0.0)
+                                                       __network_set_cache "${__key}_gateway4" nexthop
+                                               ;;
+                                               ::)
+                                                       __network_set_cache "${__key}_gateway6" nexthop
+                                               ;;
+                                       esac
+                               fi
 
                                json_select ".."
 
@@ -126,64 +149,173 @@ __network_gateway()
 
                fi
 
-               __network_switch_inactive "$4" || break
+               # parse dns info
+               local __field
+               for __field in "dns_server" "dns_search"; do
+                       if json_is_a "$__field" array; then
+
+                               json_select "$__field"
+
+                               __idx=1
+                               __list=""
+
+                               while json_is_a "$__idx" string; do
+
+                                       json_get_var __tmp "$((__idx++))"
+                                       __list="${__list:+$__list }$__tmp"
+
+                               done
+
+                               json_select ".."
+
+                               if [ -n "$__list" ]; then
+                                       __network_set_cache "${__key}_${__field}" "" "$__list"
+                               fi
+                       fi
+               done
+
+               # parse up state, device and physdev
+               for __field in "up" "l3_device" "device"; do
+                       if json_get_type __tmp "$__field"; then
+                               __network_set_cache "${__key}_${__field}" "$__field"
+                       fi
+               done
+
+               # descend into inactive table
+               json_is_a "inactive" object && json_select "inactive"
 
        done
 
-       return 1
+       json_cleanup
+       json_set_namespace "$__old_ns"
+
+       return 0
 }
 
-# determine IPv4 gateway of given logical interface
+
+__network_ipaddr()
+{
+       local __var="$1"
+       local __iface="$2"
+       local __field="$3"
+       local __subst="$4"
+       local __list="$5"
+       local __tmp=""
+
+       __network_parse_ifstatus "$__iface" || return 1
+
+       if [ $__list = 1 ] && [ -n "$__subst" ]; then
+               __network_export "__list" "${__iface}_${__field}"
+
+               for __list in $__list; do
+                       eval "__tmp=\"${__tmp:+$__tmp }\${__list$__subst}\""
+               done
+
+               export -- "$__var=$__tmp"; [ -n "$__tmp" ]
+               return $?
+       fi
+
+       __network_export "$__var" "${__iface}_${__field}" "" "$__subst"
+       return $?
+}
+
+# determine first IPv4 address of given logical interface
 # 1: destination variable
 # 2: interface
-# 3: consider inactive gateway if "true" (optional)
-network_get_gateway()  { __network_gateway "$1" "$2" 4 "${3:-0}"; }
+network_get_ipaddr()  { __network_ipaddr "$1" "$2" "address4" "%%/*" 0; }
 
-# determine  IPv6 gateway of given logical interface
+# determine first IPv6 address of given logical interface
 # 1: destination variable
 # 2: interface
-# 3: consider inactive gateway if "true" (optional)
-network_get_gateway6() { __network_gateway "$1" "$2" 6 "${3:-0}"; }
+network_get_ipaddr6() { __network_ipaddr "$1" "$2" "address6" "%%/*" 0; }
 
+# determine first IPv4 subnet of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnet()  { __network_ipaddr "$1" "$2" "address4" "%% *" 0; }
 
-__network_dns() {
-       local __var="$1"
-       local __iface="$2"
-       local __field="$3"
-       local __key="dns_${2}_${3}"
+# determine first IPv6 subnet of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnet6() { __network_ipaddr "$1" "$2" "address6" "%% *" 0; }
 
-       __network_get_cache "$__key" "$__var" && return 0
+# determine first IPv6 prefix of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_prefix6() { __network_ipaddr "$1" "$2" "prefix6" "%% *" 0; }
 
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
-       local __dns=""
+# determine all IPv4 addresses of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddrs()  { __network_ipaddr "$1" "$2" "address4" "%%/*" 1; }
+
+# determine all IPv6 addresses of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_ipaddrs6() { __network_ipaddr "$1" "$2" "address6" "%%/*" 1; }
 
-       json_load "${__tmp:-{}}"
+# determine all IPv4 subnets of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnets()  { __network_ipaddr "$1" "$2" "address4" "" 1; }
 
-       for __tmp in 0 1; do
+# determine all IPv6 subnets of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_subnets6() { __network_ipaddr "$1" "$2" "address6" "" 1; }
 
-               if json_get_type __tmp "$__field" && [ "$__tmp" = array ]; then
+# determine all IPv6 prefixes of given logical interface
+# 1: destination variable
+# 2: interface
+network_get_prefixes6() { __network_ipaddr "$1" "$2" "prefix6" "" 1; }
 
-                       json_select "$__field"
 
-                       local __idx=1
-                       while json_get_type __tmp "$__idx" && [ "$__tmp" = string ]; do
+__network_gateway()
+{
+       local __var="$1"
+       local __iface="$2"
+       local __family="$3"
+       local __inactive="$4"
 
-                               json_get_var __tmp "$((__idx++))"
-                               __dns="${__dns:+$__dns }$__tmp"
+       __network_parse_ifstatus "$__iface" || return 1
 
-                       done
+       if [ "$__inactive" = 1 -o "$__inactive" = "true" ]; then
+               __network_export "$__var" "${__iface}_inactive_gateway${__family}" && \
+                       return 0
+       fi
 
-                       json_select ".."
-               fi
+       __network_export "$__var" "${__iface}_gateway${__family}"
+       return $?
+}
 
-               __network_switch_inactive "$4" || break
+# determine IPv4 gateway of given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive gateway if "true" (optional)
+network_get_gateway()  { __network_gateway "$1" "$2" 4 "${3:-0}"; }
+
+# determine  IPv6 gateway of given logical interface
+# 1: destination variable
+# 2: interface
+# 3: consider inactive gateway if "true" (optional)
+network_get_gateway6() { __network_gateway "$1" "$2" 6 "${3:-0}"; }
 
-       done
 
-       if [ -n "$__dns" ]; then
-               eval "export -- \"$__var=$__dns\""
-               __network_set_cache "$__key" "$__var"
+__network_dns() {
+       local __var="$1"
+       local __iface="$2"
+       local __field="$3"
+       local __inactive="$4"
+
+       __network_parse_ifstatus "$__iface" || return 1
+
+       if [ "$__inactive" = 1 -o "$__inactive" = "true" ]; then
+               __network_export "$__var" "${__iface}_inactive_${__field}" && \
+                       return 0
        fi
+
+       __network_export "$__var" "${__iface}_${__field}"
+       return $?
 }
 
 # determine the DNS servers of the given logical interface
@@ -195,23 +327,23 @@ network_get_dnsserver() { __network_dns "$1" "$2" dns_server "${3:-0}"; }
 # determine the domains of the given logical interface
 # 1: destination variable
 # 2: interface
-# 3: consider inactive servers if "true" (optional)
+# 3: consider inactive domains if "true" (optional)
 network_get_dnssearch() { __network_dns "$1" "$2" dns_search "${3:-0}"; }
 
 
-__network_wan() {
+__network_wan()
+{
        local __var="$1"
        local __family="$2"
-       local __key="wan_${2}"
+       local __inactive="$3"
        local __iface
 
-       __network_get_cache "$__key" "$__var" && return 0
-
        for __iface in $(ubus list | sed -ne 's/^network\.interface\.//p'); do
-               if __network_gateway "$__var" "$__iface" "$__family"; then
-                       eval "export -- \"$__var=$__iface\""
-                       __network_set_cache "$__key" "$__var"
-                       return 0
+               if [ "$__iface" != loopback ]; then
+                       if __network_gateway "$__var" "$__iface" "$__family" "$__inactive"; then
+                               eval "export -- \"$__var=$__iface\""
+                               return 0
+                       fi
                fi
        done
 
@@ -221,11 +353,13 @@ __network_wan() {
 
 # find the logical interface which holds the current IPv4 default route
 # 1: destination variable
-network_find_wan()  { __network_wan "$1" 4; }
+# 2: consider inactive default routes if "true" (optional)
+network_find_wan()  { __network_wan "$1" 4 "${2:-0}"; }
 
 # find the logical interface which holds the current IPv6 default route
 # 1: destination variable
-network_find_wan6() { __network_wan "$1" 6; }
+# 2: consider inactive dafault routes if "true" (optional)
+network_find_wan6() { __network_wan "$1" 6 "${2:-0}"; }
 
 
 __network_device()
@@ -233,15 +367,10 @@ __network_device()
        local __var="$1"
        local __iface="$2"
        local __field="$3"
-       local __key="device_${2}_${3}"
 
-       __network_get_cache "$__key" "$__var" && return 0
-
-       local __tmp="$(ubus call network.interface."$__iface" status 2>/dev/null)"
-       [ -n "$__tmp" ] || return 1
-
-       json_load "$__tmp"
-       json_get_var "$__var" "$__field" && __network_set_cache "$__key" "$__var"
+       __network_parse_ifstatus "$__iface" || return 1
+       __network_export "$__var" "${__iface}_${__field}"
+       return $?
 }
 
 # test whether the given logical interface is running