Skip to contentSkip to conversation

Prevent buffer overflow in UVC Gadget setup handler

PATCH Superseded Szymon Heidrich 4 participants 12 messages Dec 1, 2022 – Dec 6, 2022

Subsystems (2)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 Prevent buffer overflow in UVC Gadget setup handler

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..69c5eb3a3 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = (req->actual > sizeof(uvc_event->data.data) ?
+			sizeof(uvc_event->data.data) : req->actual);
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 1 line
2.38.1
#1 lore raw
Quoted 10 lines · Szymon Heidrich

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)

What commit id does this fix? Is it needed for stable kernels?

thanks,

greg k-h

#2 lore raw
Quoted 12 lines · Greg Kroah-Hartman
Quoted 10 lines · Szymon Heidrich

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
Quoted 5 lines

What commit id does this fix? Is it needed for stable kernels?

thanks,

greg k-h

As far as I understand this would be the original commit so cdda479f15cd13fa50a913ca85129c0437cc7b91. I guess that it is also needed for stable kernels, yet please correct me if I'm wrong.

Best regards,
Szymon

#3 lore raw
In reply to Szymon Heidrich

Hello - thanks for the patch

Quoted 1 line · Szymon Heidrich

Setup function uvc_function_setup

You've written uvc_function_setup here, but the code changes uvc_function_ep0_complete.

Quoted 7 lines

permits control transfer
requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

Good catch

Quoted 9 lines
---
  drivers/usb/gadget/function/f_uvc.c | 5 +++--
  1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +0 -0
index 6e196e061..69c5eb3a3 100644

drivers/usb/gadget/function/f_uvc.c uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req) · line 220

Quoted 7 lines
drivers/usb/gadget/function/f_uvc.c +2 -2
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
  		memset(&v4l2_event, 0, sizeof(v4l2_event));
  		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = (req->actual > sizeof(uvc_event->data.data) ?
+			sizeof(uvc_event->data.data) : req->actual);

There's a clamp() macro in f_uvc.c, can we use that?

Quoted 4 lines
drivers/usb/gadget/function/f_uvc.c +1 -0
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
  		v4l2_event_queue(&uvc->vdev, &v4l2_event);
  	}
  }
#4 lore raw
Quoted 7 lines · Dan Scally

Hello - thanks for the patch

Quoted 1 line · Szymon Heidrich

Setup function uvc_function_setup

You've written uvc_function_setup here, but the code changes uvc_function_ep0_complete.

Yes, this was intentional as uvc_function_setup prevents handling of control transfer requests with wLength grater than UVC_MAX_REQUEST_SIZE. The uvc_function_ep0_complete function handles data phase thus was modified.

Quoted 16 lines
Quoted 8 lines

  permits control transfer
requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

Good catch

Quoted 4 lines

---
  drivers/usb/gadget/function/f_uvc.c | 5 +++--

  1 file changed, 3 insertions(+), 2 deletions(-)
Quoted 19 lines

drivers/usb/gadget/function/f_uvc.c uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req) · line 219

Quoted 11 lines
drivers/usb/gadget/function/f_uvc.c +2 -2
index 6e196e061..69c5eb3a3 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
             memset(&v4l2_event, 0, sizeof(v4l2_event));
           v4l2_event.type = UVC_EVENT_DATA;
-        uvc_event->data.length = req->actual;
-        memcpy(&uvc_event->data.data, req->buf, req->actual);
+        uvc_event->data.length = (req->actual > sizeof(uvc_event->data.data) ?
+            sizeof(uvc_event->data.data) : req->actual);

There's a clamp() macro in f_uvc.c, can we use that?

Quoted 4 lines
drivers/usb/gadget/function/f_uvc.c +1 -0
+        memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
           v4l2_event_queue(&uvc->vdev, &v4l2_event);
       }
   }

If it is more appropriate I will use min_t(unsigned int, req->actual, sizeof(uvc_event->data.data)).

#5 lore raw

PATCH v2 1/1 usb: gadget: uvc: Prevent buffer overflow in setup handler

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 1 line
2.38.1
#6 lore raw

Re: [PATCH v2] usb: gadget: uvc: Prevent buffer overflow in setup handler

Quoted 30 lines · Szymon Heidrich

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 1 line
2.38.1

Hi,

This is the friendly patch-bot of Greg Kroah-Hartman. You have sent him a patch that has triggered this response. He used to manually respond to these common problems, but in order to save his sanity (he kept writing the same thing over and over, yet to different people), I was created. Hopefully you will not take offence and will fix the problem in your patch and resubmit it so that it can be accepted into the Linux kernel tree.

You are receiving this message because of the following common error(s) as indicated below:

- This looks like a new version of a previously submitted patch, but you did not list below the --- line any changes from the previous version. Please read the section entitled "The canonical patch format" in the kernel file, Documentation/SubmittingPatches for what needs to be done here to properly describe this.

If you wish to discuss this problem further, or you have questions about how to resolve this issue, please feel free to respond to this email and Greg will reply once he has dug out from the pending patches received from other developers.

thanks,

greg k-h's patch email bot

#7 lore raw

PATCH v2 1/1 usb: gadget: uvc: Prevent buffer overflow in setup handler

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

---
V1 -> V2: Corrected commit message and changed ?: in favor of min_t

 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 1 line
2.38.1
Reviewed-by on v2 1/1
#8 lore raw

Re: [PATCH v2] usb: gadget: uvc: Prevent buffer overflow in setup handler

Hi Szymon

Quoted 7 lines · Szymon Heidrich

Setup function uvc_function_setuppermits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

This probably needs to be tagged with:

Fixes cdda479f15cd ("USB gadget: video class function driver")
Quoted 22 lines

---
V1 -> V2: Corrected commit message and changed ?: in favor of min_t

  drivers/usb/gadget/function/f_uvc.c | 5 +++--
  1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
  		memset(&v4l2_event, 0, sizeof(v4l2_event));
  		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
  		v4l2_event_queue(&uvc->vdev, &v4l2_event);
  	}
  }
#9 lore raw

PATCH v3 1/1 usb: gadget: uvc: Prevent buffer overflow in setup handler

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

Fixes cdda479f15cd ("USB gadget: video class function driver")

---
V1 -> V2: Corrected commit message and changed ?: in favor of min_t V2 -> V3: Added fixes tag

 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 1 line
2.38.1
Reviewed-by on v3 1/1
#10 lore raw

Re: [PATCH v3] usb: gadget: uvc: Prevent buffer overflow in setup handler

Hi Szymon,

Thank you for the patch.

Quoted 8 lines · Szymon Heidrich

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

Fixes cdda479f15cd ("USB gadget: video class function driver")

Good catch.

Quoted 23 lines

---
V1 -> V2: Corrected commit message and changed ?: in favor of min_t V2 -> V3: Added fixes tag

 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +3 -2
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }
Signature · 3 lines
Regards,

Laurent Pinchart
#11 lore raw

Re: [PATCH v3] usb: gadget: uvc: Prevent buffer overflow in setup handler

Quoted 31 lines · Laurent Pinchart

Hi Szymon,

Thank you for the patch.

Quoted 8 lines · Szymon Heidrich

Setup function uvc_function_setup permits control transfer requests with up to 64 bytes of payload (UVC_MAX_REQUEST_SIZE), data stage handler for OUT transfer uses memcpy to copy req->actual bytes to uvc_event->data.data array of size 60. This may result in an overflow of 4 bytes.

Fixes cdda479f15cd ("USB gadget: video class function driver")

Good catch.

Quoted 13 lines

---
V1 -> V2: Corrected commit message and changed ?: in favor of min_t V2 -> V3: Added fixes tag

 drivers/usb/gadget/function/f_uvc.c | 5 +++--
 1 file changed, 3 insertions(+), 2 deletions(-)
drivers/usb/gadget/function/f_uvc.c +0 -0
index 6e196e061..4419b7972 100644
@@ -216,8 +216,9 @@ uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req)
 
Quoted 11 lines

drivers/usb/gadget/function/f_uvc.c uvc_function_ep0_complete(struct usb_ep *ep, struct usb_request *req) · line 224

Quoted 10 lines
drivers/usb/gadget/function/f_uvc.c +3 -2
 		memset(&v4l2_event, 0, sizeof(v4l2_event));
 		v4l2_event.type = UVC_EVENT_DATA;
-		uvc_event->data.length = req->actual;
-		memcpy(&uvc_event->data.data, req->buf, req->actual);
+		uvc_event->data.length = min_t(unsigned int, req->actual,
+			sizeof(uvc_event->data.data));
+		memcpy(&uvc_event->data.data, req->buf, uvc_event->data.length);
 		v4l2_event_queue(&uvc->vdev, &v4l2_event);
 	}
 }

Hello Dan and Laurent,

Thank you very much for your time, review and accurate remarks.

Best regards,
Szymon