Netgate is offering COVID-19 aid for pfSense software users, learn more.
Configuring a Captive Portal Zone¶
When creating a captive portal zone, multiple settings can be edited:
Captive portal on pfSense® has 3 integrated timeout options:
- Idle timeout
Users will automatically be disconnected after a defined amount of network inactivity. The “last activity time of each user” is retrieved using the last byte sent by each device. (meaning last byte “uploaded” from the user perspective)
- Hard timeout
Users will be automatically disconnected after a defined time period, whether or not they are active.
- Traffic quota
Users will be automatically disconnected after exceeding a defined amount of combined upload and download transfer data.
If one of these options is enabled, pfSense will check once per minute to find users that meet criteria for disconnection. The way pfSense works is that a scheduled task (cron) will run every minute, checking for users to disconnect.
These options disconnect users but they do not prevent users to log in again. To prevent users from logging in again, use a RADIUS server for authentication with appropriately configured limits. See Authenticating captive portal users using a RADIUS server.
Four authentication methods are available on pfSense:
- Don’t authenticate users
All users will be redirected to the captive portal login page but will get connected as soon as they click Login. this is useful for displaying a welcome page, or forcing users to see general terms and conditions.
- Use an authentication server from the user manager
Authentication will be made using a remote authentication server. Please see Use an authentication server from the user manager for details.
- Use RADIUS MAC Authentication
This authentication method emulates 802.1X, allowing some MAC addresses to connect automatically.
- Use vouchers
Vouchers are one-time use portal access code. Please see captive portal vouchers page for details.
Vouchers can be used in parallel with any authentication method, allowing for example login/password authentication for employees, and voucher auth for others users.
Use an authentication server from the user manager¶
It is possible to authenticate users against a server from the server manager, such as an LDAP or RADIUS server. Please check the user manager documentation for details on how to setup remote authentication servers in pfSense.
Remote authentication servers have to be setup first in the server manager before they can be used for captive portal authentication.
Special note about “unauthenticated” username¶
When using an authentication server, it is recommended to block/reserve the username “unauthenticated”, in order to prevent users to connect using this username. This can be done by registering a disabled account in the remote authentication server (recommended when using LDAP) or by preventing this user from logging in (recommended when using a RADIUS server).
This username is used internally in pfSense for defining a user not yet authenticated, or for defining connected users when using “no authentication” method and no username has been provided. For this reason, this username is given special rights, such as bypassing “block concurrent logins” option.
Authenticating captive portal users using a RADIUS server¶
When using an external RADIUS server (such as FreeRADIUS) to authenticate users, it is possible to set some attributes in the RADIUS Access-Accept response that will be understood by pfSense, in order to fine-tune how the captive portal will behave for each user.
The RADIUS dictionary for pfSense may not be included by default with RADIUS servers. FreeRADIUS dictionary is available on Github. For other RADIUS servers, please contact the associated vendor.
- Individual traffic quota
An individual traffic quota may be defined for each user, using
This attribute should contain, as the name implies, an integer defining the maximum amount of data a user could spend before getting disconnected.
This attribute may override the value defined in the captive portal configuration, if any.
- Individual time limits
Custom time limits may be defined using two RADIUS attributes:
Session-Timeoutattribute will set a custom “hard timeout” for this user.
Idle-Timeoutattribute will set a custom “idle timeout” for this user.
Both values have to be provided in seconds, and may override the value defied in the captive portal configuration, if any.
- Individual bandwidth
An individual bandwidth may be set for upload and download for each user, using the following RADIUS attributes:
These attributes may override the bandwidth defined in the captive portal configuration, if any.
The value of these attributes have to be written in bits per second. Also, pfSense will assume that 1000 bits = 1kbps when applying these settings (e.g. defining pfsense-bandwidth-max-up = 512000 for one user will limit the user’s upload bandwidth to 512 kbit/s).
- Custom redirection URL
A custom redirection URL may be defined in
WISPr-Redirection-URLattribute. Users will be redirected to this URL after a successful authentication.
This attribute may override the forced redirection URL defined in the captive portal configuration, if any.
Authenticating captive portal users using RADIUS MAC Authentication¶
FreeRADIUS and captive portal may be used to authenticate users by their MAC address, thus performing pseudo 802.1x.
This authentication method is not true 802.1x because users will still need to make an HTTP request in order to get connected. When this authentication method is enabled, the captive portal will try to authenticate users against the RADIUS server every time an HTTP request is made.
It is possible, though not recommended, to display the login page as fallback when authentication failed. It is possible this way to have MAC authentication and login/password authentication altogether, both authenticating against the same RADIUS server.
Please keep in mind that this authentication method may generate many RADIUS requests and does not scale very well.
When using a RADIUS server for authentication, it is possible for pfSense to send RADIUS accounting messages containing various information about users such as their IP address, MAC address, login time and amount of uploaded/downloaded data.
pfSense can send 3 type of accounting messages:
- Accounting Start messages
If accounting is enabled, RADIUS messages with attribute
Acct-Status-Type: Startwill be sent when a user connects. The username, IP address, MAC address, and login time of this user will also be provided.
- Accounting Stop messages
If accounting is enabled, RADIUS messages with attribute
Acct-Status-Type: Stopwill be sent when a user disconnects. The disconnection time and the amount of transferred data will be provided, as well as username, IP address, MAC address, and login time.
- Accounting Updates messages
If accounting updates is enabled, RADIUS messages with attribute
Acct-Status-Type: Interim-Updatewill be sent every minute for each connected user. These messages will contain the update time and the amount of transferred data, as well as username, IP address, MAC address, and login time. The purpose of this feature is to regularly update the amount of data consumed by each user on the RADIUS server.
It is recommended to use Interim accounting update method. Other methods (Stop/Start and Stop/Start FreeRADIUS) are deprecated and should not be used.
General note when using captive portal with FreeRADIUS¶
FreeRADIUS Simultaneous-Use and Captive Portal re-authentication¶
For obvious reasons, Simultaneous-Use is not compatible with “Reauthenticate users” option. We recommend not using Simultaneous-Use in FreeRADIUS if user re-authentication is enabled on pfSense.