Message ID | 20231009-strncpy-drivers-net-ethernet-intel-e100-c-v1-1-ca0ff96868a3@google.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:a888:0:b0:403:3b70:6f57 with SMTP id x8csp2180059vqo; Mon, 9 Oct 2023 16:41:29 -0700 (PDT) X-Google-Smtp-Source: AGHT+IFr7AhfgETVMMPIc54qpQlT9vAJZ+EfPVBkVVOHxLH7qJTDR64raZEzrUSYmFO46FHiT78i X-Received: by 2002:a17:902:e5c1:b0:1c6:777:712c with SMTP id u1-20020a170902e5c100b001c60777712cmr16405459plf.51.1696894889610; Mon, 09 Oct 2023 16:41:29 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1696894889; cv=none; d=google.com; s=arc-20160816; b=k0033k+V6XkfOuUE+wnZqLr0qZRRbfJSe658mOfhb1v6hPRKDTBdO9NlDHEW1RgvY3 iNp1kTWjssUO6UkpmLHHwcqsXKKt7NH8mXruMXFiZoCxTWcaKgbKDO9FcamBvbwWIxne N3wHriMcRhWDXSAJ9a/1QJo1aXjGib3tavnLaiQj6ICeRqkwCDxN/pEdhVd8PliLWRKv z5wQK7jRqw8TFEmfL7mR0lndg9oNliwirn7zpT+Rp/XxgS8xa00a4WktoNg9S7Q8Pimi OtXN7AjR8GwdJTagA90GY4F5PvdwOKTK6i48dFLQ+u8Gf8v/9zgN/OMbks88SkM1wDwZ JG4g== 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=A6Z4evA91RaB6pmH2A/2rhvKNwl4+C0QTWWpQbLxwWQ=; fh=KoEe/vQ6ORhGDo5TgnggqYNqVJjSCkGH3Hik0lgvoJY=; b=zYojLzevRh+tWR3R5MTJ1epzrlQXk3oiNQjaMEY1ADjAti4p+JKxEsYSAsfVwMlZI8 780SO2h+YmKSOJ3C+cTVz0euxcgXD2hXkAcv+is2ScbhJj+ZL13TcpXEGPExYUtSQZgt hP4F0i+1SaHklbOeDFgniHb2Mx57rTTH7FH5yc3pqHJ1S30aHoyTYCjXjzoQvpD7wudZ eG803Wc/3OEji5dqsRNFJCzWl6pdSfdXXFMQC8uPgKtCHI4YbBlPBb5mg19G1L3S1xLs CniO82VTzxd5WQFCZ5CY1cqY5+wo+clVOs4ErG3CFVJyjaghjXiSx5BS0vmo6bUhxT5w Wf5g== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=pPS45aZW; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 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 lipwig.vger.email (lipwig.vger.email. [23.128.96.33]) by mx.google.com with ESMTPS id jc15-20020a17090325cf00b001c73626a1ffsi10177498plb.412.2023.10.09.16.41.29 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Mon, 09 Oct 2023 16:41:29 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 as permitted sender) client-ip=23.128.96.33; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=pPS45aZW; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.33 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 lipwig.vger.email (Postfix) with ESMTP id 7450D802FA28; Mon, 9 Oct 2023 16:41:27 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at lipwig.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1377918AbjJIXlL (ORCPT <rfc822;makky5685@gmail.com> + 18 others); Mon, 9 Oct 2023 19:41:11 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:50768 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234610AbjJIXlI (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Mon, 9 Oct 2023 19:41:08 -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 7CA7EA6 for <linux-kernel@vger.kernel.org>; Mon, 9 Oct 2023 16:41:02 -0700 (PDT) Received: by mail-yw1-x114a.google.com with SMTP id 00721157ae682-59e8ebc0376so76143217b3.2 for <linux-kernel@vger.kernel.org>; Mon, 09 Oct 2023 16:41:02 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1696894861; x=1697499661; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=A6Z4evA91RaB6pmH2A/2rhvKNwl4+C0QTWWpQbLxwWQ=; b=pPS45aZWuCpT+9Vxvmefh1MC6ASGGp2VC21qWmQj9/NFN9nNymBl308rBS+uUQFQjz 7yuC/YuBQ6zKGtKi0ShV3ZrL29M9gJqvSLT/FsFcQa9lotH0oS8io+MlGD7lNlP8Rnv5 hZ4dMOUK6H3Sh3S5X01KeFELb5QLg/lg/8k0Z3jr5+HgeBopmsWNIKb2p3R32HdZiMpk 5f4Jw+dvRtizWqoKybrHukV1wOWfEQq0v+N0nwPccy5CdePS8v6YDAQNv1255bk8I+L6 +qYgCGGclp7dBTmRejrn4ZErrqvS4p+3a7/thmaBLwcWgYOBCjnlfo6tDJF5M1SISco7 yLuA== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1696894861; x=1697499661; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=A6Z4evA91RaB6pmH2A/2rhvKNwl4+C0QTWWpQbLxwWQ=; b=slN/Lkv65N4T+7NIfcb1tQrtXEJpf1u9c8LJ5T+T+/bplDD4rq2esve1QzzoMm98aa SxTE312rh+67Ms/Ldh0G0dE9XIf40DDO9sHF2VyNtdLZVNxhzYXQgtm6w9lprDNCaDBp U3xqujGWkKt/bI7WYJjss2RmmI0JjUkKznszv1PPHp5FOvjQ37Tt2vsKXyszG5PzpfXD GCTcK/h8rOYp4RrHtDvAj1kRs3pI8Ll7TWIs997Mh0xUxulhaw3DXI0tA7KtaHlBG3jg uO37ThXmFO8AiPPdHMfM6aToPWSQtLDfN4rM4LxlP0i5LHoc4S0DQ3APJmDY8JRATSh6 tTWg== X-Gm-Message-State: AOJu0Yx2fDIQufoaEt3Q7i9tmH8yQyVv/34/6QGo32/4v3IRzpz/Nx3Q 7KHkp0sj5urJdwowZ5KMQ97e/Tlq/8r46L8LOg== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a05:690c:2c8c:b0:5a7:afd5:1cb1 with SMTP id ep12-20020a05690c2c8c00b005a7afd51cb1mr31543ywb.1.1696894861758; Mon, 09 Oct 2023 16:41:01 -0700 (PDT) Date: Mon, 09 Oct 2023 23:41:01 +0000 Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIAIyPJGUC/x2N0QqDMBAEf0XuuQdJtEj6K6UPJVnrQUnlLohF/ HfTvs3AsLuTQQVGt24nxSomn9LEXzpK87O8wJKbU3Ch985FtqolLV/OKivUuKAy6gz9gZSKN6O FnHi4DqMfY45TSNT2FsUk2//r/jiOExbB7zl7AAAA X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1696894860; l=2207; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=XvVTVgj9L3pc35eYMTZ+RVyQ6ZuyIqHrJFw3fZ6pxVo=; b=fGuGaHWljs9MXvOhbcaaNDiRGNceZqYhpBDPSUvVWleANuYMUnmCNkLdx8nZcCsE77WqOQfIg p/9Sahdrv55DWIKFkxJFDo8Y7ZNIJJkS44FJROIsdggDIJ5wbfN7Rmv X-Mailer: b4 0.12.3 Message-ID: <20231009-strncpy-drivers-net-ethernet-intel-e100-c-v1-1-ca0ff96868a3@google.com> Subject: [PATCH] e100: replace deprecated strncpy with strscpy From: Justin Stitt <justinstitt@google.com> To: Jesse Brandeburg <jesse.brandeburg@intel.com>, Tony Nguyen <anthony.l.nguyen@intel.com>, "David S. Miller" <davem@davemloft.net>, Eric Dumazet <edumazet@google.com>, Jakub Kicinski <kuba@kernel.org>, Paolo Abeni <pabeni@redhat.com> Cc: intel-wired-lan@lists.osuosl.org, netdev@vger.kernel.org, linux-kernel@vger.kernel.org, linux-hardening@vger.kernel.org, Justin Stitt <justinstitt@google.com> Content-Type: text/plain; charset="utf-8" X-Spam-Status: No, score=-4.8 required=5.0 tests=DKIMWL_WL_MED,DKIM_SIGNED, DKIM_VALID,DKIM_VALID_AU,HEADER_FROM_DIFFERENT_DOMAINS, MAILING_LIST_MULTI,RCVD_IN_SBL_CSS,SPF_HELO_NONE,SPF_PASS, USER_IN_DEF_DKIM_WL autolearn=no autolearn_force=no version=3.4.6 X-Spam-Checker-Version: SpamAssassin 3.4.6 (2021-04-09) on lipwig.vger.email Precedence: bulk List-ID: <linux-kernel.vger.kernel.org> X-Mailing-List: linux-kernel@vger.kernel.org X-Greylist: Sender passed SPF test, not delayed by milter-greylist-4.6.4 (lipwig.vger.email [0.0.0.0]); Mon, 09 Oct 2023 16:41:27 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1779323256061300396 X-GMAIL-MSGID: 1779323256061300396 |
Series |
e100: replace deprecated strncpy with strscpy
|
|
Commit Message
Justin Stitt
Oct. 9, 2023, 11:41 p.m. UTC
`strncpy` is deprecated for use on NUL-terminated destination strings
[1] and as such we should prefer more robust and less ambiguous string
interfaces.
The "...-1" pattern makes it evident that netdev->name is expected to be
NUL-terminated.
Meanwhile, it seems NUL-padding is not required due to alloc_etherdev
zero-allocating the buffer.
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.
This is in line with other uses of strscpy on netdev->name:
$ rg "strscpy\(netdev\->name.*pci.*"
drivers/net/ethernet/intel/e1000e/netdev.c
7455: strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name));
drivers/net/ethernet/intel/ixgbe/ixgbe_main.c
10839: strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name));
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 <justinstitt@google.com>
---
Note: build-tested only.
---
drivers/net/ethernet/intel/e100.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
---
base-commit: cbf3a2cb156a2c911d8f38d8247814b4c07f49a2
change-id: 20231009-strncpy-drivers-net-ethernet-intel-e100-c-4547179d9f2c
Best regards,
--
Justin Stitt <justinstitt@google.com>
Comments
On Mon, Oct 09, 2023 at 11:41:01PM +0000, Justin Stitt wrote: > `strncpy` is deprecated for use on NUL-terminated destination strings > [1] and as such we should prefer more robust and less ambiguous string > interfaces. > > The "...-1" pattern makes it evident that netdev->name is expected to be > NUL-terminated. > > Meanwhile, it seems NUL-padding is not required due to alloc_etherdev > zero-allocating the buffer. > > 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. > > This is in line with other uses of strscpy on netdev->name: > $ rg "strscpy\(netdev\->name.*pci.*" > > drivers/net/ethernet/intel/e1000e/netdev.c > 7455: strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name)); > > drivers/net/ethernet/intel/ixgbe/ixgbe_main.c > 10839: strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name)); > > 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 <justinstitt@google.com> > --- > Note: build-tested only. > --- > drivers/net/ethernet/intel/e100.c | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/net/ethernet/intel/e100.c b/drivers/net/ethernet/intel/e100.c > index d3fdc290937f..01f0f12035ca 100644 > --- a/drivers/net/ethernet/intel/e100.c > +++ b/drivers/net/ethernet/intel/e100.c > @@ -2841,7 +2841,7 @@ static int e100_probe(struct pci_dev *pdev, const struct pci_device_id *ent) > netdev->netdev_ops = &e100_netdev_ops; > netdev->ethtool_ops = &e100_ethtool_ops; > netdev->watchdog_timeo = E100_WATCHDOG_PERIOD; > - strncpy(netdev->name, pci_name(pdev), sizeof(netdev->name) - 1); > + strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name)); > > nic = netdev_priv(netdev); > netif_napi_add_weight(netdev, &nic->napi, e100_poll, E100_NAPI_WEIGHT); > > --- > base-commit: cbf3a2cb156a2c911d8f38d8247814b4c07f49a2 > change-id: 20231009-strncpy-drivers-net-ethernet-intel-e100-c-4547179d9f2c > > Best regards, > -- > Justin Stitt <justinstitt@google.com> > Hi, this patch was bundled up with some others. It has a new home: https://lore.kernel.org/all/20231010-netdev-replace-strncpy-resend-as-series-v1-0-caf9f0f2f021@google.com/
diff --git a/drivers/net/ethernet/intel/e100.c b/drivers/net/ethernet/intel/e100.c index d3fdc290937f..01f0f12035ca 100644 --- a/drivers/net/ethernet/intel/e100.c +++ b/drivers/net/ethernet/intel/e100.c @@ -2841,7 +2841,7 @@ static int e100_probe(struct pci_dev *pdev, const struct pci_device_id *ent) netdev->netdev_ops = &e100_netdev_ops; netdev->ethtool_ops = &e100_ethtool_ops; netdev->watchdog_timeo = E100_WATCHDOG_PERIOD; - strncpy(netdev->name, pci_name(pdev), sizeof(netdev->name) - 1); + strscpy(netdev->name, pci_name(pdev), sizeof(netdev->name)); nic = netdev_priv(netdev); netif_napi_add_weight(netdev, &nic->napi, e100_poll, E100_NAPI_WEIGHT);