a k#da @sdZddlmZddlmZddlmZmZddlm Z m Z m Z m Z m Z mZmZmZmZmZmZmZmZmZmZddlmZmZddlmZddlmZd Zd Z d Z!d Z"d ee"<GdddeZ#GdddeZ$GdddeZ%GdddeZ&GdddeZ'ddZ(ddZ)Gddde'Z*Gddde'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'Z0Gd*d+d+e'Z1Gd,d-d-e'Z2Gd.d/d/eeZ3Gd0d1d1e'Z4e-e*e+e,e.e/e0e1e2e4d2 Z5Gd3d4d4e6Z7e7ej8d <eee'e"d5eee'e"d5d6S)7a LLDP - Link Layer Discovery Protocol ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ :author: Thomas Tannhaeuser, hecke@naberius.de :description: This module provides Scapy layers for the LLDP protocol. normative references: - IEEE 802.1AB 2016 - LLDP protocol, topology and MIB description :TODO: - | organization specific TLV e.g. ProfiNet | (see LLDPDUGenericOrganisationSpecific for a starting point) - Ignore everything after EndofLLDPDUTLV :NOTES: - you can find the layer configuration options at the end of this file - default configuration enforces standard conform: * | frame structure | (ChassisIDTLV/PortIDTLV/TimeToLiveTLV/...) * multiplicity of TLVs (if given by the standard) * min sizes of strings used by the TLVs - conf.contribs['LLDP'].strict_mode_disable() -> disable strict mode )conf)Scapy_Exception)EtherDot1Q)MACFieldIPFieldIP6FieldBitField StrLenField ByteEnumField BitEnumField EnumFieldThreeBytesFieldBitFieldLenField ShortField XStrLenField ByteFieldConditionalFieldMultipleTypeField)Packet bind_layers) ETHER_TYPES)orbz01:80:c2:00:00:0ez01:80:c2:00:00:03z01:80:c2:00:00:00ïLLDPc@seZdZdZdS)LLDPInvalidFrameStructureze basic frame structure not standard conform (missing TLV, invalid order or multiplicity) N__name__ __module__ __qualname____doc__r r I/var/www/html/gsl.tools/lib/python3.9/site-packages/scapy/contrib/lldp.pyr:src@seZdZdZdS)LLDPMissingLowerLayerzB first layer below first LLDPDU must be Ethernet or Dot1q Nrr r r r!r"Bsr"c@seZdZdZdS)LLDPInvalidTLVCountz; invalid number of entries for a specific TLV type Nrr r r r!r#Isr#c@seZdZdZdS)LLDPInvalidLengthFieldz' invalid value of length field Nrr r r r!r$Psr$c seZdZdZdddddddd d d d Zd ddddddddddddddddddd d!d"d#d$d%d&d'd(d)d*d+d,Zd-Zd.Zd-Zd/Z gZ iZ d0d1Z e d2d3Zd4d5Ze d6d7Ze d8d9Zd:d;Zfdd?Zfd@dAZfdBdCZZS)DLLDPDUz, base class for all LLDP data units z end of LLDPDUz chassis idzport idz time to livezport descriptionz system namezsystem descriptionzsystem capabilitieszmanagement addresszorganisation specific TLV rotherZIPv4ZIPv6ZNSAPZHDLCZBBNZ802zE.163zE.164zF.69zX.121ZIPXZ Appletalkz Decnet IVz Banyan VineszE.164 with NSAPDNSzDistinguished Namez AS Numberz XTP over IPv4z XTP over IPv6zXTP native mode XTPz"Fiber Channel World-Wide Port Namez"Fiber Channel World-Wide Node NameZGWIDz AFI for L2VPNzMPLS-TP Section Endpoint IDzMPLS-TP LSP Endpoint IDzMPLS-TP Pseudowire Endpoint IDzMT IP Multi-Topology IPv4zMT IP Multi-Topology IPv6)rr'r(r)r*r+r,r-r. r*r7@cCs>z t|dd}t|tjWSty8tjYS0dS)Nrr()rLLDPDU_CLASS_TYPESgetrZ raw_layer IndexError)selfpayloadZlldpdu_tlv_typer r r!guess_payload_classs  zLLDPDU.guess_payload_classcCs0d}|}|r(t|tr(|tj7}|j}q||fS)z calculate size of lower dot1q layers (if present) :param layer: the layer to start at :return: size of vlan headers, layer below lowest vlan header r) isinstancerr%DOT1Q_HEADER_LEN underlayer)layerZvlan_headers_size under_layerr r r!_dot1q_headers_sizes  zLLDPDU._dot1q_headers_sizecCs|j}|dur.tjdr&tdn||St|tr@||St|\}}|r\t|ts|tjdrttdn||S|tj 7}|t |t |tj 7}|tj kr||dtj |S||S)Nrz,No lower layer (Ethernet or Dot1Q) provided.zNo Ethernet layer provided.) rQrcontribs strict_moder"rOr%rTrETHER_HEADER_LENlen ETHER_FSC_LENETHER_FRAME_MIN_LEN)rLpktZpayrS frame_sizer r r! post_builds"     zLLDPDU.post_buildcCstjtjtjdg}t|dkr:tdd|d|t|D]<\}}|dkrVq|||krBtdd|d|qBdS)z check if the structure of the frame is conform to the basic frame structure defined by the standard :param structure_description: string-list reflecting LLDP-msg structure z<...>r)z-Invalid frame structure. got: {} expected: {} N) LLDPDUChassisIDr LLDPDUPortIDLLDPDUTimeToLiverYrformatjoin enumerate)Zstructure_descriptionZstandard_frame_structureidxZ layer_namer r r!_frame_structure_checks,  zLLDPDU._frame_structure_checkcCstjdtjdtjdtjdtdtdtdtdt di }|D]^}||}|dkrJq4z&|||krnt d ||||Wq4t yt d |Yq40q4dS)z check if multiplicity of present TLVs conforms to the standard :param tlv_type_count: dict containing counte-per-TLV *r'zGInvalid number of entries for TLV type {} - expected {} entries, got {}zMissing TLV layer of type {}.N) LLDPDUEndOfLLDPDUrr`rarbLLDPDUPortDescriptionLLDPDUSystemNameLLDPDUSystemDescriptionLLDPDUSystemCapabilitiesLLDPDUManagementAddressr#rcKeyError)Ztlv_type_countZstandard_multiplicitiesZ tlv_type_nameZstandard_tlv_multiplicityr r r!_tlv_multiplicities_checks8    z LLDPDU._tlv_multiplicities_checkcCsxtjdrt|jjdkr(gt_it_nLtj|jjztj|jjd7<Wn t yrdtj|jj<Yn0|S)Nrr%r') rrVrW __class__rr% LAYER_STACKLAYER_MULTIPLICITIESappendrorLsr r r! pre_dissect s  zLLDPDU.pre_dissectcsF|jjdkr2tjdr2ttjttj t t| |dS)Nr%r) rqrrrVrWr%rgrrrprssuperdissection_done)rLr\rqr r!rys     zLLDPDU.dissection_donecCsdS)zOverwritten by LLDPU objectsNr rLr r r!_check$sz LLDPDU._checkcs|tt||SN)r|rxr% post_dissectrurzr r!r~(szLLDPDU.post_dissectcs|tt|Sr})r|rxr%do_buildr{rzr r!r,szLLDPDU.do_build)rrrrTYPESIANA_ADDRESS_FAMILY_NUMBERSrPrXrZr[rrrsrN staticmethodrTr^rgrprwryr|r~r __classcell__r r rzr!r%Ws~"   '  r%cCsR|d\}}|||d}t|tr2|jdksFt|trN|jdkrN|d7}|S)zKReturn the length of the `id` field, according to its real encoded typeidr'r*r+)Zgetfield_and_valZi2lenrOrasubtyper`)r\xfvlengthr r r!_ldp_id_adjustlen1srcCsN|j}|durdS|d8}t|tr.|jdksBt|trJ|jdkrJ|d8}|S)Nrr'r*r+)_lengthrOrarr`)r\rr r r!_ldp_id_lengthfrom=src @seZdZdZdddddddd d Zd Zd Zd ZdZdZ dZ dZ dZ e dd dejedddddddedd eeedd ejddeeddddfeddddfeddd dfgedd!ed"gZd#d$ZdS)%r`z4 ieee 802.1ab-2016 - sec. 8.5.2 / p. 26 reservedzchassis componentinterface aliasport component MAC addressnetwork addressinterface namelocally assignedrr'r(r)r*r+r,r-rr'r(r)r*r+r,r-_typerNr2rcCs t||Sr}rr\rr r r!ezLLDPDUChassisID. length_ofadjustrfamilycCs |jdkS)Nr+rr\r r r!rircCs |jdkSNr*rrr r r!rnrcCs|jdko|jdkS)Nr+r'rrrr r r!rrrcCs|jdko|jdkS)Nr+r(rrr r r!rvrZ length_fromcCs tjdr|jstddS+ run layer specific checks rzid must be >= 1 characters longNrrVrWrr$r{r r r!r||szLLDPDUChassisID._check)rrrrZLLDP_CHASSIS_ID_TLV_SUBTYPESSUBTYPE_RESERVEDZSUBTYPE_CHASSIS_COMPONENTSUBTYPE_INTERFACE_ALIASSUBTYPE_PORT_COMPONENTSUBTYPE_MAC_ADDRESSSUBTYPE_NETWORK_ADDRESSSUBTYPE_INTERFACE_NAMESUBTYPE_LOCALLY_ASSIGNEDr r%rrr rrrrrrr r fields_descr|r r r r!r`JsT     r`c @seZdZdZdddddddd d Zd Zd Zd ZdZdZ dZ dZ dZ e dd dejedddddddedd eeedd ejddeeddddfeddddfeddd dfgedd!ed"gZd#d$ZdS)%raz4 ieee 802.1ab-2016 - sec. 8.5.3 / p. 26 rrrrrrzagent circuit IDrrrr'r(r)r*r+r,r-rrNr2rcCs t||Sr}rrr r r!rrzLLDPDUPortID.rrrcCs |jdkSrrrr r r!rrcCs |jdkS)Nr)rrr r r!rrcCs|jdko|jdkS)Nr*r'rrr r r!rrcCs|jdko|jdkS)Nr*r(rrr r r!rrrrcCs tjdr|jstddSrrr{r r r!r|szLLDPDUPortID._check)rrrrZLLDP_PORT_ID_TLV_SUBTYPESrrrrrrZSUBTYPE_AGENT_CIRCUIT_IDrr r%rrr rrrrrrr rrr|r r r r!rasT     rac@s<eZdZdZedddejedddedd gZ d d Z d S) rbz4 ieee 802.1ab-2016 - sec. 8.5.4 / p. 29 rr)r-rr(r2ttlr=cCs,tjdr(|jdkr(td|jdS)rrr(zlength must be 2 - got {}NrrVrWrr$rcr{r r r!r|szLLDPDUTimeToLive._checkN) rrrrr r%rr rrr|r r r r!rbs  rbc@s<eZdZdZedddejedddgZddZ d d Z d S) riz4 ieee 802.1ab-2016 - sec. 8.5.1 / p. 26 rrr-rr2cCsd|fS)Nrr rur r r!extract_paddingsz!LLDPDUEndOfLLDPDU.extract_paddingcCs,tjdr(|jdkr(td|jdS)rrrzlength must be 0 - got {}Nrr{r r r!r|szLLDPDUEndOfLLDPDU._checkN) rrrrr r%rr rrr|r r r r!ris  ric@s@eZdZdZedddejeddddd edd d d d gZ dS)rjz4 ieee 802.1ab-2016 - sec. 8.5.5 / p. 29 rr*r-rNr2 descriptionrrcCs|jSr}rrr r r!rrzLLDPDUPortDescription.r rrrrr r%rrr rr r r r!rjs rjc@s@eZdZdZedddejeddddd edd d d d gZ dS)rkz4 ieee 802.1ab-2016 - sec. 8.5.6 / p. 30 rr+r-rNr2Z system_namerrcCs|jSr}rrr r r!rrzLLDPDUSystemName.rrr r r r!rks rkc@s@eZdZdZedddejeddddd edd d d d gZ dS)rlz4 ieee 802.1ab-2016 - sec. 8.5.7 / p. 31 rr,r-rNr2rrrcCs|jSr}rrr r r!rrz LLDPDUSystemDescription.rrr r r r!rls rlc%@steZdZdZedddejedddeddd ed dd ed dd ed dd ed dd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd eddd ed dd ed!dd ed"dd ed#dd ed$dd ed%dd ed&dd ed'dd ed(dd g"Z d)d*Z d+S),rmz4 ieee 802.1ab-2016 - sec. 8.5.8 / p. 31 rr-rr*r2Zreserved_5_availablerr'Zreserved_4_availableZreserved_3_availableZreserved_2_availableZreserved_1_availableZtwo_port_mac_relay_availableZs_vlan_component_availableZc_vlan_component_availableZstation_only_availableZdocsis_cable_device_availableZtelephone_availableZrouter_availableZwlan_access_point_availableZmac_bridge_availableZrepeater_availableZother_availableZreserved_5_enabledZreserved_4_enabledZreserved_3_enabledZreserved_2_enabledZreserved_1_enabledZtwo_port_mac_relay_enabledZs_vlan_component_enabledZc_vlan_component_enabledZstation_only_enabledZdocsis_cable_device_enabledZtelephone_enabledZrouter_enabledZwlan_access_point_enabledZmac_bridge_enabledZrepeater_enabledZ other_enabledcCs,tjdr(|jdkr(td|jdS)rrr*zlength must be 4 - got {}Nrr{r r r!r|0szLLDPDUSystemCapabilities._checkN) rrrrr r%rrr rr|r r r r!rmsJ                                 %rmc @s4eZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!d Z"d!d"d#d$Z#dZ$dZ%dZ&e'd%d d e(j)e*d&d'd d(d)d*d+e*d,d'd d(d-d*d+e+d.de(j,e-d(d/d0d*d1e+d2e$e#e.d3dd4e*d5d'd d6d7e-d6d/d8d*d1g Z/d9d:Z0d'S);rna- ieee 802.1ab-2016 - sec. 8.5.9 / p. 32 currently only 0x00..0x1e are used by standards, no way to use anything > 0xff as management address subtype is only one octet wide see https://www.iana.org/assignments/address-family-numbers/address-family-numbers.xhtml # noqa: E501 rr'r(r)r*r+r,r-r.r2r3r4r5r6r7r8r9r:r;r<r=r>r?r@rArBrCrDrErFrGunknownZifIndexzsystem port number)r'r(r)rrNmanagement_addresscCsdt|jt|jS)Nr.)rYr object_idrr r r!r}sz LLDPDUManagementAddress.r!_management_address_string_lengthcCst|jdS)Nr')rYrrr r r!rrZmanagement_address_subtypercCs|jdurdS|jdS)Nrr')rrr r r!rsrZinterface_numbering_subtypeZinterface_number _oid_string_lengthrrcCs|jSr})rrr r r!rrcCs:tjdr6t|j}|dks(|dkr6td|dS)rrrzImanagement address must be 1..31 characters long - got string of size {}N)rrVrWrYrr$rc)rLZmanagement_address_lenr r r!r|s zLLDPDUManagementAddress._check)1rrrrZ SUBTYPE_MANAGEMENT_ADDRESS_OTHERZSUBTYPE_MANAGEMENT_ADDRESS_IPV4ZSUBTYPE_MANAGEMENT_ADDRESS_IPV6ZSUBTYPE_MANAGEMENT_ADDRESS_NSAPZSUBTYPE_MANAGEMENT_ADDRESS_HDLCZSUBTYPE_MANAGEMENT_ADDRESS_BBNZSUBTYPE_MANAGEMENT_ADDRESS_802Z SUBTYPE_MANAGEMENT_ADDRESS_E_163Z SUBTYPE_MANAGEMENT_ADDRESS_E_164ZSUBTYPE_MANAGEMENT_ADDRESS_F_69Z SUBTYPE_MANAGEMENT_ADDRESS_X_121ZSUBTYPE_MANAGEMENT_ADDRESS_IPXZ$SUBTYPE_MANAGEMENT_ADDRESS_APPLETALKZ$SUBTYPE_MANAGEMENT_ADDRESS_DECNET_IVZ'SUBTYPE_MANAGEMENT_ADDRESS_BANYAN_VINESZ*SUBTYPE_MANAGEMENT_ADDRESS_E_164_WITH_NSAPZSUBTYPE_MANAGEMENT_ADDRESS_DNSZ-SUBTYPE_MANAGEMENT_ADDRESS_DISTINGUISHED_NAMEZ$SUBTYPE_MANAGEMENT_ADDRESS_AS_NUMBERZ(SUBTYPE_MANAGEMENT_ADDRESS_XTP_OVER_IPV4Z(SUBTYPE_MANAGEMENT_ADDRESS_XTP_OVER_IPV6Z.SUBTYPE_MANAGEMENT_ADDRESS_XTP_NATIVE_MODE_XTPZ=SUBTYPE_MANAGEMENT_ADDRESS_FIBER_CHANNEL_WORLD_WIDE_PORT_NAMEZ=SUBTYPE_MANAGEMENT_ADDRESS_FIBER_CHANNEL_WORLD_WIDE_NODE_NAMEZSUBTYPE_MANAGEMENT_ADDRESS_GWIDZ(SUBTYPE_MANAGEMENT_ADDRESS_AFI_FOR_L2VPNZ6SUBTYPE_MANAGEMENT_ADDRESS_MPLS_TP_SECTION_ENDPOINT_IDZ2SUBTYPE_MANAGEMENT_ADDRESS_MPLS_TP_LSP_ENDPOINT_IDZ9SUBTYPE_MANAGEMENT_ADDRESS_MPLS_TP_PSEUDOWIRE_ENDPOINT_IDZ4SUBTYPE_MANAGEMENT_ADDRESS_MT_IP_MULTI_TOPOLOGY_IPV4Z4SUBTYPE_MANAGEMENT_ADDRESS_MT_IP_MULTI_TOPOLOGY_IPV6ZINTERFACE_NUMBERING_SUBTYPESZ SUBTYPE_INTERFACE_NUMBER_UNKNOWNZ!SUBTYPE_INTERFACE_NUMBER_IF_INDEXZ+SUBTYPE_INTERFACE_NUMBER_SYSTEM_PORT_NUMBERr r%rrr rrr rr|r r r r!rn9s   rnc@seZdZddZdS)ThreeBytesEnumFieldcCst||||ddS)Nz!I)r __init__)rLnamedefaultenumr r r!rszThreeBytesEnumField.__init__N)rrrrr r r r!rsrc @seZdZdZdZdZdZdZedededed ed iZe d d d e j e ddddddde ddeeddedddddgZdS)!LLDPDUGenericOrganisationSpecificii€iii0zPROFIBUS International (PNO)z IEEE 802.1z IEEE 802.3z.TIA TR-41 Committee . Media Endpoint DiscoveryzHytec Geraetebau GmbHrr/r-rNr2datacCst|jdSr)rYrrr r r!rrz*LLDPDUGenericOrganisationSpecific.rZorg_coderrrcCs|jdurdS|jdS)Nrr*rrr r r!rsr)rrrZORG_UNIQUE_CODE_PNOZORG_UNIQUE_CODE_IEEE_802_1ZORG_UNIQUE_CODE_IEEE_802_3ZORG_UNIQUE_CODE_TIA_TR_41_MEDZORG_UNIQUE_CODE_HYTECZORG_UNIQUE_CODESr r%rrrrrrr r r r!rs&  rr&c@s0eZdZdZddZddZddZdd Zd S) LLDPConfigurationz, basic configuration for LLDP layer cCsd|_|dS)NT) _strict_modestrict_mode_enabler{r r r!rszLLDPConfiguration.__init__cCs d|_dS)z< enable strict mode and dissector debugging TNrr{r r r!rsz$LLDPConfiguration.strict_mode_enablecCs d|_dS)z= disable strict mode and dissector debugging FNrr{r r r!strict_mode_disablesz%LLDPConfiguration.strict_mode_disablecCs|jS)z/ get current strict mode state rr{r r r!rWszLLDPConfiguration.strict_modeN)rrrrrrrrWr r r r!rs r)typeN)9rZ scapy.configrZ scapy.errorrZscapy.layers.l2rrZ scapy.fieldsrrrr r r r r rrrrrrrZ scapy.packetrrZ scapy.datarZ scapy.compatrZLLDP_NEAREST_BRIDGE_MACZ LLDP_NEAREST_NON_TPMR_BRIDGE_MACZ LLDP_NEAREST_CUSTOMER_BRIDGE_MACZLLDP_ETHER_TYPErr"r#r$r%rrr`rarbrirjrkrlrmrnrrrIobjectrrVr r r r!s\  D  [  ::   2d