1177237 – redirfilter with version='1.1' allows a USB 3.0 device

RHEL Engineering is moving the tracking of its product development work on RHEL 6 through RHEL 9 to Red Hat Jira (issues.redhat.com). If you're a Red Hat customer, please continue to file support cases via the Red Hat customer portal. If you're not, please head to the "RHEL project" in Red Hat Jira and file new tickets here. Individual Bugzilla bugs in the statuses "NEW", "ASSIGNED", and "POST" are being migrated throughout September 2023. Bugs of Red Hat partners with an assigned Engineering Partner Manager (EPM) are migrated in late September as per pre-agreed dates. Bugs against components "kernel", "kernel-rt", and "kpatch" are only migrated if still in "NEW" or "ASSIGNED". If you cannot log in to RH Jira, please consult article #7032570. That failing, please send an e-mail to the RH Jira admins at rh-issues@redhat.com to troubleshoot your issue as a user management inquiry. The email creates a ServiceNow ticket with Red Hat. Individual Bugzilla bugs that are migrated will be moved to status "CLOSED", resolution "MIGRATED", and set with "MigratedToJIRA" in "Keywords". The link to the successor Jira issue will be found under "Links", have a little "two-footprint" icon next to it, and direct you to the "RHEL project" in Red Hat Jira (issue links are of type "https://issues.redhat.com/browse/RHEL-XXXX", where "X" is a digit). This same link will be available in a blue banner at the top of the page informing you that that bug has been migrated.

Bug 1177237 - redirfilter with version='1.1' allows a USB 3.0 device

Summary: redirfilter with version='1.1' allows a USB 3.0 device

Keywords:
Status:	CLOSED ERRATA
Alias:	None
Product:	Red Hat Enterprise Linux 7
Classification:	Red Hat
Component:	libvirt
Sub Component:
Version:	7.1
Hardware:	Unspecified
OS:	Unspecified
Priority:	medium
Severity:	high
Target Milestone:	rc
Target Release:	---
Assignee:	Ján Tomko
QA Contact:	Virtualization Bugs
Docs Contact:
URL:
Whiteboard:
Depends On:
Blocks:
TreeView+	depends on / blocked

Reported:	2014-12-25 10:09 UTC by lcheng
Modified:	2015-11-19 06:05 UTC (History)
CC List:	6 users (show)
Fixed In Version:	libvirt-1.2.14-1.el7
Doc Type:	Bug Fix
Doc Text:
Clone Of:
Environment:
Last Closed:	2015-11-19 06:05:54 UTC
Target Upstream Version:
Embargoed:

Attachments	(Terms of Use)

Links
System	ID	Private	Priority	Status	Summary	Last Updated
Red Hat Product Errata	RHBA-2015:2202	0	normal	SHIPPED_LIVE	libvirt bug fix and enhancement update	2015-11-19 08:17:58 UTC

Description lcheng 2014-12-25 10:09:15 UTC

Description of problem:
When start guest without 'version' element or with 'version=1.10' element, redirecting usb 3.0 device can be find in guest. But when start guest with 'version=1.0' or 'version=2.0', redirecting usb 3.0 device can not be find in guest.


Version-Release number of selected component (if applicable):
qemu-kvm-rhev-2.1.2-17.el7.x86_64
libvirt-1.2.8-11.el7.x86_64


How reproducible:
100%


Steps to Reproduce:
1. Plug a usb 3.0 device to host. Run 'usbredirserver' command on terminal.

[root@localhost ~]# lsusb
...
Bus 001 Device 007: ID 0951:1656 Kingston Technology DataTraveler Ultimate G2

[root@localhost ~]# usbredirserver -p 4000 0951:1656


2. On another terminal, start guest without 'version' element.

[root@localhost ~]# virsh start r7
Domain r7 started

[root@localhost ~]# virsh dumpxml r7
    <redirdev bus='usb' type='tcp'>
      <source mode='connect' host='localhost' service='4000'/>
      <protocol type='raw'/>
      <alias name='redir0'/>
    </redirdev>
    <redirfilter>
      <usbdev class='0x08' vendor='0x0951' product='0x1656' allow='yes'/>      <== do not set version
      <usbdev allow='no'/>
    </redirfilter>
...

[root@localhost ~]# ps -aux | grep qemu
-device ich9-usb-ehci1,id=usb,bus=pci.0,addr=0x5.0x7 -device ich9-usb-uhci1,masterbus=usb.0,firstport=0,bus=pci.0,multifunction=on,addr=0x5 -device ich9-usb-uhci2,masterbus=usb.0,firstport=2,bus=pci.0,addr=0x5.0x1 -device ich9-usb-uhci3,masterbus=usb.0,firstport=4,bus=pci.0,addr=0x5.0x2  ... -chardev socket,id=charredir0,host=localhost,port=4000 -device usb-redir,chardev=charredir0,id=redir0,filter=0x08:0x0951:0x1656:-1:1|-1:-1:-1:-1:0 ...


3. Check the usb device in guest. Can find the usb device.

[root@localhost ~]# lsusb
Bus 001 Device 002: ID 0627:0001 Adomax Technology Co., Ltd
Bus 001 Device 003: ID 0951:1656 Kingston Technology DataTraveler Ultimate G2     <== can find the usb device
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub



4. Start guest with 'version=1.10' element.

[root@localhost ~]# virsh destroy r7
Domain r7 destroyed

[root@localhost ~]# virsh edit r7
Domain r7 XML configuration edited.


[root@localhost ~]# virsh start r7
Domain r7 started

[root@localhost ~]# virsh dumpxml r7
...
    <redirdev bus='usb' type='tcp'>
      <source mode='connect' host='localhost' service='4000'/>
      <protocol type='raw'/>
      <alias name='redir0'/>
    </redirdev>
    <redirfilter>
      <usbdev class='0x08' vendor='0x0951' product='0x1656' version='1.10' allow='yes'/>
      <usbdev allow='no'/>
    </redirfilter>
...

5. Check the usb device in guest. Can find the usb device.

[root@localhost ~]# lsusb
Bus 001 Device 002: ID 0627:0001 Adomax Technology Co., Ltd
Bus 001 Device 003: ID 0951:1656 Kingston Technology DataTraveler Ultimate G2         <== can find the usb device
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub


6. Start guest with 'version=2.0' or 'version=1.0' element.

[root@localhost ~]# virsh destroy r7
Domain r7 destroyed

[root@localhost ~]# virsh edit r7
Domain r7 XML configuration edited.

[root@localhost ~]# virsh start r7
Domain r7 started

[root@localhost ~]# ps -aux | grep qemu
... -chardev socket,id=charredir0,host=localhost,port=4000 -device usb-redir,chardev=charredir0,id=redir0,filter=0x08:0x0951:0x1656:0x0200:1|-1:-1:-1:-1:0 ...

[root@localhost ~]# virsh dumpxml r7
...
    <redirdev bus='usb' type='tcp'>
      <source mode='connect' host='localhost' service='4000'/>
      <protocol type='raw'/>
      <alias name='redir0'/>
    </redirdev>
    <redirfilter>
      <usbdev class='0x08' vendor='0x0951' product='0x1656' version='2.0' allow='yes'/>    <== or version='1.0'
      <usbdev allow='no'/>
    </redirfilter>
...

7. Check the usb device in guest. Can not find the usb device.

[root@localhost ~]# lsusb
Bus 001 Device 002: ID 0627:0001 Adomax Technology Co., Ltd
Bus 001 Device 001: ID 1d6b:0002 Linux Foundation 2.0 root hub
Bus 002 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 003 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
Bus 004 Device 001: ID 1d6b:0001 Linux Foundation 1.1 root hub
                                  <== can not find the usb device


Actual results:
As steps.


Expected results:
For step 7, the usb 3.0 device should be exist in guest.


Additional info:

Comment 3 Ján Tomko 2015-03-12 12:30:57 UTC

The 'version' field refers to the revision of the device (bcdDevice in lsusb output), not the revision of the USB protocol (bcdUSB).

Its documentation does not seem clear to me, I've sent a patch to improve it:
https://www.redhat.com/archives/libvir-list/2015-March/msg00620.html

Comment 4 Ján Tomko 2015-03-13 14:42:47 UTC

Pushed upstream:
commit 76a2a5ce8ba319c63e5c5572d41d768a48d371b5
Author:     Ján Tomko <jtomko>
CommitDate: 2015-03-13 14:05:02 +0100

    Clarify the meaning of version in redirdev filters
    
    The version attribute in redirdev filters refers to the revision
    of the device, not the version of the USB protocol.
    
    Explicitly state that this is not the USB protocol and remove references
    to those round version numbers that resemble USB protocol versions.
    
    https://bugzilla.redhat.com/show_bug.cgi?id=1177237

git describe: v1.2.13-155-g76a2a5c

Comment 6 Pei Zhang 2015-05-21 06:18:11 UTC

Verify version :
libvirt-1.2.15-2.el7.x86_64

steps :
1.yum install all libvirt-1.2.15-2.el7 packets
2.check in formatdomain.html
# firefox /usr/share/doc/libvirt-docs-1.2.15/html/formatdomain.html
and 
http://libvirt.org/formatdomain.html#elementsRedir

......
  <usbdev class='0x08' vendor='0x1234' product='0xbeef' version='2.56' allow='yes'/>  
......
redirfilter
......version is the device revision from the bcdDevice field (not the version of the USB protocol). ......

It has a clear documentation now .
move to verified .

Comment 8 errata-xmlrpc 2015-11-19 06:05:54 UTC

Since the problem described in this bug report should be
resolved in a recent advisory, it has been closed with a
resolution of ERRATA.

For information on the advisory, and where to find the updated
files, follow the link below.

If the solution does not work for you, open a new bug report.

https://rhn.redhat.com/errata/RHBA-2015-2202.html

Note You need to log in before you can comment on or make changes to this bug.