Update documentation

Signed-off-by: Rob White <rob@blue-wave.net>
This commit is contained in:
Rob White
2024-06-07 11:25:44 +01:00
parent d9ea6d8b56
commit 840096cf5c
3 changed files with 128 additions and 29 deletions

View File

@@ -1,8 +1,40 @@
What's New? - ChangeLog
#######################
opennds (10.3.0)
* Fix - missing exit in library call [bluewavenet]
* Add - support for mesh11sd meshnodes and reimplement auth_restore to not use ndsctl - [bluewavenet]
* Fix - formatting of ThemeSpec scripts - [bluewavenet]
* Fix - move parsing of custom vaiables and fields to libopennds library script - [bluewavenet]
* Fix - move custom_variables_list parsing to liboppennds library - [bluewavenet]
* Fix - parsing of custom variables list - [bluewavenet]
* Fix - non placeholder themespec logo size - [bluewavenet]
* Fix - formatting of themespec custom placeholders and status page - [bluewavenet]
* Fix - missing parseing of custom files list in config - [bluewavenet]
* Fix - issue #596, Problem with fasremotefqdn that has multiple IPs ( CDN ) - [bluewavenet] [viniciussotti ]
* Add - download protocol debug message - [bluewavenet]
* Add - function resolve_fqdn() - [bluewavenet]
* Fix - failure to parse custom variables and custom images from config lists - [bluewavenet]
* Fix - issue #582, ensure list dhcp-option-force is added to the correct dnsmasq zone - [bluewavenet] [flintt]
* Fix - issue #591, error adding nft rule when fasremotefqdn not set - [bluewavenet] [billz]
* Fix - change error message to debug message when legacy ipset not present - [bluewavenet]
* Fix - issue #588, Remove default value for faskey - [bluewavenet] [billz]
* Fix - some memory leaks - [bluewavenet] [LuMingYinDetect]
* Fix - typo preventing reload of dnsmasq - [bluewavenet]
* Fix - issue #571, CVE-2024-25763, use after free - we now delete the client instead of changing state - [bluewavenet] [LuMingYinDetect]
* Fix - Evaluate system call return values - [bluewavenet] [sunweaver]
* Fix - enable iteration counter for all nft error codes - [bluewavenet]
* Fix - issue #556, use dnsmasq reload instead of restart - [bluewavenet] [rafaelfelix]
* Fix - remove unneeded memory allocation - [bluewavenet]
* Fix - ensure all client memory is freed when removing client - [bluewavenet]
* Fix - remove unneeded memory allocations and free some strdup allocations - [bluewavenet]
* Fix - race condition when dnsmasq takes too long to restart - [bluewavenet]
* Add - issue #547, Support specifying DHCP leases file location [mcassaniti]
-- Rob White <dot@blue-wave.net> Wed, 07 Jun 2024 07:31:46 +0000
opennds (10.2.0)
* Add - Page 202 HTTP_ACCEPTED for future use
* Add - Page 202 HTTP_ACCEPTED for future use [bluewavenet]
* Fix - remove redundant workaround for old MHD versions [bluewavenet]
* Fix - some nft and other error messages [bluewavenet]
* Fix - remove unnecessary debug messages [bluewavenet]
@@ -81,9 +113,7 @@ opennds (10.1.2)
-- Rob White <dot@blue-wave.net> Sat, 29 Jul 2023 10:04:52 +0000
opennds (10.1.1)
This version contains some minor bug fixes and documentation updates
* This version contains some minor bug fixes and documentation updates
* Fix - send only contents of buffer, not entire buffer when serving page511 [bluewavenet]
* Fix - Set fas_remotefqdn to gw_fqdn when overriding FAS settings [bluewavenet]
* Fix - use absolute path for css and images in ThemeSpec [bluewavenet]
@@ -94,8 +124,10 @@ This version contains some minor bug fixes and documentation updates
opennds (10.1.0)
This version is a major upgrade including full migration to nftables and native uci configuration support even for generic Linux distributions. It also includes a significant refactoring of inbuilt memory management, improving long term reliability, fixing several memory leaks, buffer overflows and several edge case crashes.
* This version is a major upgrade including full migration to nftables
* and native uci configuration support even for generic Linux distributions.
* It also includes a significant refactoring of inbuilt memory management,
* improving long term reliability, fixing several memory leaks, buffer overflows and several edge case crashes.
* Add - support for included custom binauth script [bluewavenet]
* Add - emit a useful stderr message if auth_restore fails [bluewavenet]
* Add - procd respawn threshold, respawn timeout and respawn retry parameters [bluewavenet]
@@ -107,7 +139,7 @@ This version is a major upgrade including full migration to nftables and native
* Fix - walledgarden for both nftset and ipset on OpenWrt [bluewavenet]
* Add - more meaningful output if attempt is made to restart when already running [bluewavenet]
* Fix - resolve gatewayfqdn after startup [bluewavenet]
* Fix - Choose foreground or background running according to commandline arguments [bluewavenet]
* Fix - Choose forground or background running according to commandline arguments [bluewavenet]
* Fix - remove superfluous debug message [bluewavenet]
* Fix - replace sleep with procd_set_param term_timeout [bluewavenet]
* Fix - make option enabled default to enabled [bluewavenet]
@@ -254,7 +286,7 @@ opennds (9.9.0)
* fix - safe functions to return error rather than exit [bluewavenet]
* Add - b64decode custom string received by binauth script [bluewavenet]
-- Rob White <dot@blue-wave.net> Thu, 29 Sep 2022 16:52:46 +0000
-- Rob White <dot@blue-wave.net> Thu, 03 Oct 2022 16:52:46 +0000
opennds (9.8.0)
@@ -352,7 +384,7 @@ opennds (9.6.0)
* Add - Show unrestricted burst intervals in ndsctl status [bluewavenet]
* Add - Set default bucket ratios to 10 [bluewavenet]
-- Rob White <dot@blue-wave.net> Sun, 06 Feb 2022 07:44:50 +0000
-- Rob White <dot@blue-wave.net> Fri, 18 Feb 2022 09:35:51 +0000
opennds (9.5.1)
@@ -382,7 +414,6 @@ opennds (9.5.0)
* Add - more libraries documentation [bluewavenet]
* Add - library calls startdaemon and stopdaemon [bluewavenet]
* Fix - Increase buffer length for longer interface names [koivunen]
* Add - enforce minimum data rates in ndsctl auth [bluewavenet]
* Add - Update README.md [bluewavenet]
* Add - bucket ratio option to config file [bluewavenet]
* Add - upload and download bucket ratio config values [bluewavenet]
@@ -461,21 +492,11 @@ opennds (9.4.0)
-- Rob White <dot@blue-wave.net> Wed, 22 Sep 2021 19:39:08 +0000
opennds (9.3.1)
* This version fixes some issues
* Fix - Segfault in ndsctl when -s option is used incorrectly [bluewavenet] [T-X]
* Fix - Typo making calculation of ul/dl rates incorrect [bluewavenet]
* Fix - Allow port 80 to be configured in the Walled Garden [bluewavenet]
* Add - Warning message when Walled Garden port 80 is allowed [bluewavenet]
-- Rob White <dot@blue-wave.net> Thu, 26 Aug 2021 12:09:36 +0000
opennds (9.3.0)
* This version adds new functionality, and fixes some issues
* Add - Add - firewall passthrough mode for authenticated users [bluewavenet]
* Add - Add - use configured debuglevel in authmon [bluewavenet]
* Add - firewall passthrough mode for authenticated users [bluewavenet]
* Add - use configured debuglevel in authmon [bluewavenet]
* Add - automated log rotation and client_zone to binauth_log [bluewavenet]
* Add - increased timeout interval for file downloads [bluewavenet]
* Add - local interface to MeshZone and remove unneeded call to ip utility [bluewavenet]
@@ -491,7 +512,7 @@ opennds (9.3.0)
* Fix - Prevent potential read overrun within the MHD page buffer [bluewavenet]
* Remove - legacy get_ext_iface() function [bluewavenet]
-- Rob White <dot@blue-wave.net> Sun, 8 Aug 2021 09:58:02 +0000
-- Rob White <dot@blue-wave.net> Sun, 8 Aug 2021 09:58:02 +0000
opennds (9.2.0)
@@ -503,7 +524,7 @@ opennds (9.2.0)
* Add - Use heap allocation for http page buffer allowing large page sizes [bluewavenet]
* Fix - fail to serve downloaded images on custom themespec [bluewavenet]
-- Rob White <dot@blue-wave.net> Sun, 11 July 2021 15:05:39 +0000
-- Rob White <dot@blue-wave.net> Sun, 11 July 2021 15:05:39 +0000
opennds (9.1.1)
@@ -514,7 +535,7 @@ opennds (9.1.1)
* Fix - Compiler warning, ignored return value from call to fgets() [bluewavenet]
* Fix - Remove debug message from call to get_client_interface library [bluewavenet]
-- Rob White <dot@blue-wave.net> Thu, 4 July 2021 21:07:21 +0000
-- Rob White <dot@blue-wave.net> Sun, 4 July 2021 21:07:21 +0000
opennds (9.1.0)
@@ -794,4 +815,3 @@ openNDS (5.0.0)
* Fix - Allow use of "#" in gatewayname [bluewavenet]
-- Rob White <dot@blue-wave.net> Sat, 03 Apr 2020 13:23:36 +0000

View File

@@ -53,7 +53,7 @@ master_doc = 'index'
# General information about the project.
project = 'openNDS'
copyright = '2015 - 2023 BlueWave Projects and Services and The openNDS Contributors <opennds@blue-wave.net>'
copyright = '2015 - 2024 BlueWave Projects and Services and The openNDS Contributors <opennds@blue-wave.net>'
author = 'The openNDS Contributors'
# The version info for the project you're documenting, acts as replacement for
@@ -61,9 +61,9 @@ author = 'The openNDS Contributors'
# built documents.
#
# The short X.Y version.
version = '10.2.1beta'
version = '10.3.0'
# The full version, including alpha/beta/rc tags.
release = '10.2.1beta'
release = '10.3.0'
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.

View File

@@ -398,6 +398,13 @@ configure_log_location
Returns the directory into which log files should be stored and exit code 0 if successful
is_nodog
--------
arg1: is_nodog, check if nodogsplash is installed
Returns string nodog_yes and exit code 0 if it is, nodog_no and exit code >0 if it is not
generate_key
------------
@@ -405,6 +412,78 @@ generate_key
Returns the pseudo-random hexadecimal key value
set_key
-------
arg1: set_key, adds option faskey to config file
arg2: the key to set
Returns exit code 0 always
hash_str
--------
arg1: generates a hash from the string supplied
arg2: the string to hash
Returns the hashed string and exit code 0 if successful
wget_request
------------
arg1: wget_request, send a request to a remote fas url
arg2: The url we want to send the request to
arg3: The requested action
arg4: The gatewayhash of this router
arg5: The user agent to send to the remote fas
arg6: The payload to send to the fas
Returns the reply to the request from the remote fas and exit code 0 if successful
preemptivemac
-------------
arg1: preemptivemac, parses the preemptivemac list and authenticates clients in that list
arg2: optional client mac address to immediately pre-emptively authenticate instead of parsing the list
Returns exit code 0 always
resolve_fqdn
------------
arg1: resolve_fqdn, get the first ip address to resolve from a DNS query to the fqdn
Returns the resolved ip address or an empty string and returns exit code 0 always
config_input_fields
-------------------
arg1: config_input_fields, configure custom input and hidden (passthrough) fields from fas_custom_variables_list
Returns html code for custom inputs and custom passthrough. Returns exit code 0 always.
get_meshnode_list
-----------------
arg1: get_meshnode_list, get a list of known mesh11sd meshnodes
Returns a list of meshnode mac addresses. Returns exit code 0 always.
get_next_preemptive_auth
------------------------
arg1: get_next_preemptive_auth, gets the auth string for the next client to reauthenticate after a restart. Deletes that clients record from the preemptive_auth database.
Returns the auth string for the client. Returns exit code 0 always.
?fas:
-----
arg1: "*?fas=<b64string>*", generates ThemeSpec html using b64encoded data sent from openNDS