qusal/salt/sys-mirage-firewall/README.md
Ben Grande 383c840f2f
doc: lint markdown files
Only way to have a unified markdown syntax is to enforce the wanted
syntax by linting the files. Don't rely on the many markdown syntaxes,
be consistent.
2024-07-04 17:27:31 +02:00

1.5 KiB

sys-mirage-firewall

Mirage Firewall in Qubes OS.

Table of Contents

Description

Creates a Mirage Firewall qube named "disp-sys-mirage-firewall". It is an OCaml program compiled to run as an operating system kernel, in this case, a MirageOS unikernel replacement for the default firewall (sys-firewall). It pulls in just the code it needs as libraries.

Contrary to a standard Linux Firewall, Mirage Firewall doesn't need a full system to run an excessive resources.

You can't use Mirage Firewall to be the updatevm, use another qube instead.

Installation

We have built the Unikernel locally and verified that the upstream checksum and local checksum matched when comparing the same release.

  • Top:
sudo qubesctl top.enable sys-mirage-firewall
sudo qubesctl state.apply
sudo qubesctl top.disable sys-mirage-firewall
  • State:
sudo qubesctl state.apply sys-mirage-firewall.create

Usage

Set qubes netvm to disp-sys-mirage-firewall:

qvm-prefs --set QUBE netvm disp-sys-mirage-firewall

To test the firewall, apply rules with qvm-firewall.

For monitoring, inspect the Unikernel console:

sudo xl console disp-sys-mirage-firewall

Exit the console with Ctrl-].

Credits