wifi: brcm80211: replace deprecated strncpy with strscpy
authorJustin Stitt <justinstitt@google.com>
Tue, 17 Oct 2023 20:11:28 +0000 (20:11 +0000)
committerKalle Valo <kvalo@kernel.org>
Mon, 30 Oct 2023 17:19:38 +0000 (19:19 +0200)
Let's move away from using strncpy and instead favor a less ambiguous
and more robust interface.

For ifp->ndev->name, we expect ifp->ndev->name to be NUL-terminated based
on its use in format strings within core.c:
67 |       char *brcmf_ifname(struct brcmf_if *ifp)
68 |       {
69 |            if (!ifp)
70 |                    return "<if_null>";
71 |
72 |            if (ifp->ndev)
73 |                    return ifp->ndev->name;
74 |
75 |            return "<if_none>";
76 |       }
...
288 |       static netdev_tx_t brcmf_netdev_start_xmit(struct sk_buff *skb,
289 |                                              struct net_device *ndev) {
...
330 |       brcmf_dbg(INFO, "%s: insufficient headroom (%d)\n",
331 |                 brcmf_ifname(ifp), head_delta);
...
336 |       bphy_err(drvr, "%s: failed to expand headroom\n",
337 |                brcmf_ifname(ifp));

For di->name, we expect di->name to be NUL-terminated based on its usage
with format strings:
|       brcms_dbg_dma(di->core,
|                     "%s: DMA64 tx doesn't have AE set\n",
|                     di->name);

Looking at its allocation we can see that it is already zero-allocated
which means NUL-padding is not required:
|       di = kzalloc(sizeof(struct dma_info), GFP_ATOMIC);

For wlc->modulecb[i].name, we expect each name in wlc->modulecb to be
NUL-terminated based on their usage with strcmp():
|       if (!strcmp(wlc->modulecb[i].name, name) &&

NUL-padding is not required as wlc is zero-allocated in:
brcms_c_attach_malloc() ->
|       wlc = kzalloc(sizeof(struct brcms_c_info), GFP_ATOMIC);

For all these cases, a suitable replacement is `strscpy` due to the fact
that it guarantees NUL-termination on the destination buffer without
unnecessarily NUL-padding.

Signed-off-by: Justin Stitt <justinstitt@google.com>
Reviewed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Kalle Valo <kvalo@kernel.org>
Link: https://lore.kernel.org/r/20231017-strncpy-drivers-net-wireless-broadcom-brcm80211-brcmfmac-cfg80211-c-v3-1-af780d74ae38@google.com
drivers/net/wireless/broadcom/brcm80211/brcmfmac/cfg80211.c
drivers/net/wireless/broadcom/brcm80211/brcmfmac/p2p.c
drivers/net/wireless/broadcom/brcm80211/brcmsmac/dma.c
drivers/net/wireless/broadcom/brcm80211/brcmsmac/main.c

index 6674623..133c5ea 100644 (file)
@@ -866,7 +866,7 @@ struct wireless_dev *brcmf_apsta_add_vif(struct wiphy *wiphy, const char *name,
                goto fail;
        }
 
-       strncpy(ifp->ndev->name, name, sizeof(ifp->ndev->name) - 1);
+       strscpy(ifp->ndev->name, name, sizeof(ifp->ndev->name));
        err = brcmf_net_attach(ifp, true);
        if (err) {
                bphy_err(drvr, "Registering netdevice failed\n");
index d4492d0..6e0c90f 100644 (file)
@@ -2334,7 +2334,7 @@ struct wireless_dev *brcmf_p2p_add_vif(struct wiphy *wiphy, const char *name,
                goto fail;
        }
 
-       strncpy(ifp->ndev->name, name, sizeof(ifp->ndev->name) - 1);
+       strscpy(ifp->ndev->name, name, sizeof(ifp->ndev->name));
        ifp->ndev->name_assign_type = name_assign_type;
        err = brcmf_net_attach(ifp, true);
        if (err) {
index b7df576..3d5c1ef 100644 (file)
@@ -584,8 +584,7 @@ struct dma_pub *dma_attach(char *name, struct brcms_c_info *wlc,
                      rxextheadroom, nrxpost, rxoffset, txregbase, rxregbase);
 
        /* make a private copy of our callers name */
-       strncpy(di->name, name, MAXNAMEL);
-       di->name[MAXNAMEL - 1] = '\0';
+       strscpy(di->name, name, sizeof(di->name));
 
        di->dmadev = core->dma_dev;
 
index b3663c5..34460b5 100644 (file)
@@ -5551,8 +5551,8 @@ int brcms_c_module_register(struct brcms_pub *pub,
        /* find an empty entry and just add, no duplication check! */
        for (i = 0; i < BRCMS_MAXMODULES; i++) {
                if (wlc->modulecb[i].name[0] == '\0') {
-                       strncpy(wlc->modulecb[i].name, name,
-                               sizeof(wlc->modulecb[i].name) - 1);
+                       strscpy(wlc->modulecb[i].name, name,
+                               sizeof(wlc->modulecb[i].name));
                        wlc->modulecb[i].hdl = hdl;
                        wlc->modulecb[i].down_fn = d_fn;
                        return 0;