NoCatSplash

From DD-WRT Wiki

(Difference between revisions)
Jump to: navigation, search
Revision as of 13:09, 2 May 2008 (edit)
Polskikrol (Talk | contribs)
m (Overview)
← Previous diff
Revision as of 22:08, 16 May 2008 (edit) (undo)
S2s2 (Talk | contribs)
m (Super it up. Structural, content, spelling. Lots of stuff I've been waiting to find the time to do.)
Next diff →
Line 1: Line 1:
-Enabling the use of NoCatSplash allows you to redirect a client to a specific web page when connecting via wireless or wired. It can redirect the client to a Splash URL hosted online (not on the router's filsystem). It can use the JFFS2 filesystem services on the router, so hosting the splash page can be done directly on the router. After being redirected to the splash page, the client can click on an 'I Agree', 'Continue' or similar button of your choosing on the splash page, and it brings the user to the page they were originally loading (or sends the client to the site of your choosing).+==Introduction==
 +'''NoCatSplash''' is a special type of web server. It redirects clients connecting to a DD-WRT box to a specific web page. Usually used for '''disclaimers''' and '''advertising''', it can be a very useful tool when you have ''unknown'' people connecting wirelessly. After a configurable period of time, the client's internet access is cut off, unless the Client has agreed again to the Terms. If the client has a Web Browser open & configured with a Direct Internet Connection, and loads a website, their browser is redirected again, to the NoCatSplash page.
-This could be use to advertise your neighbourhood wLAN, or display a splash screen in a cafe. While Authentication was originally envisioned for NoCat (NoCatAuth), support has been removed to make this as streamlined as possible. The DD-WRT version just displays a splash screen and nothing else. It will intercept the client's browser when the timeout period expires. So, once a day, or whatever interval you choose, the client will pull up the splash screen.+Terms:
 +*Herein referred to simply as ''NoCat'' or ''splashd'' (the technical name).
 +*''Client'' referrers to the roaming laptop user with a browser configured for direct internet connections. LAN clients are normally included, so anyone wired into the LAN ports on the DD-WRT box is also a Client. LAN Servers, for instance, can be excluded from being involved in the NoCat system within the configuration of NoCat.
 +*''Terms'' referrers to the Terms of Use, or Agreement, which protects the DD-WRT owner from legal liability for the use of the open internet connection. For more information on how an Agreement contract can effectively block a legal conviction for state-blocked internet use, please consult legal advice in your own jurisdiction. This Wiki article only describes ''how'' to make the agreement appear, and under what circumstances it might not appear (Limitations). '''In any case, failure of NoCat to force Clients to see an agreement page, or the failure of the Splash page content to protect the DD-WRT box operator from legal attacks, does not make the authors of NoCat, or this Wiki, or DD-WRT, liable.'''
-For me, NoCatSplash has been an easy point and click affair, using a Splash URL (not hosted locally on the router). +DD-WRT firmware comes complete with sample splash and status pages. Setting up basic NoCat through the Web Interface is easy. More complex options are possible by editing the nocat.conf file directly. You must have an active Internet connection working to the DD-WRT box in order to use NoCat. For instance, a client trying to ping an Internet address, like www.google.com, must be able to get an IP returned for Google, although the Ping packets will not go through until the Client agrees.
 +NoCat can redirect the client to a Splash URL hosted outside of the DD-WRT box, such as on NAS. NoCat can use the [[JFFS|JFFS2]] filesystem services on the router. Modifying the sample splash page (highly suggested) and storing directly on the DD-WRT box works.
-Simply enable NoCatSplash, enter your Homepage (this is the page people will be redirected to, after seeing the splash page),+==Quick 'Getting Started' Guide==
-then add your Allowed Web Hosts (This should be/include the domain of the Splash URL. ex: if your Splash url is on http://yoursite.com/splash/index.htm; Your allowed host should be yoursite.com) (Don't have the http:// part on the allowed web hosts),+Simply enable NoCatSplash in the DD-WRT Web Interface.<br>
-Don't change the Document Root (leave it alone),+- v23: Administration, Hotspot<br>
-Enter your Splash URL (ex: http://yoursite.com/splash/)+- v24: Services, Hotspot
 +* Enter your Homepage (this is the page people will be redirected to, after seeing the splash page),
 +* then add your Allowed Web Hosts (This automatically includes the Splash URL domain). Only put the domain name in, this means, do not prefix the name with http://.
 +* For starters, leave the Document Root as /www.
 +* Enter your Splash URL (ex: http://yoursite.com/splash/).
 +** Because we are leaving Document Root with something in it, Splash URL is ignored, but must be filled out otherwise Splashd doesn't like this!
-I left all of the other settings alone, and mine works fine!+Leave all of the other settings alone. Apply your changes, and test it out.
-A Notable Quirk: Your Splash page won't show anything linked outside of the html file if the Splash URL isn't hosted on the router or through a Samba mount. For example .css and images won't load, but style tags in the HEAD of your html page will.+==Customized Splash==
 +Terms:
 +* CLI: Command Line Interface. Either SSH (more secure, recommended) or Telnet (less or not secure). Windows users use Putty, a free download, as your SSH Client.
 +* NoKaid: A build of DD-WRT with no specific XBOX support. Leaves room for a tiny read/write folder.
-==Overview==+# See the Wiki Article [[JFFS|Enabling JFFS2]] or [[SD/MMC Mod|Adding additional Flash memory to DD-WRT]] to create the read/write space necessary
-''Note: You must have a DD-WRT Version installed which includes Nocatsplash, like the standard version and you must have enough free memory.''+# Using the CLI, Create a folder named ''nocat''<br> mkdir /jffs/nocat
 +# Check if the folder exists<br> cd /jffs/nocat
 +# Copy the default content from /www to /jffs/nocat<br> cp -R /www/* /jffs/nocat/*
 +# Next edit the /jffs/nocat/splash.html web page.<br>See [[WinSCP]] and [[WinSCP#Mirroring_Content_to_DD-WRT_Device|Mirroring]]
 +# Change the NoCatSplash configuration to /jffs/nocat instead of /www. Apply.
-''Smashtov Comments: I have to use the nokaid version of the firmware to make it works. see the forum at http://www.dd-wrt.com/phpBB2/viewtopic.php?t=6651&highlight=nocatsplash. Thanks to tomnsc.+Notes:
 +* If splash.html calls another page, such as when using HTML Frames, the final page's form for the 'I Accept' button must have action="http://the DD-WRT enabled box's IP:5280/" instead of action="$action", and any other variables filled out with the values in the Web Interface/nocat.conf. The variables present in the original splash.html sample do not pass to sub-pages.
 +* Your Splash page won't show anything linked outside of the html file if the Splash URL isn't hosted on the router or through a Samba mount. For example .css and images won't load, but style tags in the HEAD of your html page will.
-''PolskiKrol Comments: It would appear that that nokaid version of DD-WRT v24 RC7 no longer leaves any space for JFFS2 on 4MB Firmware. This issue was seen on the WRT150N. The last working firmware is DD-WRT v24 RC6.2.+==Configuration Screen Photos==
-1. In DD-WRT under Administration/Management enable under JFFS2 Support the first time both tags:+[[Image:V23-hotspot-nocatsplash.png|v23 NoCatSplash Configuration Web Interface]]
-JFFS2 and Clean JFFS2+
- +
-2. reboot the system+
- +
-3. create a folder named nocat per telnet (open your-router-ip, Login, mkdir /jffs/nocat)+
- (Why do not create? readonly?)+
-4. check per telnet if the folder is created. (cd /jffs/nocat)+
- +
-5. enable SSH in DD-WRT (under Administration/Services Secure Shell - enable)+
- +
-6. Now you can enable SSH under remote Management (Administration/Management/Remote Access SSH Management enable)+
- +
-7. Next you can start to create a Splash.html page. the easiest way is: copy the html text of an example into a new txt file and save this. Here is an example under splash.html: http://forum.bsr-clan.de/viewtopic.php?t=8319&highlight=nocat (the URL is Invalid)+
-Then rename this to splash.html. Thats it. You can make changes in text, colours,etc.+
- +
-8. Upload the splash.html file to /jffs/nocat. For Windows user: Download the Program [[Winscp]] and use this one. It is important that you use as Protocol SCP or you will be unable to connect.+
- +
-9. Finally configure DD-WRT as Described below.+
- +
- +
-'''Splash Page Code'''+
- +
- +
-'''Typical Oversight'''+
-A typical problem with most installations is the administrator (you) forgetting that the splash page must contain a form with a button that submits certain data to the router, allowing it to "know" which clients have or have not visited the splash page. +
- +
- +
-'''Solution:'''+
-The Form code for your "I Accept" button is similar to the following. This was taken from the original nocat splash page:+
- +
-<pre>+
- <form name="login" method="post" action="http://192.168.1.1:5280/">+
- <div align="center">+
- <input type="hidden" name="accept_terms" value="yes" /> +
- <input type="hidden" name="redirect" value="http://yoursitehere.com">+
- <input type="hidden" name="mode_login">+
- <!--<input type="image" name="mode_login" src="images/login.gif" border="0">-->+
- <input type="submit" value="enter">+
- <!--<input type="submit" value="submit">-->+
- </div>+
- </form>+
-</pre>+
-! Why are some of the buttons commented out. What actual data does the form need?!+
- +
-Alternatively in the above example you can use "$redirect" for the redirect location (instead of http://yoursitehere.com) to allow the client to browse to their originally intended site vs. always being redirected to the site of your choosing.+
- +
-=Configuration=+
- +
-[[Image:V23-hotspot-nocatsplash.png]]+
[[Image:V23-hotspot-nocatsplash-conf.png]] [[Image:V23-hotspot-nocatsplash-conf.png]]
- 
-'''Install'''<br/> 
-To make the configuration options appear, you have to enable NoCatSplash then Save the configuration. Now you can configure the options.<br/> 
-When finished configuring, use "Reboot Router". 
'''Gateway Name'''<br/> '''Gateway Name'''<br/>
Line 154: Line 120:
NC_AllowedWebHosts=mydomain.com NC_AllowedWebHosts=mydomain.com
-=Remarks=+==History==
 +While Authentication was originally envisioned for NoCat (NoCatAuth), support has been removed to make this as streamlined as possible.
-The TCP port to bind the gateway service to. 5280 is de-facto standard for+==References==
-NoCatSplash.+http://cvs.sourceforge.net/viewcvs.py/nocatsplash/nocatsplash/man/nocat.conf.5?rev=1.1.1.1&view=markup<br>
 +http://www.aixmarseille.com/NoCatSplash
-Just a couple things to keep in mind when using/testing this:+==Remarks==
-1. Since this is a web portal capture only, no other traffic is blocked.+'''Please:'''
-2. DNS must happen in order for the redirection to occur - so if you are testing on a machine that is not connected up you will not see the capture page.+* The place for Questions and Conjecture is on the [[Talk:NoCatSplash|Article Discussion]] page, or post your Questions in the DD-WRT Forum.
-3. If you attempt to access the "status" page, then you must have a status.html page there. Variables available are $GatewayName, $LocalTime, $GatewayStartTime, $TotalConnections, $Version, $GatewayMode, $LoginTimeout, $IdleTimeout, $HomePage,+Smashtov Comments: I have to use the nokaid version of the firmware to make it works. see the forum at http://www.dd-wrt.com/phpBB2/viewtopic.php?t=6651&highlight=nocatsplash. Thanks to tomnsc.
-$AllowedWebHosts, $LastConnectionTime, $ConnectionCount, $UserTable+
-=References=+PolskiKrol Comments: It would appear that that nokaid version of DD-WRT v24 RC7 no longer leaves any space for JFFS2 on 4MB Firmware. This issue was seen on the WRT150N. The last working firmware is DD-WRT v24 RC6.2.
-http://cvs.sourceforge.net/viewcvs.py/nocatsplash/nocatsplash/man/nocat.conf.5?rev=1.1.1.1&view=markup<br>+
-http://www.aixmarseille.com/NoCatSplash+
[[Category:English documentation]] [[Category:English documentation]]
[[Category:Basic tutorials]] [[Category:Basic tutorials]]

Revision as of 22:08, 16 May 2008

Contents

Introduction

NoCatSplash is a special type of web server. It redirects clients connecting to a DD-WRT box to a specific web page. Usually used for disclaimers and advertising, it can be a very useful tool when you have unknown people connecting wirelessly. After a configurable period of time, the client's internet access is cut off, unless the Client has agreed again to the Terms. If the client has a Web Browser open & configured with a Direct Internet Connection, and loads a website, their browser is redirected again, to the NoCatSplash page.

Terms:

  • Herein referred to simply as NoCat or splashd (the technical name).
  • Client referrers to the roaming laptop user with a browser configured for direct internet connections. LAN clients are normally included, so anyone wired into the LAN ports on the DD-WRT box is also a Client. LAN Servers, for instance, can be excluded from being involved in the NoCat system within the configuration of NoCat.
  • Terms referrers to the Terms of Use, or Agreement, which protects the DD-WRT owner from legal liability for the use of the open internet connection. For more information on how an Agreement contract can effectively block a legal conviction for state-blocked internet use, please consult legal advice in your own jurisdiction. This Wiki article only describes how to make the agreement appear, and under what circumstances it might not appear (Limitations). In any case, failure of NoCat to force Clients to see an agreement page, or the failure of the Splash page content to protect the DD-WRT box operator from legal attacks, does not make the authors of NoCat, or this Wiki, or DD-WRT, liable.

DD-WRT firmware comes complete with sample splash and status pages. Setting up basic NoCat through the Web Interface is easy. More complex options are possible by editing the nocat.conf file directly. You must have an active Internet connection working to the DD-WRT box in order to use NoCat. For instance, a client trying to ping an Internet address, like www.google.com, must be able to get an IP returned for Google, although the Ping packets will not go through until the Client agrees. NoCat can redirect the client to a Splash URL hosted outside of the DD-WRT box, such as on NAS. NoCat can use the JFFS2 filesystem services on the router. Modifying the sample splash page (highly suggested) and storing directly on the DD-WRT box works.

Quick 'Getting Started' Guide

Simply enable NoCatSplash in the DD-WRT Web Interface.
- v23: Administration, Hotspot
- v24: Services, Hotspot

  • Enter your Homepage (this is the page people will be redirected to, after seeing the splash page),
  • then add your Allowed Web Hosts (This automatically includes the Splash URL domain). Only put the domain name in, this means, do not prefix the name with http://.
  • For starters, leave the Document Root as /www.
  • Enter your Splash URL (ex: http://yoursite.com/splash/).
    • Because we are leaving Document Root with something in it, Splash URL is ignored, but must be filled out otherwise Splashd doesn't like this!

Leave all of the other settings alone. Apply your changes, and test it out.

Customized Splash

Terms:

  • CLI: Command Line Interface. Either SSH (more secure, recommended) or Telnet (less or not secure). Windows users use Putty, a free download, as your SSH Client.
  • NoKaid: A build of DD-WRT with no specific XBOX support. Leaves room for a tiny read/write folder.
  1. See the Wiki Article Enabling JFFS2 or Adding additional Flash memory to DD-WRT to create the read/write space necessary
  2. Using the CLI, Create a folder named nocat
    mkdir /jffs/nocat
  3. Check if the folder exists
    cd /jffs/nocat
  4. Copy the default content from /www to /jffs/nocat
    cp -R /www/* /jffs/nocat/*
  5. Next edit the /jffs/nocat/splash.html web page.
    See WinSCP and Mirroring
  6. Change the NoCatSplash configuration to /jffs/nocat instead of /www. Apply.

Notes:

  • If splash.html calls another page, such as when using HTML Frames, the final page's form for the 'I Accept' button must have action="http://the DD-WRT enabled box's IP:5280/" instead of action="$action", and any other variables filled out with the values in the Web Interface/nocat.conf. The variables present in the original splash.html sample do not pass to sub-pages.
  • Your Splash page won't show anything linked outside of the html file if the Splash URL isn't hosted on the router or through a Samba mount. For example .css and images won't load, but style tags in the HEAD of your html page will.

Configuration Screen Photos

v23 NoCatSplash Configuration Web Interface

Image:V23-hotspot-nocatsplash-conf.png

Gateway Name
The name of the gateway. Whatever you want to call it. "Joe's Pizza Shop and free DSL Cafe" for example. Use the variable $GatewayName in your splash.html page to display this.

AllowedWebHosts
Space separated list of hostnames.
List any hosts (for example, the webserver with the splash page, or other websites) that you would like to allow clients to have web access to (TCP port 80 (HTTP) and 443 (HTTPS?)) before they "log in" (before they click on "I Accept" in your splash page), however actual authentication is not supported.
List any webservers, that you would like connecting clients to be able to access, before clicking on I Agree on the initial nocatsplash screen. Such as the webserver hosting your EULA or Welcome Page, if it isn't the router itself.

Document Root
Where all of the application templates (including SplashForm) are hiding. Can be different from Apache's DocumentRoot.
splash.html is the form displayed to users on capture.

Splash URL
Optional URL to fetch dynamic remote splash page from.
Leave empty if using a page stored on the router.

ExcludePorts
Space separated list of ports.
Specify TCP ports to denied access to when public class users login. All others will be allowed. If nothing is specified, access is granted to all ports to public class users.

You should *always* exclude port 25 (SMTP), unless you want to run a portal for wanton spam sending. Users should have their own way of sending mail. It sucks, but that's the way it is.

MAC White List

Add a space separated list of MAC-addresses that should have unlimited Internet Access. The MAC addresses listed in this field will not be redirected to the Splash-page but have internet-access straight away.

Login Timeout
How much time, in seconds, elapses before the client has to see the splash screen again, and click on 'I Agree'. How often a client is shown the EULA or other designated splash page.

For Open Mode portals, you probably want to set LoginTimeout to something large (like 86400, for one notification per day). Open Mode, is the only mode supported at this time.

Verbosity
Log verbosity (to syslogd)

  • 0 is (almost) no logging.
  • 10 is log everything.
  • 5 is probably a safe middle road.

Route only
Required only if you DO NOT want your gateway to act as a NAT.
Enable this only if you're running a strictly routed network, and don't need the gateway to enable NAT for you. You would not normally use this option. So if you don't understand it, leave it to No/Off.

A few things I found while looking for documentation on the net: In the nocat.conf file (you'll have to telnet or ssh into the router to set these)
comment: The only supported option at this time. I don't think it has to be set. GatewayMode Open
comment: The IP Range which will see the splash page.
LocalNetwork 192.168.1.0/24
comment: The LAN/wLAN IP of the router. I don't think it needs to be set
InsideIP 192.168.1.1
comment: The DNS server. Again, I don't think this needs to be set here.
DNSAddr 10.15.6.1

Advanced Configuration

Daemon:
/usr/sbin/splashd

Configuration file:
/etc # cat nocat.conf

nvram entries:

NC_Verbosity=0
NC_SplashURL=http://www.mydomain.com/
NC_DocumentRoot=/jffs/nocat
NC_RouteOnly=0
NC_HomePage=http://www.mydomain.com/
NC_GatewayName=DDWRT
NC_ExcludePorts=25 21 23
NC_enable=1
NC_LoginTimeout=86400
NC_AllowedWebHosts=mydomain.com

History

While Authentication was originally envisioned for NoCat (NoCatAuth), support has been removed to make this as streamlined as possible.

References

http://cvs.sourceforge.net/viewcvs.py/nocatsplash/nocatsplash/man/nocat.conf.5?rev=1.1.1.1&view=markup
http://www.aixmarseille.com/NoCatSplash

Remarks

Please:

  • The place for Questions and Conjecture is on the Article Discussion page, or post your Questions in the DD-WRT Forum.

Smashtov Comments: I have to use the nokaid version of the firmware to make it works. see the forum at http://www.dd-wrt.com/phpBB2/viewtopic.php?t=6651&highlight=nocatsplash. Thanks to tomnsc.

PolskiKrol Comments: It would appear that that nokaid version of DD-WRT v24 RC7 no longer leaves any space for JFFS2 on 4MB Firmware. This issue was seen on the WRT150N. The last working firmware is DD-WRT v24 RC6.2.