a k#dZO@sdZddlZddlmZddlmZmZddlmZm Z m Z m Z m Z m Z mZmZddlmZmZddlmmZddlmZmZmZGdd d eZGd d d eZGd d d eZGdddeeZdddZdddZGdddeZ Gddde Z!Gddde Z"Gddde Z#Gddde Z$Gdd d e Z%Gd!d"d"e Z&Gd#d$d$e Z'Gd%d&d&e Z(Gd'd(d(e Z)Gd)d*d*e Z*Gd+d,d,e Z+Gd-d.d.e Z,Gd/d0d0e Z-Gd1d2d2e Z.Gd3d4d4eZ/eee/d5d6eee/d5d6ee/e!d7d6ee/e"d7d6ee/e#d7d6ee/e$d7d6ee/e%d7d6ee/e&d7d6ee/e'd7d6ee/e(d7d6ee/e)d7d6ee/e*d7d6ee/e+d7d6ee/e,d7d6ee/e-d7d6ee/e.d7d6dS)8a EtherCat automation protocol ~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :author: Thomas Tannhaeuser, hecke@naberius.de :description: This module provides Scapy layers for the EtherCat protocol. normative references: - IEC 61158-3-12 - data link service and topology description - IEC 61158-4-12 - protocol specification Currently only read/write services as defined in IEC 61158-4-12, sec. 5.4 are supported. :TODO: - Mailbox service (sec. 5.5) - Network variable service (sec. 5.6) :NOTES: - EtherCat frame type defaults to TYPE-12-PDU (0x01) using xxx bytes of padding - padding for minimum frame size is added automatically N)raw) log_runtimeScapy_Exception)BitField ByteField LEShortFieldFieldListField LEIntField FieldLenField _EnumField EnumField)EtherDot1Q) bind_layersPacketPaddingc@seZdZdZdS)LEBitFieldSequenceExceptionz, thrown by EtherCat structure tests N)__name__ __module__ __qualname____doc__rrM/var/www/html/gsl.tools/lib/python3.9/site-packages/scapy/contrib/ethercat.pyr9src@s(eZdZdZddZddZddZdS) LEBitFieldz1 a little endian version of the BitField cCsn|j|}z:|j||}t|turD|jjturDtd|jWn"t yhtd|jYn0dS)z check if the field addressed by given index relative to this field shares type of this field so we can catch a mix of LEBitField and BitField/other types zBfield after field {} must be of type LEBitField or derived classesz7Missing further LEBitField based fields after field {} N) fields_descindextyper __class____base__rformatname IndexError)selfpktrZmy_idxZ next_fieldrrr_check_field_typeEs     zLEBitField._check_field_typec Cs:t|tur2t|dkr2|\}}}}||dnd}g}||j7}||j|||f|dr||d|||ttfS|d}d}t } |D]\} }| |kr|| }|||>O}qq| |kr | |8} ||| ?O}t d|| } d}d}|d| dM}qq||O}t d|| } d}d}qqq|| S)a :param pkt: packet instance the raw string s and field belongs to :param s: raw string representing the frame :param val: value :return: final raw string, tuple (s, bitsdone, data) if in between bit field # noqa: E501 as we don't know the final size of the full bitfield we need to accumulate the data. # noqa: E501 if we reach a field that ends at a octet boundary, we build the whole string # noqa: E501 rz!B) rtuplelenr$sizeappendi2mrreverse bytearraystructpack) r"r#svalZbitsdonedata_octetZ remaining_lenoctetsr,rrraddfieldYsB        zLEBitField.addfieldcCspt|tur$t|dkr$|\}}}nd}g}||j7}|||drV|||fdfSd}d}d}d}||} | j} d} t|}|d} |d| D]} | d7} d}|r| |kr|| |>O}||j| j<d}|}q| |kr0|| d| d@|>O}||j| j<| | L} || 8}|d7}||} | j} d}d}q| |kr|| |>O}||7}| |8} d}qq|| d|fSdS)a extract data from raw str collect all instances belonging to the bit field set. if we reach a field that ends at a octet boundary, dissect the whole bit field at once # noqa: E501 :param pkt: packet instance the field belongs to :param s: raw string representing the frame -or- tuple containing raw str, number of bits and array of fields # noqa: E501 :return: tuple containing raw str, number of bits and array of fields -or- remaining raw str and value of this # noqa: E501 rr'Nr(r))rr*r+r,r-r0fieldsr )r"r#r3Z bits_in_setr;Zcur_valZcur_val_bit_idxZthis_valZ field_idxfieldZfield_required_bitsidxZbf_total_byte_lengthr7Zoctet_bits_leftrrrgetfieldsT         zLEBitField.getfieldN)rrrrr$r9r>rrrrr@s>rc@s0eZdZgdZddddfddZddZdS) LEBitFieldLenField) length_ofcount_ofadjustNcCs|SNr)r#xrrrzLEBitFieldLenField.cCs&t||||||_||_||_dSrC)r__init__r@rArB)r"r defaultr,r@rArBrrrrGszLEBitFieldLenField.__init__cCstjrtjjntj|||SrC)sixPY2r r.__func__)r"r#rDrrrr.szLEBitFieldLenField.i2m)rrr __slots__rGr.rrrrr?sr?c@seZdZejZddZdS)LEBitEnumFieldcCs(t|||||dk|_t||_dS)Nr)r rGrevabsr,)r"r rHr,enumrrrrGs zLEBitEnumField.__init__N)rrrr rLrGrrrrrMsrMzFRAME-NOT-CIRCULATINGzFRAME-CIRCULATED-ONCE)rr(zLAST-TYPE12-PDUzTYPE12-PDU-FOLLOWSc@seZdZdZddZddZeddedded ded d d d de ddde ddde e dd de edde d gedddddeddg ZeZeddedded d d d de ddde ddde e dd de edde d gedddddeddg Zd S)EtherCatType12DLPDUz# Type12 message base class cCst|j}|dkr"td|d|jdur<|jr6dnd}n|rFd}nd}|rbt|ddBg}nt|dd@g}|dd||d d|S) z set next attr automatically if not set explicitly by user :param pkt: raw string containing the current layer :param pay: raw string containing the payload :return: + payload z7payload size {} exceeds maximum length {} of data size.NTFr')r+r5 ValueErrorrnextr0)r"r#paydata_lenZhas_nextZ next_flagrrr post_builds  zEtherCatType12DLPDU.post_buildcCsLz|d}tj|WStyFtd|jjt ||YS0dSNrz8{}.guess_payload_class() - unknown or invalid DLPDU type EtherCatETHERCAT_TYPE12_DLPDU_TYPESKeyErrorrerrorrrrrguess_payload_classr"payloadZ dlpdu_typerrrra<s  z'EtherCatType12DLPDU.guess_payload_classr=rZadpZador+N r5)rA _reservedr:cr(rWZirqcCs|jSrCr+r#rrrrESrFzEtherCatType12DLPDU.)Z count_fromZwkcZadrcCs|jSrCrhrirrrrEbrF)rrrrrZrarrr?rrM"ETHERCAT_TYPE_12_CIRCULATING_FRAMEETHERCAT_TYPE_12_NEXT_FRAMErPHYSICAL_ADDRESSING_DESCBROADCAST_ADDRESSING_DESCr LOGICAL_ADDRESSING_DESCrrrrrQs:      rQc@s"eZdZdZeddgejZdS) EtherCatAPRDz` APRD - Auto Increment Physical Read (IEC 61158-5-12, sec. 5.4.1.2 tab. 14 / p. 32) _cmdr(NrrrrrrQrlrrrrrroks roc@s"eZdZdZeddgejZdS) EtherCatFPRDzd FPRD - Configured address physical read (IEC 61158-5-12, sec. 5.4.1.3 tab. 15 / p. 33) rpr%Nrqrrrrrrus rrc@s"eZdZdZeddgejZdS) EtherCatBRDzQ BRD - Broadcast read (IEC 61158-5-12, sec. 5.4.1.4 tab. 16 / p. 34) rprSNrrrrrrQrmrrrrrrss rsc@s"eZdZdZeddgejZdS) EtherCatLRDzO LRD - Logical read (IEC 61158-5-12, sec. 5.4.1.5 tab. 17 / p. 36) rp NrrrrrrQrnrrrrrrus ruc@s"eZdZdZeddgejZdS) EtherCatAPWRza APWR - Auto Increment Physical Write (IEC 61158-5-12, sec. 5.4.2.2 tab. 18 / p. 37) rpr)Nrqrrrrrxs rxc@s"eZdZdZeddgejZdS) EtherCatFPWRze FPWR - Configured address physical write (IEC 61158-5-12, sec. 5.4.2.3 tab. 19 / p. 38) rpNrqrrrrrys ryc@s"eZdZdZeddgejZdS) EtherCatBWRzM BWR - Broadcast read (IEC 61158-5-12, sec. 5.4.2.4 tab. 20 / p. 39) rpr'Nrtrrrrr{s r{c@s"eZdZdZeddgejZdS) EtherCatLWRzP LWR - Logical write (IEC 61158-5-12, sec. 5.4.2.5 tab. 21 / p. 40) rprdNrwrrrrr|s r|c@s"eZdZdZeddgejZdS) EtherCatAPRWzf APRW - Auto Increment Physical Read Write (IEC 61158-5-12, sec. 5.4.3.1 tab. 22 / p. 41) rpr:Nrqrrrrr}s r}c@s"eZdZdZeddgejZdS) EtherCatFPRWzj FPRW - Configured address physical read write (IEC 61158-5-12, sec. 5.4.3.2 tab. 23 / p. 43) rpNrqrrrrr~s r~c@s"eZdZdZeddgejZdS) EtherCatBRWzW BRW - Broadcast read write (IEC 61158-5-12, sec. 5.4.3.3 tab. 24 / p. 39) rp Nrtrrrrrs rc@s"eZdZdZeddgejZdS) EtherCatLRWzU LRW - Logical read write (IEC 61158-5-12, sec. 5.4.3.4 tab. 25 / p. 45) rp Nrwrrrrrs rc@s"eZdZdZeddgejZdS) EtherCatARMWzo ARMW - Auto increment physical read multiple write (IEC 61158-5-12, sec. 5.4.3.5 tab. 26 / p. 46) rp Nrqrrrrrs rc@s"eZdZdZeddgejZdS) EtherCatFRMWzs FRMW - Configured address physical read multiple write (IEC 61158-5-12, sec. 5.4.3.6 tab. 27 / p. 47) rpNrqrrrrrs rc@seZdZdZdZdZdZdZdddd Ze d d d e d d de dd dgZ e e e eeeeeeeeeeedZddZddZdS)r]z& Common EtherCat header layer rr%@r)z TYPE-12-PDUzNETWORK-VARIABLESZMAILBOX)r(r%rzlengthrrdrer(r)r(r%rSrvr)rzr'rdr:rrrrrc CsGdddt}t|}|dkr0td|d||_d}|j}|r^t|tr^|d7}|j}q@t|tspt dt j t j |t j |t j}|dkrt}d||_t||j|jd |t|St||j|jd |S) a need to set the length of the whole PDU manually to avoid any bit fiddling use a dummy class to build the layer content also add padding if frame is < 64 bytes Note: padding only handles Ether/n*Dot1Q/EtherCat (no special mumbo jumbo) :param pkt: raw string containing the current layer :param pay: raw string containing the payload :return: + payload c@s2eZdZdZedddedddeddd gZdS) z0EtherCat.post_build.._EtherCatLengthCalczP dummy class used to generate str representation easily rNrdrerr(rr%)rrrrrrrrrr_EtherCatLengthCalc5s    rrRz>payload size {} exceeds maximum length {} of EtherCat message.rr%zmissing Ether layer)rr)rr+rVrrZ underlayer isinstancerr Exceptionr]ETHER_FRAME_MIN_LENETHER_HEADER_LENETHERCAT_HEADER_LEN ETHER_FSC_LENrloadrr) r"r#rXrZ payload_lenZvlan_headers_total_sizeZ upper_layerZpad_lenpadrrrrZ&sL   zEtherCat.post_buildcCsLz|d}tj|WStyFtd|jjt ||YS0dSr[r\rbrrrrabs  zEtherCat.guess_payload_classN)rrrrrrrrZ FRAME_TYPESrrrorrrsrurxryr{r|r}r~rrrrr^rZrarrrrr]s<   sd ( 6 Q            m