github/openNDS
1
1
Fork 0
mirror of https://github.com/openNDS/openNDS.git synced 2026-01-10 20:37:54 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update README.md, OpenWrt makefile and overview documentation

Browse Source 
Signed-off-by: Rob White <rob@blue-wave.net>
This commit is contained in:
Rob White
2022-10-07 14:29:54 +01:00
parent fc2360067b
commit dd46dfdbb4
3 changed files with 23 additions and 19 deletions
Download Patch File Download Diff File Expand all files Collapse all files

12
community/themespec/theme_legacy/README.md
View File

@@ -1,16 +1,18 @@
# Legacy ThemeSpec
This ThemeSpec enables the legacy splash.html portal page from a Themespec script.
Legacy splash pages used the long deprecated NDS template system. The code supporting this was removed starting with openNDS version 9.0.0.
Legacy splash pages used the long deprecated NoDogSplash template system. The code supporting this was removed starting with openNDS version 9.0.0.
Only gatewayname, tok, redir and authaction variables from the original template system are supported.
# WARNING:
Using the legacy splash.html file, the client is NOT required to accept a terms of service statement and does not receive any indication of a privacy policy.
# WARNING!!
If you use the unedited legacy splash.html file, the client is NOT required to accept a terms of service statement and does not receive a privacy policy notice.
Use of the unchanged simple legacy splash.html file with this ThemeSpec, at a public venue, may make you personally liable for misuse of the Internet connection and may not comply with your country or state regulations. Use at your own risk at public venues.
Before using at a public venue, you should edit the file to add a Terms of Service statement and a Privacy Policy notice that comply with local laws and regulations.
For simplicity, it is recommended that the default theme_click-to-continue script is used instead, where html content of the splash page sequence can be edited within the script itself.
Failure to do this may make you personally liable for misuse of the Internet connection. Use unchanged at your own risk at public venues.
For simplicity, it is recommended that the default theme_click-to-continue script is used instead, as this contains default Terms of Service and Privacy policy. The html content of the ThemeSpec splash page sequence can be edited within the script itself.
# Installation (openWRT)
**Copy the themespec (theme_click-to-continue-legacy.sh) file and the splash.html file.**

20
docs/source/overview.rst
View File

@@ -1,15 +1,21 @@
Overview
########
**openNDS** (NDS) is a high performance, small footprint Captive Portal, offering by default a simple splash page restricted Internet connection, yet incorporates an API that allows the creation of sophisticated authentication applications.
What is openNDS?
****************
openNDS (a short form of "open Network Demarcation Service") is a high performance, small footprint, Captive Portal.
It provides a border control gateway between a public local area network and the Internet, offering by default a simple splash page restricted Internet connection, yet incorporates an API that allows the creation of sophisticated authentication applications.
It is a fork of the NoDogSplash project that in turn was derived originally from the codebase of the Wifi Guard Dog project.
Captive Portal Detection (CPD)
******************************
All modern mobile devices, most desktop operating systems and most browsers now have a CPD process that automatically issues a port 80 request on connection to a network. NDS detects this and serves a special "**splash**" web page to the connecting client device.
All modern mobile devices, most desktop operating systems and most browsers now have a CPD process that automatically issues a port 80 request on connection to a network. openNDS detects this and serves a special "**splash**" web page to the connecting client device.
Provide simple and immediate public Internet access
***************************************************
NDS provides two selectable ready to run methods.
openNDS provides two selectable ready to run methods.
* **Click to Continue**. A simple "Click to Continue" dynamic splash page sequence requiring a client user to accept Terms of Service before continuing to access the Internet (*default*). Basic client device information is recorded in a log file.
* **username/email-address login**. A simple dynamic splash page sequence that requires the client user to enter their username and email-address before accepting the Terms of Service. A welcome page and landing page that can carry an information or advertising payload are served to the client in sequence. Client user and client device information is recorded in the log file. (*This mode is selected in the configuration file*)
@@ -18,12 +24,12 @@ Provide simple and immediate public Internet access
Modifying the content seen by users is a simple matter of editing the html blocks within the script file.
Additional more advanced ThemeSpec files are included and can also be enabled from the config file. These additional files make use of the custom_parameters, custom_images and custom_files config options. Form input fields and text comments can be added, and images and content blocks can be downloaded on demand from remote servers.
Additional more advanced ThemeSpec files are included and can also be enabled from the config file. These additional files make use of the custom_parameters, custom_images and custom_files config options. Form input fields and text comments can be added, and images and content blocks can be downloaded on demand from remote servers.
Write Your Own Captive Portal.
******************************
NDS can be used as the "Engine" behind the most sophisticated Captive Portal systems using the tools provided.
openNDS can be used as the "Engine" behind the most sophisticated Captive Portal systems using the tools provided.
* **Forward Authentication Service (FAS)**. FAS provides pre-authentication user validation in the form of a set of dynamic web pages, typically served by a web service independent of NDS, located remotely on the Internet, on the local area network or on the NDS router.
* **PreAuth**. A special case of FAS that runs locally on the NDS router with dynamic html served by NDS itself. This requires none of the overheads of a full FAS implementation and is ideal for NDS routers with limited RAM and Flash memory.
* **Forward Authentication Service (FAS)**. FAS provides pre-authentication user validation in the form of a set of dynamic web pages, typically served by a web service independent of openNDS, located remotely on the Internet, on the local area network or on the openNDS router.
* **PreAuth**. A special case of FAS that runs locally on the openNDS router with dynamic html served by NDS itself. This requires none of the overheads of a full FAS implementation and is ideal for openNDS routers with limited RAM and Flash memory.
* **BinAuth**. A method of running a post authentication script or extension program.

10
linux_openwrt/opennds/Makefile
View File

@@ -37,13 +37,9 @@ define Package/opennds
endef
define Package/opennds/description
openNDS is a Captive Portal solution that offers an instant way to provide restricted access to the Internet.
With little or no configuration, a dynamically generated and adaptive splash page sequence is automatically served.
Both client driven Captive Portal Detection (CPD) and gateway driven Captive Portal Identification (CPI - RFC 8910 and RFC 8908) are supported.
Internet access is granted by either a click to continue button, or after credential verification as a result of filling in a login form.
The package incorporates the FAS API allowing many flexible customisation options.
The creation of sophisticated third party authentication applications is fully supported.
Internet hosted https portals can be implemented with no security errors, to inspire maximum user confidence.
openNDS (a short form of "open Network Demarcation Service") is a high performance, small footprint, Captive Portal.
It provides a border control gateway between a public local area network and the Internet.
Both the client driven Captive Portal Detection (CPD) method and gateway driven Captive Portal Identification method (CPI - RFC 8910 and RFC 8908) are supported.
endef
define Package/opennds/install