o _,@sddZddlZddlZddlZddlZddlmZddlmZddZefddZ Gd d d e Z dS) zHID Transport for U2F. This module imports the U2F HID Transport protocol as well as methods for discovering devices implementing this protocol. N)errors)hidcCs |ddkr|ddkrdSdS)NZ usage_pageiusageTF)Zdevicerr2lib/python3.10/site-packages/pyu2f/hidtransport.pyHidUsageSelectorsrc csLtD]}||r#zt|d}t|VWqty"YqwqdS)Npath)rZ EnumerateZOpenUsbHidTransportOSError)selectorddevrrrDiscoverLocalHIDU2FDevices#s  rc@seZdZdZdZdZdZdZdZdZ dZ d Z e gd Z e d gZGd d d eZGdddeZd(ddZddZddZddZddZddZddZdd Zd!d"Zd#d$Zd%d&Zd'S))r amImplements the U2FHID transport protocol. This class implements the U2FHID transport protocol from the FIDO U2F specs. This protocol manages fragmenting longer messages over a short hid frame (usually 64 bytes). It exposes an APDU channel through the MSG command as well as a series of other commands for configuring and interacting with the device. )rrrc@,eZdZdZddZddZeddZdS) zUsbHidTransport.InitPacketaRepresent an initial U2FHID packet. Represent an initial U2FHID packet. This packet contains metadata necessary to interpret the entire packet stream associated with a particular exchange (read or write). Attributes: packet_size: The size of the hid report (packet) used. Usually 64. cid: The channel id for the connection to the device. size: The size of the entire message to be sent (including all continuation packets) payload: The portion of the message to put into the init packet. This must be smaller than packet_size - 7 (the overhead for an init packet). cCs`||_t|dks|dks|dkrtt||jdkr"t||_||_||_||_dS)Nri) packet_sizelenrInvalidPacketErrorcidcmdsizepayload)selfrr r!r"r#rrr__init__Vs z#UsbHidTransport.InitPacket.__init__cCsXtd}|j|dd<|j|d<td|d|j|j|ddt|j<tt t |S)Serializes the packet.@rr>Hr) bytearrayr r!struct pack_intor"r#rlistmapintr$retrrr ToWireFormatbs  z'UsbHidTransport.InitPacket.ToWireFormatcCsnt|}t||krt|dd}|d}tdt|ddd}|dd|}t|||||S)amDerializes the packet. Deserializes the packet from wire format. Args: packet_size: The size of all packets (usually 64) data: List of ints or bytearray containing the data from the wire. Returns: InitPacket object for specified data Raises: InvalidPacketError: if the data isn't a valid InitPacket rrr(r)r) r*rrrr+unpackbytesr InitPacket)rdatabar r!r"r#rrrFromWireFormatks  z)UsbHidTransport.InitPacket.FromWireFormatN__name__ __module__ __qualname____doc__r%r2 staticmethodr8rrrrr5Es   r5c@r) zUsbHidTransport.ContPacketaRepresents a continutation U2FHID packet. Represents a continutation U2FHID packet. These packets follow the intial packet and contains the remaining data in a particular message. Attributes: packet_size: The size of the hid report (packet) used. Usually 64. cid: The channel id for the connection to the device. seq: The sequence number for this continuation packet. The first continuation packet is 0 and it increases from there. payload: The payload to put into this continuation packet. This must be less than packet_size - 5 (the overhead of the continuation packet is 5). cCsF||_||_||_||_t||jdkrt|dkr!tdS)Nr))rr seqr#rrr)r$rr r@r#rrrr%sz#UsbHidTransport.ContPacket.__init__cCsHt|j}|j|dd<|j|d<|j|ddt|j<ttt|S)r&rrr)) r*rr r@r#rr-r.r/r0rrrr2s  z'UsbHidTransport.ContPacket.ToWireFormatcCsLt|}t||krt|dd}|d}|dd}t||||S)amDerializes the packet. Deserializes the packet from wire format. Args: packet_size: The size of all packets (usually 64) data: List of ints or bytearray containing the data from the wire. Returns: InitPacket object for specified data Raises: InvalidPacketError: if the data isn't a valid ContPacket rrr)N)r*rrrr ContPacket)rr6r7r r@r#rrrr8s   z)UsbHidTransport.ContPacket.FromWireFormatNr9rrrrrAs  rA@cCs^||_|}|}||krtd|dkrtd||_||_td|_ | dS)Nz6unsupported device with different in/out packet sizes.rzunable to determine packet sizezpyu2f.hidtransport) hid_deviceZGetInReportDataLengthZGetOutReportDataLengthr HardwareErrorrread_timeout_secsloggingZ getLoggerlogger InternalInit)r$rCrEZin_sizeZout_sizerrrr%s   zUsbHidTransport.__init__cCs|tj|}|SN)InternalExchanger U2FHID_MSG)r$msgrrrr SendMsgBytesszUsbHidTransport.SendMsgBytescCs|tjt|gSrI)rJr U2FHID_PROMPTr*)r$lengthrrr SendBlinkszUsbHidTransport.SendBlinkcCs|tjtgSrI)rJr U2FHID_WINKr*)r$rrrSendWinkszUsbHidTransport.SendWinkcCs|tj|SrI)rJr U2FHID_PING)r$r6rrrSendPingszUsbHidTransport.SendPingcCsttj|_ttd}|tj|}t|dkrt d|dd|kr*t dt|dd|_|d|_ dS)z.Initializes the device and obtains channel id.zunexpected init reply lenrznonce mismatch N) r U2FHID_BROADCAST_CIDr r*osurandomrJ U2FHID_INITrrHidErrorZu2fhid_version)r$ZnoncerMrrrrHs   zUsbHidTransport.InternalInitcCs|jdtt|t}||dd<tdD]5}||||\}}|tj krB|tj kr7t dqt dt|d||krKt d|St d) z-Sends and receives a message from the device.z payload: Ng?zDevice error: %drzCommand mismatch!zDevice Busy. Please retry)rGdebugstrr-r*range InternalSend InternalRecvr U2FHID_ERRORERR_CHANNEL_BUSYtimesleeprr]r/)r$r!Z payload_inr#_Zret_cmdZ ret_payloadrrrrJs         z UsbHidTransport.InternalExchangec Cst|}|jd}|d|}t|j|j|t||}|d|=|t|8}||d}|dkra|jd}|d|}|d|=|t|8}t|j|j||} || |d7}|dks2dSdS)z8Sends a message to the device, including fragmenting it.rrr)rN)rrr r5r InternalSendPacketrA) r$r!r#Zlength_to_sendZ max_payloadZ first_frame first_packetr@Z next_frame next_packetrrrrbs*          zUsbHidTransport.InternalSendcCs,|}|jdt||j|dS)Nzsending packet: )r2rGr_r`rCZWrite)r$ZpacketZwirerrrrisz"UsbHidTransport.InternalSendPacketcCs"|j}|jdt||S)Nzrecv: )rCZReadrGr_r`)r$framerrrInternalReadFrame s z!UsbHidTransport.InternalReadFramecCs|}tj|j|}|j}|jt|j}d}|dkrO|}tj|j|}|j |j kr0q||j kr:t d|t|j8}| |j|d7}|dks|d|j}|j|fS)z?Receives a message from the device, including defragmenting it.rzPackets received out of orderr)rmr r5r8rr#r"rrAr r@rrDextendr!)r$Z first_readrjr6Zto_readr@Z next_readrkrrrrc)s,       zUsbHidTransport.InternalRecvN)rB)r:r;r<r=rTrKrRrOr\Z U2FHID_LOCKrdZ U2FHID_SYNCr*rYreobjectr5rAr%rNrQrSrUrHrJrbrirmrcrrrrr .s2   ? ?  r ) r=rFrZr+rfZpyu2frrrrror rrrrs