Sophos XG Services Configuration File

Templates for Sophos XG environments

IT service providers usually use standards to build customer environments. Such standards enable the system to be maintained by different engineers, even if they are not directly familiar with the environment. Templates can facilitate the implementation of such standards.

Sophos is not directly concerned about such templates for Sophos XG Firewalls, but has implemented a very sophisticated import/export feature for configurations. With some background knowledge, this can be used quite easily to implement standards.

Create templates by export

I recommend using a separate virtual lab appliance to create the templates.

Step 1: Export the configuration

The export function of Sophos XG Appliances can be found under “Backup & firmware” -> “Import export”. The export function is very powerful: the configuration items can be exported very selectively and with dependencies if desired.

  • Selektiver Export
  • Abhängige Objekte mit exportieren.
  • Konfiguration erfolgt als .tar

Step 2: Edit the configuration

Since the exports are always full-scope, the configurations must be edited so that they can be used as templates. Unnecessary configuration objects should be removed from the XML exports. In principle, manual ” building” of a template is also possible.

For editing, the Entities.xml must be unzipped from the downloaded TAR files. I recommend the use of 7-Zip for this. The contained Entities.xml can then be edited with any text editor. Of course, editing with an editor that supports XML markups is much more comfortable. I used Notepad++ in this case.

The XML files are relatively easy to understand. It is good to know that the configuration files seem to be structured chronologically. So most recently added objects are at the end of the file. The referencing among the configuration objects is also not done by IDs but by the object names. Which significantly simplifies the editing of the files.

Collection of ready-made templates for services & service groups

I have started collecting service objects and service groups on Github:

Feel free to contribute your templates too!

Step 3: Prepare edited XML files for upload (create TAR-balls)

Sophos appliances do not accept the “naked” XML files. The Entities.xml must therefore be zipped again as TAR files.

Sophos appliances do not accept the “naked” XML files. The Entities.xml must therefore be zipped again as TAR files.

The best way to create the TAR files is to use 7-Zip:

  • Funktion "Add to archive..." von 7-Zip
  • Einstellungen für .tar Dateien in 7-Zip

Share templates

The finished templates can be shared across the organization via file shares, sharepoints, GitHub repos wikis, etc.

Leave a Reply