2023-10-23 20:26:37

by Justin Stitt

[permalink] [raw]
Subject: [PATCH] scsi: csiostor: replace deprecated strncpy with strscpy

strncpy() is deprecated for use on NUL-terminated destination strings
[1] and as such we should prefer more robust and less ambiguous string
interfaces.

`hw` is kzalloc'd just before this string assignment:
| hw = kzalloc(sizeof(struct csio_hw), GFP_KERNEL);

... which means any NUL-padding is redundant.

Since CSIO_DRV_VERSION is a small string literal (smaller than
sizeof(dest)):

... there is functionally no change in this swap from strncpy() to
strscpy(). Nonetheless, let's make the change for robustness' sake -- as
it will ensure that drv_version is _always_ NUL-terminated.

Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [1]
Link: https://github.com/KSPP/linux/issues/90
Cc: [email protected]
Signed-off-by: Justin Stitt <[email protected]>
---
Note: build-tested only.

Found with: $ rg "strncpy\("
---
drivers/scsi/csiostor/csio_init.c | 3 ++-
1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/drivers/scsi/csiostor/csio_init.c b/drivers/scsi/csiostor/csio_init.c
index 0c32faefad7c..d649b7a2a879 100644
--- a/drivers/scsi/csiostor/csio_init.c
+++ b/drivers/scsi/csiostor/csio_init.c
@@ -521,7 +521,8 @@ static struct csio_hw *csio_hw_alloc(struct pci_dev *pdev)
goto err;

hw->pdev = pdev;
- strncpy(hw->drv_version, CSIO_DRV_VERSION, 32);
+ strscpy(hw->drv_version, CSIO_DRV_VERSION,
+ sizeof(hw->drv_version));

/* memory pool/DMA pool allocation */
if (csio_resource_alloc(hw))

---
base-commit: 9c5d00cb7b6bbc5a7965d9ab7d223b5402d1f02c
change-id: 20231023-strncpy-drivers-scsi-csiostor-csio_init-c-9c96b2f77e22

Best regards,
--
Justin Stitt <[email protected]>


2023-10-25 00:31:03

by Kees Cook

[permalink] [raw]
Subject: Re: [PATCH] scsi: csiostor: replace deprecated strncpy with strscpy

On Mon, Oct 23, 2023 at 08:26:13PM +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.
>
> `hw` is kzalloc'd just before this string assignment:
> | hw = kzalloc(sizeof(struct csio_hw), GFP_KERNEL);
>
> ... which means any NUL-padding is redundant.
>
> Since CSIO_DRV_VERSION is a small string literal (smaller than
> sizeof(dest)):
>
> ... there is functionally no change in this swap from strncpy() to
> strscpy(). Nonetheless, let's make the change for robustness' sake -- as
> it will ensure that drv_version is _always_ NUL-terminated.
>
> Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings [1]
> Link: https://github.com/KSPP/linux/issues/90
> Cc: [email protected]
> Signed-off-by: Justin Stitt <[email protected]>

Another direct replacement.

Reviewed-by: Kees Cook <[email protected]>

--
Kees Cook

2023-11-15 14:10:55

by Martin K. Petersen

[permalink] [raw]
Subject: Re: [PATCH] scsi: csiostor: replace deprecated strncpy with strscpy


Justin,

> strncpy() is deprecated for use on NUL-terminated destination strings
> [1] and as such we should prefer more robust and less ambiguous string
> interfaces.

Applied to 6.8/scsi-staging, thanks!

--
Martin K. Petersen Oracle Linux Engineering

2023-11-25 02:54:53

by Martin K. Petersen

[permalink] [raw]
Subject: Re: [PATCH] scsi: csiostor: replace deprecated strncpy with strscpy

On Mon, 23 Oct 2023 20:26:13 +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.
>
> `hw` is kzalloc'd just before this string assignment:
> | hw = kzalloc(sizeof(struct csio_hw), GFP_KERNEL);
>
> [...]

Applied to 6.8/scsi-queue, thanks!

[1/1] scsi: csiostor: replace deprecated strncpy with strscpy
https://git.kernel.org/mkp/scsi/c/4592411784cc

--
Martin K. Petersen Oracle Linux Engineering