scsi: lpfc: Replace deprecated strncpy() with strscpy()
authorJustin Stitt <justinstitt@google.com>
Mon, 26 Feb 2024 23:53:44 +0000 (23:53 +0000)
committerMartin K. Petersen <martin.petersen@oracle.com>
Tue, 27 Feb 2024 02:18:52 +0000 (21:18 -0500)
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 ae->value_string to be NUL-terminated because there's a comment
that says as much; these attr strings are also used with other string APIs,
further cementing the fact.

Now, the question of whether or not to NUL-pad the destination buffer:
lpfc_fdmi_rprt_defer() initializes vports (all zero-initialized), then we
call lpfc_fdmi_cmd() with each vport and a mask. Then, inside of
lpfc_fdmi_cmd() we check each bit in the mask to invoke the proper
callback. Importantly, the zero-initialized vport is passed in as the
"attr" parameter. Seeing this:
| struct lpfc_fdmi_attr_string *ae = attr;
... we can tell that ae->value_string is entirely zero-initialized. Due
to this, NUL-padding is _not_ required as it would be redundant.

Considering the above, a suitable replacement is strscpy() [2].

Link: https://www.kernel.org/doc/html/latest/process/deprecated.html#strncpy-on-nul-terminated-strings
Link: https://manpages.debian.org/testing/linux-manual-4.8/strscpy.9.en.html
Link: https://github.com/KSPP/linux/issues/90
Cc: linux-hardening@vger.kernel.org
Signed-off-by: Justin Stitt <justinstitt@google.com>
Link: https://lore.kernel.org/r/20240226-strncpy-drivers-scsi-lpfc-lpfc_ct-c-v2-1-2df2e46569b9@google.com
Reviewed-by: Kees Cook <keescook@chromium.org>
Signed-off-by: Martin K. Petersen <martin.petersen@oracle.com>
drivers/scsi/lpfc/lpfc_ct.c

index b30765b9689a685fdaebb824aba26e76959955bd..8cc08e58dc05e82f7d9a03f9f02b81279b8a03f1 100644 (file)
@@ -2553,9 +2553,9 @@ lpfc_fdmi_set_attr_string(void *attr, uint16_t attrtype, char *attrstring)
         * 64 bytes or less.
         */
 
-       strncpy(ae->value_string, attrstring, sizeof(ae->value_string));
+       strscpy(ae->value_string, attrstring, sizeof(ae->value_string));
        len = strnlen(ae->value_string, sizeof(ae->value_string));
-       /* round string length to a 32bit boundary. Ensure there's a NULL */
+       /* round string length to a 32bit boundary */
        len += (len & 3) ? (4 - (len & 3)) : 4;
        /* size is Type/Len (4 bytes) plus string length */
        size = FOURBYTES + len;