Skip to contentSkip to conversation

nvme: nvme_identify_ns_descs: prevent oob

PATCH Superseded Eugene Korenevsky 3 participants 5 messages Dec 1, 2025 – Dec 2, 2025 NVMe

v3 of 4 Superseded Latest is v4 →

lore
Share & tools
lore
#0 lore raw

PATCH v3 1/1 nvme: nvme_identify_ns_descs: prevent oob

Broken or malicious controller can send invalid ns id. Out-of-band memory access may occur if remaining buffer size is less than .nidl (ns id length) field of struct nvme_ns_id_desc

Fix this issue by checking (header size + .nidl) against remaining buffer length.

Also small minor related fix: pos should be unsigned size_t, not signed int.

---
v1->v2:
* Simplification: do not touch nvme_process_ns_desc()
* Update commit description
v2->v3:
* Even more simplification
* Replace while with do-while as first pre-loop condition check is pointless
* Change pos type: int -> size_t
* Update commit description

---
 drivers/nvme/host/core.c | 17 ++++++++++++-----
 1 file changed, 12 insertions(+), 5 deletions(-)
drivers/nvme/host/core.c +12 -5
index f1f719351f3f..73263545e3cd 100644
@@ -1538,8 +1538,10 @@ static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl,
 {
 	struct nvme_command c = { };
 	bool csi_seen = false;
-	int status, pos, len;
+	int status, len;
+	size_t pos;
 	void *data;
+	struct nvme_ns_id_desc *cur;
 
 	if (ctrl->vs < NVME_VS(1, 3, 0) && !nvme_multi_css(ctrl))
 		return 0;
@@ -1563,18 +1565,23 @@ static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl,
 		goto free_data;
 	}
 
-	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
-		struct nvme_ns_id_desc *cur = data + pos;
+	pos = 0;
+	do {
+		cur = data + pos;
 
 		if (cur->nidl == 0)
 			break;
+		/* check ns id desc does not exceed remaining buffer by size */
+		if (cur->nidl + sizeof(*cur) > NVME_IDENTIFY_DATA_SIZE - pos)
+			break;
 
 		len = nvme_process_ns_desc(ctrl, &info->ids, cur, &csi_seen);
 		if (len < 0)
 			break;
 
-		len += sizeof(*cur);
-	}
+		pos += sizeof(*cur);
+		pos += len;
+	} while (pos < NVME_IDENTIFY_DATA_SIZE - sizeof(*cur));
 
 	if (nvme_multi_css(ctrl) && !csi_seen) {
 		dev_warn(ctrl->device, "Command set not reported for nsid:%d\n",
Signature · 1 line
2.47.3
maintainer
#1 lore raw
Quoted 11 lines · Eugene Korenevsky
drivers/nvme/host/core.c +6 -2
-	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
-		struct nvme_ns_id_desc *cur = data + pos;
+	pos = 0;
+	do {
+		cur = data + pos;
 
 		if (cur->nidl == 0)
 			break;
+		/* check ns id desc does not exceed remaining buffer by size */
+		if (cur->nidl + sizeof(*cur) > NVME_IDENTIFY_DATA_SIZE - pos)
+			break;

drivers/nvme/host/core.c static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, · line 1584

Quoted 10 lines
drivers/nvme/host/core.c +3 -2
 
 		len = nvme_process_ns_desc(ctrl, &info->ids, cur, &csi_seen);
 		if (len < 0)
 			break;
 
-		len += sizeof(*cur);
-	}
+		pos += sizeof(*cur);
+		pos += len;
+	} while (pos < NVME_IDENTIFY_DATA_SIZE - sizeof(*cur));

I don't want bikeshed this, but I thought this looked better as a for-loop. You can just modify the continuing condition instead of changing the loop type to do-while.

#2 lore raw
Quoted 3 lines · Keith Busch

I don't want bikeshed this, but I thought this looked better as a for-loop. You can just modify the continuing condition instead of changing the loop type to do-while.

The reason I went for the while in my whiteboard coding is that it would allow for keeping len local inside the loop, which I like in general. The actual patch doesn't do this anyway, and I don't care too strongly, so I'm fine with the somewhat more natural for loop as well.

#3 lore raw
In reply to Keith Busch
Quoted 11 lines

drivers/nvme/host/core.c static int nvme_identify_ns_descs(struct nvme_ctrl *ctrl, · line 1584

Quoted 7 lines
drivers/nvme/host/core.c +3 -2
-	for (pos = 0; pos < NVME_IDENTIFY_DATA_SIZE; pos += len) {
-		struct nvme_ns_id_desc *cur = data + pos;
 
+	pos = 0;
+	do {
 
+	} while (pos < NVME_IDENTIFY_DATA_SIZE - sizeof(*cur));

I don't want bikeshed this, but I thought this looked better as a for-loop. You can just modify the continuing condition instead of changing the loop type to do-while.

OK, tried to make the patch as close as possible to previous code. See v4.

Also, adding 'pos += len' to modified for makes the line longer than 80 symbols. However, checkpatch.pl says it is OK. Let me know if it should be fixed somehow (e.g. by moving 'pos += len' to the end of loop compound statement).

maintainer
#4 lore raw
Quoted 2 lines · Eugene Korenevsky

OK, tried to make the patch as close as possible to previous code. See v4.

Yep, I saw. Mostly looks good to me.

Quoted 4 lines

Also, adding 'pos += len' to modified for makes the line longer than 80 symbols. However, checkpatch.pl says it is OK. Let me know if it should be fixed somehow (e.g. by moving 'pos += len' to the end of loop compound statement).

The convention for this driver is to wrap lines at 80 characters. But don't worry about sending a new version for just that; I can fix that when applying.