2018-01-30 10:40:13 +00:00
|
|
|
|
=========================
|
|
|
|
|
|
Captive portal & GuestNET
|
|
|
|
|
|
=========================
|
|
|
|
|
|
A **Captive Portal** allows you to force authentication, or redirection to a click
|
|
|
|
|
|
through page for network access. This is commonly used on hotspot networks,
|
|
|
|
|
|
but is also widely used in corporate networks for an additional layer of security
|
|
|
|
|
|
on wireless or Internet access.
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: images/hotspot_login.png
|
|
|
|
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
Typical Applications
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
* Guest Network
|
2018-11-07 16:45:54 +00:00
|
|
|
|
* Hotel & Camping Wi-Fi Access
|
2018-01-30 10:40:13 +00:00
|
|
|
|
* Bring Your Own Device (BOYD)
|
|
|
|
|
|
|
|
|
|
|
|
-------------------
|
|
|
|
|
|
Template Management
|
|
|
|
|
|
-------------------
|
|
|
|
|
|
OPNsense’s unique template manager makes setting up your own login page an easy
|
|
|
|
|
|
task. At the same time it offers additional functionalities, such as:
|
|
|
|
|
|
|
|
|
|
|
|
* URL redirection
|
|
|
|
|
|
* Option for your own Pop-up
|
|
|
|
|
|
* Custom Splash page
|
|
|
|
|
|
|
|
|
|
|
|
.. image:: images/captiveportal_template_folder.png
|
|
|
|
|
|
|
|
|
|
|
|
---------------
|
|
|
|
|
|
Zone Management
|
|
|
|
|
|
---------------
|
|
|
|
|
|
Different zones can be setup on each interface or multiple interfaces can share
|
|
|
|
|
|
one zone setup. Each Zone can use a different Captive Portal Template or share it
|
|
|
|
|
|
with another zone.
|
|
|
|
|
|
|
|
|
|
|
|
--------------
|
|
|
|
|
|
Authentication
|
|
|
|
|
|
--------------
|
|
|
|
|
|
Secure authentication via HTTPS or splash-only portal with URL redirection to a
|
|
|
|
|
|
given page Different sources can be used to authenticate a user in a zone:
|
|
|
|
|
|
|
|
|
|
|
|
* LDAP [Microsoft Active Directory]
|
|
|
|
|
|
* Radius
|
|
|
|
|
|
* Local user manager
|
|
|
|
|
|
* Vouchers / Tickets
|
|
|
|
|
|
* No authentication (Splash Screen Only)
|
|
|
|
|
|
* Multiple (a combination of above)
|
|
|
|
|
|
|
|
|
|
|
|
---------------
|
|
|
|
|
|
Voucher Manager
|
|
|
|
|
|
---------------
|
|
|
|
|
|
OPNsense's Captive Portal has an easy voucher creation system that exports the
|
2018-12-24 11:06:22 +00:00
|
|
|
|
vouchers to a csv file for use with your favorite application. The export allows
|
|
|
|
|
|
you to print vouchers by merging them with your Microsoft Word or LibreOffice template and
|
2018-01-30 10:40:13 +00:00
|
|
|
|
create a good looking handout with your logo and company style.
|
|
|
|
|
|
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
Timeouts & Welcome Back
|
|
|
|
|
|
-----------------------
|
|
|
|
|
|
Connection can be terminated after the user has been idle for a certain amount
|
|
|
|
|
|
of time (idle timeout) and/or force a disconnect when a number of minutes
|
|
|
|
|
|
have passed even if the user is still active (hard timeout). In case a user
|
2019-02-10 10:16:48 +00:00
|
|
|
|
reconnects within the idle timeout and/or hard timeout no login is required and
|
2018-01-30 10:40:13 +00:00
|
|
|
|
the user can resume its active session.
|
|
|
|
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
Bandwidth Management
|
|
|
|
|
|
--------------------
|
2018-11-07 16:45:54 +00:00
|
|
|
|
The Built-in traffic shaper can be utilized to:
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
|
|
* Share bandwidth evenly
|
2018-11-08 19:59:18 +00:00
|
|
|
|
* Give priority to protocols port numbers and/or IP addresses
|
2018-01-30 10:40:13 +00:00
|
|
|
|
|
|
|
|
|
|
See also: :doc:`/manual/shaping`
|
|
|
|
|
|
|
|
|
|
|
|
-------------
|
|
|
|
|
|
Portal bypass
|
|
|
|
|
|
-------------
|
|
|
|
|
|
MAC and IP addresses can be white listed to bypass
|
|
|
|
|
|
the portal.
|
|
|
|
|
|
|
|
|
|
|
|
-------------------
|
|
|
|
|
|
Real Time Reporting
|
|
|
|
|
|
-------------------
|
|
|
|
|
|
Basic Real Time Reporting is Integrated
|
|
|
|
|
|
|
|
|
|
|
|
* Live top IP bandwidth usage (Traffic Graph)
|
|
|
|
|
|
* Active Sessions
|
|
|
|
|
|
* Time left on Vouchers
|
|
|
|
|
|
|
|
|
|
|
|
----------------------------
|
|
|
|
|
|
Category based Web Filtering
|
|
|
|
|
|
----------------------------
|
|
|
|
|
|
By combining the Captive Portal with the caching proxy it is possible to utilize
|
|
|
|
|
|
category web filtering and block certain content for the users and by enabling the
|
|
|
|
|
|
cache reduce bandwidth and improve response times. See also: :doc:`/manual/proxy`
|
|
|
|
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
Platform Integration
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
Through the integrated REST API the captive portal application can be integrated
|
|
|
|
|
|
with other services. See: :doc:`/development/how-tos/api`
|
|
|
|
|
|
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
Configure the Portal
|
|
|
|
|
|
--------------------
|
|
|
|
|
|
To setup a hotspot controller for business or hotel usage see:
|
|
|
|
|
|
:doc:`how-tos/guestnet`
|
