hotspotlogin 0.1.2 → 1.0.0

data/README.rdoc

@@ -6,7 +6,13 @@ Hotspotlogin is a reimplementation in Ruby/Sinatra of the popular
 hotspotlogin.cgi used with ChilliSpot and compatible Network Access 
 Controllers to provide a Captive Portal environment.
 
-http://github.com/gderosa/hotspotlogin.rb
+This release features displaying of detailed accounting info for the end user,
+and is strongly based on CoovaChilli Network Access Controller and its
+JSON interface.
+
+* http://github.com/gderosa/hotspotlogin.rb
+
+* http://coova.org/CoovaChilli/JSON
 
 === USAGE:
 
@@ -18,37 +24,52 @@ On the command-line:
   
   $ hotspotlogin [options]
 
-==== Options
+==== General Options
+
+  --[no-]daemon                   daemonize [by default, executes in foreground]
+
+  --log                           log file (ignored when --no-daemon)
+
+  --pid                           pid file (ignored when --no-daemon)
+
+  --port                          [default 4990]
+
+  --listen-address                [default 0.0.0.0]
+
+  --[no-]userpassword             [default true]		
+
+  --[no-]log-http                 [default false]
 
-  --[no-]daemon		daemonize [by default, executes in foreground]
+  --uamsecret <PASS>              optional, shared secret as in chilli.conf(5) 
 
-  --log			log file (ignored when --no-daemon)
+  --conf <FILE>                   YAML configuration file, see examples/ 	
 
-  --pid			pid file (ignored when --no-daemon)
+==== End User Interface Options
 
-  --port 		[default 4990]
+  --interval <SECONDS>            autorefresh interval
 
-  --listen-address	[default 0.0.0.0]
+  --logo <IMAGE FILE>             will be displayed in any page as 
+                                  /hotspotlogin/logo.( png | jpg | etc... )  
 
-  --[no-]userpassword	[default true]		
+  --custom-text <FRAGMENT.html>
 
-  --[no-]log-http	[default false]
+  --custom-footer <FRAGMENT.html>
 
-  --uamsecret <PASS>	optional, shared secret as in chilli.conf(5) 
+  --custom-headline <TEXT>        will be put inside <h1></h1>
 
-  --conf <FILE>		YAML configuration file, see examples/ 	
+  --favicon <FILE>
 
 See also chilli.conf(5) manual page.
 
 ==== Unix Signals
 
-  USR1			sync/update log file (flush buffered I/O) 
+  USR1                            sync/update log file (flush buffered I/O) 
   
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2010 Guido De Rosa <guido.derosa*vemarsas.it>
+Copyright (c) 2010 Guido De Rosa (guido.derosa*vemarsas.it)
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/examples/etc/lighttpd/lighttpd.conf

@@ -0,0 +1,31 @@
+# Example configuration snippet on how to setup a reverse HTTPS proxy
+# with Lighty (http://www.lighttpd.net).
+
+server.modules += (
+  "mod_proxy"
+)
+
+# enable SSL 
+$SERVER["socket"] == "0.0.0.0:443" {
+                  ssl.engine                  = "enable"
+                  ssl.pemfile                 = "/etc/lighttpd/server.pem"
+                  ssl.ca-file                 = "/etc/lighttpd/ca.crt"
+}
+
+proxy.server = (
+	"/hotspotlogin" => (
+		(
+			"host" => "127.0.0.1",
+			"port" => 4990
+		)
+	),
+	# another application...
+  #"" => (
+	#	(
+	#		"host" => "127.0.0.1",
+	#		"port" => 4567
+	#	)
+  #
+	#)
+)
+

data/examples/hotspotlogin.conf.yaml

@@ -4,3 +4,9 @@ port: 4991
 uamsecret: uampass
 userpassword: false
 log-http: true
+interval: 300
+custom-headline: My Organization Name
+custom-text: /some/path/fragment.html
+custom-footer: /some/other/path/fragment.html
+logo: /some/path/to/mylogo.png
+favicon: /path/to/favicon.ico

data/lib/hotspotlogin/app.rb

@@ -3,6 +3,7 @@ require 'sinatra/base'
 require 'erb'
 require 'pp'
 
+require 'hotspotlogin/constants'
 require 'hotspotlogin/config'
 require 'hotspotlogin/extensions/string'
 
@@ -22,39 +23,20 @@ module HotSpotLogin
 
     result, titel, headline, bodytext = '', '', '', ''
 
-    # TODO: This is not classy: all that JS code should not be layout.erb;
-    # to avoid failures we have to pass all this de-facto unused variables...
-    # Horror  ;-/    
+    before do
+      headers(
+        'X-HotSpotLoginRb-Version' => HotSpotLogin::VERSION
+      )
+    end
+
     not_found do # Sinatra doesn't know this ditty ;-)
       erb(
         :"404",
-        :locals => {
-          :titel => 'Not Found',
-          :headline => headline,
-          :bodytext => bodytext,
-          :uamip => params['uamip'],
-          :uamport => params['uamport'],
-          :userurl => params['userurl'],
-          :redirurl => params['redirurl'],
-          :timeleft => params['timeleft'],
-          :result => nil
-        }
+        :layout => false
       )
     end
 
-    # comments adapted from hotspotlogin.php :
-    
-    # possible Cases:
-    # attempt to login                          login=login
-    # 1: Login successful                       res=success
-    # 2: Login failed                           res=failed
-    # 3: Logged out                             res=logoff
-    # 4: Tried to login while already logged in res=already
-    # 5: Not logged in yet                      res=notyet
-    #11: Popup                                  res=popup1
-    #12: Popup                                  res=popup2
-    #13: Popup                                  res=popup3
-    # 0: It was not a form request              res=""
+    require 'hotspotlogin/app/helpers'
 
     #Read query parameters which we care about
     # params['res']
@@ -81,9 +63,40 @@ module HotSpotLogin
     # params['redirurl']
     
 
-    # Matches '/', '/hotspotlogin' and '/hotspotlogin.rb'
-    get %r{^/(hotspotlogin(\.rb)?/?)?$} do 
+    # All paths should be under /hotspotlogin, to allow easier 
+    # setup of "conditional" HTTPS reverse proxies
+    
+    get '/' do
+      redirect '/hotspotlogin'
+    end
+
+    get '/hotspotlogin/favicon.ico' do
+      if HotSpotLogin.config['favicon'] 
+        if File.file? HotSpotLogin.config['favicon']
+          send_file HotSpotLogin.config['favicon']
+        else
+          not_found
+        end
+      else
+        not_found
+      end
+    end
 
+    get '/hotspotlogin/logo.:ext' do
+      if HotSpotLogin.config['logo'] 
+        if 
+            File.file?(   HotSpotLogin.config['logo'])                      and
+            File.extname( HotSpotLogin.config['logo']) == ".#{params[:ext]}"
+          send_file HotSpotLogin.config['logo']
+        else
+          not_found
+        end
+      else
+        not_found
+      end
+    end
+    
+    get '/hotspotlogin/?' do 
       if HotSpotLogin.config['uamsecret'] and
           HotSpotLogin.config['uamsecret'].length > 0
         uamsecret = HotSpotLogin.config['uamsecret']
@@ -110,69 +123,80 @@ module HotSpotLogin
         headline = 'Logging in to HotSpot'
 
         #if uamsecret and userpassword
-        if userpassword
+        if userpassword # PAP
           headers({
             'Refresh' => "0;url=http://#{params['uamip']}:#{params['uamport']}/logon?username=#{params['UserName']}&password=#{pappassword}&userurl=#{params['userurl']}" 
             # NOTE: no userurl passed... why? 
             # NOTE: if you pass it, nothing changes
           })
-        else
+        else # CHAP
           headers({
             'Refresh' => "0;url=http://#{params['uamip']}:#{params['uamport']}/logon?username=#{params['UserName']}&response=#{response}&userurl=#{params['userurl']}"
           })
         end
       elsif params['res'] == 'success' 
-        result = 1
+        result = Result::SUCCESS
         titel = 'Logged in to HotSpot'
         headline = 'Logged in to HotSpot'
         bodytext = 'Welcome'
       elsif params['res'] == 'failed' 
-        result = 2
+        result = Result::FAILED
         titel = 'HotSpot Login Failed'
         headline = 'HotSpot Login Failed'
       elsif params['res'] == 'logoff'
-        result = 3
+        result = Result::LOGOFF
         titel = 'Logged out from HotSpot'
         headline = 'Logged out from HotSpot'
       elsif params['res'] == 'already' 
-        result = 4
+        result = Result::ALREADY 
         titel = 'Already logged in to HotSpot'
         headline = 'Already logged in to HotSpot'
       elsif params['res'] == 'notyet'
-        result = 5
+        result = Result::NOTYET
         titel = 'Logged out from HotSpot'
         headline = 'Logged out from HotSpot'
       elsif params['res'] == 'popup1'
-        result = 11
+        result = Result::PopUp::LOGGING_IN
         titel = 'Logging into HotSpot'
         headline = 'Logged in to HotSpot'
       elsif params['res'] == 'popup2'
-        result = 12
+        result = Result::PopUp::LOGGED_IN
         titel = 'Logged in to HotSpot'
         headline = 'Logged in to HotSpot'
       elsif params['res'] == 'popup3'
-        result= 13
+        result= Result::PopUp::LOGGED_OUT
         titel = 'Logged out from HotSpot'
         headline = 'Logged out from HotSpot'
       elsif params['res'] == '' or !params['res'] # not a form request: err!
-        result = 0
+        result = Result::NONE
         titel = 'What do you want here?'
         headline = 'HotSpot Login Failed'
       end
 
+      logoext = nil
+      logoext = 
+          File.extname(HotSpotLogin.config['logo']) if
+          File.extname(HotSpotLogin.config['logo'])
+
       erb(
         :hotspotlogin,
         :locals => {
-          :titel => titel,
-          :headline => headline,
-          :bodytext => bodytext,
-          :uamip => params['uamip'],
-          :uamport => params['uamport'],
-          :userurl => params['userurl'],
-          #:redirurl => params['redirurl'],
-          :redirurl => params['userurl'],
-          :timeleft => params['timeleft'],
-          :result => result
+          :titel            => titel,
+          :headline         => headline, # like 'Logged out from HotSpot'
+          :bodytext         => bodytext,
+          :uamip            => params['uamip'],
+          :uamport          => params['uamport'],
+          :userurl          => params['userurl'],
+          #:redirurl        => params['redirurl'],
+          :redirurl         => params['userurl'],
+          :timeleft         => params['timeleft'], # legacy... 
+          :interval         => HotSpotLogin.config['interval'],
+          :custom_headline  => 
+              HotSpotLogin.config['custom-headline'], # like "MyOrg Name"
+          :custom_text      => HotSpotLogin.config['custom-text'],
+          :custom_footer    => HotSpotLogin.config['custom-footer'],
+          :logoext          => logoext,
+          :result           => result,
         }
       )
 

data/lib/hotspotlogin/app/helpers.rb

@@ -0,0 +1,17 @@
+require 'sinatra/base'
+require 'hotspotlogin/constants'
+
+module HotSpotLogin
+  class App < Sinatra::Base
+    helpers do
+      def logged_in?(result)
+        [
+          HotSpotLogin::Result::ALREADY,
+          HotSpotLogin::Result::SUCCESS,
+          HotSpotLogin::Result::PopUp::SUCCESS,
+        ].include? result
+      end
+      alias status_window? logged_in?
+    end
+  end
+end

data/lib/hotspotlogin/config.rb

@@ -27,7 +27,31 @@ module HotSpotLogin
       end
 
       # Command line switches override configuration file.
+      
+      opts.on('--interval SECONDS', 'autorefresh accounting/session data every SECONDS seconds') do |seconds|
+        @@config['interval'] = seconds.to_i
+      end
+
+      opts.on('--custom-headline TEXT', 'display <h1>TEXT</h1> on top of the login page, tipically your Organization name') do |text|
+        @@config['custom-headline'] == text
+      end
+
+      opts.on('--custom-text FILE', 'display HTML fragment FILE before the user stats table/login form') do |file|
+        @@config['custom-text'] == file
+      end
 
+      opts.on('--custom-footer FILE', 'display HTML fragment FILE after the user stats table/login form') do |file|
+        @@config['custom-footer'] == file
+      end
+
+      opts.on('--logo FILE', 'logo (of your Organization etc.)') do |file|
+        @@config['logo'] = file
+      end
+
+      opts.on('--favicon FILE', 'well, favicon ;)') do |file|
+        @@config['favicon'] = file
+      end
+     
       opts.on('--[no-]daemon', 'become a daemon') do |daemonize|
         @@config['daemon'] = daemonize
       end
@@ -44,7 +68,7 @@ module HotSpotLogin
         @@config['uamsecret'] = uamsecret
       end
 
-      opts.on('--[no-]userpassword', 'like setting $userpassword=1 in hotspotlogin.cgi') do |userpassword|
+      opts.on('--[no-]userpassword', 'like setting $userpassword=1 in hotspotlogin.cgi (use PAP instead of CHAP)') do |userpassword|
         @@config['userpassword'] = userpassword
       end
 

data/lib/hotspotlogin/constants.rb

@@ -1,12 +1,42 @@
 module HotSpotLogin
 
-  VERSION = '0.1.2'
+  VERSION = '1.0.0'
 
   DEFAULT_CONFIG = {
     'listen-address'    => '0.0.0.0',
     'port'              => 4990,
     'log-http'          => false,
-    'userpassword'      => true # like $userpassword in hotpotlgin.(cgi|php)
+    'userpassword'      => true, # like $userpassword in hotpotlgin.(cgi|php)
+    'interval'          => 300
   } 
+
+  ROOTDIR = File.join(File.dirname(File.expand_path __FILE__), '../..')
+
+  # Corresponding GET parameters are res=success, res=failed, res=popup1, etc.
+  module Result
+    SUCCESS =  1
+    FAILED  =  2
+    LOGOFF  =  3  # logged out
+    ALREADY =  4
+    NOTYET  =  5
+    POPUP1  = 11
+    POPUP2  = 12
+    POPUP3  = 13
+    NONE    =  0  # It was not a form request
+    
+    # More meaningful constants for popup windows.
+    module PopUp
+      LOGGING_IN  = POPUP1
+      LOGGED_IN   = POPUP2
+      LOGGED_OUT  = POPUP3
+
+      # convenient aliases
+      LOGGING     = LOGGING_IN 
+      LOGGED      = LOGGED_IN
+      SUCCESS     = LOGGED_IN
+      LOGOFF      = LOGGED_OUT
+      LOGOUT      = LOGOFF
+    end
+  end
    
 end

data/public/hotspotlogin/css/default.css

@@ -0,0 +1,77 @@
+body {
+  font-size: 10pt;
+}
+h1, h2 {
+  text-align: center;
+  font-family: sans-serif;
+}
+h1 {
+  font-size: 160%;
+  margin: 0.1ex 0;
+}
+h2 {
+  font-size: 135%;
+  margin-top: 0.1ex;
+  font-style: italic;
+}
+#powered-by {
+  text-align: right; 
+  font-style: italic; 
+  margin-right: 3em; 
+  margin-bottom: 1ex;
+  font-family: sans-serif; 
+  font-size:smaller;
+}
+#logo-container {
+  text-align: center;
+  margin: 0 0;
+}
+#form-container {
+  text-align: center;
+}
+#form-container table {
+  margin: 1em auto 0.5em auto;
+}
+#form-container table tr th {
+  text-align: left;
+}
+#logInLogOut-container {
+  padding: 0;
+  margin: 0.5em 0;
+  text-align: center;
+}
+#status-container {
+  text-align: center;
+  margin: 0 0 1em 0;
+}
+#status-table {
+  margin: auto;
+  border: 1px blue solid;
+  padding: 0.5ex;
+}
+#status-table th {
+  text-align: left;
+}
+#status-table td {
+  text-align: right;
+}
+#status-table th.optinfo {
+  font-size: smaller;
+  font-style: italic;
+}
+#submit-container {
+}
+#submit-container button, #submit-container input[type="submit"] {
+  width: 5em;
+}
+#custom-text {
+  font-size: 94%;
+  padding: 0 1ex;
+  margin-bottom: 1.5em;
+}
+#custom-footer {
+  margin-top: 2em;
+  font-size: small;
+  font-family: sans-serif;
+  text-align: center;
+}