nodogsplash: migrate to uci based configuration
[feed/routing.git] / nodogsplash / files / nodogsplash.init
old mode 100644 (file)
new mode 100755 (executable)
index 7eba60b..682d505
@@ -2,6 +2,7 @@
 #
 # description: Startup/shutdown script for nodogsplash captive portal
 #
+# Alexander Couzens <lynxis@fe80.eu> 2014
 # P. Kube 2007
 #
 # (Based on wifidog startup script
 # Comment by that author: Could be better, but it's working as expected)
 #
 
+START=95
+STOP=95
+
+USE_PROCD=1
 
 IPT=/usr/sbin/iptables
 WD_DIR=/usr/bin
-OPTIONS=""
-START=65
-STOP=65
 # -s -d 5 runs in background, with level 5 (not so verbose) messages to syslog
 # -f -d 7 runs in foreground, with level 7 (verbose) debug messages to terminal
-# N.B.: -f will fail if starting at boot from rcS
-#OPTIONS="-s -d 5"
-
-start() {
-       echo "Starting nodogsplash ... "
-       if $WD_DIR/ndsctl status 2> /dev/null; then
-               echo "FAILED:  nodogsplash already running"
-       else
-               if test_module && $WD_DIR/nodogsplash $OPTIONS; then
-                       echo "OK: nodogsplash started"
-               else
-                       echo "FAILED:  nodogsplash exited with non 0 status"
-               fi
-       fi
+OPTIONS="-s -f -d 5"
+CONFIGFILE="/tmp/invalid_nodogsplash.conf"
+
+# nolog(loglevel message ...)
+nolog() {
+  local level=$1
+  shift
+  logger -s -t nodogsplash -p daemon.$level $@
 }
 
-stop() {
-       echo "Stopping nodogsplash ... "
-       if $WD_DIR/ndsctl status 2> /dev/null; then
-               if $WD_DIR/ndsctl stop; then
-                       echo "OK: nodogsplash stopped"
-               else
-                       echo "FAILED:  ndsctl stop exited with non 0 status"
-               fi
-       else
-               echo "FAILED:  nodogsplash was not running"
-       fi
+# append_config_option <cfgfile> <uci_cfg_obj> <option_name> <config_counterpart> [<optional default>]
+# append "$config_counterpart $value" to cfgfile if option_name exists
+# e.g. append_config_option "$CONFIGFILE" "$cfg" bind_address BindAddress 0.0.0.0
+# will append "BindAddress 192.168.1.1" if uci bind_address is '192.168.1.1'
+append_config_option() {
+  local val=""
+  local cfg="$1"
+  local config_file="$2"
+  local option_name="$3"
+  local config_counterpart="$4"
+  local default="$5"
+  config_get val "$cfg" "$option_name" "$default"
+  [ -n "$val" ] && echo "" >> $config_file
+}
+
+setup_user_authentication() {
+  local cfg="$1"
+  local val
+
+  config_get_bool val "$cfg" authenticate_immediately 0
+  [ $val -gt 0 ] && echo "AuthenticateImmediately yes" >> $CONFIGFILE
+
+  config_get val "$cfg" username
+  if [ -n "${val}" ] ; then
+    echo "UsernameAuthentication" >> $CONFIGFILE
+    echo "Username ${val}" >> $CONFIGFILE
+  fi
+
+  config_get val "$cfg" password
+  if [ -n "${val}" ] ; then
+    echo "PasswordAuthentication" >> $CONFIGFILE
+    echo "Password ${val}" >> $CONFIGFILE
+  fi
+}
+
+setup_mac_lists() {
+  local cfg="$1"
+  local MAC=""
+  local val
+
+  append_mac() {
+    append MAC $1 ,
+  }
+
+  config_get val "$cfg" macmechanism
+  if [ -z "${val}" ] ; then
+    # check if we have AllowedMACList or BlockedMACList defined they will be ignored
+    config_get val "$cfg" allowedmac
+    if [ -n "${val}" ] ; then
+      echo "Ignoring allowedmac - macmechanism not \"allow\"" >&2
+    fi
+
+    config_get val "$cfg" blockedmac
+    if [ -n "${val}" ] ; then
+      echo "Ignoring blockedmac - macmechanism not \"block\"" >&2
+    fi
+  elif [ "${val}" == "allow" ] ; then
+    MAC=""
+    config_list_foreach "$cfg" allowedmac append_mac
+    echo "AllowedMACList $MAC" >> $CONFIGFILE
+  elif [ "${val}" == "block" ] ; then
+    MAC=""
+    config_list_foreach "$cfg" blockedmac append_mac
+    echo "BlockedMACList $MAC" >> $CONFIGFILE
+  else
+    nolog error "$cfg Invalid macmechanism '$val' - allow or block are valid."
+    return 1
+  fi
+  MAC=""
+  config_list_foreach "$cfg" trustedmac append_mac
+  [ -n "$MAC" ] && echo "TrustedMACList $MAC" >> $CONFIGFILE
+}
+
+setup_firewall() {
+  local cfg="$1"
+  local uciname
+  local val
+
+  append_firewall() {
+    echo "    FirewallRule $1" >> $CONFIGFILE
+  }
+
+  for rule in $(echo authenticated-users preauthenticated-users users-to-router trusted-users trusted-users-to-router)
+  do
+    uci_name=${rule//-/_}
+    # uci does not allow - dashes
+    echo "FirewallRuleSet $rule {" >> $CONFIGFILE
+    config_list_foreach "$cfg" ${uci_name} append_firewall
+    echo "}" >> $CONFIGFILE
+    config_get val "$cfg" policy_${uci_name}
+    [ -n "${val}" ] && echo "EmptyRuleSetPolicy $rule $val" >> $CONFIGFILE
+  done
+}
+
+generate_uci_config() {
+  local cfg="$1"
+  local val
+  local ifname
+  local download
+  local upload
+
+  CONFIGFILE="/tmp/etc/nodogsplash_$cfg.conf"
+
+  echo "# auto-generated config file from /etc/config/nodogsplash" > $CONFIGFILE
+  config_get val "$cfg" network
+  if [ ! -n "${val}" ] ; then
+    nolog error "$cfg missing network"
+    return 1
+  fi
+
+  if ! network_get_device ifname $val ; then
+    nolog error "$cfg can not find ifname for network '${val}'"
+    return 1
+  fi
+
+  echo "GatewayInterface $ifname" >> $CONFIGFILE
+  config_get val "$cfg" externalnetwork
+  [ -n "${val}" ] && network_get_device ifname ${val} && echo "ExternalInterface $ifname" >> $CONFIGFILE
+
+  append_config_option "$CONFIGFILE" "$cfg" gatewayname GatewayName
+  append_config_option "$CONFIGFILE" "$cfg" gatewayaddress GatewayAddress
+  append_config_option "$CONFIGFILE" "$cfg" gatewayport GatewayPort
+  append_config_option "$CONFIGFILE" "$cfg" maxclients MaxClients
+  append_config_option "$CONFIGFILE" "$cfg" imagedir ImagesDir
+  append_config_option "$CONFIGFILE" "$cfg" redirecturl RedirectURL
+  append_config_option "$CONFIGFILE" "$cfg" clientidletimeout ClientIdleTimeout
+  append_config_option "$CONFIGFILE" "$cfg" clientforcetimeout ClientForceTimeout
+  append_config_option "$CONFIGFILE" "$cfg" gatewayiprange GatewayIPRange
+  append_config_option "$CONFIGFILE" "$cfg" passwordattempts PasswordAttempts
+  append_config_option "$CONFIGFILE" "$cfg" macmechanism MACMechanism
+  append_config_option "$CONFIGFILE" "$cfg" uploadlimit UploadLimit
+  append_config_option "$CONFIGFILE" "$cfg" downloadlimit DownloadLimit
+
+  config_get download "$cfg" downloadlimit
+  config_get upload "$cfg" uploadlimit
+  [ -n "$upload" -o -n "$download" ] && echo "TrafficControl yes" >> $CONFIGFILE
+
+  setup_mac_lists "$cfg"
+  setup_user_authentication "$cfg"
+  setup_firewall "$cfg"
+}
+
+# setup configuration and start instance
+create_instance() {
+  local cfg="$1"
+  local manual_config
+  local val
+  CONFIGFILE="/tmp/etc/nodogsplash_$cfg.conf"
+
+  config_get_bool val "$cfg" disabled 0
+  [ $val -gt 0 ] && return 0
+
+  config_get manual_config "$cfg" config ""
+  if [ ! -n "$manual_config" ] ; then
+    generate_uci_config "$cfg"
+  else
+    # check if configration exists
+    if [ ! -f "$manual_config" ] ; then
+      nolog error "Configuration file '$file' doesn't exists"
+      return 0
+    fi
+    CONFIGFILE="$manual_config"
+  fi
+
+  if ! test_module ;  then
+    logger -s -t nodogsplash -p daemon.error "nodogsplash is missing some kernel modules"
+  fi
+
+  procd_open_instance $cfg
+  procd_set_param command /usr/bin/nodogsplash -c $CONFIGFILE $OPTIONS
+  procd_set_param respawn
+  procd_set_param file $CONFIGFILE
+  procd_close_instance
+}
+
+start_service() {
+  include /lib/functions
+
+  mkdir -p /tmp/etc/
+  config_load nodogsplash
+
+  config_foreach create_instance instance
+}
+
+stop_service() {
+  # nodogsplash doesn't exit fast enought, when procd terminates it.
+  # otherwise procd will restart nodogsplash twice. first time starting nodogsplash fails, second time it succeeds
+  sleep 1
 }
 
 status() {
-       $WD_DIR/ndsctl status
+  $WD_DIR/ndsctl status
 }
 
+# Test if we got all modules loaded
 test_module() {
 
     ### Test ipt_mark with iptables
@@ -168,9 +342,11 @@ test_module() {
 
     do_module_tests "ipt_mac"
     do_module_tests "ipt_mark"
-    # if not using traffic control,
-    # you can comment out the following 3 lines:
-    do_module_tests "imq" "numdevs=2"
-    do_module_tests "ipt_IMQ"
-    do_module_tests "sch_htb"
+
+    # test for imq modules, only if TrafficControl is enabled in conf
+    if ( grep -q -E '^[[:space:]]*TrafficControl[[:space:]]+(yes|true|1)' "$NDS_CONF" ) ; then
+        do_module_tests "imq" "numdevs=2"
+        do_module_tests "ipt_IMQ"
+        do_module_tests "sch_htb"
+    fi
 }