a k#dˊ@szddlZddlZddlZddlZddlZddlZddlmZmZm Z ddl m Z m Z m Z mZmZmZmZmZmZddlmZddlmZddlmmZddlmZddlmZddlm Z dd l!m"Z"dd l#m$Z$dd l%m&Z&m'Z'dd l(m)Z)m*Z*m+Z+m,Z,m-Z-m.Z.m/Z/m0Z0er dd l1m2Z2e3dZ4dZ5dZ6dZ7dZ8dZ9dZ:dZ;dZGdddZ?dS)N)ThreadEventRLock) OptionalUnionListTupleAnyTypecastCallable TYPE_CHECKING)Packet)CAN)Scapy_Exception) SuperSocket)conf)LINUX)EDecimal) ObjectPipeselect_objects)ISOTP CAN_MAX_DLENN_PCI_SFN_PCI_CFN_PCI_FCN_PCI_FFISOTP_MAX_DLENISOTP_MAX_DLEN_2015) CANSocketzscapy.contrib.isotpc sleZdZdZdZdddddddddef ddZdd Zd d Zdd dZ dfdd Z e dddZ Z S)ISOTPSoftSocketa This class is a wrapper around the ISOTPSocketImplementation, for the reasons described below. The ISOTPSoftSocket aims to be fully compatible with the Linux ISOTP sockets provided by the can-isotp kernel module, while being usable on any operating system. Therefore, this socket needs to be able to respond to an incoming FF frame with a FC frame even before the recv() method is called. A thread is needed for receiving CAN frames in the background, and since the lower layer CAN implementation is not guaranteed to have a functioning POSIX select(), each ISOTP socket needs its own CAN receiver thread. SuperSocket automatically calls the close() method when the GC destroys an ISOTPSoftSocket. However, note that if any thread holds a reference to an ISOTPSoftSocket object, it will not be collected by the GC. The implementation of the ISOTP protocol, along with the necessary thread, are stored in the ISOTPSocketImplementation class, and therefore: * There no reference from ISOTPSocketImplementation to ISOTPSoftSocket * ISOTPSoftSocket can be normally garbage collected * Upon destruction, ISOTPSoftSocket.close() will be called * ISOTPSoftSocket.close() will call ISOTPSocketImplementation.close() * RX background thread can be stopped by the garbage collector Initialize an ISOTPSoftSocket using the provided underlying can socket. Example (with NativeCANSocket underneath): >>> conf.contribs['ISOTP'] = {'use-can-isotp-kernel-module': False} >>> load_contrib('isotp') >>> with ISOTPSocket("can0", tx_id=0x641, rx_id=0x241) as sock: >>> sock.send(...) Example (with PythonCANSocket underneath): >>> conf.contribs['ISOTP'] = {'use-can-isotp-kernel-module': False} >>> conf.contribs['CANSocket'] = {'use-python-can': True} >>> load_contrib('isotp') >>> with ISOTPSocket(CANSocket(bustype='socketcan', channel="can0"), tx_id=0x641, rx_id=0x241) as sock: >>> sock.send(...) :param can_socket: a CANSocket instance, preferably filtering only can frames with identifier equal to rx_id :param tx_id: the CAN identifier of the sent CAN frames :param rx_id: the CAN identifier of the received CAN frames :param ext_address: the extended address of the sent ISOTP frames :param rx_ext_address: the extended address of the received ISOTP frames :param bs: block size sent in Flow Control ISOTP frames :param stmin: minimum desired separation time sent in Flow Control ISOTP frames :param padding: If True, pads sending packets with 0x00 which not count to the payload. Does not affect receiving packets. :param listen_only: Does not send Flow Control frames if a First Frame is received :param basecls: base class of the packets emitted by this socket TNrFc Cstjr,tr,t|tjr,ddlm} | |}nt|tjr@td||_|pL||_ ||_ ||_ t ||j |j ||j|j ||| d } t tj| |_t tj| |_| |_| |_| durtddS)Nr)NativeCANSocketz"Provide a CANSocket object instead)tx_idrx_idpadding ext_addressrx_ext_addressbsstmin listen_onlyzProvide a basecls )sixPY3r isinstance string_typesZscapy.contrib.cansocket_nativer%rr)r*r&r'ISOTPSocketImplementationr socketZinsZoutsimplbasecls log_isotpwarning) self can_socketr&r'r)r*r+r,r(r-r5r%r4r:\/var/www/html/gsl.tools/lib/python3.9/site-packages/scapy/contrib/isotp/isotp_soft_socket.py__init__ns4     zISOTPSoftSocket.__init__cCs|js|jd|_dS)NT)closedr4closer8r:r:r;r>s zISOTPSoftSocket.closecCs|jdSN)r4failure_analysisr?r:r:r;rAsz ISOTPSoftSocket.failure_analysiscCs<|js0|j}|dur0|j|dt|dfS|jddfS)aReceive a complete ISOTP message, blocking until a message is received or the specified timeout is reached. If self.timeout is 0, then this function doesn't block and returns the first frame in the receive buffer or None if there isn't any.Nrr )r=r4recvr5float)r8xtupr:r:r;recv_raws  zISOTPSoftSocket.recv_rawcshtt||}|durdSt|dr.|j|_t|dr@|j|_t|drR|j|_t|drd|j|_|S)Nr&r'r)r*)superr$rChasattrr&r'r)r*)r8rEmsg __class__r:r;rCs    zISOTPSoftSocket.recvcs*dd|D}t||fdd|DS)zmThis function is called during sendrecv() routine to wait for sockets to be ready to receive cSs$g|]}t|tr|js|jjqSr:r0r$r=r4rx_queue.0rEr:r:r; sz*ISOTPSoftSocket.select..cs,g|]$}t|tr|js|jjvr|qSr:rMrOZ ready_pipesr:r;rQs)r)socketsZremainZ obj_pipesr:rRr;selects zISOTPSoftSocket.select)rB)rB)N)__name__ __module__ __qualname____doc__Znonblocking_socketrr<r>rArGrC staticmethodrT __classcell__r:r:rKr;r$2s&9 - r$c@seZdZdZdZeZeZdZ gZ e ddZ e ddZ e dd Ze d d Ze d d Ze ddZe ddZeddZGdddZdS)TimeoutSchedulerzA timeout scheduler which uses a single thread for all timeouts, unlike python's own Timer objects which use a thread each.皙?NcCs||}|||}|j`t|j||jd|k}|jdurpt|jdd}d}||_|j | Wdn1s0Y|r|j t d|S)zSchedules the execution of a timeout. The function `callback` will be called in `timeout` seconds. Returns a handle that can be used to remove the timeout.rNTimeoutScheduler._task)targetnameF)_timeHandle_mutexheapqheappush_handles_threadr_task_eventclearstartsettimesleep)clstimeoutcallbackwhenhandleZmust_interrupttr:r:r;schedules    &  zTimeoutScheduler.schedulecCst|jZ||jvrJd|_|j|t|jt|jdkrR|jnt dWdn1sf0YdS)z8Provided its handle, cancels the execution of a timeout.NrzHandle not found) rbre_cbremovercheapifylenrhrkr)rnrrr:r:r;cancels    zTimeoutScheduler.cancelcCs:|jg|_Wdn1s"0Y|jdS)z&Cancels the execution of all timeouts.N)rbrerhrkrnr:r:r;ris$zTimeoutScheduler.clearcCs>|j$|jr|jdndWdS1s00YdS)zcReturns the next timeout to execute, or `None` if list is empty, without modifying the listrN)rbrerzr:r:r; _peek_nextszTimeoutScheduler._peek_nextcCsn|}|dur|j}n |j|}|dkr`td|||j|}|}td|||||jdS)ziWaits until it is time to execute the provided handle, or until another thread calls _event.set()Nrz3TimeoutScheduler Thread going to sleep @ %f for %fsz@TimeoutScheduler Thread awake @ %f, slept for %f, interrupted=%d)r`GRACE_whenr6debugrhwaitri)rnrrnowZto_wait interruptednewr:r:r;_wait"s  zTimeoutScheduler._waitc Cstd|d}z|}|durf|}|dur:|}|j||krjWtd|d|_dSnd}|||qWtd|d|_ntd|d|_0dS)zExecuted in a background thread, this thread will automatically start when the first timeout is added and stop when the last timeout is removed or executed.z%TimeoutScheduler Thread spawning @ %fNz!TimeoutScheduler Thread died @ %f)r6r~r`r{r|rfr_poll)rnZ time_emptyrrrr:r:r;rg?s(   r]cCs|jj|}t|jdks.|jdj|kr>WddSt|j}d}|durb|j}d|_Wdn1sv0Yt|rz |Wqt yt Yq0qdS)z1Execute all the callbacks that were due until nowrNT) rbr`rxrer}rcheappoprucallable Exception traceback print_exc)rnrrrrpr:r:r;r_s $  zTimeoutScheduler._pollcCstjrtStSr@)r.PY2rl monotonicr:r:r:r;r`yszTimeoutScheduler._timec@sHeZdZdZddgZddZddZdd Zd d Zd d Z ddZ dS)zTimeoutScheduler.Handlez]Handle for a timeout, consisting of a callback and a time when it should be executed.r}rucCs||_||_dSr@)r}ru)r8rqcbr:r:r;r<sz TimeoutScheduler.Handle.__init__cCsz|jdurtdnbtjLt|jtr8WddSd|_t|WddSWdn1sl0YdS)zKCancels this timeout, preventing it from executing its callbackNz+cancel() called on previous canceled HandleFT)rurr[rbr0boolryr?r:r:r;rys   zTimeoutScheduler.Handle.cancelcCst|tjst|j|jkSr@r0r[ra TypeErrorr}r8otherr:r:r;__lt__s zTimeoutScheduler.Handle.__lt__cCst|tjst|j|jkSr@rrr:r:r;__le__s zTimeoutScheduler.Handle.__le__cCst|tjst|j|jkSr@rrr:r:r;__gt__s zTimeoutScheduler.Handle.__gt__cCst|tjst|j|jkSr@rrr:r:r;__ge__s zTimeoutScheduler.Handle.__ge__N) rUrVrWrX __slots__r<ryrrrrr:r:r:r;rasra)rUrVrWrXr|rrbrrhrfre classmethodrtryrir{rrgrrYr`rar:r:r:r;r[s. "       r[c@seZdZdZd)ddZddZd d Zd d Zd dZddZ ddZ ddZ ddZ ddZ ddZddZddZdd Zd!d"Zd#d$Zd%d&Zd*d'd(ZdS)+r2a Implementation of an ISOTP "state machine". Most of the ISOTP logic was taken from https://github.com/hartkopp/can-isotp/blob/master/net/can/isotp.c This class is separated from ISOTPSoftSocket to make sure the background thread can't hold a reference to ISOTPSoftSocket, allowing it to be collected by the GC. :param can_socket: a CANSocket instance, preferably filtering only can frames with identifier equal to rx_id :param tx_id: the CAN identifier of the sent CAN frames :param rx_id: the CAN identifier of the received CAN frames :param padding: If True, pads sending packets with 0x00 which not count to the payload. Does not affect receiving packets. :param ext_address: Extended Address byte to be added at the beginning of every CAN frame _sent_ by this object. Can be None in order to disable extended addressing on sent frames. :param rx_ext_address: Extended Address byte expected to be found at the beginning of every CAN frame _received_ by this object. Can be None in order to disable extended addressing on received frames. :param bs: Block Size byte to be included in every Control Flow Frame sent by this object. The default value of 0 means that all the data will be received in a single block. :param stmin: Time Minimum Separation byte to be included in every Control Flow Frame sent by this object. The default value of 0 indicates that the peer will not wait any time between sending frames. :param listen_only: Disables send of flow control frames FNrc Cs,||_||_||_||_d|_d|_d|_d|_||_d|_ |durRt d||_ | |_ ||_ ||_ttttttff|_d|_d|_d|_d|_d|_d|_t|_tt|_d|_d|_ d|_!d|_"d|_#d|_$d|_%d|_&t|_'d|_(d|_)d|_*t+,|j(|j-|_.t+,|j(|j/|_0d|_1dS) Nr FBrg{Gzt?)2r9r'r&r( fc_timeout cf_timeoutfilter_warning_emittedr=r*ea_hdrstructpackr-rxfc_bs rxfc_stminrrbytesrrDrrNrx_lenrx_bufrx_snrx_bsrx_idxrx_ts ISOTP_IDLErx_statetx_queuetxfc_bs txfc_stmintx_gaptx_buftx_sntx_bstx_idxrx_ll_dltx_staterx_tx_poll_ratetx_timeout_handlerx_timeout_handler[rtcan_recv rx_handle_send tx_handle last_rx_call) r8r9r&r'r(r)r*r+r,r-r:r:r;r<sV  z"ISOTPSocketImplementation.__init__cCsjtdtdt|jtdt|jtdt|jjtdt|jjtdtdS)NzFailure analysiszLast_rx_call: %szself.rx_handle: %szself.rx_handle._cb: %szself.rx_handle._when: %szNow: %s) r6r~strrrrur}r[r`r?r:r:r;rAs  z*ISOTPSocketImplementation.failure_analysiscCs |dSr@)r>r?r:r:r;__del__!sz!ISOTPSocketImplementation.__del__cCsb|jr|dtt|7}|jdus.|jdkrF|jt|j|dn|jt|jd|ddS)Ni) identifierdataextended)rflagsr)r(rrxr&r9sendr)r8loadr:r:r;can_send%sz"ISOTPSocketImplementation.can_sendcCst|_|j|jgdr4|j}|r4|||jsr|jjsr|j|jgdrZd}n|j}t ||j |_ n"z|j Wnt yYn0dS)Nrr)r[r`rr9rTrC on_can_recvr=rrtrrryr)r8pktZ poll_timer:r:r;r/s     z"ISOTPSocketImplementation.can_recvcCs@|j|jkr2|jsMs(     zISOTPSocketImplementation.closecCs(|jtkr$t|_tjdkr$tddS)zMethod called every time the rx_timer times out, due to the peer not sending a consecutive frame within the expected time windowr!z!RX state was reset due to timeoutN)rISOTP_WAIT_DATArrrr6r7r?r:r:r;_rx_timer_handlerfs  z+ISOTPSocketImplementation._rx_timer_handlercCsL|jtks|jtkr(t|_tddS|jtkrHt|j}d|}|j durdt|_tddS|j}|t dt |j 7}||j |j|j|7}|||j dd|_ |jd7_|j|7_t|j |jkrt|_dS|jdkr |j|jkr t|_t|j|j|_dS|jdkr0qdqdt|j|j|_dSqddS) zMethod called every time the tx_timer times out, which can happen in two situations: either a Flow Control frame was not received in time, or the Separation Time Min is expired and a new frame must be sent.z!TX state was reset due to timeoutNzTX buffer is not filledrr r)r ISOTP_WAIT_FCISOTP_WAIT_FIRST_FCrr6r7 ISOTP_SENDINGrxrrrrrrrrrrr[rtr_tx_timer_handlerrr)r8Zsrc_offZ max_bytesrr:r:r;rrsF        z+ISOTPSocketImplementation._tx_timer_handlercCst|j}t|dkrdSd}|jdurRd}t|dkr|_ |j t |d d >7_ |j t |d d>7_ |j t |d7_ d}||d}t ||_||_||_d |_t|_|jsP|j}|tdt|j|j7}||d|_t|j|j|_dS)z&Process a received 'First Frame' framez Processing FFNr!z3RX state was reset because first frame was receivedrrrr r"rr#BBB) r6r~rryrrrrr7rxrr.rrrrrrrr-rrrrrrrrr[rtrr)r8rrZ ff_pci_szZ data_bytesrr:r:r;rsF            z"ISOTPSocketImplementation._recv_ffcCstd|jtkrdS|jdur2|jd|_t||jkrDdSt||jkr||j|j |jkr|t j dkrxt ddSt |dd@|jkrt j dkrt dt|_dS|jdurt j dkrt dt|_dS|jd d |_|j|d d7_t|j|_ |j |jkrN|jd|j|_t|_|j|j|jfd|_dS|jdkr|jd 7_|j|jkr|js|j}|td t|j|j7}d|_||td t|j |j!|_dS) z,Process a received 'Consecutive Frame' framez Processing CFNr!z&Received a CF with insufficient lengthrrz=RX state was reset because wrong sequence number was receivedzrx_buf not filled with data!r rrzWait for another CF)"r6r~rrrryrxrrrrrr7r.rrrrrNrrrrr-rrrrrrr[rtrr)r8rrr:r:r;rJsZ               z"ISOTPSocketImplementation._recv_cfcCs|jtkrtddSt|_t|}|tkr8tdt|j|dkr||j}|t d|7}||7}t|_| |dS|j}|t kr|t dd|7}n|t dd|B7}|d d t|}||7}| |||_ d |_ d |_t||_t|_t|j|j|_dS) zHIiz>Hrrr )rrr6r7rrxrrrrrrrrrrrr[rtrrr)r8rErrrr:r:r; begin_sends:      z$ISOTPSocketImplementation.begin_sendcCsp|jtkr0t|jgdr0|j}|r0|||jsJt|j |j |_ n"z|j Wnt yjYn0dS)Nr)rrrrrCrr=r[rtrrrryr)r8rr:r:r;rs    zISOTPSocketImplementation._sendcCs|j|dS)zTSend an ISOTP frame and block until the message is sent or an error happens.N)rrrr:r:r;rszISOTPSocketImplementation.sendcCs&z |jWSty YdS0dS)zjReceive an ISOTP frame, blocking if none is available in the buffer for at most 'timeout' seconds.N)rNrC IndexError)r8ror:r:r;rCs  zISOTPSocketImplementation.recv)FNNrrF)N)rUrVrWrXr<rArrrrr>rrrrrrrrrrrCr:r:r:r;r2s2& =    3<6D(r2)@loggingrrlrrcr3 threadingrrrZ scapy.compatrrrrr r r r r Z scapy.packetrZscapy.layers.canrZscapy.libs.sixZlibsr.Z scapy.errorrZscapy.supersocketrZ scapy.configrZ scapy.constsrZ scapy.utilsrZscapy.automatonrrZ scapy.contrib.isotp.isotp_packetrrrrrrrrZscapy.contrib.cansocketr getLoggerr6rrrrrrrrr$r[r2r:r:r:r; sB,       (  i