User Tools

Site Tools


networkmanager

This is an old revision of the document!


Using IWD with Network Manager

Network Manager version 1.12 integrated a basic IWD-based wifi backend as an alternative to wpa_supplicant. To use Network Manager (NM) with the IWD backend one NM configuration change is necessary. Additionally the versions of the two software packages need to be compatible, this is because IWD's API and capabilities are evolving and the NM backend is adapting to those changes. IWD and the NM backend are work in progress and the capabilities are still limited.

IWD version Compatible NM versions Capabilities
0.3 to 0.4 1.12.* Open, WPA/WPA2 Personal wifi networks, WPA2 Enterprise (see below), No AP mode, no hidden or Ad-hoc networks
0.5 to 0.7 1.14.0 Open, WPA/WPA2 Personal and Enterprise networks, No AP mode, no hidden or Ad-hoc networks
0.8 to 0.23 1.14.* Open, WPA/WPA2 Personal and Enterprise networks, No AP mode, no hidden or Ad-hoc networks
0.8 to 0.23 1.16.0 to 1.28-rc1 Open, WPA/WPA2 Personal and Enterprise networks, Infrastructure/AP/Ad-hoc modes, no hidden networks or P2P
1.0 and later 1.20.6 and later Open, WPA/WPA2/WPA3 Personal and Enterprise networks, Infrastructure/AP/Ad-hoc modes, no hidden networks or P2P
1.0 and later 1.24.0 and later Open, WPA/WPA2/WPA3 Personal and Enterprise networks, Infrastructure/AP/Ad-hoc modes, infrastructure-mode Hidden networks, no P2P
1.0 and later 1.30.0 and later Open, WPA/WPA2/WPA3 Personal and Enterprise networks, Infrastructure/AP/Ad-hoc modes, infrastructure-mode Hidden networks, no P2P, IWD-side autoconnect
1.0 and later 1.34.0 and later Open, WPA/WPA2/WPA3 Personal and Enterprise networks, Infrastructure/AP/Ad-hoc modes, infrastructure-mode Hidden networks, no P2P, IWD-side autoconnect, network config editing from NM

Building NM

If you can use an NM build provided by the Linux distribution that will simplify things a lot. So far Arch linux is known to ship compatible iwd and NM packages so there's no need to manually build the sources.

Even though a distribution may ship an NM-1.12 or later package, the IWD backend may not have been enabled. This is done with with –with-iwd switch to ./configure during the build process (or ./autogen). Pass other ./configure options as required and follow with standard compilation and installation instructions. See the ./configure –help output for the possible options, some will be required and some can not be used depending on what other packages are installed on your system and their settings – this page will not cover other options.

$ wget https://github.com/NetworkManager/NetworkManager/archive/1.30.2.tar.gz
$ tar -xvzf 1.30.2.tar.gz
$ cd NetworkManager-1.30.2
$ ./autogen.sh --with-crypto=gnutls --disable-ppp --without-tests --disable-ovs --without-wext --disable-maintainer-mode --disable-qt --disable-gtk-doc --disable-introspection --with-iwd
$ make -j 3
# make install

Note that on some distributions, including Ubuntu, an NM installation in /usr/local may be disallowed to launch the DHCP client subprocess by the Linux audit mechanism and a permission needs to be added through app_armor. Before that is done, making connections, of any type, from Network Manager, will fail after about a 1 minute timeout (dmesg will show a line similar to this: [98438.542859] audit: type=1400 audit(1532953834.917:242): apparmor=“DENIED” operation=“open” profile=“/sbin/dhclient” name=“/usr/local/var/lib/NetworkManager/dhclient-wlp2s0.conf” pid=31241 comm=“dhclient” requested_mask=“r” denied_mask=“r” fsuid=0 ouid=0). You can either add necessary rules to /etc/apparmor.d/local/sbin.dhclient (see /etc/apparmor.d/sbin.dhclient) or temporarily unload the dhclient-related rules with:

# apparmor_parser -R /etc/apparmor.d/sbin.dhclient
# /etc/init.d/apparmor stop

NM configuration

To switch NM from the wpa_supplicant backend to the IWD backend the following lines need to be added in nm.conf. This file is normally located at /etc/NetworkManager/conf.d/nm.conf but if you've built NM from source it may be in your /usr/local/etc/NetworkManager/conf.d/ instead.

[device]
wifi.backend=iwd

The example above switches all NM-managed WiFi devices to use the IWD backend. NM configuration syntax allows for other possibilties, for details see the relevant section of NetworkManager.conf(5).

After this Network Manager needs to be restarted. The wpa_supplicant daemon will often still be running in the background and needs to be explicitly stopped with killall wpa_supplicant. IWD is currently not automatically started by NM, see Getting Started about starting IWD – this can be done either before or after starting NM. wpa_supplicant and IWD should not generally be active at the same time, neither will be able to manage WiFi connections correctly during the time both are active.

Once this is done you should be able to see a list of available networks from your Network Manager client interface (nm-applet, Gnome Shell or one of the command line NM clients) and be able to connect to Open and WPA/WPA2-Personal networks (Pre-Shared Key networks) as normal.

The following settings fine-tune NM's IWD backend.


(Since 1.30) Selects between IWD-driven (when yes, default) or NM-driven (when no) autoconnect logic:

[device]
wifi.iwd.autoconnect=yes

For details see the relevant section of NetworkManager.conf(5).


(Currently in master, to arrive in 1.32 or 1.34) Tells NM to re-write IWD network configurations whenever an NM network profile is changed thus enabling editing settings such as EAP authentication from nm-connection-editor GUI. With IWD versions 1.15 and later this is on by default (set to no or an empty string to disable). With IWD versions 1.14 you must specify a valid path (iwd-config-path=/var/lib/iwd) to enable. Warning: when enabled NM profiles are the authoritative ones and IWD's /var/lib/iwd files can get overwritten any time:

[main]
iwd-config-path=auto

For details see the relevant section of NetworkManager.conf(5).

Converting network profiles

If you've been using the NM + wpa_supplicant combo and switched to IWD it's possible to bulk-convert your existing network profiles to the IWD format, so that you can keep using them with the IWD backend. Especially useful for EAP (802.1X) networks. You will need to have the iwd-config-path mechanism enabled (see previous section). Optimally these steps would be done automatically by distribution scripts such as Debian's update-alternatives but they require a few changes to the profile settings so the user needs to be conscious this is happening. This is how to do it:

  1. Remove any [wifi].mac-address=, [connection].interface-name= and [connection].permissions= settings from the profiles. In some NM versions some of those keys were set by default on new profiles. IWD profiles are global so any user can activate them on any interface, so NM's IWD backend will refuse to use profiles that have any of those settings.
  2. Delete, then restore all NM profiles. The IWD backend will notice new NM profiles being added and will automatically create IWD network configuration files for each one. From that point on, the iwd-config-path mechanism will automatically keep the IWD configuration files in sync with NM connection profiles when you add, modify or delete them.

This can look something like this:

# cd /etc/NetworkManager/system-connections
# mkdir ../system-connections-iwd
# for f in *; do grep -v '^\(mac-address\|interface-name\|permissions\)=' "$f" > ../system-connections-iwd/"$f"; done
# chmod 0600 ../system-connections-iwd/*
# cd /etc/NetworkManager
# mv system-connections system-connections-backup
# dbus-send --system --print-reply --dest=org.freedesktop.NetworkManager /org/freedesktop/NetworkManager/Settings org.freedesktop.NetworkManager.Settings.ReloadConnections
# sleep 1
# mv system-connections-iwd system-connections
# dbus-send --system --print-reply --dest=org.freedesktop.NetworkManager /org/freedesktop/NetworkManager/Settings org.freedesktop.NetworkManager.Settings.ReloadConnections

Check if you can now see all your usual network names in /var/lib/iwd to confirm if it worked. (Note this method will flush NM “agent-owned secrets” – a rarely-used NM feature)

Limitations

EAP-PWD, EAP-GTC, EAP-MsCHAPv2 Identity

IWD allows the EAP Identity, i.e. the username, to be omitted in the .8021x config files for the following EAP methods: PWD, GTC and MsCHAPv2 in which case they would be requested from the user through the Agent API. Network Manager's agent API is reserved for secrets only and Identity is not a secret so the Identity has to be always provided in the network's config file.

Ad-Hoc networks

IWD does not show Ad-Hoc networks in its scan results and does not support scanning while connected in Ad-Hoc mode. Thus connecting to an existing Ad-Hoc network is done in the same way as setting up a new one and requires an NM Connection object to be first set up. With nm-applet this is done using the Create New Wi-Fi Network… dialog and either selecting and existing Connection or selecting New….

(fixed) WPA2 Enterprise (802.1X) pre-NM-1.14

This section is mainly for network administrators information who are configuring access to a WPA Enterprise network on the users systems, or users who configure their own networks.

IWD requires 802.1X-secured WiFi networks to be set up by using a provisioning file in /var/lib/iwd. However with the NM IWD-backend before 1.14.0 this alone is not enough to allow connecting to such networks. In the 1.12 NM versions each 802.1X network needs to also be configured with an NM Connection profile (i.e. a settings file in /etc/NetworkManager/system-connections). The profile can also be created using the nm-applet GUI or the Gnome Shell GUI, same as with the wpa_supplicant backend.

The NM-side profile for the 802.1X network should match the settings stored in the IWD provisioning file for given network, as closely as possible, but using the standard NM settings sytntax (nm-settings(5), nm-settings-keyfile(5)) – this will allow the NM clients to ask users for the right secrets during a connection attempt, if any secrets are required. If no connection-time secrets are needed, e.g. because they're provided in the provisioning file already, then the NM profile can have any settings in it – the profile will not be used by IWD, it only tells NM that given network is known and connectable.

Distribution info

networkmanager.1621731126.txt.gz · Last modified: 2021/05/23 00:52 by Andrew Zaborowski