mirror of
https://github.com/ben-grande/qusal.git
synced 2024-09-21 01:35:41 +00:00
61 lines
1.4 KiB
Markdown
61 lines
1.4 KiB
Markdown
|
# sys-mirage-firewall
|
||
|
|
|
||
|
|
Mirage Firewall in Qubes OS.
|
||
|
|
|
||
|
|
## Table of Contents
|
||
|
|
|
||
|
|
* [Description](#description)
|
||
|
|
* [Installation](#installation)
|
||
|
|
* [Usage](#usage)
|
||
|
|
* [Credits](#credits)
|
||
|
|
|
||
|
|
## Description
|
||
|
|
|
||
|
|
Creates a Mirage Firewall qube named "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
|
||
|
|
```sh
|
||
|
|
qubesctl top.enable sys-mirage-firewall
|
||
|
|
qubesctl state.apply
|
||
|
|
qubesctl top.disable sys-mirage-firewall
|
||
|
|
```
|
||
|
|
|
||
|
|
- State
|
||
|
|
<!-- pkg:begin:post-install -->
|
||
|
|
```sh
|
||
|
|
qubesctl state.apply sys-mirage-firewall.create
|
||
|
|
```
|
||
|
|
<!-- pkg:end:post-install -->
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
As a started, set qubes `netvm` to `sys-mirage-firewall`:
|
||
|
|
```sh
|
||
|
|
qvm-prefs --set QUBE netvm sys-mirage-firewall
|
||
|
|
```
|
||
|
|
|
||
|
|
To test the firewall, apply rules with `qvm-firewall`.
|
||
|
|
|
||
|
|
For monitoring, inspect the Unikernel console:
|
||
|
|
```sh
|
||
|
|
sudo xl console sys-mirage-firewall
|
||
|
|
```
|
||
|
|
Exit the console with `Ctrl-]`.
|
||
|
|
|
||
|
|
## Credits
|
||
|
|
|
||
|
|
- [Unman](https://github.com/unman/shaker/tree/main/mirage)
|