Message ID | 20231020-strncpy-drivers-power-supply-bq2515x_charger-c-v1-1-46664c6edf78@google.com |
---|---|
State | New |
Headers |
Return-Path: <linux-kernel-owner@vger.kernel.org> Delivered-To: ouuuleilei@gmail.com Received: by 2002:a05:612c:2010:b0:403:3b70:6f57 with SMTP id fe16csp1263574vqb; Fri, 20 Oct 2023 12:00:33 -0700 (PDT) X-Google-Smtp-Source: AGHT+IG8Sj4YiWzoOtzVoGIewFi3JQcPy7KfR5sf0x7Fs3bKHfxJQ171HmwdSen2HoHg3fYtSuu5 X-Received: by 2002:a05:6a00:2d8a:b0:6b3:6bc6:68d1 with SMTP id fb10-20020a056a002d8a00b006b36bc668d1mr2604069pfb.11.1697828432929; Fri, 20 Oct 2023 12:00:32 -0700 (PDT) ARC-Seal: i=1; a=rsa-sha256; t=1697828432; cv=none; d=google.com; s=arc-20160816; b=vfXDBqQI5u+eoaZLUV3+qWIIqpuO8zTtvpoQVKnG/yGNP6Vfevilojs6vlHyfSltv3 OI+FRrpGhbs8MqyOOtne00gB2apElKppQ5wqHLsNs/ha7J4Xw+dJ9N0C9S9pteE3dm55 PxffZk8AsG1TmQhWBeahsUGvTCNwGwraQpMtQpcJbQ6hi7q0DigVrFqItV9QNHgGzZRL Yx5EEIe6B/srgfGp1HS00Hg1GmWbW2zqaK1PZovyaUsfow/GCuZ69RJAkNyvu+qN8Gox l+iD5yyXspKdoaz9C5Nd9NX9NxkuRb9EOTHnmPwmKoNsbWcupa7Ulfxq4+w3VeH7zNux 7ygA== 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=aC7KxLBec/eSA4myIMpLcsC0tK2N6BssGDn4X++BO/4=; fh=KeV11nzvo88hufxlmjsqCfOWznUjQ01GrvsGuBkCEic=; b=0GvWJYIklTlITAGDZrH6AuDvqdIR0YNy432M1+aaANq/+ZVE5XsBWangACqhio/9Db Wf71Ri+8+DqHH80psMwHcPcXw8H7bFSr1LFUxMGJ1nh6slknoej3cdo1bn8hTkcaQ/N1 s6MY7WzBgG7Po75xI98Ju2VtgSF7LvHDGlbKSVXDrMeHnGvgPmbbfGMmSGAaGo4ZNAZX ZDU9CAD7QPuVBzcYYU3DE5kYAEs3HObTRARVlEP6KBIbdd1/6zzjabjA9BOQtraOpi8o jS7+NB9lrZgDFIQZTbye8AhlC/JusxZiX3obw6cLxCN4tdN2QdKKyrjL07wAFGDFcv3C ZXRw== ARC-Authentication-Results: i=1; mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=lR0PKqHJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 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 agentk.vger.email (agentk.vger.email. [23.128.96.32]) by mx.google.com with ESMTPS id g22-20020a056a001a1600b006bd9c159a98si2600437pfv.186.2023.10.20.12.00.32 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256); Fri, 20 Oct 2023 12:00:32 -0700 (PDT) Received-SPF: pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 as permitted sender) client-ip=23.128.96.32; Authentication-Results: mx.google.com; dkim=pass header.i=@google.com header.s=20230601 header.b=lR0PKqHJ; spf=pass (google.com: domain of linux-kernel-owner@vger.kernel.org designates 23.128.96.32 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 agentk.vger.email (Postfix) with ESMTP id 52FB48198C76; Fri, 20 Oct 2023 12:00:16 -0700 (PDT) X-Virus-Status: Clean X-Virus-Scanned: clamav-milter 0.103.10 at agentk.vger.email Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S229886AbjJTS7n (ORCPT <rfc822;a1648639935@gmail.com> + 26 others); Fri, 20 Oct 2023 14:59:43 -0400 Received: from lindbergh.monkeyblade.net ([23.128.96.19]:37746 "EHLO lindbergh.monkeyblade.net" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S229881AbjJTS7l (ORCPT <rfc822;linux-kernel@vger.kernel.org>); Fri, 20 Oct 2023 14:59:41 -0400 Received: from mail-yb1-xb49.google.com (mail-yb1-xb49.google.com [IPv6:2607:f8b0:4864:20::b49]) by lindbergh.monkeyblade.net (Postfix) with ESMTPS id 28633D6A for <linux-kernel@vger.kernel.org>; Fri, 20 Oct 2023 11:59:39 -0700 (PDT) Received: by mail-yb1-xb49.google.com with SMTP id 3f1490d57ef6-d9a538026d1so1467183276.0 for <linux-kernel@vger.kernel.org>; Fri, 20 Oct 2023 11:59:39 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com; s=20230601; t=1697828378; x=1698433178; darn=vger.kernel.org; h=cc:to:from:subject:message-id:mime-version:date:from:to:cc:subject :date:message-id:reply-to; bh=aC7KxLBec/eSA4myIMpLcsC0tK2N6BssGDn4X++BO/4=; b=lR0PKqHJ0uJgeTJrrffRrc6cYcn29O+LJl0AFNCO7ByvoJqcCeJ1PP3ZEJAAMzULe1 NBnk9QEOzoKJa9iN85Ixim6MmHQ5lzY8dmiK1V1GMiR8/OM7wRyiCbW6rQmWiphYz8lh x/bo3x/oVc3LlzMzId4F1hY6vR/sLsTNyYlYuFVDjvqDRZ7jexIetJYmyKjKIB8523JM XT1QilTSnCFHbivl92ujcjn8ev3ln2QDWHXpjHAoHxKLhjLbAKeYXtI+743+cAd97HNk mYsK8XUbS/zc4eo6xcnYpSGNokVzavTUNeiDBIAybBioY4BdIiknOukCMu1qchu5LkvC EJ1A== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20230601; t=1697828378; x=1698433178; h=cc:to:from:subject:message-id:mime-version:date:x-gm-message-state :from:to:cc:subject:date:message-id:reply-to; bh=aC7KxLBec/eSA4myIMpLcsC0tK2N6BssGDn4X++BO/4=; b=GjhQiaOA+JEsgRjHLwmch3D5i7KEm9KXYqBrUP0av94DncSoaiJBSYFy8uKLSRakYn XS9egTr9XXDbdCe+9MkxFt+Yu73hAdgHDINb8cjPkOEFkVFw5X1jasZ/wsljltXzhkir /NRsQ7oVtIKXJiNYuX+Z9k5KP2HwGvNhjogA4Aw3Px1I8fJtcBR4e5GGHgPuI4TTqRHc pt1NT5F4iSNJSr0CytzpcAQy/9DYt4brgQ1aSSvN7MlacA1yEvQ+t3lwle0puHjr3dMr xkTPDRoW0EdiFO2NXOZLezaK/49W0WYfCBA22Te2lXPwy8/Nobi4eRVJtF/BBCmpx1Ce cmZg== X-Gm-Message-State: AOJu0YxL5F1weYm5Hvc66WdFLZ3SNfDWyt3MqhEZuOWl8FbOJIcmdRdb N0npEBcI+tkeuPmuqamnqO1DnplcwMF/aOv8AQ== X-Received: from jstitt-linux1.c.googlers.com ([fda3:e722:ac3:cc00:2b:ff92:c0a8:23b5]) (user=justinstitt job=sendgmr) by 2002:a25:d7d8:0:b0:d9a:da03:97e8 with SMTP id o207-20020a25d7d8000000b00d9ada0397e8mr53942ybg.2.1697828378406; Fri, 20 Oct 2023 11:59:38 -0700 (PDT) Date: Fri, 20 Oct 2023 18:59:34 +0000 Mime-Version: 1.0 X-B4-Tracking: v=1; b=H4sIABXOMmUC/x2N0QrCMAxFf2Xk2UDTbiD+ioi4Lp0B6Wqic2Ps3 1d8PBfOPRsYq7DBpdlAeRaTKVegUwPx+cgjowyVwTsfyHmH9tEcy4qDysxqWKYfK9q3lNeK/dt 31C33qupY54ixT3QmCqFNHuppUU6y/IPX274foYe/1oAAAAA= X-Developer-Key: i=justinstitt@google.com; a=ed25519; pk=tC3hNkJQTpNX/gLKxTNQKDmiQl6QjBNCGKJINqAdJsE= X-Developer-Signature: v=1; a=ed25519-sha256; t=1697828377; l=2719; i=justinstitt@google.com; s=20230717; h=from:subject:message-id; bh=T+2bP/VZordKJivg0WULS6xpMGyCh5PEFbjppJMYDyw=; b=wfeBrFDrlPg11uAXCMlr1FrdbFjab3mH++hd8n+V8J6m4i2+5fSu+wTfIKW7ADNr0aV6HkBe9 dAIOowSQjgXD6wkWvunWsFVJIEBXYJV97Ryx0HNqH5J9WFFJxzHyBii X-Mailer: b4 0.12.3 Message-ID: <20231020-strncpy-drivers-power-supply-bq2515x_charger-c-v1-1-46664c6edf78@google.com> Subject: [PATCH] power: supply: bq2515x: replace deprecated strncpy with strscpy From: Justin Stitt <justinstitt@google.com> To: Sebastian Reichel <sre@kernel.org> Cc: linux-pm@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 agentk.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 (agentk.vger.email [0.0.0.0]); Fri, 20 Oct 2023 12:00:16 -0700 (PDT) X-getmail-retrieved-from-mailbox: INBOX X-GMAIL-THRID: 1780302146899389435 X-GMAIL-MSGID: 1780302146899389435 |
Series |
power: supply: bq2515x: replace deprecated strncpy with strscpy
|
|
Commit Message
Justin Stitt
Oct. 20, 2023, 6:59 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 bq2515x->model_name to be NUL-terminated based on its usage with
sysfs_emit and format strings:
val->strval is assigned to bq2515x->model_name in
bq2515x_mains_get_property():
| val->strval = bq2515x->model_name;
... then in power_supply_sysfs.c we use value.strval with a format string:
| ret = sysfs_emit(buf, "%s\n", value.strval);
we assigned value.strval via:
| ret = power_supply_get_property(psy, psp, &value);
... which invokes psy->desc->get_property():
| return psy->desc->get_property(psy, psp, val);
with bq2515x_mains_get_property():
| static const struct power_supply_desc bq2515x_mains_desc = {
...
| .get_property = bq2515x_mains_get_property,
Moreover, no NUL-padding is required as bq2515x is zero-allocated in
bq2515x_charger.c:
| bq2515x = devm_kzalloc(dev, sizeof(*bq2515x), GFP_KERNEL);
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.
Let's also opt to use the more idiomatic strscpy() usage of (dest, src,
sizeof(dest)) as this more closely ties the destination buffer and the
length.
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>
Similar-to: https://lore.kernel.org/all/20231020-strncpy-drivers-power-supply-bq24190_charger-c-v1-1-e896223cb795@google.com/
---
Note: build-tested only.
Found with: $ rg "strncpy\("
---
drivers/power/supply/bq2515x_charger.c | 2 +-
1 file changed, 1 insertion(+), 1 deletion(-)
---
base-commit: bb55d7f7f7445abcc8db50e6a65d4315e79f75c7
change-id: 20231020-strncpy-drivers-power-supply-bq2515x_charger-c-cbf1811334f2
Best regards,
--
Justin Stitt <justinstitt@google.com>
Comments
On Fri, Oct 20, 2023 at 06:59:34PM +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. > > We expect bq2515x->model_name to be NUL-terminated based on its usage with > sysfs_emit and format strings: > > val->strval is assigned to bq2515x->model_name in > bq2515x_mains_get_property(): > | val->strval = bq2515x->model_name; > > ... then in power_supply_sysfs.c we use value.strval with a format string: > | ret = sysfs_emit(buf, "%s\n", value.strval); > > we assigned value.strval via: > | ret = power_supply_get_property(psy, psp, &value); > ... which invokes psy->desc->get_property(): > | return psy->desc->get_property(psy, psp, val); > > with bq2515x_mains_get_property(): > | static const struct power_supply_desc bq2515x_mains_desc = { > ... > | .get_property = bq2515x_mains_get_property, > > Moreover, no NUL-padding is required as bq2515x is zero-allocated in > bq2515x_charger.c: > | bq2515x = devm_kzalloc(dev, sizeof(*bq2515x), GFP_KERNEL); > > 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. > > Let's also opt to use the more idiomatic strscpy() usage of (dest, src, > sizeof(dest)) as this more closely ties the destination buffer and the > length. > > 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> This looks like a good replacement, just like the prior I2C change. Reviewed-by: Kees Cook <keescook@chromium.org>
On Fri, 20 Oct 2023 18:59:34 +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. > > We expect bq2515x->model_name to be NUL-terminated based on its usage with > sysfs_emit and format strings: > > [...] Applied, thanks! [1/1] power: supply: bq2515x: replace deprecated strncpy with strscpy commit: e3c2af5d49bb96ad460ef6aa873975fb0f7c7f17 Best regards,
diff --git a/drivers/power/supply/bq2515x_charger.c b/drivers/power/supply/bq2515x_charger.c index 1dbacc9b015d..b4ea1707304a 100644 --- a/drivers/power/supply/bq2515x_charger.c +++ b/drivers/power/supply/bq2515x_charger.c @@ -1092,7 +1092,7 @@ static int bq2515x_probe(struct i2c_client *client) bq2515x->dev = dev; - strncpy(bq2515x->model_name, id->name, I2C_NAME_SIZE); + strscpy(bq2515x->model_name, id->name, sizeof(bq2515x->model_name)); bq2515x->device_id = id->driver_data;