qubes-mirage-firewall/README.md

# qubes-mirage-firewall

A unikernel that can run as a QubesOS ProxyVM, replacing `sys-firewall`.
It uses the [mirage-qubes][] library to implement the Qubes protocols.

Note: This firewall *ignores the rules set in the Qubes GUI*. See `rules.ml` for the actual policy.

See [A Unikernel Firewall for QubesOS][] for more details.

## Build (with Docker)

Clone this Git repository and run the `build-with-docker.sh` script:

    sudo yum install docker
    sudo systemctl start docker
    git clone https://github.com/talex5/qubes-mirage-firewall.git
    cd qubes-mirage-firewall
    sudo ./build-with-docker.sh

This took about 10 minutes on my laptop (it will be much quicker if you run it again).

## Build (without Docker)

1. Install build tools:

        sudo yum install git gcc m4 0install patch ncurses-devel tar bzip2 unzip make which findutils xen-devel
        mkdir ~/bin
        0install add opam http://tools.ocaml.org/opam.xml
        opam init --comp=4.04.0
        eval `opam config env`

2. Install mirage, pinning a few unreleased features we need:

        opam pin add -n -y tcpip 'https://github.com/talex5/mirage-tcpip.git#fix-length-checks'
        opam pin add -y mirage-nat 'https://github.com/talex5/mirage-nat.git#cleanup'
        opam install mirage

3. Build mirage-firewall:

        git clone https://github.com/talex5/qubes-mirage-firewall.git
        cd qubes-mirage-firewall
        mirage configure --xen
        make

## Deploy

If you want to deploy manually, use `make tar` to create `mirage-firewall.tar.bz2` and unpack this in dom0, inside `/var/lib/qubes/vm-kernels/`. e.g. (if `dev` is the AppVM where you built it):

        [tal@dom0 ~]$ cd /var/lib/qubes/vm-kernels/
        [tal@dom0 vm-kernels]$ qvm-run -p dev 'cat qubes-mirage-firewall/mirage-firewall.tar.bz2' | tar xjf -

The tarball contains `vmlinuz`, which is the unikernel itself, plus a couple of dummy files that Qubes requires.

For development, use the [test-mirage][] scripts to deploy the unikernel (`mir-qubes-firewall.xen`) from your development AppVM. e.g.

    $ test-mirage mir-firewall.xen mirage-firewall
    Waiting for 'Ready'... OK
    Uploading 'mir-qubes-firewall.xen' (4843304 bytes) to "mirage-firewall"
    Waiting for 'Booting'... OK
    --> Loading the VM (type = ProxyVM)...
    --> Starting Qubes DB...
    --> Setting Qubes DB info for the VM...
    --> Updating firewall rules...
    --> Starting the VM...
    --> Starting the qrexec daemon...
    Waiting for VM's qrexec agent.connected
    --> Starting Qubes GUId...
    Connecting to VM's GUI agent: .connected
    --> Sending monitor layout...
    --> Waiting for qubes-session...
    Connecting to mirage-firewall console...
    MirageOS booting...
    Initialising timer interface
    Initialising console ... done.
    Netif: add resume hook
    gnttab_stubs.c: initialised mini-os gntmap
    2015-12-30 10:04.42: INF [qubes.rexec] waiting for client...
    2015-12-30 10:04.42: INF [qubes.gui] waiting for client...
    2015-12-30 10:04.42: INF [qubes.db] connecting to server...
    2015-12-30 10:04.42: INF [qubes.db] connected
    2015-12-30 10:04.42: INF [qubes.rexec] client connected, using protocol version 2
    2015-12-30 10:04.42: INF [qubes.db] got update: "/qubes-keyboard" = "xkb_keymap {\n\txkb_keycodes  { include \"evdev+aliases(qwerty)\"\t};\n\txkb_types     { include \"complete\"\t};\n\txkb_compat    { include \"complete\"\t};\n\txkb_symbols   { include \"pc+gb+inet(evdev)\"\t};\n\txkb_geometry  { include \"pc(pc104)\"\t};\n};"
    2015-12-30 10:04.42: INF [qubes.gui] client connected (screen size: 6720x2160)
    2015-12-30 10:04.42: INF [unikernel] agents connected in 0.052 s (CPU time used since boot: 0.007 s)
    Netif.connect 0
    Netfront.create: id=0 domid=1
     sg:true gso_tcpv4:true rx_copy:true rx_flip:false smart_poll:false
    MAC: 00:16:3e:5e:6c:0b
    ARP: sending gratuitous from 10.137.1.13
    2015-12-30 10:04.42: INF [application] Client (internal) network is 10.137.3.0/24
    ARP: transmitting probe -> 10.137.1.1
    2015-12-30 10:04.42: INF [net] Watching backend/vif
    2015-12-30 10:04.42: INF [qubes.rexec] Execute "user:QUBESRPC qubes.SetMonitorLayout dom0\000"
    2015-12-30 10:04.42: WRN [command] << Unknown command "QUBESRPC qubes.SetMonitorLayout dom0"
    2015-12-30 10:04.42: INF [qubes.rexec] Execute "root:QUBESRPC qubes.WaitForSession none\000"
    2015-12-30 10:04.42: WRN [command] << Unknown command "QUBESRPC qubes.WaitForSession none"
    2015-12-30 10:04.42: INF [qubes.db] got update: "/qubes-netvm-domid" = "1"
    ARP: retrying 10.137.1.1 (n=1)
    ARP: transmitting probe -> 10.137.1.1
    ARP: updating 10.137.1.1 -> fe:ff:ff:ff:ff:ff


# LICENSE

Copyright (c) 2015, Thomas Leonard
All rights reserved.

Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.

2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
gg

[test-mirage]: https://github.com/talex5/qubes-test-mirage
[mirage-qubes]: https://github.com/talex5/mirage-qubes
[A Unikernel Firewall for QubesOS]: http://roscidus.com/blog/blog/2016/01/01/a-unikernel-firewall-for-qubesos/
Initial import 2015-12-30 04:52:24 -05:00			`# qubes-mirage-firewall`

Add 'make tar' build target 2016-01-01 10:21:28 -05:00			A unikernel that can run as a QubesOS ProxyVM, replacing `sys-firewall`.
Initial import 2015-12-30 04:52:24 -05:00			`It uses the [mirage-qubes][] library to implement the Qubes protocols.`

Move NAT code to router and add DNS redirects 2015-12-30 11:07:16 -05:00			Note: This firewall ignores the rules set in the Qubes GUI. See `rules.ml` for the actual policy.
Initial import 2015-12-30 04:52:24 -05:00
Link to blog post 2016-01-02 03:34:39 -05:00			`See [A Unikernel Firewall for QubesOS][] for more details.`

Add option to build with Docker 2017-01-09 11:45:16 -05:00			`## Build (with Docker)`

			Clone this Git repository and run the `build-with-docker.sh` script:

			`sudo yum install docker`
			`sudo systemctl start docker`
			`git clone https://github.com/talex5/qubes-mirage-firewall.git`
			`cd qubes-mirage-firewall`
Update README: you need "sudo docker" by default 2017-01-28 10:19:05 -05:00			`sudo ./build-with-docker.sh`
Add option to build with Docker 2017-01-09 11:45:16 -05:00
			`This took about 10 minutes on my laptop (it will be much quicker if you run it again).`

			`## Build (without Docker)`

Add 'make tar' build target 2016-01-01 10:21:28 -05:00			`1. Install build tools:`
Initial import 2015-12-30 04:52:24 -05:00
Add option to build with Docker 2017-01-09 11:45:16 -05:00			`sudo yum install git gcc m4 0install patch ncurses-devel tar bzip2 unzip make which findutils xen-devel`
Add 'make tar' build target 2016-01-01 10:21:28 -05:00			`mkdir ~/bin`
			`0install add opam http://tools.ocaml.org/opam.xml`
Mirage 3 support 2017-03-02 09:52:55 -05:00			`opam init --comp=4.04.0`
Add 'make tar' build target 2016-01-01 10:21:28 -05:00			eval `opam config env`

			`2. Install mirage, pinning a few unreleased features we need:`

Update to new mirage-nat API 2017-03-05 11:31:04 -05:00			`opam pin add -n -y tcpip 'https://github.com/talex5/mirage-tcpip.git#fix-length-checks'`
			`opam pin add -y mirage-nat 'https://github.com/talex5/mirage-nat.git#cleanup'`
Add 'make tar' build target 2016-01-01 10:21:28 -05:00			`opam install mirage`

			`3. Build mirage-firewall:`

			`git clone https://github.com/talex5/qubes-mirage-firewall.git`
			`cd qubes-mirage-firewall`
			`mirage configure --xen`
			`make`

Add option to build with Docker 2017-01-09 11:45:16 -05:00			`## Deploy`

Add 'make tar' build target 2016-01-01 10:21:28 -05:00			If you want to deploy manually, use `make tar` to create `mirage-firewall.tar.bz2` and unpack this in dom0, inside `/var/lib/qubes/vm-kernels/`. e.g. (if `dev` is the AppVM where you built it):

			`[tal@dom0 ~]$ cd /var/lib/qubes/vm-kernels/`
			`[tal@dom0 vm-kernels]$ qvm-run -p dev 'cat qubes-mirage-firewall/mirage-firewall.tar.bz2' \| tar xjf -`

			The tarball contains `vmlinuz`, which is the unikernel itself, plus a couple of dummy files that Qubes requires.

			For development, use the [test-mirage][] scripts to deploy the unikernel (`mir-qubes-firewall.xen`) from your development AppVM. e.g.
Initial import 2015-12-30 04:52:24 -05:00
			`$ test-mirage mir-firewall.xen mirage-firewall`
			`Waiting for 'Ready'... OK`
			`Uploading 'mir-qubes-firewall.xen' (4843304 bytes) to "mirage-firewall"`
			`Waiting for 'Booting'... OK`
			`--> Loading the VM (type = ProxyVM)...`
			`--> Starting Qubes DB...`
			`--> Setting Qubes DB info for the VM...`
			`--> Updating firewall rules...`
			`--> Starting the VM...`
			`--> Starting the qrexec daemon...`
			`Waiting for VM's qrexec agent.connected`
			`--> Starting Qubes GUId...`
			`Connecting to VM's GUI agent: .connected`
			`--> Sending monitor layout...`
			`--> Waiting for qubes-session...`
			`Connecting to mirage-firewall console...`
			`MirageOS booting...`
			`Initialising timer interface`
			`Initialising console ... done.`
			`Netif: add resume hook`
			`gnttab_stubs.c: initialised mini-os gntmap`
			`2015-12-30 10:04.42: INF [qubes.rexec] waiting for client...`
			`2015-12-30 10:04.42: INF [qubes.gui] waiting for client...`
			`2015-12-30 10:04.42: INF [qubes.db] connecting to server...`
			`2015-12-30 10:04.42: INF [qubes.db] connected`
			`2015-12-30 10:04.42: INF [qubes.rexec] client connected, using protocol version 2`
			`2015-12-30 10:04.42: INF [qubes.db] got update: "/qubes-keyboard" = "xkb_keymap {\n\txkb_keycodes { include \"evdev+aliases(qwerty)\"\t};\n\txkb_types { include \"complete\"\t};\n\txkb_compat { include \"complete\"\t};\n\txkb_symbols { include \"pc+gb+inet(evdev)\"\t};\n\txkb_geometry { include \"pc(pc104)\"\t};\n};"`
			`2015-12-30 10:04.42: INF [qubes.gui] client connected (screen size: 6720x2160)`
			`2015-12-30 10:04.42: INF [unikernel] agents connected in 0.052 s (CPU time used since boot: 0.007 s)`
			`Netif.connect 0`
			`Netfront.create: id=0 domid=1`
			`sg:true gso_tcpv4:true rx_copy:true rx_flip:false smart_poll:false`
			`MAC: 00:16:3e:5e:6c:0b`
			`ARP: sending gratuitous from 10.137.1.13`
			`2015-12-30 10:04.42: INF [application] Client (internal) network is 10.137.3.0/24`
			`ARP: transmitting probe -> 10.137.1.1`
			`2015-12-30 10:04.42: INF [net] Watching backend/vif`
			`2015-12-30 10:04.42: INF [qubes.rexec] Execute "user:QUBESRPC qubes.SetMonitorLayout dom0\000"`
			`2015-12-30 10:04.42: WRN [command] << Unknown command "QUBESRPC qubes.SetMonitorLayout dom0"`
			`2015-12-30 10:04.42: INF [qubes.rexec] Execute "root:QUBESRPC qubes.WaitForSession none\000"`
			`2015-12-30 10:04.42: WRN [command] << Unknown command "QUBESRPC qubes.WaitForSession none"`
			`2015-12-30 10:04.42: INF [qubes.db] got update: "/qubes-netvm-domid" = "1"`
			`ARP: retrying 10.137.1.1 (n=1)`
			`ARP: transmitting probe -> 10.137.1.1`
			`ARP: updating 10.137.1.1 -> fe:ff:ff:ff:ff:ff`



			`# LICENSE`

			`Copyright (c) 2015, Thomas Leonard`
			`All rights reserved.`

			`Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:`

			`1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.`

			`2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.`

			THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
			`gg`

			`[test-mirage]: https://github.com/talex5/qubes-test-mirage`
			`[mirage-qubes]: https://github.com/talex5/mirage-qubes`
Link to blog post 2016-01-02 03:34:39 -05:00			`[A Unikernel Firewall for QubesOS]: http://roscidus.com/blog/blog/2016/01/01/a-unikernel-firewall-for-qubesos/`