Message ID | 20231024-strncpy-drivers-scsi-fcoe-fcoe_sysfs-c-v1-1-1e0026ee032d@google.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a59:ce89:0:b0:403:3b70:6f57 with SMTP id p9csp2170694vqx; Tue, 24 Oct 2023 12:52:46 -0700 (PDT) X-Google-Smtp-Source: AGHT+IGSvbbsA0ZKbGuGGd2pHFaWF2mjs8lsjn6aZRoql0pmDEXRI2Ed+IXU9bDdzmII+grJAWYe X-Received: by 2002:a17:902:e548:b0:1c7:2697:ec10 with SMTP id n8-20020a170902e54800b001c72697ec10mr17088332plf.56.1698177166242; Tue, 24 Oct 2023 12:52:46 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1698177166; cv=none; d=google.com; s=arc-20160816; b=WDhnj3aGUDaS2FX527qmWhWjMG4u/PZ9WUzKmpjOh+8e3vJYeB5cD9BsJkh6bT4YjU DECYbHxznySN5DYoh3Zb9K641KFAAbX/5T1vOMJB9Dnt+BJXnIutiLcXmsAfsyB2F/3t tcKLwuJjoznPuNiT9Paibl/5eSnpsR191IRGztgDHEouNUTmUnU6p9mMdn9IEl6huOgJ ugxwO64pnhjs3fLYzgqq6HI+0A6DMBd2FiiVy3VF162Em9HkuDbdekOiMofG4gJvbj9t qa7xC7hHUFzxM7dtt3MNNvvWEBmY58kUNBQjWt6SW9RGU0BPqZQNRl6UGK4m8X85dlF4 ywSw== 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=e8aQgWjy+g6rrzKEDI21tp5NK7yplRQyyhfNiiPxWK0=; fh=xj8nTl55YM40VdqnxfQs4WpvsRY9vFNkcAfpZFL4Mds=; b=wiKMisStXDLlVdP7vTKi1qVkTfY/aw7mcY2SlL1NCjcXFj0Rwj7bT8E9uflO02WgBL zwDZDuU6hxBR/2vlhMUXx5GChYVbm6h7o3YUbZUGYeK9GHy5yVEToTxDzZ3BpWdaFEgS dX66Auhsmjmucs4Z1Sz9eaBzvnUuFA5qDaRsr2UF0HFHIWv/s/CAXfSkXbNxVPjMLMFW qVnlwXw5Qnud8csv/s82IIm7JJEM14pWbXBI9uoRL9klJgJ35mVn5wXrZYEafeEhMKQ2 9XoYQ5vMmFm7Gfj3g9OH7qrmNP/Crh4wxeWaeDdvKS7tVhW7pMfVr9m2m8VN76lJ6HBd IAVw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=mo5et0EQ; 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 g19-20020a170902869300b001c3e13018ffsi8811297plo.51.2023.10.24.12.52.45 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Tue, 24 Oct 2023 12:52:46 -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=mo5et0EQ; 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 1E952802646E; Tue, 24 Oct 2023 12:52:44 -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 S1344312AbjJXTwc (ORCPT <rfc822;aposhian.dev@gmail.com> + 27 others); Tue, 24 Oct 2023 15:52:32 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:59910 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S234918AbjJXTwb (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Tue, 24 Oct 2023 15:52:31 -0400 Received: from mail-oa1-x49.google.com (mail-oa1-x49.google.com [IPv6:2001:4860:4864:20::49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 6741710C9 for <linux-kernel@vger.kernel.org>; Tue, 24 Oct 2023 12:52:29 -0700 (PDT) Received: by mail-oa1-x49.google.com with SMTP id 586e51a60fabf-1c8c1f34aadso6766355fac.3 for <linux-kernel@vger.kernel.org>; Tue, 24 Oct 2023 12:52:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1698177148; x=1698781948; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=e8aQgWjy+g6rrzKEDI21tp5NK7yplRQyyhfNiiPxWK0=; b=mo5et0EQNBbjn0YYf02+tHNMi5Qt8QpTnjDmOuLVZYB0UbKp9TfDe3btq2w2wPliL7 EeraHHLcoG/hLzSbFfqh6+y3OTE9FdUbjn6LaKGcLSYK5JR5aYI+DrmWvoOXiPoF1d1a KpnlQggqhHvgEHG1SFukRaZGxughB1L1oCYupjw94amlcVhwA/waaUw/kPL7SpdIeUnF jb1RRcnzItOmxt2sTAiYNcdAdFQV7/HtHJOLgV3Zssx5M4LEryZ3edxorQMK+cr+ab5r +laiovkXixdEMnEv02VlmDnBq1JHhxHrdyrvVOjR1VqN65fPfCpwsQviQQBCzzy2OcsC qWVw== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1698177148; x=1698781948; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=e8aQgWjy+g6rrzKEDI21tp5NK7yplRQyyhfNiiPxWK0=; b=UzTIKZXsLxPYImYkx0A3bs/psUG+cS72gXYbD20Cfp+MtZT26clP4SVvNqwuXdL58N uRYBp1vKNZH0TO0gUlC0ASUKKUASBO/wOnX0UGA7aEojsNzkDfOCAU9Fk4wpGgwK1OOp nV02e+gjuWxMjTz6ZLO9VQyoLDZh6ZwKb66eiUD1MEXL7YxBGn3+jBGD/TdHOAXZJGFI WKQCX67qSpJZSUWk4KTVvXIqbcOhL0cRIMzxFjn+GIPdsSJsRDa1RXZ6+taCqkl1FiMr 406nlvz6KAI/7sofAcWhN4HvZHaF1oS03Ms4KOihhqptcBWpQZM8axl1fAz6uzx6UJcj CZHg== X-Gm-Message-State: AOJu0YxdKrMyldMb/ctSMhX8bz/CwcaVYOf55SGL/T7IS2FJjOd8DtgL jIuctDLH1mlX8Sifqxxvyg8GEoItgyS2YRMpvA== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a05:6870:148d:b0:1d6:5e45:3bc7 with SMTP id k13-20020a056870148d00b001d65e453bc7mr6259319oab.5.1698177148786; Tue, 24 Oct 2023 12:52:28 -0700 (PDT) Date: Tue, 24 Oct 2023 19:52:27 +0000 Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIAHogOGUC/x2NwQqDMBAFf0X23IUkrSD+SilFkt26lyj7ilTEf 2/wMjCXmYMgbgIau4NcNoMttUm8dZTnqX6ErTSnFNI9hvRgfL3mdefitomDkWGseZELb+xQcOY gsajKkIa+pxZbXdR+1+j5Os8/ZQjSqngAAAA= X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1698177147; l=2135; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=x4lXZ/M2v+LVXy5eVUWTnpdEr6YXqOCKy8sodhN2WbQ=; b=kNvSxaD6+DzKoEiD6sLJnAjh94iZPbZ1UevGx+Ev4FErVJiOdmvYoPiz8xLD17iSe3bcC4IOa Hd8masltLb4DdvVMlYaADHPOuC3Dpr7PWEcQ4FlU+zfiGwohD+QaLT2 X-Mailer: b4 0.12.3 Message-ID: <20231024-strncpy-drivers-scsi-fcoe-fcoe_sysfs-c-v1-1-1e0026ee032d@google.com> Subject: [PATCH] scsi: fcoe: replace deprecated strncpy with strscpy From: Justin Stitt <justinstitt@google.com> To: Hannes Reinecke <hare@suse.de>, "James E.J. Bottomley" <jejb@linux.ibm.com>, "Martin K. Petersen" <martin.petersen@oracle.com> Cc: linux-scsi@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=-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 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]); Tue, 24 Oct 2023 12:52:44 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780667819895913682 X-GMAIL-MSGID: 1780667819895913682 |
Series |
scsi: fcoe: replace deprecated strncpy with strscpy
|
|
Commit Message
Justin Stitt
Oct. 24, 2023, 7:52 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.
We expect `mode` to be NUL-terminated based on its usage with
strcasecmp():
| ctlr->mode = fcoe_parse_mode(mode);
...
| static enum fip_conn_type fcoe_parse_mode(const char *buf)
| {
| int i;
|
| for (i = 0; i < ARRAY_SIZE(fip_conn_type_names); i++) {
| if (strcasecmp(buf, fip_conn_type_names[i]) == 0)
| return i;
| }
|
| return FIP_CONN_TYPE_UNKNOWN;
| }
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.
We can drop the manual NUL-byte assignment but should keep the newline
removal so newlines don't creep into the string.
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.
Found with: $ rg "strncpy\("
---
drivers/scsi/fcoe/fcoe_sysfs.c | 4 +---
1 file changed, 1 insertion(+), 3 deletions(-)
---
base-commit: d88520ad73b79e71e3ddf08de335b8520ae41c5c
change-id: 20231024-strncpy-drivers-scsi-fcoe-fcoe_sysfs-c-0e1dffe82855
Best regards,
--
Justin Stitt <justinstitt@google.com>
Comments
On 10/24/23 12:52, Justin Stitt wrote: > diff --git a/drivers/scsi/fcoe/fcoe_sysfs.c b/drivers/scsi/fcoe/fcoe_sysfs.c > index e17957f8085c..7a3ca6cd3030 100644 > --- a/drivers/scsi/fcoe/fcoe_sysfs.c > +++ b/drivers/scsi/fcoe/fcoe_sysfs.c > @@ -279,12 +279,10 @@ static ssize_t store_ctlr_mode(struct device *dev, > if (count > FCOE_MAX_MODENAME_LEN) > return -EINVAL; > > - strncpy(mode, buf, count); > + strscpy(mode, buf, count); > > if (mode[count - 1] == '\n') > mode[count - 1] = '\0'; > - else > - mode[count] = '\0'; > > switch (ctlr->enabled) { > case FCOE_CTLR_ENABLED: Please consider to remove the code for copying the sysfs string and to use sysfs_match_string() instead. Thanks, Bart.
Hi, On Tue, Oct 24, 2023 at 1:01 PM Bart Van Assche <bvanassche@acm.org> wrote: > > On 10/24/23 12:52, Justin Stitt wrote: > > diff --git a/drivers/scsi/fcoe/fcoe_sysfs.c b/drivers/scsi/fcoe/fcoe_sysfs.c > > index e17957f8085c..7a3ca6cd3030 100644 > > --- a/drivers/scsi/fcoe/fcoe_sysfs.c > > +++ b/drivers/scsi/fcoe/fcoe_sysfs.c > > @@ -279,12 +279,10 @@ static ssize_t store_ctlr_mode(struct device *dev, > > if (count > FCOE_MAX_MODENAME_LEN) > > return -EINVAL; > > > > - strncpy(mode, buf, count); > > + strscpy(mode, buf, count); > > > > if (mode[count - 1] == '\n') > > mode[count - 1] = '\0'; > > - else > > - mode[count] = '\0'; > > > > switch (ctlr->enabled) { > > case FCOE_CTLR_ENABLED: > > Please consider to remove the code for copying the sysfs string and to > use sysfs_match_string() instead. > Sorry, I'm not too familiar with sysfs strings here. Let me know what you think of this patch [1]. > Thanks, > > Bart. > [1]: https://lore.kernel.org/r/20231211-strncpy-drivers-scsi-fcoe-fcoe_sysfs-c-v1-1-73b942238396@google.com Thanks Justin
On 12/11/23 12:08, Justin Stitt wrote: > Hi, > > On Tue, Oct 24, 2023 at 1:01 PM Bart Van Assche <bvanassche@acm.org> wrote: >> >> On 10/24/23 12:52, Justin Stitt wrote: >>> diff --git a/drivers/scsi/fcoe/fcoe_sysfs.c b/drivers/scsi/fcoe/fcoe_sysfs.c >>> index e17957f8085c..7a3ca6cd3030 100644 >>> --- a/drivers/scsi/fcoe/fcoe_sysfs.c >>> +++ b/drivers/scsi/fcoe/fcoe_sysfs.c >>> @@ -279,12 +279,10 @@ static ssize_t store_ctlr_mode(struct device *dev, >>> if (count > FCOE_MAX_MODENAME_LEN) >>> return -EINVAL; >>> >>> - strncpy(mode, buf, count); >>> + strscpy(mode, buf, count); >>> >>> if (mode[count - 1] == '\n') >>> mode[count - 1] = '\0'; >>> - else >>> - mode[count] = '\0'; >>> >>> switch (ctlr->enabled) { >>> case FCOE_CTLR_ENABLED: >> >> Please consider to remove the code for copying the sysfs string and to >> use sysfs_match_string() instead. >> > > Sorry, I'm not too familiar with sysfs strings here. > > Let me know what you think of this patch [1]. I don't use FCoE so I will leave it to an FCoE user to review that patch. Thanks, Bart.
diff --git a/drivers/scsi/fcoe/fcoe_sysfs.c b/drivers/scsi/fcoe/fcoe_sysfs.c index e17957f8085c..7a3ca6cd3030 100644 --- a/drivers/scsi/fcoe/fcoe_sysfs.c +++ b/drivers/scsi/fcoe/fcoe_sysfs.c @@ -279,12 +279,10 @@ static ssize_t store_ctlr_mode(struct device *dev, if (count > FCOE_MAX_MODENAME_LEN) return -EINVAL; - strncpy(mode, buf, count); + strscpy(mode, buf, count); if (mode[count - 1] == '\n') mode[count - 1] = '\0'; - else - mode[count] = '\0'; switch (ctlr->enabled) { case FCOE_CTLR_ENABLED: