Sophos UTM 9.6 customisation - web and email messaging
July 10, 2019
Marcel Zimmer
Sophos
Sophos
The tabs of the Administration > Customisations menu allow you to customise and localise the templates for status messages and email notifications created by Sophos UTM. This makes it possible to customise these messages to fit your company's policies and corporate identity. In addition, you can upload and edit custom web templates to further customise messages about blocked pages or other notifications.
On the Administration > Customisations > General tab, you can make general settings for status messages that are displayed to users. Note that UTF-8/Unicode is supported.
The example below shows the customisable global options (Company Logo and Company Specific Text) in a sample "Content Blocked" message that can be customised on the Administration > Customisations > Web Messages page.
Company logo
Here you can upload your own company logo/banner (only in png format), which will be used in the following cases:
Web messages
Blocked POP3 emails
Quarantine removal status messages (displayed when an email classified as spam has been released from quarantine or whitelisted via the quarantine report)
Quarantine report
Some of the user messages are optimised for the standard logo (195 x 73 pixels with transparent background). For best results, use an image with the same properties.
Note - For HTTPS connections, the logo will not be embedded if it is larger than 512 KB.
To upload a logo:
Open the Upload File dialogue box. To do so, click on the folder symbol next to the Upload new logo field. The Upload File dialogue box opens.
Select the logo. Change to the directory in which the company logo is located. Select the logo and click Start Upload.
Click Apply. The logo is uploaded, replacing the previously installed file.
Company-specific text
This is the text below the company logo on the default error message page displayed by the browser when a user opens a website that is blocked by the Sophos UTM virus scanner or content filter. You can enter the administrator's contact details here, for example.
Web messages
You can customise the texts of web filter messages that are displayed by Sophos UTM. For example, messages are displayed when users are not allowed to download certain files because they are too large, of a certain type or contain a virus. Messages are also displayed when users try to access blocked websites or applications, when they download files, or when they need to authenticate to the UTM. You can translate messages into other languages or add support contact information to them, just to name a few examples.
Note - The text you enter here on the Web Messages tab can be used in user-specific web templates.
The following templates can be customised:
Block Content
Surf Protection: This message is displayed when a user tries to access a web page whose URL matches a category that should be blocked, or when the page's reputation is below the set threshold.
Blacklist: This message is displayed when a user wants to access a web page whose URL is blacklisted. To add URLs to the blacklist, go to the Web Protection > Web Filter > Policies > Categories page.
MIME type: This message is displayed when a user requests a file with a MIME type that should be blocked. For more information on setting MIME types, see Web Protection > Web Filter > Policies > Downloads.
File extension: This message is displayed when a user requests a file with an extension that should be blocked. For more information on setting file extensions, see Web Protection > Web Filter > Policies > Downloads.
File size: This message is displayed when a user requests a file that exceeds the maximum allowed file size. You set the maximum download file size here: Web Protection > Web Filter > Policies > Downloads.
Application Control: This message is displayed when a user tries to use a network traffic type that is blocked by Application Control.
Virus found: This message is displayed when a file containing a virus is blocked. For more information about antivirus settings, see Web Protection > Web Filter > Policies > Antivirus.
Download/Scan
Download in progress: This message is displayed while a file is being downloaded.
Virus scan in progress: This message is displayed while the UTM is scanning files for malicious content.
Download complete: This message is displayed after a file has been completely downloaded, scanned and found to be safe.
Authentication
Transparent mode with authentication: This option only applies if you operate the web filter in transparent mode and have selected the authentication method "Browser". For more information, see Web Protection > Web Filter Profiles > Filter Profiles. The text is displayed on the authentication page where users must log in before they are allowed to use the web filter. If the Terms of Use field is filled in, they will be displayed on the authentication page. If the field is empty, no terms of use are displayed.
Bypass content blocking: This message is displayed if a page is blocked by Surf Protection and the option to bypass blocking is active (see Web Protection > Filter Options > Bypass User). If the Terms of Use field contains text, it will be displayed on the authentication page. If the field is empty, no terms of use are displayed.
Error
Server error: This message is displayed if an error occurs when processing a user request.
Administrator details: Here you can enter information about the administrator who manages the web filter, including his or her e-mail address.
Change web message
To change a message, proceed as follows:
Select the message. From the Page drop-down list, select the user message you want to edit. The subject and description of this message are displayed.
Change the subject and/or description. Edit the default text as required.
Click Apply. The text changes will be saved.
Download Management
If the Web Filter is enabled, the Web browser will display the following download pages whenever a user attempts to download content larger than 1MB that does not include text or images. The download pages are not displayed if video or audio streams are requested, or if more than 50% of a file has been downloaded within five seconds.
The information on the download pages can be customized in the Web Messages tab.
Web templates
To customize the appearance and content of messages displayed to users, you can upload HTML files to Sophos UTM. As a guide, Sophos provides some sample templates. These templates show you how to use variables to dynamically insert information that is relevant to each user message. For example, if a file is blocked because it contains a virus, you can use a variable that inserts the name of the blocked virus.
Customise web templates
Warning - Customizing Sophos UTM notifications is an advanced topic. You should only tackle this task if you have sufficient knowledge of HTML and JavaScript.
You can upload customised versions of Sophos UTM notifications, including blocked content messages, status messages, error messages and authentication prompts. The four sample templates include use cases for variables and several images. For your specific messages and notifications, either use the sample templates as a basis or upload your own HTML files. The valid variables are described in the Using Variables in UTM Web Templates article in the Sophos Knowledgebase.
To use text from a notification defined in the Web Notifications tab, you can paste the appropriate variable into your custom template.
To download the sample templates and images, click the following link and save the .zip file:
http://www.astaro.com/lists/Web_Templates.zip
Note - The zip file contains samples with and without embedded images. If an image is embedded in an HTML file, you do not need to upload the corresponding image.
Upload user-specific web templates and images
After you have edited and saved your user-specific template, you can upload it to UTM.
To upload a web template or image:
Open the Upload File dialogue box. Click on the folder icon next to the name of the template type you want to upload, or click on the folder icon next to images if you want to upload an image. The Upload File dialogue box opens. The following file types are supported: .png, .jpg, .jpeg and .gif. Use embedded images and style sheets for HTTPS connections.
Select the template or image. Change to the directory where the template or image is located. After you have selected the template or image, click Start Upload. The Upload File dialogue box closes.
Click Apply. The template or picture is uploaded.
Email messages
Customise the text in user messages generated by Sophos UTM SMTP/POP3 proxies. You can translate the templates into other languages or add additional contact information to them, to name a few examples. The following messages can be customised:
Quarantine
AAEmail released from quarantine: This message is displayed when an email has been successfully released from quarantine.
An error occurred during the quarantine release of the email: This message is displayed when an error occurred while releasing an e-mail from quarantine.
POP3
POP3 message blocked: This message is sent to the recipient when a POP3 email has been blocked.
SPX
These notification emails are sent when SPX encryption is enabled and an error has occurred. These notifications are sent to the specified person(s) (see the Email Encryption > SPX Encryption > SPX Configuration tab).
Password defined by sender is missing: This email is sent to the specified person(s) if the sender of the email did not specify a password for SPX encryption.
Password specified by sender too short: This e-mail will be sent to the specified person(s) if the password specified by the sender of the e-mail is too short.
Password specified by sender does not contain special characters: This email is sent to the specified person(s) if the password specified by the sender of the email does not contain a special character.
Internal error: This email is sent to the specified person(s) if the email could not be delivered due to technical problems.
Internal error - sender notification: This email is sent to the specified person(s) if the email could not be delivered due to an error in the creation of the SPX mail.
Response portal URL not found: This message is displayed on the Reply Portal page if the recipient clicks the Reply button in the encrypted email and the underlying URL cannot be found.
As the default settings show, some variables can be used in the notifications.
%%SENDER%% (only in the email subject): The sender of the email
%%RECIPIENT%%: The recipient of the email
%%REASON%% (only in the email description): The reason for the message. Replaced by the corresponding error text
On the Administration > Customisations > General tab, you can make general settings for status messages that are displayed to users. Note that UTF-8/Unicode is supported.
The example below shows the customisable global options (Company Logo and Company Specific Text) in a sample "Content Blocked" message that can be customised on the Administration > Customisations > Web Messages page.
Company logo
Here you can upload your own company logo/banner (only in png format), which will be used in the following cases:
Web messages
Blocked POP3 emails
Quarantine removal status messages (displayed when an email classified as spam has been released from quarantine or whitelisted via the quarantine report)
Quarantine report
Some of the user messages are optimised for the standard logo (195 x 73 pixels with transparent background). For best results, use an image with the same properties.
Note - For HTTPS connections, the logo will not be embedded if it is larger than 512 KB.
To upload a logo:
Open the Upload File dialogue box. To do so, click on the folder symbol next to the Upload new logo field. The Upload File dialogue box opens.
Select the logo. Change to the directory in which the company logo is located. Select the logo and click Start Upload.
Click Apply. The logo is uploaded, replacing the previously installed file.
Company-specific text
This is the text below the company logo on the default error message page displayed by the browser when a user opens a website that is blocked by the Sophos UTM virus scanner or content filter. You can enter the administrator's contact details here, for example.
Web messages
You can customise the texts of web filter messages that are displayed by Sophos UTM. For example, messages are displayed when users are not allowed to download certain files because they are too large, of a certain type or contain a virus. Messages are also displayed when users try to access blocked websites or applications, when they download files, or when they need to authenticate to the UTM. You can translate messages into other languages or add support contact information to them, just to name a few examples.
Note - The text you enter here on the Web Messages tab can be used in user-specific web templates.
The following templates can be customised:
Block Content
Surf Protection: This message is displayed when a user tries to access a web page whose URL matches a category that should be blocked, or when the page's reputation is below the set threshold.
Blacklist: This message is displayed when a user wants to access a web page whose URL is blacklisted. To add URLs to the blacklist, go to the Web Protection > Web Filter > Policies > Categories page.
MIME type: This message is displayed when a user requests a file with a MIME type that should be blocked. For more information on setting MIME types, see Web Protection > Web Filter > Policies > Downloads.
File extension: This message is displayed when a user requests a file with an extension that should be blocked. For more information on setting file extensions, see Web Protection > Web Filter > Policies > Downloads.
File size: This message is displayed when a user requests a file that exceeds the maximum allowed file size. You set the maximum download file size here: Web Protection > Web Filter > Policies > Downloads.
Application Control: This message is displayed when a user tries to use a network traffic type that is blocked by Application Control.
Virus found: This message is displayed when a file containing a virus is blocked. For more information about antivirus settings, see Web Protection > Web Filter > Policies > Antivirus.
Download/Scan
Download in progress: This message is displayed while a file is being downloaded.
Virus scan in progress: This message is displayed while the UTM is scanning files for malicious content.
Download complete: This message is displayed after a file has been completely downloaded, scanned and found to be safe.
Authentication
Transparent mode with authentication: This option only applies if you operate the web filter in transparent mode and have selected the authentication method "Browser". For more information, see Web Protection > Web Filter Profiles > Filter Profiles. The text is displayed on the authentication page where users must log in before they are allowed to use the web filter. If the Terms of Use field is filled in, they will be displayed on the authentication page. If the field is empty, no terms of use are displayed.
Bypass content blocking: This message is displayed if a page is blocked by Surf Protection and the option to bypass blocking is active (see Web Protection > Filter Options > Bypass User). If the Terms of Use field contains text, it will be displayed on the authentication page. If the field is empty, no terms of use are displayed.
Error
Server error: This message is displayed if an error occurs when processing a user request.
Administrator details: Here you can enter information about the administrator who manages the web filter, including his or her e-mail address.
Change web message
To change a message, proceed as follows:
Select the message. From the Page drop-down list, select the user message you want to edit. The subject and description of this message are displayed.
Change the subject and/or description. Edit the default text as required.
Click Apply. The text changes will be saved.
Download Management
If the Web Filter is enabled, the Web browser will display the following download pages whenever a user attempts to download content larger than 1MB that does not include text or images. The download pages are not displayed if video or audio streams are requested, or if more than 50% of a file has been downloaded within five seconds.
The information on the download pages can be customized in the Web Messages tab.
Web templates
To customize the appearance and content of messages displayed to users, you can upload HTML files to Sophos UTM. As a guide, Sophos provides some sample templates. These templates show you how to use variables to dynamically insert information that is relevant to each user message. For example, if a file is blocked because it contains a virus, you can use a variable that inserts the name of the blocked virus.
Customise web templates
Warning - Customizing Sophos UTM notifications is an advanced topic. You should only tackle this task if you have sufficient knowledge of HTML and JavaScript.
You can upload customised versions of Sophos UTM notifications, including blocked content messages, status messages, error messages and authentication prompts. The four sample templates include use cases for variables and several images. For your specific messages and notifications, either use the sample templates as a basis or upload your own HTML files. The valid variables are described in the Using Variables in UTM Web Templates article in the Sophos Knowledgebase.
To use text from a notification defined in the Web Notifications tab, you can paste the appropriate variable into your custom template.
To download the sample templates and images, click the following link and save the .zip file:
http://www.astaro.com/lists/Web_Templates.zip
Note - The zip file contains samples with and without embedded images. If an image is embedded in an HTML file, you do not need to upload the corresponding image.
Upload user-specific web templates and images
After you have edited and saved your user-specific template, you can upload it to UTM.
To upload a web template or image:
Open the Upload File dialogue box. Click on the folder icon next to the name of the template type you want to upload, or click on the folder icon next to images if you want to upload an image. The Upload File dialogue box opens. The following file types are supported: .png, .jpg, .jpeg and .gif. Use embedded images and style sheets for HTTPS connections.
Select the template or image. Change to the directory where the template or image is located. After you have selected the template or image, click Start Upload. The Upload File dialogue box closes.
Click Apply. The template or picture is uploaded.
Email messages
Customise the text in user messages generated by Sophos UTM SMTP/POP3 proxies. You can translate the templates into other languages or add additional contact information to them, to name a few examples. The following messages can be customised:
Quarantine
AAEmail released from quarantine: This message is displayed when an email has been successfully released from quarantine.
An error occurred during the quarantine release of the email: This message is displayed when an error occurred while releasing an e-mail from quarantine.
POP3
POP3 message blocked: This message is sent to the recipient when a POP3 email has been blocked.
SPX
These notification emails are sent when SPX encryption is enabled and an error has occurred. These notifications are sent to the specified person(s) (see the Email Encryption > SPX Encryption > SPX Configuration tab).
Password defined by sender is missing: This email is sent to the specified person(s) if the sender of the email did not specify a password for SPX encryption.
Password specified by sender too short: This e-mail will be sent to the specified person(s) if the password specified by the sender of the e-mail is too short.
Password specified by sender does not contain special characters: This email is sent to the specified person(s) if the password specified by the sender of the email does not contain a special character.
Internal error: This email is sent to the specified person(s) if the email could not be delivered due to technical problems.
Internal error - sender notification: This email is sent to the specified person(s) if the email could not be delivered due to an error in the creation of the SPX mail.
Response portal URL not found: This message is displayed on the Reply Portal page if the recipient clicks the Reply button in the encrypted email and the underlying URL cannot be found.
As the default settings show, some variables can be used in the notifications.
%%SENDER%% (only in the email subject): The sender of the email
%%RECIPIENT%%: The recipient of the email
%%REASON%% (only in the email description): The reason for the message. Replaced by the corresponding error text
Author:
Marcel Zimmer
Marcel Zimmer is the Technical Managing Director of EnBITCon. During his time in the German Armed Forces, the trained IT developer was able to gain numerous project experiences. His interest in IT security was significantly awakened by his service in command support. Even after his service, he is an active reservist in the Bundeswehr.
His first firewall was a Sophos UTM 120, which he had to set up for a customer project. Since then, his interest in IT security has grown steadily. In the course of time, various security and infrastructure topics have come into his focus. His most interesting projects included, for example, WLAN coverage in an explosion-proof area, as well as a multi-site WLAN solution for a large