From patchwork Thu Oct 12 21:20:04 2023 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: Justin Stitt X-Patchwork-Id: 152190 Return-Path: Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2908:b0:403:3b70:6f57 with SMTP id ib8csp1505064vqb; Thu, 12 Oct 2023 14:20:35 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFr2myfkcESwxbSfAc9ZF+LPvcQ7BcxOp6j2XbwlsK/nuEm4JjxwU6AomMrbwRxTNstsuRW X-Received: by 2002:a05:6a00:1d8f:b0:692:afaf:32b4 with SMTP id z15-20020a056a001d8f00b00692afaf32b4mr27187253pfw.0.1697145635548; Thu, 12 Oct 2023 14:20:35 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1697145635; cv=none; d=google.com; s=arc-20160816; b=UfYSnZelXk7pR3Y8L1Anz9vmtLQ+wWGN+Enrnr1AansSIn1RRWc3nsw9OngCyi0zsh 2eULeQHaErDMMdcUDm15ybrSgVRDBqtHqaZ+lOjj8uK0SKHsQXjIHVCSG6z844HaMKxJ dbZg7letbcdgrDNPHX9rx6a6Zli4Qy+KysqB7MojAg7cfG8xjeEvhcokKg6m5DX2YM7k O9yqZkftgQZlZvD6DAfCyl31ULDFgJQtloY0FpSnKRypiWNRw8vObS8NiSI8rC3PoPlz oprmgofafVoLMs5yjNRicbqH1MuFIyXJT0sMbVgvEh3gNATl0y4QkcANRpCeoQ0eLJhO qYlg== ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=arc-20160816; h=list-id:precedence:cc:to:from:subject:message-id:mime-version:date :dkim-signature; bh=Hnx2hMUROy5hPaWMuQS6wGUcTD4C+Y8X52y6T46QNnk=; fh=sm5k7NdgtYLbWyXUg9vpg41ryPKuX6/0QLBJ7ucehy4=; b=bU0mOTeaA1E0iaw7Am/SLeH2khvu1mAfsF5cKNTA80yskz0RO7Ejs75Wud+m+duy9a 9saoq7gjYoKHdDuD5fJiLoaztfeFOYfXKqg7C6yqMNweZnjbOZ8cPK14YMxUhC5lGbkS aou58jENKJ4LNDYBGNSunTdfjYvxsRmSVwGO4c7aXJZyaL7W5uFEX/eEipLfOt8hL6Ph YUS/01UqgeZdLwdiilH+ORy/0oGwi4Zkj8twCEgeoJjw46S/UmNA9usVXptULXeNem1c AgNifkiQaaXQzudEVLEF9m+U2c0gLaogx5t1ScNRNaoTK6LoTDcbw9i0V1pTXNHBL3oQ vdHw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=XkLaD7X7; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from pete.vger.email (pete.vger.email. [2620:137:e000::3:6]) by mx.google.com with ESMTPS id e5-20020a630f05000000b00565f0e91894si3068964pgl.394.2023.10.12.14.20.35 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Thu, 12 Oct 2023 14:20:35 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=XkLaD7X7; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) smtp.mailfrom=linux-kernel-owner@vger.kernel.org; dmarc=pass (p=REJECT sp=REJECT dis=NONE) header.from=google.com Received: from out1.vger.email (depot.vger.email [IPv6:2620:137:e000::3:0]) by pete.vger.email (Postfix) with ESMTP id A1AED81DF249; Thu, 12 Oct 2023 14:20:16 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at pete.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1442894AbjJLVUI (ORCPT + 19 others); Thu, 12 Oct 2023 17:20:08 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:33460 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1442853AbjJLVUH (ORCPT ); Thu, 12 Oct 2023 17:20:07 -0400 Received: from mail-yw1-x114a.google.com (mail-yw1-x114a.google.com [IPv6:2607:f8b0:4864:20::114a]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 7B7AB9D for ; Thu, 12 Oct 2023 14:20:05 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-5a813755ef4so8677027b3.2 for ; Thu, 12 Oct 2023 14:20:05 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1697145604; x=1697750404; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=Hnx2hMUROy5hPaWMuQS6wGUcTD4C+Y8X52y6T46QNnk=; b=XkLaD7X7q8fkKutL6vUFBc68A+tAQ9/sIOS21rjfw57sGiz+TOYsD85qQSv+C2xgxb lQDhbPztXnHeZES2/gdkdSUtRMUy8REZ4UJFj9Wo4iRMZ84Dd5/liVwuL3Qa1TqBW3BH jlpV7rdPPrLIYATw07Jk3evdgmyuXvzIHkEGEk1MHCN+1ZQ+EE4jMRSvwSBWHHzOEPAk j1ScvGrYxWsfh5SFjmTTKze7NVdYdnL+tG8UWmick/5GdFthB9vlwYaNSPzlI2hnWGs9 EfgIFe99jOKuRqoGvITo5UTaq3jlPGHSrrVVVCoAM0y2QIbIcL9a34qRo7VFpnpf7FAi zQ5Q== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697145604; x=1697750404; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=Hnx2hMUROy5hPaWMuQS6wGUcTD4C+Y8X52y6T46QNnk=; b=Y2iq/EAFpdVbSFKtrHXzuG/4mm2wmQv5SX/A7oYzzfxm6y5l7Hd96dCT4XFdRb+Vqm y3i5+jPPK1gJ32E2o0yt3sifFdcHtbiA9M9M2iSxkzEHtQnAZA5s3qPRG+VB2HpKhm+H QVrR0J2JWLsz8dRidAGY9Be6ltdZJqWvqAldHkjmTA1d3FTSbezpH/8mFvJtzgVufAHG F2k8A+P1Qv296KpoM4YLX9WunAIJRfAOPLcLFYwpz2uvDk3f8rVxEHWX3Gchpu55dj1t neKo87IZI+zwDIg4cGyEGpaJbVXV/nqyy3sqZkXkwOqdgDT+FxvnOvOzHooLrP+AIhb1 v+/A== X-Gm-Message-State: AOJu0YwSyPESIX4U8hpW9ZxurOtrclSRhb4/eq+mVK59Y7IM9ZBI1J1l kVITBX4JsCfSK/cj/J7BRL56OzKALXuj8jRA4A== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a81:af27:0:b0:5a7:b54e:bfc1 with SMTP id n39-20020a81af27000000b005a7b54ebfc1mr243135ywh.10.1697145604749; Thu, 12 Oct 2023 14:20:04 -0700 (PDT) Date: Thu, 12 Oct 2023 21:20:04 +0000 Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIAANjKGUC/yWNQQ6DMAwEv4J8rqUkFRe+UlVVCAZ8qIvsFFIh/ t60XFY7h9ndwUiZDLpmB6WVjV9SwV8aSHOUiZCHyhBcuHrnA1pWScsHB+WV1FAoI+WZ9Fe2apS 3YC5TT2c+npEFE7rWt6GPY0zBQV1flEYu/+fb/Ti++Q+lF4kAAAA= X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1697145603; l=2721; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=K5JHCGxkEZHPygsVoHqfoDZGkV0pxG6IhwPB2u479/U=; b=bsjP3OcLje0SPvVnGKRcZtcvFRKAeLjmhv0CkhKsA5enluy6XHRLQ3iodA/qzFgN/6BR552D8 h2380adLrRVA7mWJ7s69+bGSfcNmC0XDqvDOKG9KsHHWLGb/SSqaOQU X-Mailer: b4 0.12.3 Message-ID: <20231012-strncpy-drivers-net-ethernet-wangxun-txgbe-txgbe_main-c-v1-1-c9bb3270ac98@google.com> Subject: [PATCH] net: txgbe: replace deprecated strncpy with strscpy From: Justin Stitt To: Jiawen Wu , Mengyuan Lou , "David S. Miller" , Eric Dumazet , Jakub Kicinski , Paolo Abeni Cc: netdev@vger.kernel.org, linux-kernel@vger.kernel.org, linux-hardening@vger.kernel.org, Justin Stitt X-Spam-Status: No, score=-8.4 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,SPF_HELO_NONE,SPF_PASS,USER_IN_DEF_DKIM_WL autolearn=unavailable autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on pete.vger.email Precedence: bulk List-ID: X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (pete.vger.email [0.0.0.0]); Thu, 12 Oct 2023 14:20:16 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779586181911419008 X-GMAIL-MSGID: 1779586181911419008 strncpy() is deprecated for use on NUL-terminated destination strings [1] and as such we should prefer more robust and less ambiguous string interfaces. Based on usage part_str usage within txgbe_read_pba_string(), we expect part_str to be NUL-terminated but not necessarily NUL-padded: | /* put a null character on the end of our string */ | pba_num[10] = '\0'; Interestingly, part_str is not used after txgbe_read_pba_string(): | ... | err = txgbe_read_pba_string(wx, part_str, TXGBE_PBANUM_LENGTH); | if (err) | strscpy(part_str, "Unknown", sizeof(part_str)); | | netif_info(wx, probe, netdev, "%pM\n", netdev->dev_addr); | | return 0; | |err_remove_phy: | txgbe_remove_phy(txgbe); |err_release_hw: | wx_clear_interrupt_scheme(wx); | wx_control_hw(wx, false); |err_free_mac_table: | kfree(wx->mac_table); |err_pci_release_regions: | pci_release_selected_regions(pdev, | pci_select_bars(pdev, IORESOURCE_MEM)); |err_pci_disable_dev: | pci_disable_device(pdev); | return err; |} ... this means this strncpy (or now strscpy) is probably useless. For now, let's make the swap to strscpy() as I am not sure if this is truly dead code or not. Considering the above, a suitable replacement is `strscpy` [2] due to the fact that it guarantees NUL-termination on the destination buffer without unnecessarily NUL-padding. Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [1] Link: https://manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html [2] Link: https://github.com/KSPP/linux/issues/90 Cc: linux-hardening@vger.kernel.org Signed-off-by: Justin Stitt --- Note: build-tested only. Found with: $ rg "strncpy\(" --- drivers/net/ethernet/wangxun/txgbe/txgbe_main.c | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- base-commit: cbf3a2cb156a2c911d8f38d8247814b4c07f49a2 change-id: 20231012-strncpy-drivers-net-ethernet-wangxun-txgbe-txgbe_main-c-05152bafac20 Best regards, -- Justin Stitt diff --git a/drivers/net/ethernet/wangxun/txgbe/txgbe_main.c b/drivers/net/ethernet/wangxun/txgbe/txgbe_main.c index 5c3aed516ac2..c795fbab37be 100644 --- a/drivers/net/ethernet/wangxun/txgbe/txgbe_main.c +++ b/drivers/net/ethernet/wangxun/txgbe/txgbe_main.c @@ -739,7 +739,7 @@ static int txgbe_probe(struct pci_dev *pdev, /* First try to read PBA as a string */ err = txgbe_read_pba_string(wx, part_str, TXGBE_PBANUM_LENGTH); if (err) - strncpy(part_str, "Unknown", TXGBE_PBANUM_LENGTH); + strscpy(part_str, "Unknown", sizeof(part_str)); netif_info(wx, probe, netdev, "%pM\n", netdev->dev_addr);