Library Utilities¶
Overview¶
A number of library utilities are included. These may be used by NDS itself, FAS and Preauth. These may in the future, be enhanced, have additional functionality added.
By default, library utilities will be installed in the folder
/usr/lib/opennds/
List of Library Utilities¶
get_client_interface.sh¶
This utility allows the interface a client is using to be determined from the client mac address.
It can be used in PreAuth and local FAS scripts.
Its output is also sent to FAS in the encrypted query string as the variable “clientif”
Usage: get_client_interface.sh [clientmac]
Returns: [local_interface] [meshnode_mac] [local_mesh_interface]
Where:
[local_interface] is the local interface the client is using.
[meshnode_mac] is the mac address of the 802.11s meshnode the client is using (null if mesh not present).
[local_mesh_interface] is the local 802.11s interface the client is using (null if mesh not present).
unescape.sh¶
This utility allows an input string to be unescaped. It currently only supports url-decoding.
It can be used by NDS as the unescape callback for libmicrohttpd.
To enable, set the unescape_callback_enabled option to “1”
To disable, set the unescape_callback_enabled option to “0”
The default is disabled (use internal MHD unescape)
eg In the OpenWrt configuration file
option unescape_callback_enabled '0'
Usage: unescape.sh [-option] [escapedstring]
Returns: [unescapedstring]
Where:
[-option] is unescape type, currently -url only
libopennds.sh¶
This utility controls many of the functions required for PreAuth/ThemeSpec scripts.
Usage: libopennds arg1 arg2 … argN
clean:¶
arg1: “clean”, removes custom files, images and client data
returns: tmpfsmountpoint (the mountpoint of the tmpfs volatile storage of the router.
tmpfs:¶
arg1: “tmpfs”, finds the tmpfs mountpoint
returns: tmpfsmountpoint (the mountpoint of the tmpfs volatile storage of the router.
mhdcheck:¶
arg1: “mhdcheck”, checks if MHD is running (used by MHD watchdog)
returns: “1” if MHD is running, “2” if MHD is not running
gatewaymac:¶
arg1: “gatewaymac”, finds the mac address of an interface.
arg2: ifnamereturns: mac address of the interface
gatewayroute:¶
arg1: “gatewayroute”, checks for a valid gateway route for an interface.
returns: the ip gateway address and the ip gateway interface, or “offline” if the router is offline
clientaddress:¶
arg1: “clientaddress”, find and return both ip and mac of a client
arg2: contains either client mac or client ipreturns: client ip and mac
rmcid:¶
arg1: “rmcid”, Remove an existing cidfile (client identifcation file)
arg2: contains the cid (client id)
arg3: contains mountpoint of the ndscids database
returns: “done”
write:¶
arg1: “write”, Write client info element to cidfile (client identifcation file)
arg2: contains the cid (client id)
arg2: contains mountpoint of the ndscids database
arg3: contains info element
returns: “done”
parse:¶
arg1: “parse”, Parse for sub elements and write to cidfile (client identification file)
arg2: contains the cid (client id)
arg3: contains mountpoint of the ndscids database
arg4: contains info elements to parse
returns: “done”
download:¶
arg1: “download”, Download files required for themespec
arg2: contains the themespec path
arg3: contains the image list
arg4: contains the file list
arg5: contains the refresh flag, set to 0 to download if file missing, 1 to refresh downloads, 3 to skip downloads
arg6: contains the webroot
returns: “done”
get_option_from_config:¶
arg1: “get_option_from_config”, Get the config option value
arg2: contains the option to getreturns: the requested config option, or an empty string if not configured
debuglevel:¶
arg1: “debuglevel”, Sets the debuglevel for externals
arg2: contains the debuglevelreturns: the debuglevel
get_debuglevel:¶
arg1: “get_debuglevel”, Gets the debuglevel set for externalsreturns: the debuglevel
syslog:¶
arg1: “syslog”, Write a debug message to syslog
arg2: contains the string to to write to syslog if enabled by debuglevel
arg3: “debugtype” contains debug type: debug, info, warn, notice, err, emerg.
returns: “done”
startdaemon:¶
arg1: “startdaemon”, Start a daemon process
arg2: contains the b64 encoded daemon startup commandreturns: pid of the daemon and exit code 0 if successful. If unsuccessful or terminated immediately returns “0” or a status information string with code 1
stopdaemon:¶
arg1: “stopdaemon”, Stop a daemon process
arg2: contains the pid of the daemon to stopreturns: “done” if sucessful or “nack” with exit code 1 if unsuccessful
get_interface_by_ip:¶
arg1: “get_interface_by_ip”, get the interface name that is the gateway for an IP address
arg2: contains the ip to checkreturns: Interface name with exit code 0, or exit code 1 if failed to get interface name
write_log:¶
arg1: “write_log”, write a string to the openNDS log
arg2: contains the string to logreturns: “done”
dhcpcheck:¶
arg1: “dhcpcheck”, Checks if an ip address was allocated by dhcp
arg2: contains the ip to checkreturns: The mac address that was allocated to the ip address or null and exit code 1 if not allocated
?fas:¶
arg1: “?fas=<b64string>”, generates ThemeSpec html using b64encoded data sent from openNDS
arg2: urlencoded_useragent_string
arg3: mode (1, 2 or 3) (this is the mode specified in option login_option in the config file.
arg4: themespecpath (if mode = 3)
returns: html for the specified ThemeSpec.