You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
174 lines
5.6 KiB
174 lines
5.6 KiB
# This file is part of the Trezor project.
|
|
#
|
|
# Copyright (C) 2012-2018 SatoshiLabs and contributors
|
|
#
|
|
# This library is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License version 3
|
|
# as published by the Free Software Foundation.
|
|
#
|
|
# This library is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU Lesser General Public License for more details.
|
|
#
|
|
# You should have received a copy of the License along with this library.
|
|
# If not, see <https://www.gnu.org/licenses/lgpl-3.0.html>.
|
|
|
|
import atexit
|
|
import sys
|
|
import time
|
|
from typing import Iterable, Optional
|
|
|
|
import usb1
|
|
|
|
from . import TransportException
|
|
from .protocol import ProtocolBasedTransport, get_protocol
|
|
|
|
if False:
|
|
# mark Optional as used, otherwise it only exists in comments
|
|
Optional
|
|
|
|
DEV_TREZOR1 = (0x534C, 0x0001)
|
|
DEV_TREZOR2 = (0x1209, 0x53C1)
|
|
DEV_TREZOR2_BL = (0x1209, 0x53C0)
|
|
|
|
INTERFACE = 0
|
|
ENDPOINT = 1
|
|
DEBUG_INTERFACE = 1
|
|
DEBUG_ENDPOINT = 2
|
|
|
|
|
|
class WebUsbHandle:
|
|
def __init__(self, device: usb1.USBDevice, debug: bool = False) -> None:
|
|
self.device = device
|
|
self.interface = DEBUG_INTERFACE if debug else INTERFACE
|
|
self.endpoint = DEBUG_ENDPOINT if debug else ENDPOINT
|
|
self.count = 0
|
|
self.handle = None # type: Optional[usb1.USBDeviceHandle]
|
|
|
|
def open(self) -> None:
|
|
self.handle = self.device.open()
|
|
if self.handle is None:
|
|
if sys.platform.startswith("linux"):
|
|
args = (
|
|
"Do you have udev rules installed? https://github.com/trezor/trezor-common/blob/master/udev/51-trezor.rules",
|
|
)
|
|
else:
|
|
args = ()
|
|
raise IOError("Cannot open device", *args)
|
|
self.handle.claimInterface(self.interface)
|
|
|
|
def close(self) -> None:
|
|
if self.handle is not None:
|
|
self.handle.releaseInterface(self.interface)
|
|
self.handle.close()
|
|
self.handle = None
|
|
|
|
def write_chunk(self, chunk: bytes) -> None:
|
|
assert self.handle is not None
|
|
if len(chunk) != 64:
|
|
raise TransportException("Unexpected chunk size: %d" % len(chunk))
|
|
self.handle.interruptWrite(self.endpoint, chunk)
|
|
|
|
def read_chunk(self) -> bytes:
|
|
assert self.handle is not None
|
|
endpoint = 0x80 | self.endpoint
|
|
while True:
|
|
chunk = self.handle.interruptRead(endpoint, 64)
|
|
if chunk:
|
|
break
|
|
else:
|
|
time.sleep(0.001)
|
|
if len(chunk) != 64:
|
|
raise TransportException("Unexpected chunk size: %d" % len(chunk))
|
|
return chunk
|
|
|
|
|
|
class WebUsbTransport(ProtocolBasedTransport):
|
|
"""
|
|
WebUsbTransport implements transport over WebUSB interface.
|
|
"""
|
|
|
|
PATH_PREFIX = "webusb"
|
|
context = None
|
|
|
|
def __init__(
|
|
self, device: str, handle: WebUsbHandle = None, debug: bool = False
|
|
) -> None:
|
|
if handle is None:
|
|
handle = WebUsbHandle(device, debug)
|
|
|
|
self.device = device
|
|
self.handle = handle
|
|
self.debug = debug
|
|
|
|
protocol = get_protocol(handle, is_trezor2(device))
|
|
super().__init__(protocol=protocol)
|
|
|
|
def get_path(self) -> str:
|
|
return "%s:%s" % (self.PATH_PREFIX, dev_to_str(self.device))
|
|
|
|
@classmethod
|
|
def enumerate(cls) -> Iterable["WebUsbTransport"]:
|
|
if cls.context is None:
|
|
cls.context = usb1.USBContext()
|
|
cls.context.open()
|
|
atexit.register(cls.context.close)
|
|
devices = []
|
|
for dev in cls.context.getDeviceIterator(skip_on_error=True):
|
|
if not (is_trezor1(dev) or is_trezor2(dev) or is_trezor2_bl(dev)):
|
|
continue
|
|
if not is_vendor_class(dev):
|
|
continue
|
|
try:
|
|
# workaround for issue #223:
|
|
# on certain combinations of Windows USB drivers and libusb versions,
|
|
# Trezor is returned twice (possibly because Windows know it as both
|
|
# a HID and a WebUSB device), and one of the returned devices is
|
|
# non-functional.
|
|
dev.getProduct()
|
|
devices.append(WebUsbTransport(dev))
|
|
except usb1.USBErrorNotSupported:
|
|
pass
|
|
return devices
|
|
|
|
def find_debug(self) -> "WebUsbTransport":
|
|
if self.protocol.VERSION >= 2:
|
|
# TODO test this
|
|
# XXX this is broken right now because sessions don't really work
|
|
# For v2 protocol, use the same WebUSB interface with a different session
|
|
return WebUsbTransport(self.device, self.handle)
|
|
else:
|
|
# For v1 protocol, find debug USB interface for the same serial number
|
|
return WebUsbTransport(self.device, debug=True)
|
|
|
|
|
|
def is_trezor1(dev: usb1.USBDevice) -> bool:
|
|
return (dev.getVendorID(), dev.getProductID()) == DEV_TREZOR1
|
|
|
|
|
|
def is_trezor2(dev: usb1.USBDevice) -> bool:
|
|
return (dev.getVendorID(), dev.getProductID()) == DEV_TREZOR2
|
|
|
|
|
|
def is_trezor2_bl(dev: usb1.USBDevice) -> bool:
|
|
return (dev.getVendorID(), dev.getProductID()) == DEV_TREZOR2_BL
|
|
|
|
|
|
def is_vendor_class(dev: usb1.USBDevice) -> bool:
|
|
configurationId = 0
|
|
altSettingId = 0
|
|
return (
|
|
dev[configurationId][INTERFACE][altSettingId].getClass()
|
|
== usb1.libusb1.LIBUSB_CLASS_VENDOR_SPEC
|
|
)
|
|
|
|
|
|
def dev_to_str(dev: usb1.USBDevice) -> str:
|
|
return ":".join(
|
|
str(x) for x in ["%03i" % (dev.getBusNumber(),)] + dev.getPortNumberList()
|
|
)
|
|
|
|
|
|
TRANSPORT = WebUsbTransport
|