On the Wireless Protection > Hotspots > Hotspots tab you can manage different hotspots.
Note – A hotspot has to be assigned to an existing interface, typically a WLANWireless Local Area Network interface. All hosts using this interface will automatically be restricted by the hotspot. Therefore, before you create a hotspot you would typically create a wireless network with client traffic Separate Zone, then create an interface for the respective WLAN interface hardware. For more information, see Wireless Protection > Wireless Networks.
To create a hotspot, proceed as follows:
Click Add Hotspot.
The Add Hotspot dialog box opens.
Make the following settings:
Name: Enter a descriptive name for this hotspot.
Interfaces: Add the interfaces which are to be restricted by the hotspot. Please ensure that for the selected interfaces a firewall rule exists which allows the desired traffic. An interface can only be used by one hotspot.
Caution – You should not select an uplink interface here because traffic to the Internet will completely be blocked afterwards. Additionally, we strongly advise against using interfaces used by servers which provide essential services like authentication. You may irreversibly lock yourself out of WebAdmin!
Administrative Users: Add or select users for administrative settings. Administrative users are allowed to create vouchers or change the password of the day in the User Portal. By default nobody is allowed to make administrative settings.
Redirect to HTTPS: If enabled, users will be redirected to HTTPS.
- Hostname type: Select if you want to redirect to an IP address or to a custom hostname (DNS).
- Hostname (only available with custom hostname): Select or add the hostname for the redirect.
Hotspot type: Select the hotspot type for the selected interfaces.
- Password of the day: A new password will be created automatically once a day. This password will be available in the User Portal on the Hotspots tab which is available to all users specified on the Global tab. Additionally it will be sent to the specified email addresses.
Voucher (not available with BasicGuard subscription): With this hotspot type, in the User Portal tokens with different limitations and properties can be generated, printed and given to customers. After entering the code, the customers can then directly access the Internet.
Note – If only a normal Ethernet interface is configured for this hotspot, SSID and PSK will not be displayed. If you use a normal interface and a WLAN interface, it will be displayed.
- Backend authentication: With this hotspot type, users can authenticate via any supported backend mechanism (see Definitions & Users > Authentication Services). With this type, the user credentials are stored to periodically check if the users are still authorized.
Note – If you select Backend authentication a new entry field for OTP token appears on the login form if Hotspot is configured as an OTP facility.
Note – Every hotspot type drops the packets if the conditions are not fulfilled. ICMP packets types 8 and 0 (Echo Request and Echo Reply) will not be dropped.
Password creation time (only with Hotspot type Password of the day): The assigned time of the day at which the new password will be created. At this time the former password will immediately get invalid and current sessions will be cut off.
Voucher definitions (only with Hotspot type Voucher): Add or select the voucher definitions you want to use for the hotspot. How to add a voucher definition is explained on the Voucher Definitions page.
Devices per voucher (only with Hotspot type Voucher): Enter the number of devices which are allowed to log in with one voucher during its lifetime. It is not recommended to use the unlimited entry.
Hotspot users (only with Hotspot type Backend Authentication): Select the users or user groups or add the users that should be able to access the hotspot via backend authentication. Typically, this is a backend user group.
Synchronize password with PSK of wireless networks (only with Hotspot type Password of the day): Select this option to synchronize the new generated/saved password with wireless PSK for separate zone networks.
Note – With the new PSK all APs that are configured with a separate zone wireless network that is also used as a hotspot interface will be reconfigured and restarted. This means all connections will be dropped.
Redirect to URL after login: If selected, after entering the password or the voucher data, the users will be redirected automatically to a particular URL, e.g., your hotel's website or a webpage stating your portal system policies.
- URL: URL to which users are redirected.
Note – When you select hotspot type Voucher the Redirect to URL after login does not automatically redirect to the configured URL. Users will be redirected to a statistics page which contains important information about the voucher, e.g. period of validity. Users will be able to continue to the configured URL when they click on the link: You will be redirected to [URL].
Comment (optional): Add a description or other information.
Optionally, make the following hotspot customization settings:
By default, users will be presented a login page with the Sophos logo. You can use a customized HTML file with your own images and stylesheets. Additionally, you can customize the voucher layout.
Customization type: Select the customization type. The following types are available:
Basic: Use the default login page template. If required, change logo, title, and text.
Logo: Upload a logo for the login page. Supported image file types are jpg, png and gif. A maximum image width of 300 px and height of 100 px is recommended (depending on the title length). Use the Restore Default button to select the default Sophos logo again.
Scale logo to recommended size: If selected, a logo exceeding the recommended width or height will be scaled down and displayed in the recommended size. If not selected, the logo will be displayed in the original size.
Title: Add a title for the login page. Simple HTML markup and hyperlinks are allowed.
Custom text: Add an additional text for the login page. You can for example enter the SSID of the wireless network to be used. Simple HTML markup and hyperlinks are allowed.
Full: Select an individual login HTML page.
Voucher template (only with hotspot type Voucher): Clicking the Folder icon opens a window where you can select and upload the PDF file with the voucher layout. By default, a default template is used. You can restore the default clicking the Restore Default button. The voucher PDF file has to have a PDF version PDF 1.5 or lower. It may have any page size and format—both size and format will be adjust during voucher creation in the User Portal, depending on page size and number of vouchers per page specified there. You can download the default PDF template on the Wireless Protection > Hotspots > Global tab.
The PDF file may contain the following variables that will be replaced with the respective values during voucher generation in the User Portal:
- Wireless network name (SSID): <?ssid0?> (and <?ssid1?>, <?ssid2?> and so on, if the WLAN has more than one SSIDs)
- Wireless network password: <?psk0?> (and <?psk1?>, <?psk2?> and so on, if the WLAN has more than one SSIDs)
- Voucher code: <?code?>
- Voucher validity time: <?validity?>
- Voucher data limit: <?datalimit?>
- Voucher time limit: <?timelimit?>
- Comment: <?comment?>
- QR code with the hotspot access data encoded: <?qrX?>. The upper left corner of the QR code will be placed on the lower left corner of the variable.
Note – When using variables, the PDF file must include the entire character sets of the fonts used. When a variable is replaced by its value, and one of the substitute characters is not available, it will be displayed incorrectly. We recommend to add the string <?abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789?> (for English usage) to your PDF file, which will automatically be removed during voucher generation. If you use another language, you can include any other character set you want. Additionally, it is recommended to use a separate line for the variables as the layout could get corrupted if the substituted text is too long.
The hotspot will be created and appears on the Hotspots list.
Tip – You can open a preview of the login page after saving the hotspot. In the Hotspots list just click the button Preview Login Page of the respective hotspot.
To either edit or delete a hotspot, click the corresponding buttons.
Cross Reference – Find information about enabling backend authentication for hotspots in the Sophos Knowledge Base.
The HTML template for the login page may contain various variables that can dynamically insert information for the hotspot login page. When Sophos UTM processes a template in order to display a login page, it replaces any template variables with the relevant value. Valid variables are:
<?company_text?>: Custom company text as defined on Management > Customization > Global
<?company_logo?>: Company logo as defined on Management > Customization > Global. The variable will be replaced by the path of the logo file, usage e.g., <img src="<?company_logo?>">
<?admin_contact?>: Administrator name or address as defined on Management > Customization > Web Messages
<?admin_message?>: Administrator information label as defined on Management > Customization > Web Messages (default: Your cache administrator is:)
<?error?>: Error message that arose while trying to log in.
Variables used for all hotspot types
<?redirect_host?>: Redirect URL that is specified for the hotspot (as defined on Hotspots page)
<?location?>: URL the user requested
<?location_host?>: Hostname of the URL the user requested
<?login_form?>: Login form suitable for the respective hotspot type: Password text box, Token text box, Username and Password text boxes, or Accept checkbox, and Login button. For creating customized login forms, see User Specific Login Form below.
<?asset_path?> (only important for customization mode Full): Hotspot-specific directory for storage of images or stylesheets (example usage: <img src="<?asset_path?>/logo.png">)
Variables only used for Voucher type hotspots
<?maclimit?> Number of allowed devices per voucher of this hotspot (as defined on Hotspots page)
<?numdevices?>: Number of devices used for this voucher
<?timeend?>: End of validity period (can be defined on Voucher Definitions page)
<?time_total?>: Total time quota allowed (can be defined on Voucher Definitions page)
<?time_used?>: Time quota used up (can be defined on Voucher Definitions page)
<?traffic_total?>: Total data volume allowed (can be defined on Voucher Definitions page)
<?traffic_used?>: Data volume used up (can be defined on Voucher Definitions page)
Templates can contain if variables that make up sections like the ones shown below. Each section has an opening and a closing variable. The contents of an if section is only displayed on a specific condition.
|Section is displayed when the user has successfully logged in.|
|Section is displayed when hotspot type is Password of the day.|
|Section is displayed when hotspot type is Voucher.|
|Section is displayed when hotspot type is Backend Authentication.|
|Section is displayed when the user has been redirected.|
|Section is displayed when the checkbox Redirect to URL after login is enabled.|
|Section is displayed when the checkbox Redirect to URL after login is disabled.|
|Section is displayed when a validity period is set for a voucher.|
|Section is displayed when a data volume is set for a voucher.|
|Section is displayed when a time quota is set for a voucher.|
|Section is displayed when a Devices per voucher value is specified.|
|Section is displayed when an error occurred while trying to log in.|
If you want to create your own login form instead of using the pre-defined <?login_form?> variable, consider the following:
Enclose the form in the following tags:
<form action="?action=login" method="POST"> ... </form>
<input type="checkbox" name="accept" value="true">
For Password of the Day or Voucher hotspots, add a text box named "token":
<input type="text" name="token">
For a Backend Authentication hotspot, add the two text boxes named "username" and "password":
<input type="text" name="username">
<input type="password" name="password">
Add a means to submit the form, e.g., a Login button:
<input type="submit" name="login" value="Login">
Cross Reference – Find information about customizing the login page for Sophos UTM hotspots in the Sophos Knowledge Base.