Skip to contentSkip to conversation

scsi: zfcp: Replace strlcpy() with strscpy()

PATCH Superseded Kees Cook 3 participants 4 messages Nov 16, 2023 – Nov 20, 2023

Subsystems (3)

v1 of 2 Superseded Latest is v2 →

lore
Share & tools
lore

Kees Cook

author
#0 lore raw

PATCH 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().

Be explicitly robust in the face of truncation, which should be an impossible state.

---
 drivers/s390/scsi/zfcp_fc.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
drivers/s390/scsi/zfcp_fc.c +9 -2
index 4f0d0e55f0d4..1a29f10767fc 100644
@@ -900,8 +900,15 @@ 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);
+	len = strscpy(rspn_req->name, fc_host_symbolic_name(shost),
+		      sizeof(rspn_req->name));
+	/*
+	 * It should be impossible for this to truncate, as
+	 * sizeof(rspn_req->name) is equal to max size of
+	 * fc_host_symbolic_name(shost), but check anyway.
+	 */
+	if (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
#1 lore raw

On Thu, Nov 16, 2023 at 11:14:35AM -0800, Kees Cook wrote:

Hi Kees,

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 904

Quoted 12 lines
drivers/s390/scsi/zfcp_fc.c +2 -2
index 4f0d0e55f0d4..1a29f10767fc 100644
@@ -900,8 +900,15 @@ 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);
+	len = strscpy(rspn_req->name, fc_host_symbolic_name(shost),
+		      sizeof(rspn_req->name));

Could you please explain why do you copy to rspn_req->name instead of rspn_req->rspn.fr_name?

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 914

Quoted 10 lines
drivers/s390/scsi/zfcp_fc.c +7 -0
+	/*
+	 * It should be impossible for this to truncate, as
+	 * sizeof(rspn_req->name) is equal to max size of
+	 * fc_host_symbolic_name(shost), but check anyway.
+	 */
+	if (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));

Thanks!

#2 lore raw
Quoted 11 lines · Alexander Gordeev

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 904

Quoted 8 lines
drivers/s390/scsi/zfcp_fc.c +2 -2
@@ -900,8 +900,15 @@ 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);
+	len = strscpy(rspn_req->name, fc_host_symbolic_name(shost),
+		      sizeof(rspn_req->name));

Could you please explain why do you copy to rspn_req->name instead of rspn_req->rspn.fr_name?

Please, ignore this (stupid Friday evening) quesiton.

Although the use of sizeof() is right thing, FC_SYMBOLIC_NAME_SIZE is so ubiquotous in this source that it probably makes sense to address in a separate cleanup.

@Steffen, @Benjamin, could you please comment in this and below?

Quoted 7 lines

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 911

Quoted 7 lines
drivers/s390/scsi/zfcp_fc.c +7 -0
+	/*
+	 * It should be impossible for this to truncate, as
+	 * sizeof(rspn_req->name) is equal to max size of
+	 * fc_host_symbolic_name(shost), but check anyway.
+	 */
+	if (len < 0)
+		len = sizeof(rspn_req->name) - 1;

Not sure if this check is really needed. It could have been done for strlcpy() also, but as you say - should not ever happen.

Quoted 3 lines

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 914

Quoted 3 lines
drivers/s390/scsi/zfcp_fc.c +0 -0
 	rspn_req->rspn.fr_name_len = len;
 
 	sg_init_one(&fc_req->sg_req, rspn_req, sizeof(*rspn_req));

Thanks!

#3 lore raw
In reply to Kees Cook

Hey Kees,

thanks for the patch.

can you please send this patch to linux-scsi and CC the SCSI Maintainers (Martin and James) instead (having linux-s390 on CC is fine)? zFCP doesn't go via s390, being a SCSI driver.

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 remove strlcpy() completely[2], replace strlcpy() here with strscpy().

Be explicitly robust in the face of truncation, which should be an impossible state.

---
 drivers/s390/scsi/zfcp_fc.c | 11 +++++++++--
 1 file changed, 9 insertions(+), 2 deletions(-)
drivers/s390/scsi/zfcp_fc.c +0 -0
index 4f0d0e55f0d4..1a29f10767fc 100644

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 904

Quoted 7 lines
drivers/s390/scsi/zfcp_fc.c +2 -2
@@ -900,8 +900,15 @@ 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);
+	len = strscpy(rspn_req->name, fc_host_symbolic_name(shost),
+		      sizeof(rspn_req->name));

This is corrct.

drivers/s390/scsi/zfcp_fc.c static void zfcp_fc_rspn(struct zfcp_adapter *adapter, · line 911

Quoted 7 lines
drivers/s390/scsi/zfcp_fc.c +7 -0
+	/*
+	 * It should be impossible for this to truncate, as
+	 * sizeof(rspn_req->name) is equal to max size of
+	 * fc_host_symbolic_name(shost), but check anyway.
+	 */
+	if (len < 0)
+		len = sizeof(rspn_req->name) - 1;

I'd rather have a compile-time check, whether the array sizes of rspn_req->name and fc_host_symbolic_name(shost) run out of sync, or against our expectations.

Something like:

	len = strscpy(rspn_req->name, fc_host_symbolic_name(shost),
		      sizeof(rspn_req->name));
	BUILD_BUG_ON(sizeof(rspn_req->name) !=
			     sizeof(fc_host_symbolic_name(shost)) ||
		     sizeof(rspn_req->name) !=
			     1 << sizeof(rspn_req->rspn.fr_name_len) * 8);
	rspn_req->rspn.fr_name_len = len;

Then the last assignment should also be correct; and if something changes - unexpectedly, because this follows a FC standard - we need to adapt the code anyway I'd think.

Or am I missing something?

Quoted 6 lines
drivers/s390/scsi/zfcp_fc.c +0 -0
 	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
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