[Bug 2039825] Re: Keyfile parser will not generate the correct configuration for unsupported EAP methods

Mon Nov 20 13:43:59 UTC 2023

This bug was fixed in the package netplan.io - 0.107-5ubuntu0.1

---------------
netplan.io (0.107-5ubuntu0.1) mantic; urgency=medium

  * d/p/lp2039821/0008-wireguard-ignore-empty-endpoints.patch (LP: #2039821)
    Network Manager GUIs might emit a Wireguard endpoint as an empty string
    when it's omitted. Netplan is rejecting the generated YAML. With this
    patch Netplan will just ignore empty endpoints.
  * d/p/lp2039825/0009-auth-add-support-for-LEAP-and-EAP-PWD.patch
    Netplan's keyfile parser will generate incorrect configuration when
    unsupported EAP method are used. It ends up generating invalid Network
    Manager configuration. This patch implements support for LEAP and PWD
    methods. (LP: #2039825)

 -- Danilo Egea Gondolfo <danilo.egea.gondolfo at canonical.com>  Thu, 19
Oct 2023 15:14:56 +0100

** Changed in: netplan.io (Ubuntu Mantic)
       Status: Fix Committed => Fix Released

-- 
You received this bug notification because you are a member of Ubuntu
Foundations Bugs, which is subscribed to netplan.io in Ubuntu.
Matching subscriptions: foundations-bugs
https://bugs.launchpad.net/bugs/2039825

Title:
  Keyfile parser will not generate the correct configuration for
  unsupported EAP methods

Status in netplan.io package in Ubuntu:
  Fix Released
Status in netplan.io source package in Mantic:
  Fix Released

Bug description:
  [ Impact ]

  When a Network Manager connection that uses EAP for authentication is created, libnetplan's keyfile parser
  (the code that loads Network Manager's keyfile into Netplan state), will end up generating a broken
  configuration when the EAP method is not supported. Unsupported EAP methods will be handled as if EAP were not
  used by the connection. When libnetplan emits the final keyfile, the [802-1x] section (where the EAP configuration
  is supposed to be added) will be missing and Network Manager will error out.

  This SRU includes a patch that implements support for two additional EAP methods so
  the connection will be properly generated when they are used.

  This SRU is important for Ubuntu Mantic due to the new integration between Network Manager and libnetplan.
  Users that hit the conditions aforementioned are experiencing crashes in the Network Manager daemon.

  [ Test Plan ]

  How to reproduce the issues.

  1) Launch a Mantic desktop instance on LXD (or any Mantic desktop
  installation)

  $ lxc launch images:ubuntu/mantic/desktop mantic-desktop --vm -c
  limits.memory=2GiB --console=vga

  2) Open the "Advanced Network Configuration" application

  3) Add a new connection of type "Wifi"

  4) In the Wi-Fi tab, set an SSID and a fake Device

  5) In the Wi-Fi Security tab
    a) Set Security to WPA/WPA3 Enterprise
    b) Set Authentication to LEAP
    c) Set random Identity and Password values and click on Save

  6) You will get an error message and will find the errors below in the
  Network Manager's journal:

  Oct 20 10:52:45 mantic-desktop NetworkManager[2715]: <error> [1697799165.1861] BUG: the profile cannot be stored in keyfile format without becoming unusable: invalid connection: 802-1x: 'wpa-eap' security requires '802-1x' setting presence
  Oct 20 10:52:45 mantic-desktop NetworkManager[2715]: **
  Oct 20 10:52:45 mantic-desktop NetworkManager[2715]: nm:ERROR:src/core/settings/plugins/keyfile/nms-keyfile-writer.c:551:<unknown-fcn>: assertion failed: (<dropped>)
  Oct 20 10:52:45 mantic-desktop NetworkManager[2715]: Bail out! nm:ERROR:src/core/settings/plugins/keyfile/nms-keyfile-writer.c:551:<unknown-fcn>: assertion failed: (<dropped>)
  Oct 20 10:52:45 mantic-desktop systemd[1]: NetworkManager.service: Main process exited, code=dumped, status=6/ABRT
  Oct 20 10:52:45 mantic-desktop systemd[1]: NetworkManager.service: Failed with result 'core-dump'.

  Testing the fixes

  1) Add the PPA repository with the updated package and upgrade netplan

  $ sudo add-apt-repository ppa:danilogondolfo/netplan-sru
  $ sudo apt update && sudo apt upgrade -y

  3) Restart Network Manager

  $ sudo systemctl restart NetworkManager

  4) Run the test described above again and check they will not cause
  any crashes

  [ Where problems could occur ]

  As we are only adding two new EAP methods to the methods list we are not expecting any regressions caused
  by these changes. There are no intended changes in behavior introduced by these changes.

  All the autopkgtests from netplan.io and network-manager are still
  passing with this patch.

  [ Other Info ]

  There are still some (less common we believe) situations that can lead to crashes. They involve the use
  of both PSK and EAP identity keys simultaneously. This is a small design issue in Netplan where it was
  assumed that both keys wouldn't be used at the same time. The attempts to address this issue for this SRU
  resulted in small changes in behavior so we decided to not include it. We are planning to add this fix as part
  of netplan.io 0.107.1 early when the new ubuntu-devel is available. More details about this issue can
  be found here https://github.com/canonical/netplan/pull/416

  --- Original description ---

  This is causing problems with Netplan everywhere as it ends up
  generating invalid Network Manager configuration (that will not be
  accepted by it) and lead to a failure.

  This problem is partially addresses by this patch
  https://github.com/canonical/netplan/pull/415

  A more complete solution is being worked here
  https://github.com/canonical/netplan/pull/416. As it might cause
  changes in behavior and/or libnetplan ABI breakages, we are working on
  it separately.

  This problem is related to this LP bug
  https://bugs.launchpad.net/ubuntu/+source/network-manager/+bug/2038811

To manage notifications about this bug go to:
https://bugs.launchpad.net/ubuntu/+source/netplan.io/+bug/2039825/+subscriptions