Skip to contentSkip to conversation

hw/scsi: validate IU buffer bounds in vscsi_preprocess_desc()

PATCH In review Chinmay Rath 4 participants 6 messages Aug 19 – Nov 19

lore
Share & tools
lore
#0 lore raw

PATCH 1/1 hw/scsi: validate IU buffer bounds in vscsi_preprocess_desc()

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

---
 hw/scsi/spapr_vscsi.c | 43 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 38 insertions(+), 5 deletions(-)
hw/scsi/spapr_vscsi.c +38 -5
index b4c8f94d22..9fef224727 100644
@@ -484,6 +484,8 @@ static int data_out_desc_size(struct srp_cmd *cmd)
 static int vscsi_preprocess_desc(vscsi_req *req)
 {
     struct srp_cmd *cmd = &req_iu(req)->srp.cmd;
+    /* bytes available for descriptors behind srp_cmd.add_data */
+    const unsigned avail = SRP_MAX_IU_LEN - offsetof(struct srp_cmd, add_data);
 
     req->cdb_offset = cmd->add_cdb_len & ~3;
 
@@ -498,16 +500,35 @@ static int vscsi_preprocess_desc(vscsi_req *req)
     case SRP_NO_DATA_DESC:
         break;
     case SRP_DATA_DESC_DIRECT:
+        if (req->cdb_offset + sizeof(struct srp_direct_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: direct desc out of bounds\n");
+            return -1;
+        }
         req->total_desc = req->local_desc = 1;
         break;
     case SRP_DATA_DESC_INDIRECT: {
-        struct srp_indirect_buf *ind_tmp = (struct srp_indirect_buf *)
-                (cmd->add_data + req->cdb_offset);
+        struct srp_indirect_buf *ind_tmp;
+
+        if (req->cdb_offset + sizeof(struct srp_indirect_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: indirect desc out of bounds\n");
+            return -1;
+        }
+        ind_tmp = (struct srp_indirect_buf *)(cmd->add_data + req->cdb_offset);
 
         req->total_desc = be32_to_cpu(ind_tmp->table_desc.len) /
                           sizeof(struct srp_direct_buf);
         req->local_desc = req->writing ? cmd->data_out_desc_cnt :
                           cmd->data_in_desc_cnt;
+
+        /* desc_list[] entries must also fit inside the IU buffer */
+        if (req->local_desc * sizeof(struct srp_direct_buf) >
+            avail - req->cdb_offset - sizeof(struct srp_indirect_buf)) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: local_desc out of bounds\n");
+            return -1;
+        }
         break;
     }
     default:
@@ -725,7 +746,11 @@ static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
     memcpy(&resp_data[8], "QEMU    ", 8);
 
     req->writing = 0;
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
     rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
     if (rc < 0) {
         vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
@@ -775,7 +800,12 @@ static void vscsi_report_luns(VSCSIState *s, vscsi_req *req)
         i += 8;
     }
 
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        g_free(resp_data);
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
     rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
     g_free(resp_data);
     if (rc < 0) {
@@ -823,7 +853,10 @@ static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
         req->writing = (n < 1);
 
         /* Preprocess RDMA descriptors */
-        vscsi_preprocess_desc(req);
+        if (vscsi_preprocess_desc(req) < 0) {
+            scsi_req_cancel(req->sreq);
+            return 1;
+        }
 
         /* Get transfer direction and initiate transfer */
         if (n > 0) {
Signature · 1 line
2.55.0
#1 lore raw
Quoted 11 lines · Chinmay Rath

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

Quoted 94 lines
---
  hw/scsi/spapr_vscsi.c | 43 ++++++++++++++++++++++++++++++++++++++-----
  1 file changed, 38 insertions(+), 5 deletions(-)
hw/scsi/spapr_vscsi.c +38 -5
index b4c8f94d22..9fef224727 100644
@@ -484,6 +484,8 @@ static int data_out_desc_size(struct srp_cmd *cmd)
  static int vscsi_preprocess_desc(vscsi_req *req)
  {
      struct srp_cmd *cmd = &req_iu(req)->srp.cmd;
+    /* bytes available for descriptors behind srp_cmd.add_data */
+    const unsigned avail = SRP_MAX_IU_LEN - offsetof(struct srp_cmd, add_data);
 
      req->cdb_offset = cmd->add_cdb_len & ~3;
 
@@ -498,16 +500,35 @@ static int vscsi_preprocess_desc(vscsi_req *req)
      case SRP_NO_DATA_DESC:
          break;
      case SRP_DATA_DESC_DIRECT:
+        if (req->cdb_offset + sizeof(struct srp_direct_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: direct desc out of bounds\n");
+            return -1;
+        }
          req->total_desc = req->local_desc = 1;
          break;
      case SRP_DATA_DESC_INDIRECT: {
-        struct srp_indirect_buf *ind_tmp = (struct srp_indirect_buf *)
-                (cmd->add_data + req->cdb_offset);
+        struct srp_indirect_buf *ind_tmp;
+
+        if (req->cdb_offset + sizeof(struct srp_indirect_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: indirect desc out of bounds\n");
+            return -1;
+        }
+        ind_tmp = (struct srp_indirect_buf *)(cmd->add_data + req->cdb_offset);
 
          req->total_desc = be32_to_cpu(ind_tmp->table_desc.len) /
                            sizeof(struct srp_direct_buf);
          req->local_desc = req->writing ? cmd->data_out_desc_cnt :
                            cmd->data_in_desc_cnt;
+
+        /* desc_list[] entries must also fit inside the IU buffer */
+        if (req->local_desc * sizeof(struct srp_direct_buf) >
+            avail - req->cdb_offset - sizeof(struct srp_indirect_buf)) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: local_desc out of bounds\n");
+            return -1;
+        }
          break;
      }
      default:
@@ -725,7 +746,11 @@ static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
      memcpy(&resp_data[8], "QEMU    ", 8);
 
      req->writing = 0;
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
      rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
      if (rc < 0) {
          vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
@@ -775,7 +800,12 @@ static void vscsi_report_luns(VSCSIState *s, vscsi_req *req)
          i += 8;
      }
 
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        g_free(resp_data);
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
      rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
      g_free(resp_data);
      if (rc < 0) {
@@ -823,7 +853,10 @@ static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
          req->writing = (n < 1);
 
          /* Preprocess RDMA descriptors */
-        vscsi_preprocess_desc(req);
+        if (vscsi_preprocess_desc(req) < 0) {
+            scsi_req_cancel(req->sreq);
+            return 1;
+        }
 
          /* Get transfer direction and initiate transfer */
          if (n > 0) {
Reviewed-by on v1 1/1
#2 lore raw
In reply to Chinmay Rath
Quoted 109 lines · Chinmay Rath

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

---
 hw/scsi/spapr_vscsi.c | 43 ++++++++++++++++++++++++++++++++++++++-----
 1 file changed, 38 insertions(+), 5 deletions(-)
hw/scsi/spapr_vscsi.c +38 -5
index b4c8f94d22..9fef224727 100644
@@ -484,6 +484,8 @@ static int data_out_desc_size(struct srp_cmd *cmd)
 static int vscsi_preprocess_desc(vscsi_req *req)
 {
     struct srp_cmd *cmd = &req_iu(req)->srp.cmd;
+    /* bytes available for descriptors behind srp_cmd.add_data */
+    const unsigned avail = SRP_MAX_IU_LEN - offsetof(struct srp_cmd, add_data);
 
     req->cdb_offset = cmd->add_cdb_len & ~3;
 
@@ -498,16 +500,35 @@ static int vscsi_preprocess_desc(vscsi_req *req)
     case SRP_NO_DATA_DESC:
         break;
     case SRP_DATA_DESC_DIRECT:
+        if (req->cdb_offset + sizeof(struct srp_direct_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: direct desc out of bounds\n");
+            return -1;
+        }
         req->total_desc = req->local_desc = 1;
         break;
     case SRP_DATA_DESC_INDIRECT: {
-        struct srp_indirect_buf *ind_tmp = (struct srp_indirect_buf *)
-                (cmd->add_data + req->cdb_offset);
+        struct srp_indirect_buf *ind_tmp;
+
+        if (req->cdb_offset + sizeof(struct srp_indirect_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: indirect desc out of bounds\n");
+            return -1;
+        }
+        ind_tmp = (struct srp_indirect_buf *)(cmd->add_data + req->cdb_offset);
 
         req->total_desc = be32_to_cpu(ind_tmp->table_desc.len) /
                           sizeof(struct srp_direct_buf);
         req->local_desc = req->writing ? cmd->data_out_desc_cnt :
                           cmd->data_in_desc_cnt;
+
+        /* desc_list[] entries must also fit inside the IU buffer */
+        if (req->local_desc * sizeof(struct srp_direct_buf) >
+            avail - req->cdb_offset - sizeof(struct srp_indirect_buf)) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: local_desc out of bounds\n");
+            return -1;
+        }
         break;
     }
     default:
@@ -725,7 +746,11 @@ static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
     memcpy(&resp_data[8], "QEMU    ", 8);
 
     req->writing = 0;
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
     rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
     if (rc < 0) {
         vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
@@ -775,7 +800,12 @@ static void vscsi_report_luns(VSCSIState *s, vscsi_req *req)
         i += 8;
     }
 
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        g_free(resp_data);
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
     rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
     g_free(resp_data);
     if (rc < 0) {
@@ -823,7 +853,10 @@ static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
         req->writing = (n < 1);
 
         /* Preprocess RDMA descriptors */
-        vscsi_preprocess_desc(req);
+        if (vscsi_preprocess_desc(req) < 0) {
+            scsi_req_cancel(req->sreq);
+            return 1;
+        }
 
         /* Get transfer direction and initiate transfer */
         if (n > 0) {
Signature · 1 line
2.55.0

LGTM, did a light sanity with this

#3 lore raw
In reply to Chinmay Rath
Quoted 4 lines · Chinmay Rath

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Quoted 8 lines

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

Shouldn't this be Cc: [email protected] ?

Did we deliberately decide this wasn't CVE-worthy, or did that step in the process get skipped?

Ideally bug fix commits, especially ones we might want to backport, should include a "Fixes:" tag giving the commit hash and subject of the commit that introduced the bug they're fixing.

thanks
-- PMM

#4 lore raw

+CC : qemu-stable

Hi Peter,

Quoted 7 lines · Peter Maydell
Quoted 6 lines · Chinmay Rath

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Quoted 6 lines
Quoted 5 lines

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

Shouldn't this be Cc: [email protected] ?

This got missed. I have cced now. Will take care further on.

Quoted 3 lines

Did we deliberately decide this wasn't CVE-worthy, or did that step in the process get skipped?

This got skipped as well. I have added the "CVE-required" tag in the Gitlab issue now. Will take care in future.

Quoted 4 lines

Ideally bug fix commits, especially ones we might want to backport, should include a "Fixes:" tag giving the commit hash and subject of the commit that introduced the bug they're fixing.

I shall post a v2 with fixes tag for the CVE that gets assigned and the commit hash which introduced the bug.

Thanks,
Chinmay

Quoted 4 lines

thanks
-- PMM

#5 lore raw
In reply to Chinmay Rath

Hi Chinmay,

Quoted 29 lines · Chinmay Rath

cdb_offset and local_desc values are dependent on the guest. If the value is large enough, it can lead to an out-of-bounds read in vscsi_fetch_desc().

Add an 'avail' constant in vscsi_preprocess_desc() representing the number of bytes available in srp_cmd.add_data[] and use it to prevent out-of-bound reads.

Make all callers of vscsi_preprocess_desc() check its return value and handle failure accordingly.

---
  hw/scsi/spapr_vscsi.c | 43 ++++++++++++++++++++++++++++++++++++++-----
  1 file changed, 38 insertions(+), 5 deletions(-)
hw/scsi/spapr_vscsi.c +2 -0
index b4c8f94d22..9fef224727 100644
@@ -484,6 +484,8 @@ static int data_out_desc_size(struct srp_cmd *cmd)
  static int vscsi_preprocess_desc(vscsi_req *req)
  {
      struct srp_cmd *cmd = &req_iu(req)->srp.cmd;
+    /* bytes available for descriptors behind srp_cmd.add_data */
+    const unsigned avail = SRP_MAX_IU_LEN - offsetof(struct srp_cmd, add_data);
 
      req->cdb_offset = cmd->add_cdb_len & ~3;
 

hw/scsi/spapr_vscsi.c static int vscsi_preprocess_desc(vscsi_req *req) · line 505

Quoted 6 lines
hw/scsi/spapr_vscsi.c +3 -0
@@ -498,16 +500,35 @@ static int vscsi_preprocess_desc(vscsi_req *req)
      case SRP_NO_DATA_DESC:
          break;
      case SRP_DATA_DESC_DIRECT:
+        if (req->cdb_offset + sizeof(struct srp_direct_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: direct desc out of bounds\n");

Please replace fprintf() by qemu_log...(GUEST_ERRORS, ...).

hw/scsi/spapr_vscsi.c static int vscsi_preprocess_desc(vscsi_req *req) · line 515

Quoted 12 lines
hw/scsi/spapr_vscsi.c +7 -2
+            return -1;
+        }
          req->total_desc = req->local_desc = 1;
          break;
      case SRP_DATA_DESC_INDIRECT: {
-        struct srp_indirect_buf *ind_tmp = (struct srp_indirect_buf *)
-                (cmd->add_data + req->cdb_offset);
+        struct srp_indirect_buf *ind_tmp;
+
+        if (req->cdb_offset + sizeof(struct srp_indirect_buf) > avail) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: indirect desc out of bounds\n");

Ditto.

Quoted 4 lines
hw/scsi/spapr_vscsi.c +3 -0
+            return -1;
+        }
+        ind_tmp = (struct srp_indirect_buf *)(cmd->add_data + req->cdb_offset);
 

hw/scsi/spapr_vscsi.c static int vscsi_preprocess_desc(vscsi_req *req) · line 529

Quoted 10 lines
hw/scsi/spapr_vscsi.c +6 -0
          req->total_desc = be32_to_cpu(ind_tmp->table_desc.len) /
                            sizeof(struct srp_direct_buf);
          req->local_desc = req->writing ? cmd->data_out_desc_cnt :
                            cmd->data_in_desc_cnt;
+
+        /* desc_list[] entries must also fit inside the IU buffer */
+        if (req->local_desc * sizeof(struct srp_direct_buf) >
+            avail - req->cdb_offset - sizeof(struct srp_indirect_buf)) {
+            fprintf(stderr,
+                    "vscsi_preprocess_desc: local_desc out of bounds\n");

Ditto.

Quoted 33 lines
hw/scsi/spapr_vscsi.c +13 -2
+            return -1;
+        }
          break;
      }
      default:
@@ -725,7 +746,11 @@ static void vscsi_inquiry_no_target(VSCSIState *s, vscsi_req *req)
      memcpy(&resp_data[8], "QEMU    ", 8);
 
      req->writing = 0;
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
      rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
      if (rc < 0) {
          vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
@@ -775,7 +800,12 @@ static void vscsi_report_luns(VSCSIState *s, vscsi_req *req)
          i += 8;
      }
 
-    vscsi_preprocess_desc(req);
+    if (vscsi_preprocess_desc(req) < 0) {
+        g_free(resp_data);
+        vscsi_makeup_sense(s, req, HARDWARE_ERROR, 0, 0);
+        vscsi_send_rsp(s, req, CHECK_CONDITION, 0, 0);
+        return;
+    }
      rc = vscsi_srp_transfer_data(s, req, 0, resp_data, len);
      g_free(resp_data);
      if (rc < 0) {

hw/scsi/spapr_vscsi.c static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req) · line 856

Quoted 5 lines
hw/scsi/spapr_vscsi.c +1 -1
@@ -823,7 +853,10 @@ static int vscsi_queue_cmd(VSCSIState *s, vscsi_req *req)
          req->writing = (n < 1);
 
          /* Preprocess RDMA descriptors */
-        vscsi_preprocess_desc(req);
+        if (vscsi_preprocess_desc(req) < 0) {

scsi_req_cancel() does not send an SRP response by itself, so now guest waits until timeout... (That makes me wonder how this patch was tested). In order to return a proper error to the guest, please add:

               req->dma_error = true;
Quoted 6 lines
hw/scsi/spapr_vscsi.c +3 -0
+            scsi_req_cancel(req->sreq);
+            return 1;
+        }
 
          /* Get transfer direction and initiate transfer */
          if (n > 0) {