Linux Ethernet Bridging - Aug 2021 - [Bridge] [PATCH net] net: bridge: validate the NUD_PERMANENT bit when adding an extern_learn FDB entry

On 02/08/2021 02:17, Vladimir Oltean wrote:
> Currently it is possible to add broken extern_learn FDB entries to the
> bridge in two ways:
> 
> 1. Entries pointing towards the bridge device that are not local/permanent:
> 
> ip link add br0 type bridge
> bridge fdb add 00:01:02:03:04:05 dev br0 self extern_learn static
> 
> 2. Entries pointing towards the bridge device or towards a port that
> are marked as local/permanent, however the bridge does not process the
> 'permanent' bit in any way, therefore they are recorded as though
they
> aren't permanent:
> 
> ip link add br0 type bridge
> bridge fdb add 00:01:02:03:04:05 dev br0 self extern_learn permanent
> 
> Since commit 52e4bec15546 ("net: bridge: switchdev: treat local FDBs
the
> same as entries towards the bridge"), these incorrect FDB entries can
> even trigger NULL pointer dereferences inside the kernel.
> 
> This is because that commit made the assumption that all FDB entries
> that are not local/permanent have a valid destination port. For context,
> local / permanent FDB entries either have fdb->dst == NULL, and these
> point towards the bridge device and are therefore local and not to be
> used for forwarding, or have fdb->dst == a net_bridge_port structure
> (but are to be treated in the same way, i.e. not for forwarding).
> 
> That assumption _is_ correct as long as things are working correctly in
> the bridge driver, i.e. we cannot logically have fdb->dst == NULL under
> any circumstance for FDB entries that are not local. However, the
> extern_learn code path where FDB entries are managed by a user space
> controller show that it is possible for the bridge kernel driver to
> misinterpret the NUD flags of an entry transmitted by user space, and
> end up having fdb->dst == NULL while not being a local entry. This is
> invalid and should be rejected.
> 
> Before, the two commands listed above both crashed the kernel in this
> check from br_switchdev_fdb_notify:
> 
Not before 52e4bec15546 though, the check used to be:
struct net_device *dev = dst ? dst->dev : br->dev;

which wouldn't crash. So the fixes tag below is incorrect, you could
add a weird extern learn entry, but it wouldn't crash the kernel.
> 	struct net_device *dev = info.is_local ? br->dev : dst->dev;
> 
> info.is_local == false, dst == NULL.
> 
> After this patch, the invalid entry added by the first command is
> rejected:
> 
> ip link add br0 type bridge && bridge fdb add 00:01:02:03:04:05 dev
br0 self extern_learn static; ip link del br0
> Error: bridge: FDB entry towards bridge must be permanent.
> 
> and the valid entry added by the second command is properly treated as a
> local address and does not crash br_switchdev_fdb_notify anymore:
> 
> ip link add br0 type bridge && bridge fdb add 00:01:02:03:04:05 dev
br0 self extern_learn permanent; ip link del br0
> 
> Fixes: eb100e0e24a2 ("net: bridge: allow to add externally learned
entries from user-space")
Please change fixes tag to 52e4bec15546.
> Reported-by: syzbot+9ba1174359adba5a5b7c at syzkaller.appspotmail.com
> Signed-off-by: Vladimir Oltean <vladimir.oltean at nxp.com>
> ---
[snip]

Thanks,
 Nik

On Mon, Aug 02, 2021 at 10:42:41AM +0300, Nikolay Aleksandrov
wrote:
> On 02/08/2021 02:17, Vladimir Oltean wrote:
> > Currently it is possible to add broken extern_learn FDB entries to the
> > bridge in two ways:
> >
> > 1. Entries pointing towards the bridge device that are not
local/permanent:
> >
> > ip link add br0 type bridge
> > bridge fdb add 00:01:02:03:04:05 dev br0 self extern_learn static
> >
> > 2. Entries pointing towards the bridge device or towards a port that
> > are marked as local/permanent, however the bridge does not process the
> > 'permanent' bit in any way, therefore they are recorded as
though they
> > aren't permanent:
> >
> > ip link add br0 type bridge
> > bridge fdb add 00:01:02:03:04:05 dev br0 self extern_learn permanent
> >
> > Since commit 52e4bec15546 ("net: bridge: switchdev: treat local
FDBs the
> > same as entries towards the bridge"), these incorrect FDB entries
can
> > even trigger NULL pointer dereferences inside the kernel.
> >
> > This is because that commit made the assumption that all FDB entries
> > that are not local/permanent have a valid destination port. For
context,
> > local / permanent FDB entries either have fdb->dst == NULL, and
these
> > point towards the bridge device and are therefore local and not to be
> > used for forwarding, or have fdb->dst == a net_bridge_port
structure
> > (but are to be treated in the same way, i.e. not for forwarding).
> >
> > That assumption _is_ correct as long as things are working correctly
in
> > the bridge driver, i.e. we cannot logically have fdb->dst == NULL
under
> > any circumstance for FDB entries that are not local. However, the
> > extern_learn code path where FDB entries are managed by a user space
> > controller show that it is possible for the bridge kernel driver to
> > misinterpret the NUD flags of an entry transmitted by user space, and
> > end up having fdb->dst == NULL while not being a local entry. This
is
> > invalid and should be rejected.
> >
> > Before, the two commands listed above both crashed the kernel in this
> > check from br_switchdev_fdb_notify:
> >
>
> Not before 52e4bec15546 though, the check used to be:
> struct net_device *dev = dst ? dst->dev : br->dev;
"Before", as in "before this patch, on net-next/linux-next".
> which wouldn't crash. So the fixes tag below is incorrect, you could
> add a weird extern learn entry, but it wouldn't crash the kernel.
:)

Is our only criterion whether a patch is buggy or not that it causes a
NULL pointer dereference inside the kernel?

I thought I'd mention the interaction with the net-next work for the
sake of being thorough, and because this is how the syzcaller caught it
by coincidence, but "kernel does not treat an FDB entry with the
'permanent' flag as permanent" is enough of a reason to submit this
as a
bug fix for the commit that I pointed to. Granted, I don't have any use
case with extern_learn, so probably your user space programs simply
don't add permanent FDB entries, but as this is the kernel UAPI, it
should nevertheless do whatever the user space is allowed to say. For a
permanent FDB entry, that behavior is to stop forwarding for that MAC
DA, and that behavior obviously was not taking place even before any
change in br_switchdev_fdb_notify(), or even with CONFIG_NET_SWITCHDEV=n.