scsi: zfcp: Replace strlcpy() with strscpy()
Subsystems (3)
PATCH v2 1/1 scsi: zfcp: Replace strlcpy() with strscpy()
strlcpy() reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to remove strlcpy() completely[2], replace strlcpy() here with strscpy().
Overflow should be impossible here, but actually check for buffer sizes being identical with BUILD_BUG_ON(), and include a run-time check as well.
---
v2:
- add BUILD_BUG_ON (bblock)
- CC SCSI maintainers (bblock)
v1: https://lore.kernel.org/all/[email protected]/
--- drivers/s390/scsi/zfcp_fc.c | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-)
drivers/s390/scsi/zfcp_fc.c +13 -2
@@ -900,8 +900,19 @@ static void zfcp_fc_rspn(struct zfcp_adapter *adapter,zfcp_fc_ct_ns_init (&rspn_req->ct_hdr,FC_NS_RSPN_ID ,FC_SYMBOLIC_NAME_SIZE );hton24 (rspn_req->rspn.fr_fid.fp_fid,fc_host_port_id (shost)); - len =strlcpy (rspn_req->rspn.fr_name,fc_host_symbolic_name (shost), -FC_SYMBOLIC_NAME_SIZE ); + +BUILD_BUG_ON (sizeof (rspn_req->name) != +sizeof (fc_host_symbolic_name (shost))); +BUILD_BUG_ON (sizeof (rspn_req->name) != +type_max (typeof (rspn_req->rspn.fr_name_len)) +1 ); + len =strscpy (rspn_req->name,fc_host_symbolic_name (shost), +sizeof (rspn_req->name)); +/* +* It should be impossible for this to truncate (see BUILD_BUG_ON() +* above), but be robust anyway. +*/ +if (WARN_ON (len <0 )) + len =sizeof (rspn_req->name) -1 ; rspn_req->rspn.fr_name_len = len;sg_init_one (&fc_req->sg_req, rspn_req,sizeof (*rspn_req));
Signature · 1 line
2.34.1
Hello Kees, Martin, James,
Quoted 31 lines · Kees Cook
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to removestrlcpy()completely[2], replacestrlcpy()here withstrscpy().Overflow should be impossible here, but actually check for buffer sizes being identical with
BUILD_BUG_ON(), and include a run-time check as well.--- drivers/s390/scsi/zfcp_fc.c | 15 +++++++++++++-- 1 file changed, 13 insertions(+), 2 deletions(-)drivers/s390/scsi/zfcp_fc.c +3
-2@@ -900,8 +900,19 @@ static void zfcp_fc_rspn(struct zfcp_adapter *adapter,zfcp_fc_ct_ns_init (&rspn_req->ct_hdr,FC_NS_RSPN_ID ,FC_SYMBOLIC_NAME_SIZE );hton24 (rspn_req->rspn.fr_fid.fp_fid,fc_host_port_id (shost)); - len =strlcpy (rspn_req->rspn.fr_name,fc_host_symbolic_name (shost), -FC_SYMBOLIC_NAME_SIZE ); + +BUILD_BUG_ON (sizeof (rspn_req->name) != +sizeof (fc_host_symbolic_name (shost)));
drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 915
Quoted 10 lines
drivers/s390/scsi/zfcp_fc.c +10
-0+BUILD_BUG_ON (sizeof (rspn_req->name) != +type_max (typeof (rspn_req->rspn.fr_name_len)) +1 ); + len =strscpy (rspn_req->name,fc_host_symbolic_name (shost), +sizeof (rspn_req->name)); +/* +* It should be impossible for this to truncate (see BUILD_BUG_ON() +* above), but be robust anyway. +*/ +if (WARN_ON (len <0 )) + len =sizeof (rspn_req->name) -1 ;
Looks good to me.
drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 916
Quoted 1 line
drivers/s390/scsi/zfcp_fc.c +0
-0rspn_req->rspn.fr_name_len = len;
Martin, James, can you please pick this up for the v6.8 queue?
Signature · 4 lines
Best Regards, Benjamin Block / Linux on IBM Z Kernel Development IBM Deutschland Research & Development GmbH / https://www.ibm.com/privacy Vors. Aufs.-R.: Gregor Pillen / Geschäftsführung: David Faller Sitz der Ges.: Böblingen / Registergericht: AmtsG Stuttgart, HRB 243294
Martin K. Petersen
AppliedKees,
Quoted 6 lines
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to removestrlcpy()completely[2], replacestrlcpy()here withstrscpy().
Applied to 6.8/scsi-staging, thanks!
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering
Martin K. Petersen
AppliedQuoted 8 lines · Kees Cook
strlcpy()reads the entire source buffer first. This read may exceed the destination size limit. This is both inefficient and can lead to linear read overflows if a source string is not NUL-terminated[1]. Additionally, it returns the size of the source string, not the resulting size of the destination string. In an effort to removestrlcpy()completely[2], replacestrlcpy()here withstrscpy().[...]
Applied to 6.8/scsi-queue, thanks!
[1/1] scsi: zfcp: Replace strlcpy() with strscpy()
https://git.kernel.org/mkp/scsi/c/0d224b1088af
Signature · 1 line
Martin K. Petersen Oracle Linux Engineering