Notes and attachments for GSoC 2021 for Qubes OS implementing easy port forwarding.

Giulio 9589a9fe49 Status update 1 week ago
assets da33365f07 Added note in chart 1 month ago 9589a9fe49 Status update 1 week ago

QubesOS Port Forwarding GSoC 2021

Proposal text


Forwarding ports to Qubes VM is currently possible only though a multi step, error prone, manual process that also requires writing custom configuration in order to be persistent between reboots. Things as simple as starting a webserver or netcat for LAN file sharing canbe eventually a troublesome and time-wasting process[1][2]. Furthermore, applications thatrely on NAT traversal protocols such as those for audio and video communications do not workin direct P2P mode with STUN and always use TURN instead[3].

Project Goals

Implement a GUI for automatic and persistent, eventually with a predefined timespan (ie: untilreboot), port forwarding. The idea is to split horizontally the "Firewall Rules" tab in the"Qubes Settings" window and add another area below it. It is aloready possible to forward TCP streams, however there is no GUI nor a clear dashboard and furthermore its versatility is limited. In addition, discuss and verify the possibility to implement a secure NAT traversal systemand GUI. A basic proposal could be a checkbox to enable NAT traversal requests. When thecheckbox is selected, the FirwallVM will redirect NAT traversal requests to a local pythondaemon or a dedicated VM that will negotiate the NAT traversal and configure the networkaccordingly. In this case, prompt the user in Dom0 about the NAT traversal request. Of coursethe qvm-* set of tools must e able to achieve the same tasks via CLI.


First develop and document the part related to manual port forwarding since it is both a more frequent use case and is less complicated. Depending on the problems encountered, evaluate the feasibility of secure NAT traversal.





Dev Repositories

Main components involved

  1. Firewall GUI in "Settings" (qubes-manager)
  2. CLI interface available via qvm-firewall (core-admin-client)
  3. Actual client logic for the Admin API (core-admin-client)
  4. Admin API interface - XML conf manager (core-admin)
  5. Agent running in firewall vm - executes nft or iptables

Current Status

How does the GUI and qvm-firewall configuration work?

The Qubes Manager GUI and the qvm-firewall both use the code imlemented in the Admi API Client library. The Client Library sends specific messages to the qubesd daemon. The currently supported operatins are:

  • admin.vm.firewall.Get
  • admin.vm.firewall.Set
  • admin.vm.firewall.Reload

These actions can be tested by using the qvm-firewall utility. It is important to note that both the client and the daemon are more flexibile compared to the settings available via the GUI.

Configuration files

If any non default configuration is set by the user, an AppVM will have a firewall.xml configuration file in the var/lib/qubes/<appvm>/ path. Deleting the file will reset the firewall to the default state and any customization will be lost.

The firewall.xml is clearly human readable and contains rules in the form:

<firewall version="2">
				<!-- accept outgoing to porto tcp port 443 -->
				<property name="action">accept</property>
				<property name="dsthost"></property>
				<property name="proto">tcp</property>
				<property name="dstports">443</property>
				<!-- accept outgoing to proto any -->
				<property name="action">accept</property>
				<property name="dsthost"></property>
				<!-- allow outgoing dns queries. needed for domain based rules -->
				<property name="action">accept</property>
				<property name="specialtarget">dns</property>
				<!-- drop everything else -->
				<property name="action">drop</property>

The following command will return the firewall rules for <vmnname>.

qvm-firewall <vmname>

As can be seen, the output will show more colums that the GUI, specifically an EXPIRE, COMMENT, and SPECIAL TARGET columns will be displayed.

The following command will reload the persistent rules stored in firewall.xml of <vmname>

qvm-firewall <vmname> --reload

The following command can be used to add a rule. Not that if the GUI detects that the firewall has been edited from CLI, since it does not support all CLI settings, it will refuse to allow management again from the GUI.

qvm-firewall <vmname> add action=accept dsthost= proto=tcp dstports=80-80 expire=+5000 comment="cloudflare http test rule"


Currently, all firewall rules have an action properties which can be either accept or drop. The plan is to add a third option forward specifically for implementing automatic port forwarding. Such options must be supported both in the configuration file and in the Admin API (client-server). Lastly, it shall be implemented in the agent daemon. The main issue however is the fact that currenly, the firewall client library is designated to operate only on the AppVM configured Firewall NetVM. However, in order to forward ports from the outside world, specific rules needs to be applied to the Firewall NetVM Networking NetVM. (ie: both is sys-firewall and sys-net, as currently done for manual port forwarding).


Since in the case of port forwarding the target ip address would always be the <vmname> IP address, users should not be asked for a dsthost field. Adding a forward rule could look like this:

qvm-firewall <vmname> add action=forward proto=tcp forwardtype=external srcports=443-443 dstports=80443-80443 srchost= expire=+500000 comment="example https server rule"
qvm-firewall <vmname> add action=forward proto=tcp forwardtype=internal srcports=80-80 dstports=8000-8000 srchost= expire=+500000 comment="example internal simplehttpserver file sharing rule"

Of course expire= and comment= are optional fields.

				<!-- sample syntax for port forwarding -->
				<property name="action">forward</property>
				<property name="proto">tcp</property>
				<property name="forwardtype">external</property>
				<property name="srcports">443-443</property>
				<property name="dstports">80443-80443</property>
				<property name="srchost"></property>
				<property name="comment">example https server rule</property>

Proposal chart

The main distinction between internal and external port forwarding is:
  • Internal resolves only <appvm>'s <ntvm>
  • External recursively resolves all upstream networking vm and sets forwarding rules on all of them
This should cover multiple scenarios:
  • Standard external forwarding when <appvm> service needs to be exposed on a physical interface
  • Standard internal forwarding when <appvm> service needs to be exposed to other <appvm2/3/4> connected to the same <netvm>
  • VPN internal port forwarding when <appvm> service needs to be exposed through a VPN

It is important to note that in the last case, it is just a standard case of internal forwarding.


Implementation Roadmap

  1. ✔️ In core-admin-client/qubesadmin/ > The code needs to support the new options for the rule (action=forward frowardtype= srcports=443-443 srchosts=
  2. ✔️ In core-admin/qubes/ -> The code needs to support the same options as the point above
  3. ✔️ In core-admin/qubes/vm/mix/ -> The most important logic goes here. Here there is the need to resolve the full network chain for external port forwarding. From here it is possible to add the respective rules to the QubesDB of each NetVM in he chain and trigger a reload event.
  4. 🚧 In core-agent-linux/qubesagent/ -> Here goes the logic for building the correct syntax for iptables or nft and the actual execution
  5. ❌ GUI
  6. ❌ Tests
  7. Required rules


    ***srchost and srcports support yet to be written here *** In <networkvm>:

    iptables -t nat -A PREROUTING -i <external_iinterface> -p tcp --dport <target_port> -d <interface_ip> -j DNAT --to-destination <firewallvm_ip>
    iptables -I FORWARD 2 -i <external_iinterface> -d <firewallvm_ip> -p tcp --dport <target_port> -m conntrack --ctstate NEW -j ACCEPT
    nft add rule ip qubes-firewall forward meta iifname <external_iinterface> ip daddr <firewallvm_ip> tcp dport <target_port> ct state new counter accept

    In <firewallvm>:

    iptables -t nat -A PREROUTING -i <interface> -p tcp --dport <target_port> -d <firewallvm_ip> -j DNAT --to-destination <appvm_ip>
    iptables -I FORWARD 2 -i <interface> -d <appvm_ip> -p tcp --dport <target_port> -m conntrack --ctstate NEW -j ACCEPT
    nft add rule ip qubes-firewall forward meta iifname <interface> ip daddr <appvm_ip> tcp dport <target_port> ct state new counter accept

    in <appvm>:

    iptables -w -I INPUT 5 -d <appvm_ip> -p tcp --dport <target_port> -m conntrack --ctstate NEW -j ACCEPT


    In <firewallvm>:

    iptables -t nat -A PREROUTING -i <interface> -p tcp --dport <target_port> -d <firewallvm_ip> -j DNAT --to-destination <appvm_ip>
    iptables -I FORWARD 2 -i <interface> -d <appvm_ip> -p tcp --dport <target_port> -m conntrack --ctstate NEW -j ACCEPT
    nft add rule ip qubes-firewall forward meta iifname <interface> ip daddr <appvm_ip> tcp dport <target_port> ct state new counter accept

    in <appvm>:

    iptables -w -I INPUT 5 -d <appvm_ip> -p tcp --dport <target_port> -m conntrack --ctstate NEW -j ACCEPT


    QubedDB Debugging

    Since all firewall rules are written to the respective domains QubesDB by the qubesd it is essential dor debugging purposes to be able to easily read QubesDB entries. The QubesOS Project provide some useful utilities to interact with each DB. Such utilities have self explicative names and works like the respective functions used in the source code. The most useful are:

    • qubesdb-list
    • qubesdb-read
    • qubesdb-write

    Useful example:

     # qubesdb-list -fr /qubes-firewall/ -d sys-firewall
     # qubesdb-read -fr /qubes-firewall/ -d sys-firewall


    Flags explanation as produced from the qvm-ls utility:

            Type of domain (When it is HVM, the letter is capital).
            0   AdminVM (AKA Dom0)
            aA  AppVM
            dD  DisposableVM
            sS  StandaloneVM
            tT  TemplateVM
            Current power state.
            r   running
            t   transient
            p   paused
            s   suspended
            h   halting
            d   dying
            c   crashed
            ?   unknown
         	U   updateable
         	N   provides_network
         	R   installed_by_rpm
         	i   internal
         	D   debug
         	A   autostart

    Dev Environment

    Currently developing on VMWare Workstation on Windows due to issues in virtualizing on linux on my home hardware. QubesOS is virtualized behind NAT and can reach Windows Host via SSH.

    In order to the the code, I wrote some helper scripts. The required setup involves:

    • Clone the tools on the Windows Host
    • Generate an SSH keypair on sys-net
    • Add sys-net SSH pubkey on Windows for non interactive authentication (sshd is easier using Windows Subsystem for Linux)
    • Via scp/sftp, copy all the bash script in the sys-net VM. Leve in /home/user/
    • Using qvm-run copy, and in Dom0
    • First, run once and pay attention to never run it again in order to recover from broken states (breaking qubesd, qvm-run will stop working and it will be hard to recover)
    • Run to automatically pull changes from the Windows host. qubesd is restarted within the same script.
    • In case of issues, run and investigate the previous errors