README

Open Secure Access Point

An portal software for OpenBSD

Features:
--------

 o uses PF & dhcpd features
 o Self registration (Name / e-mail address)
 o written in Perl
 o No fancy java/javascript

Pre-requisites 
--------------

 o a router running OpenBSD 4.7 or later on which to install this

Typical use scenario
--------------------

 o guest machines connecting to a network, need to be authenticated
 o the router gives them DHCP leases and redirects all web traffic 
   to the portal. The rest is blocked.
 o once identified, the IP is added to a different table, to let 
   traffic pass the gateway
 o if the users clicks on the 'Disconnect' button, or its lease expires, 
   go back to initial (blocked) state
 o machines without a valid DHCP lease can't do anything : all trafic
   is blocked 
 
Installing
----------

 o setup router: sysctl.conf, hostname.if for interfaces
 o edit /etc/pf.conf
 o edit /etc/dhcpd.conf
 o set up caching named
 o edit httpd.conf
 o copy logo and css files to /www/htdocs
 o copy login.pl to /www/cgi-bin, edit it for LDAP auth parameters
 o copy osapd to /usr/local/sbin
 o add osapd startup in /etc/rc.local
 o edit rc.conf.local : start dhcpd, httpd (-u), named.

----------------------------------------------------------------------
License:

Copyright (c) 2006-2011 CNRS/LAAS

Permission to use, copy, modify, and distribute this software for any
purpose with or without fee is hereby granted, provided that the above
copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.