o l>j1@sddlmZddlZddlZddlmZmZddlmZddl m Z m Z m Z ddl mZddlmZd d lmZmZd d lmZeeZGd d d ZGdddeZGdddZGdddeZdS)) annotationsN)IntEnumunique)Event)AnyCallableMapping)cbor) CtapError)Ctap2Info) PinProtocolc@sjeZdZeGdddeZeGdddeZeGdddeZedd d Z dddZ dddZ dS) BioEnrollmentc@s,eZdZdZdZdZdZdZdZdZ dZ d S) zBioEnrollment.RESULTr r N) __name__ __module__ __qualname__MODALITYFINGERPRINT_KINDMAX_SAMPLES_REQUIRED TEMPLATE_IDLAST_SAMPLE_STATUSREMAINING_SAMPLESTEMPLATE_INFOSMAX_TEMPLATE_FRIENDLY_NAMEr"r"D/home/thesage/.local/lib/python3.10/site-packages/fido2/ctap2/bio.pyRESULT-sr$c@seZdZdZdZdS)zBioEnrollment.TEMPLATE_INFOr r N)rrrIDNAMEr"r"r"r# TEMPLATE_INFO8sr'c@seZdZdZdS)zBioEnrollment.MODALITYr N)rrr FINGERPRINTr"r"r"r#r=srinforreturnboolcCs*d|jvrdSd|jvrd|jvrdSdS)N bioEnrollT FIDO_2_1_PREuserVerificationMgmtPreviewF)optionsversions)r)r"r"r# is_supportedAs   zBioEnrollment.is_supportedctapr modalitycCsB||js td||_||_||jkrtd|ddS)Nz(Authenticator does not support BioEnrollzDevice does not support s)r1r) ValueErrorr2 get_modalityr3)selfr2r3r"r"r#__init__Ms   zBioEnrollment.__init__intcCs|jjddtjjS)zaGet bio modality. :return: The type of modality supported by the authenticator. T)r6)r2bio_enrollmentrr$rr7r"r"r#r6Vs zBioEnrollment.get_modalityN)r)rr*r+)r2r r3r)r*r9) rrrrrr$r'r staticmethodr1r8r6r"r"r"r#r,s    rcseZdZdfdd ZZS) CaptureErrorcoder9cs||_td|dS)NzFingerprint capture error: )r>superr8)r7r> __class__r"r#r8aszCaptureError.__init__)r>r9)rrrr8 __classcell__r"r"r@r#r=`sr=c@s6eZdZdZddddZ  ddddZdddZdS)FPEnrollmentContextajHelper object to perform fingerprint enrollment. :param bio: An instance of FPBioEnrollment. :param timeout: Optional timeout for fingerprint captures (ms). :ivar remaining: The number of (estimated) remaining samples needed. :ivar template_id: The ID of the new template (only available after the initial sample has been captured). Nbio'FPBioEnrollment'timeout int | NonecCs||_||_d|_d|_dSN)_biorF template_id remaining)r7rDrFr"r"r#r8ps zFPEnrollmentContext.__init__event Event | None on_keepaliveCallable[[int], None] | Noner* bytes | NonecCsl|jdur|j|j||\|_}|_n|j|j|j||\}|_|tjjkr,t ||jdkr4|jSdS)aTCapture a fingerprint sample. This call will block for up to timeout milliseconds (or indefinitely, if timeout not specified) waiting for the user to scan their fingerprint to collect one sample. :return: None, if more samples are needed, or the template ID if enrollment is completed. Nr) rJrI enroll_beginrFrKenroll_capture_nextFPBioEnrollmentFEEDBACKFP_GOODr=)r7rLrNstatusr"r"r#capturevs    zFPEnrollmentContext.captureNonecCs|jd|_dS)zCancels ongoing enrollment.N)rI enroll_cancelrJr;r"r"r#cancels  zFPEnrollmentContext.cancelrH)rDrErFrG)NN)rLrMrNrOr*rPr*rX)rrr__doc__r8rWrZr"r"r"r#rCfs  rCcseZdZdZeGdddeZeGdddeZeGdddeZd4fdd Z d5ddZ d6ddZ   d7d8dd Z   d7d9d#d$Z d:d&d'Zd;dd0d1Zd?d2d3ZZS)@rSaImplementation of the bio enrollment API. NOTE: The get_fingerprint_sensor_info method does not require authentication, and can be used by setting pin_uv_protocol and pin_uv_token to None. :param ctap: An instance of a CTAP2 object. :param pin_uv_protocol: The PIN/UV protocol version used. :param pin_uv_token: A valid PIN/UV Auth Token for the current CTAP session. c@s(eZdZdZdZdZdZdZdZdZ dS) zFPBioEnrollment.CMDr r rrrrrN) rrr ENROLL_BEGINENROLL_CAPTURE_NEXT ENROLL_CANCELENUMERATE_ENROLLMENTSSET_NAMEREMOVE_ENROLLMENTGET_SENSOR_INFOr"r"r"r#CMDsrdc@seZdZdZdZdZdS)zFPBioEnrollment.PARAMr r rN)rrrr TEMPLATE_NAME TIMEOUT_MSr"r"r"r#PARAMsrgc@sPeZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZddZdS)zFPBioEnrollment.FEEDBACKrr r rrrrrr cCsd|jdd|jS)N0x02Xz - )valuenamer;r"r"r#__str__sz FPBioEnrollment.FEEDBACK.__str__N)rrrrU FP_TOO_HIGH FP_TOO_LOW FP_TOO_LEFT FP_TOO_RIGHT FP_TOO_FAST FP_TOO_SLOWFP_POOR_QUALITY FP_TOO_SKEWED FP_TOO_SHORTFP_MERGE_FAILURE FP_EXISTSFP_DATABASE_FULLNO_USER_ACTIVITYNO_UP_TRANSITIONrrr"r"r"r#rTs" rTr2r pin_uv_protocolr pin_uv_tokenbytescs"t|tjj||_||_dSrH)r?r8rrr(rr)r7r2rrr@r"r#r8s zFPBioEnrollment.__init__NTcCsn|j||||d}|r.td|j|}|dur|t|7}|jj|d<|j|j||d<|j j di|S)N)r3sub_cmdsub_cmd_paramsrLrNz>BBr pin_uv_paramr") r3structpackr encoderVERSION authenticaterr2r:)r7rparamsauthrLrNkwargsmsgr"r"r#_calls zFPBioEnrollment._callr*Mapping[int, Any]cCs|jtjjddS)ztGet fingerprint sensor info. :return: A dict containing FINGERPRINT_KIND and MAX_SAMPLES_REQUIRES. Fr)rrSrdrcr;r"r"r#get_fingerprint_sensor_infosz+FPBioEnrollment.get_fingerprint_sensor_inforFrGrLrMrNrO+tuple[bytes, FPBioEnrollment.FEEDBACK, int]cCsttd|d|jtjj|durtjj|ind||d}td||tj j t |tj j |tj j fS)aStart fingerprint enrollment. Starts the process of enrolling a new fingerprint, and will wait for the user to scan their fingerprint once to provide an initial sample. :param timeout: Optional timeout in milliseconds. :return: A tuple containing the new template ID, the sample status, and the number of samples remaining to complete the enrollment. z)Starting fingerprint enrollment (timeout=)NrLrNSample capture result: )loggerdebugrrSrdr]rgrfrr$rrTrr)r7rFrLrNresultr"r"r#rQs   zFPBioEnrollment.enroll_beginrJ$tuple[FPBioEnrollment.FEEDBACK, int]cCsvtd|dtjj|i}|dur||tjj<|jtjj|||d}td|t |t j j |t j j fS)aContinue fingerprint enrollment. Continues enrolling a new fingerprint and will wait for the user to scan their fingerpring once to provide a new sample. Once the number of samples remaining is 0, the enrollment is completed. :param template_id: The template ID returned by a call to `enroll_begin`. :param timeout: Optional timeout in milliseconds. :return: A tuple containing the sample status, and the number of samples remaining to complete the enrollment. z$Capturing next sample with (timeout=rNrr)rrrSrgrrfrrdr^rTrr$rr)r7rJrFrLrNrrr"r"r#rRs   z#FPBioEnrollment.enroll_capture_nextrXcCs td|jtjjdddS)z*Cancel any ongoing fingerprint enrollment.z"Cancelling fingerprint enrollment.FrN)rrrrSrdr_r;r"r"r#rY)s zFPBioEnrollment.enroll_cancelrCcCs t||S)zConvenience wrapper for doing fingerprint enrollment. See FPEnrollmentContext for details. :return: An initialized FPEnrollmentContext. )rC)r7rFr"r"r#enroll.s zFPBioEnrollment.enrollMapping[bytes, str | None]c Cs\zdd|tjjtjjDWSty-}z|jtj j kr(iWYd}~Sd}~ww)zGet a dict of enrolled fingerprint templates which maps template ID's to their friendly names. :return: A dict of enrolled template_id -> name pairs. cSs"i|] }|tjj|tjjqSr")rr'r%r&).0tr"r"r# =sz9FPBioEnrollment.enumerate_enrollments..N) rrSrdr`rr$r r r>ERRINVALID_OPTION)r7er"r"r#enumerate_enrollments6s z%FPBioEnrollment.enumerate_enrollmentsrqstrcCsHtd|d||tjjtjj |tjj |it ddS)zSet/Change the friendly name of a previously enrolled fingerprint template. :param template_id: The ID of the template to change. :param name: A friendly name to give the template. zChanging name of template: z to zFingerprint template renamedN) rrhexrrSrdrarr'r%r&r))r7rJrqr"r"r#set_nameHszFPBioEnrollment.set_namecCs:td||tjjtjj |it ddS)zzRemove a previously enrolled fingerprint template. :param template_id: The Id of the template to remove. zDeleting template: zFingerprint template deletedN) rrrrrSrdrbrr'r%r))r7rJr"r"r#remove_enrollmentXs  z!FPBioEnrollment.remove_enrollment)r2r rrrr)NTNN)r*r)NNN)rFrGrLrMrNrOr*r) rJrrFrGrLrMrNrOr*rr[rH)rFrGr*rC)r*r)rJrrqrr*rX)rJrr*rX)rrrr\rrrdrgrTr8rrrQrRrYrrrrrBr"r"r@r#rSs0      $ "   rS) __future__rloggingrenumrr threadingrtypingrrrr r2r baser rpinr getLoggerrrr Exceptionr=rCrSr"r"r"r#s      42