File: //lib/python3.9/site-packages/yubico/__pycache__/yubikey_usb_hid.cpython-39.pyc
a
O�b�X � @ sL d Z g d�ZddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
dd
l m Z m Z m
Z
dd l
mZ d d
lZd d
lZd d
lZd d
lZdZdZdZd ZdZdZdZdZdZe j e j d�e j e j d�d�Z G dd� dej!�Z"G dd� de
j#�Z$G dd� de%�Z&G d d � d e�Z'G d d � d e%�Z(G d d!� d!ej)�Z*d
S )"z(
module for accessing a USB HID YubiKey
)�
YubiKeyUSBHID�YubiKeyUSBHIDError�YubiKeyUSBHIDStatus� )� __version__)� yubico_util)�yubico_exception)�
yubikey_frame)�yubikey_config)� yubikey_defs)� yubikey_base)�SLOT�
YUBICO_VID�PID)�YubiKey� N� � � i� � � �r � ��HMAC�OTPc @ s e Zd ZdZdS )r z= Exception raised for errors with the USB HID communication. N)�__name__�
__module__� __qualname__�__doc__� r r �:/usr/lib/python3.9/site-packages/yubico/yubikey_usb_hid.pyr 4 s r c sp e Zd ZdZ� fdd�Zdd� Zdd� Zdd � Zd
d � Zd d
� Z dd� Z
dd� Z dd� Z dd� Z
dd� Z� ZS )�YubiKeyUSBHIDCapabilitiesz�
Capture the capabilities of the various versions of YubiKeys.
Overrides just the functions from YubiKeyCapabilities() that are available
in one or more versions, leaving the other ones at False through default_answer.
c s t t| �j|||d� d S )N��model�version�default_answer)�superr! �__init__)�selfr# r$ r% �� __class__r r r' ? s
�z"YubiKeyUSBHIDCapabilities.__init__c C s dS )zG Yubico OTP support has always been available in the standard YubiKey. Tr �r( r r r �have_yubico_OTPE s z)YubiKeyUSBHIDCapabilities.have_yubico_OTPc C s |dvr dS | j dkS )z* OATH HOTP was introduced in YubiKey 2.2. )ZHOTPF�r r r �r$ �r( �moder r r � have_OATHI s z#YubiKeyUSBHIDCapabilities.have_OATHc C s |dvr dS | j dkS )z3 Challenge-response was introduced in YubiKey 2.2. r F�r r r r. r/ r r r �have_challenge_responseO s z1YubiKeyUSBHIDCapabilities.have_challenge_responsec C s
| j dkS )zW Reading serial number was introduced in YubiKey 2.2, but depends on extflags set too. r2 r. r+ r r r �have_serial_numberU s z,YubiKeyUSBHIDCapabilities.have_serial_numberc C s |j | j| jd�S �N�r# r$ �Z
is_compatibler# r$ �r( �flagr r r �have_ticket_flagY s z*YubiKeyUSBHIDCapabilities.have_ticket_flagc C s |j | j| jd�S r5 r7 r8 r r r �have_config_flag\ s z*YubiKeyUSBHIDCapabilities.have_config_flagc C s |j | j| jd�S r5 r7 r8 r r r �have_extended_flag_ s z,YubiKeyUSBHIDCapabilities.have_extended_flagc C s
| j dkS �N)r r r r. r+ r r r � have_extended_scan_code_modeb s z6YubiKeyUSBHIDCapabilities.have_extended_scan_code_modec C s
| j dkS r= r. r+ r r r �have_shifted_1_modee s z-YubiKeyUSBHIDCapabilities.have_shifted_1_modec C s |dv S )Nr r )r( �slotr r r �have_configuration_sloth s z1YubiKeyUSBHIDCapabilities.have_configuration_slot)r r r r r' r, r1 r3 r4 r: r; r< r> r? rA �
__classcell__r r r) r r! 8 s r! c @ s� e Zd ZdZd'dd�Zdd� Zdd � Zd
d � Zd(d d
�Zdd� Z dd� Z
dd� Z d)dd�Z d*dd�Z
d+dd�Zd,d d �Zd-d d �Zd d!� Zd.d"d#�Zd/d%d&�ZdS )0�YubiKeyHIDDevicezP
High-level wrapper for low-level HID commands for a HID based YubiKey.
Fr c C s* || _ d| _| �|�s td��| �� dS )��
Find and connect to a YubiKey (USB HID).
Attributes :
skip -- number of YubiKeys to skip
debug -- True or False
Nz%YubiKey USB HID initialization failed)�debug� _usb_handle�_openr �status)r( rE �skipr r r r' q s
zYubiKeyHIDDevice.__init__c C s | � � }t|�| _| jS �z*
Poll YubiKey for status.
)�_readr �_status�r( �datar r r rH s
zYubiKeyHIDDevice.statusc C s. z| j r| �� W n ttfy( Y n0 d S �N)rF �_close�IOError�AttributeErrorr+ r r r �__del__� s
zYubiKeyHIDDevice.__del__c C s� | j j}|j|d�}| �dt�|j�|f � | �|� | �t j
� | � � | �d||| j jf � | j � � }|s�| j jdkr�dS | j j|d kr�dS t
d|| j jf ��dS )z! Write configuration to YubiKey. )r@ zWriting %s frame :
%s
z&Programmed slot %i, sequence %i -> %i
r Nr z6YubiKey programming failed (seq %i not increased (%i)))rL �pgm_seqZto_frame�_debugr Z command2str�command�_write�_waitfor_clearr
�SLOT_WRITE_FLAGrH �
valid_configsr )r( �cfgr@ Z old_pgm_seq�frameZcfgsr r r �
_write_config� s" �
�z YubiKeyHIDDevice._write_configc C sn | � tj|�dd� }| �� }t�|d �}|tj@ rb|d@ }|rL|dkrLqb||dd� 7 }qqbq| �� |S )z7 Wait for a response to become available, and read it. N� � r )� _waitfor_setr
ZRESP_PENDING_FLAGrK r �ord_byte� _write_reset)r( � may_block�res�this�flags�seqr r r �_read_response� s
z YubiKeyHIDDevice._read_responsec C s� t tB tB }td> }| jj|tt|td�}t |�tkrP| �
dt|f � t d��d� dd� |D ��}| �
dt
j|d d
� � |S ) z1 Read a USB HID feature report from the YubiKey. r ��value�timeoutz7Failed reading %i bytes (got %i) from USB HID YubiKey.
z#Failed reading from USB HID YubiKey� c s s | ]}t �|�V qd S rO )r Zchr_byte)�.0�cr r r � <genexpr>� rl z)YubiKeyHIDDevice._read.<locals>.<genexpr>z
READ : %sT�Zcolorize)�_USB_TYPE_CLASS�_USB_RECIP_INTERFACE�_USB_ENDPOINT_IN�_REPORT_TYPE_FEATURErF �
controlMsg�_HID_GET_REPORT�_FEATURE_RPT_SIZE�_USB_TIMEOUT_MS�lenrU r �joinr �hexdump)r( � request_typerj ZrecvrN r r r rK � s � �zYubiKeyHIDDevice._readc C sB |j | jd�D ].}d}| jr$|\}}| �tj� | �||� qdS )zy
Write a YubiKeyFrame to the USB HID.
Includes polling for YubiKey readiness before each write.
)rE NT)Zto_feature_reportsrE rX r
rY �
_raw_write)r( r\ rN � debug_strr r r rW � s zYubiKeyHIDDevice._writec C s d}| � |� | �tj� dS )z;
Reset read mode by issuing a dummy write.
s �T)r} rX r
rY rM r r r rb � s
z YubiKeyHIDDevice._write_resetNc C s� | j r6|sd}tj|dd�dd� }| �d||f � ttB tB }td> }| jj |t
||t d�}|t kr�| � d t |f � t
d
��|S ) z(
Write data to YubiKey.
� Trp N���zWRITE : %s %s
r ri z7Failed writing %i bytes (wrote %i) to USB HID YubiKey.
z!Failed talking to USB HID YubiKey)rE r r{ rU rq rr �_USB_ENDPOINT_OUTrt rF ru �_HID_SET_REPORTrx rw r )r( rN r~ r{ r| rj �sentr r r r} � s& ��zYubiKeyHIDDevice._raw_writec C s | � d||�S )z�
Wait for the YubiKey to turn OFF the bits in 'mask' in status responses.
Returns the 8 bytes last read.
�nand��_waitfor�r( �maskrc r r r rX � s z YubiKeyHIDDevice._waitfor_clearc C s | � d||�S )z�
Wait for the YubiKey to turn ON the bits in 'mask' in status responses.
Returns the 8 bytes last read.
�andr� r� r r r r` � s z YubiKeyHIDDevice._waitfor_setr c
C s` d}d}|d d d }d}|�s\t �|� | �� } t�| d �}
|
tj@ r�|s�d}|
tj@ } | �d| � |r�t d | �} | d d d }|d
kr�|
|@ |ks�d}n | �d t
|
�|
t
|�|f � nD|d kr�|
|@ |kr�d}n | �d
t
|
�|
t
|�|f � n
d�sJ �|�sV|d8 }|dk�rF|d
k�r4d| } nd| } t � | ��t || d�}q | S q dS )z�
Wait for the YubiKey to either turn ON or OFF certain bits in the status byte.
mode is either 'and' or 'nand'
timeout is a number of seconds (precision about ~0.5 seconds)
Fg{�G�z�?r r � r^ Tz0Device indicates RESP_TIMEOUT (%i seconds left)
� r� z0Status %s (0x%x) has not cleared bits %s (0x%x)
r� z,Status %s (0x%x) has not set bits %s (0x%x)
r r z2Timed out waiting for YubiKey to clear status 0x%xz0Timed out waiting for YubiKey to set status 0x%xg �?N)
�time�sleeprK r ra r
ZRESP_TIMEOUT_WAIT_FLAGZRESP_TIMEOUT_WAIT_MASKrU �min�binr ZYubiKeyTimeout)
r( r0 r� rc rk �finishedr� Zwait_numZ resp_timeoutre rf Z seconds_left�reasonr r r r� sP
�
� �
zYubiKeyHIDDevice._waitforc
C s� | � |�}|r*|jd }|jd d | _ntd��z|�� | _| j�d� W nF ty� } z.dt |�v rt| �
d� n
| �
d� W Y d}~n
d}~0 0 z| j� d� W n t j
y� | �
d� Y n0 | j�| j� d S )
z Perform HID initialization r zNo USB YubiKey foundz-could not detach kernel driver from interfacez3The in-kernel-HID driver has already been detached
z"detachKernelDriver not supported!
Nr z)Unable to set configuration, ignoring...
T)�_get_usb_deviceZconfigurationsZ
interfaces�_usb_intr �openrF ZdetachKernelDriver� Exception�strrU ZsetConfiguration�usbZUSBErrorZclaimInterface)r( rI Z
usb_deviceZusb_conf�errorr r r rG ; s$
zYubiKeyHIDDevice._openc C s: | j �� z| j j�d� W n Y n0 d| _d| _ dS )z2
Release the USB interface again.
r NT)rF ZreleaseInterface�devZattach_kernel_driverr� r+ r r r rP U s
zYubiKeyHIDDevice._closec s� z2ddl � ddl� � fdd�� jjdtd�D �}W n, ty^ ddl� dd� � �� D �}Y n0 |D ]8}|jtkrd|j t
j dd�v rd|dkr�| S |d 8 }qddS )
z�
Get YubiKey USB device.
Optionally allows you to skip n devices, to support multiple attached YubiKeys.
r Nc s g | ]}� j �|��qS r )�legacyZDevice)rm �d�r� r r �
<listcomp>n rl z4YubiKeyHIDDevice._get_usb_device.<locals>.<listcomp>T)Zfind_all�idVendorc S s g | ]}|j D ]}|�qqS r )�devices)rm Zbusr� r r r r� s rl )Zotpr ) Zusb.coreZ
usb.legacyZcore�findr
� ImportErrorr� Zbussesr� Z idProductr �all)r( rI r� Zdevicer r� r r� c s �
z YubiKeyHIDDevice._get_usb_deviceTc C sF | j rB|r6| jj}t| d�r&t| d�}tj�d| � tj�|� dS )z/ Print out to stderr, if debugging is enabled. Z debug_prefixz%s: N)rE r* r �hasattr�getattr�sys�stderr�write)r( �outZ print_prefixZprer r r rU | s
zYubiKeyHIDDevice._debug)Fr )F)N)F)F)r )r )r )T)r r r r r' rH rS r] rh rK rW rb r} rX r` r� rG rP r� rU r r r r rC l s"
7
rC c s� e Zd ZdZdZdZeZd"� fdd� Zd d
� Z d d � Z
d
d� Z dd� Z dd� Z
d#dd�Zd$dd�Zdd� Zd%d d �Zd d � Zd d!� Z� ZS )&r a�
Class for accessing a YubiKey over USB HID.
This class is for communicating specifically with standard YubiKeys
(USB vendor id = 0x1050, product id = 0x10) using USB HID.
There is another class for the YubiKey NEO BETA, even though that
product also goes by product id 0x10 for the BETA versions. The
expectation is that the final YubiKey NEO will have it's own product id.
Tested with YubiKey versions 1.3 and 2.2.
r zYubiKey (or YubiKey NANO)Fr Nc sH t t| ��|� |du r&t||�| _n|| _| j| j| �� dd�| _dS )rD NFr" ) r& r r' rC �_device�_capabilities_clsr# � version_num� capabilities)r( rE rI Z
hid_devicer) r r r' � s ��zYubiKeyUSBHID.__init__c C s d| j jtt| ��| �� f S )Nz'<%s instance at %s: YubiKey version %s>)r* r �hex�idr$ r+ r r r �__repr__� s
�zYubiKeyUSBHID.__repr__c C s d| j | �� f S )Nz%s (%s)r6 r+ r r r �__str__� s zYubiKeyUSBHID.__str__c C s
| j �� S rJ )r� rH r+ r r r rH � s zYubiKeyUSBHID.statusc C s | j j�� S )z; Get the YubiKey version as a tuple (major, minor, build). )r� rL �ykverr+ r r r r� � s zYubiKeyUSBHID.version_numc C s | j j�� S )z Get the YubiKey version. )r� rL r$ r+ r r r r$ � s zYubiKeyUSBHID.versionTc C s& | j �� s t�d| �� ��| �|�S )z7 Get the YubiKey serial number (requires YubiKey 2.2). z'Serial number unsupported in YubiKey %s)r� r4 r �YubiKeyVersionErrorr$ � _read_serial)r( rc r r r �serial� s
zYubiKeyUSBHID.serialr r c C s4 | j �|�s"t�d|| �� f ��| �|||||�S )zR Issue a challenge to the YubiKey and return the response (requires YubiKey 2.2). z/%s challenge-response unsupported in YubiKey %s)r� r3 r r� r$ �_challenge_response)r( � challenger0 r@ �variablerc r r r �challenge_response� s z YubiKeyUSBHID.challenge_responsec K s t f | �� | jd�|��S )z6 Get a configuration object for this type of YubiKey. �r� r� )�YubiKeyConfigUSBHIDr� r� )r( �kwr r r � init_config� s
��zYubiKeyUSBHID.init_configc C sZ |� � }|| �� kr4t�d|d |d | �� f ��| j�|�sLtd| ��| j� ||�S )z' Write a configuration to the YubiKey. z9Configuration requires YubiKey version %i.%i (this is %s)r r z$Can't write configuration to slot %i)
Zversion_requiredr� r r� r$ r� rA r r� r] )r( r[ r@ Z cfg_req_verr r r � write_config� s � zYubiKeyUSBHID.write_configc C sV t jtjd�}| j�|� | jj|d�}t�|dd� �sBt d��t
� d|�}|d S )z. Read the serial number from a YubiKey > 2.2. )rV �rc Nr� �!Read from device failed CRC checkz>lxxxr ) r � YubiKeyFramer Z
DEVICE_SERIALr� rW rh r �validate_crc16r �struct�unpack)r( rc r\ �responser� r r r r� � s zYubiKeyUSBHID._read_serialc C s> |dkrnt |�tjkr.t�dtjt |�f ��t |�tjk rfd}|rX|dd� |krXd}|�tj|�}tj}nP|dkr�t |�tjkr�t�dtjt |�f ��|�tjd�}d }nt�d
| ��zt| | }W n t�d | ��Y n0 t j
||d �} | j � | � | j j
|d
�}
t�|
d|d � ��s2td��|
d|� S )z- Do challenge-response with a YubiKey > 2.0. r z#Mode HMAC challenge too big (%i/%i)� r� N� �r z,Mode OTP challenge must be %i bytes (got %i)� z9Invalid mode supplied (%s, valid values are HMAC and OTP)zInvalid slot specified (%s))rV Zpayloadr� r r� )ry r
ZSHA1_MAX_BLOCK_SIZEr Z
InputError�ljustZSHA1_DIGEST_SIZEZUID_SIZE�_CMD_CHALLENGEr r� r� rW rh r r� r ) r( r� r0 r@ r� rc Zpad_withZ response_lenrV r\ r� r r r r� � s> � �� z!YubiKeyUSBHID._challenge_response)Fr N)T)r r TT)r )r r r r r# � descriptionr! r� r' r� r� rH r� r$ r� r� r� r� r� r� rB r r r) r r � s
r c @ s@ e Zd ZdZdZdZdd� Zdd� Zdd � Zd
d � Z d d
� Z
dS )r zD Class to represent the status information we get from the YubiKey. r r c C s, d}t �||�\| _| _| _| _| _| _d S )Nz <x BBB B H B)r� r� �
version_major�
version_minor�
version_buildrT � touch_levelrf )r( rN Zfmtr r r r' s
��z YubiKeyUSBHIDStatus.__init__c C sZ d}d}| � � dkr d| �� }| jr0d| j }d| jjtt| ��| �� | j| j ||f S )Nr r- z
, valid=%sz
(flags 0x%x)zG<%s instance at %s: YubiKey version %s, pgm_seq=%i, touch_level=%i%s%s>)
r� rZ rf r* r r� r� r$ rT r� )r( Z valid_strZ flags_strr r r r� ' s
�z YubiKeyUSBHIDStatus.__repr__c C s | j | j| jfS )zQ Returns a tuple with the (major, minor, build) version of the YubiKey firmware. )r� r� r� r+ r r r r� 9 s zYubiKeyUSBHIDStatus.ykverc C s d| � � }|S )z2 Return the YubiKey firmware version as a string. z%d.%d.%d)r� )r( r$ r r r r$ = s zYubiKeyUSBHIDStatus.versionc C s\ | � � dk r td| �� ��g }| j| j@ | jkr<|�d� | j| j@ | jkrX|�d� |S )zL Return a list of slots having a valid configurtion. Requires firmware 2.1. r- z(Valid configs unsupported in firmware %sr r )r� r r$ r� �
CONFIG1_VALID�append�
CONFIG2_VALID)r( rd r r r rZ B s
z!YubiKeyUSBHIDStatus.valid_configsN) r r r r r� r� r' r� r� r$ rZ r r r r r s r c s" e Zd ZdZd� fdd� Z� ZS )r� z3
Configuration class for USB HID YubiKeys.
Nc s t t| �jf ||d�|�� d S )Nr� )r& r� r' )r( r� r� r� r) r r r' R s z YubiKeyConfigUSBHID.__init__)N)r r r r r' rB r r r) r r� N s r� )+r �__all__Zyubico_versionr r r r r r r
r r r
r r r� r� r� r� rq rr rs r� rv r� rx rw rt Z
CHAL_HMAC1Z
CHAL_HMAC2Z CHAL_OTP1Z CHAL_OTP2r� Z YubicoErrorr ZYubiKeyCapabilitiesr! �objectrC r r Z
YubiKeyConfigr� r r r r �<module> sF �4 ?