Skip to content

Latest commit

 

History

History
112 lines (78 loc) · 8.21 KB

README.md

File metadata and controls

112 lines (78 loc) · 8.21 KB
Raw

UTMFW

UTMFW is a UTM firewall running on OpenBSD. UTMFW is expected to be used on production systems. The UTMFW project provides a Web User Interface (WUI) for monitoring and configuration. You can also use A4PFFW and W4PFFW for monitoring.

You can find a couple of screenshots on the wiki.

The installation iso file for the amd64 arch is available for download at utmfw67_20200605_amd64.iso. Make sure the SHA256 checksum is correct: 50bebb6b945bde21254042b372b45e5b3f35a9d97c8c2d060ee3d1e98f1c4153.

UTMFW is an updated version of ComixWall. However, there are a few major changes, such as SSLproxy, Snort Inline IPS, PFRE, E2Guardian, many fixes and improvements to the system and the WUI, Firebase push notifications, and network user authentication. Also note that UTMFW 6.7 comes with OpenBSD 6.7-stable including all updates until May 25th, 2020.

UTMFW supports deep SSL inspection of HTTP, POP3, and SMTP protocols. SSL/TLS encrypted traffic is decrypted by SSLproxy and fed into the UTM services: Web Filter, POP3 Proxy, SMTP Proxy, and Inline IPS (and indirectly into Virus Scanner and Spam Filter through those UTM software). These UTM software have been modified to support the mode of operation required by SSLproxy.

Features

UTMFW includes the following software, alongside what is already available on a basic OpenBSD installation:

  • SSLproxy: Transparent SSL/TLS proxy for deep SSL inspection
  • PFRE: Packet Filter Rule Editor
  • E2Guardian: Web filter, anti-virus using ClamAV, blacklists
  • Snort: Intrusion detection and inline prevention system, with the latest rules
  • SnortIPS: Passive intrusion prevention software
  • ClamAV: Virus scanner with periodic virus signature updates
  • SpamAssassin: Spam scanner
  • P3scan: Anti-virus/anti-spam transparent POP3 proxy
  • Smtp-gated: Anti-virus/anti-spam transparent SMTP proxy
  • Dante: SOCKS proxy
  • IMSpector: IM proxy which supports IRC and others.
  • OpenVPN: Virtual private networking
  • Symon system monitoring software
  • Pmacct: Network monitoring via graphs
  • ISC DNS server
  • PHP

Console

The web user interface of UTMFW helps you manage your firewall:

  • Dashboard provides an overview of system status. If enabled, Notifier sends the system status as Firebase push notifications to the Android application, A4PFFW.
  • System, network, and service configuration can be achieved on the web interface.
  • Pf rules are maintained using PFRE.
  • Information on hosts, interfaces, pf rules, states, and queues are provided in a tabular form.
  • System, pf, network, and internal clients can be monitored via graphs.
  • Logs can be viewed and downloaded on the web interface. Compressed log files are supported.
  • Statistics collected over logs are displayed in bar charts and top lists. Bar charts and top lists are clickable, so you don't need to touch your keyboard to search anything on the statistics pages. You can view the top lists on pie charts too. Statistics over compressed log files are supported.
  • The web interface provides many help boxes and windows, which can be disabled.
  • Man pages of OpenBSD and installed software can be accessed and searched on the web interface.
  • There are two users who can log in to the web interface. Unprivileged user does not have access rights to configuration pages, thus cannot interfere with system settings, and cannot even change user password (i.e. you can safely give the unprivileged user's password to your boss).
  • The web interface supports languages other than English: Turkish, Chinese, Dutch, Russian, French, Spanish.
  • The web interface configuration pages are designed such that changes you may have made to the configuration files on the command line (such as comments you might have added) remain intact after you configure a module using the web interface.

Dashboard

How to install

Download the installation iso file mentioned above and follow the instructions in the installation guide available in the iso file. Below are the same instructions.

A few notes about UTMFW installation:

  • Thanks to a modified auto-partitioner of OpenBSD, the disk can be partitioned with a recommended layout for UTMFW, so most users don't need to use the label editor at all.
  • All install sets including siteXY.tgz are selected by default, so you cannot 'not' install UTMFW by mistake.
  • OpenBSD installation questions are modified according to the needs of UTMFW. For example, X11 related questions are never asked.
  • Make sure you have at least 2GB RAM. And an 8GB HD should be enough.

UTMFW installation is very intuitive and easy, just follow the instructions on the screen and answer the questions asked. You are advised to accept the default answers to all the questions. In fact, the installation can be completed by accepting default answers all the way from the first question until the last. The only obvious exceptions are network configuration and password setup.

Auto allocator will provide a partition layout recommended for your disk. Suggested partitioning should be suitable for most installations, simply accept it.

Make sure you configure two network interfaces. You will be asked to choose internal and external interfaces later on.

All of the install sets and software packages are selected by default, simply accept the selections.

If the installation script finds an already existing file which needs to be updated, it saves the old file as filename.orig.

Installation logs can be found under the /root directory.

You can access the web administration interface using the IP address of the system's internal interface you have selected during installation. You can log in to the system over ssh from internal network.

Web interface user names are admin and user. Network user is utmfw. All are set to the same password you have provided during installation.

References:

  1. INSTALL.amd64 in the installation iso file.
  2. Supported hardware.
  3. OpenBSD installation guide.

How to build

The purpose in this section is to build the installation iso file using the createiso script at the root of the project source tree. You are expected to be doing these on an OpenBSD 6.7 and have installed git, gettext, and doxygen on it.

The createiso script:

  • Clones the git repo of the project to a tmp folder.
  • Generates gettext translations and doxygen documentation.
  • Prepares the webif and config packages and the site install set.
  • And finally creates the iso file.

However, the source tree has links to OpenBSD install sets and packages, which should be broken, hence need to be fixed when you first obtain the sources. Make sure you see those broken links now. So, before you can run createiso, you need to do a couple of things:

  • Install sets:
    • Obtain the sources of OpenBSD.
    • Patch the OpenBSD sources using the patch-* files under openbsd/utmfw.
    • Create the UTMFW secret and public key pair to sign and verify the SHA256 checksums of the install sets, and copy them to their appropriate locations.
    • Build an OpenBSD release, as described in release(8) or faq5.
    • Copy the required install sets to the appropriate locations to fix the broken links in the sources.
  • Packages:
    • Download the required packages available on the OpenBSD mirrors.
    • Create the packages which are not available on the OpenBSD mirrors and/or have been modified for UTMFW: sslproxy, e2guardian, p3scan, smtp-gated, snort, imspector, snortips, and libevent 2.1.11 (see ports and ports/distfiles).
    • Copy them to the appropriate locations to fix the broken links in the sources.

Note that you can strip down xbase and xfont install sets to reduce the size of the iso file. Copy or link them to the appropriate locations under openbsd/utmfw.

Now you can run the createiso script which should produce an iso file in the same folder as itself.