scapy.layers.l2
Classes and functions for layer 2 protocols.
- class scapy.layers.l2.ARP(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- answers(other: scapy.packet.Packet) int[source]
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | HWTYPE | PTYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | HWLEN | PLEN | OP | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | HWSRC | PSRC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | HWDST | PDST | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. ARPARP fields hwtype
1ptype
2048hwlen
Noneplen
Noneop
1hwsrc
MultipleTypeField(SourceMACField, StrFixedLenField)Nonepsrc
MultipleTypeField(SourceIPField, SourceIP6Field, StrFixedLenField)Nonehwdst
MultipleTypeField(MACField, StrFixedLenField)Nonepdst
MultipleTypeField(IPField, IP6Field, StrFixedLenField)None
- route() Tuple[Optional[Union[scapy.interfaces.NetworkInterface, str]], Optional[str], Optional[str]][source]
- class scapy.layers.l2.ARP_am(**kargs)[source]
Bases:
scapy.ansmachine.AnsweringMachineFake ARP Relay Daemon (farpd)
example: To respond to an ARP request for 192.168.100 replying on the ingress interface:
farpd(IP_addr='192.168.1.100',ARP_addr='00:01:02:03:04:05')
To respond on a different interface add the interface parameter:
farpd(IP_addr='192.168.1.100',ARP_addr='00:01:02:03:04:05',iface='eth0')
To respond on ANY arp request on an interface with mac address ARP_addr:
farpd(ARP_addr='00:01:02:03:04:05',iface='eth1')
To respond on ANY arp request with my mac addr on the given interface:
farpd(iface='eth1')
Optional Args:
inter=<n> Interval in seconds between ARP replies being sent
- filter = 'arp'
- function_name = 'farpd'
- is_request(req: scapy.layers.l2.Ether) bool[source]
- make_reply(req: scapy.layers.l2.Ether) scapy.layers.l2.Ether[source]
- print_reply(req: scapy.layers.l2.Ether, reply: scapy.layers.l2.Ether) None[source]
- static send_function(x: Union[List[scapy.packet.Packet], scapy.packet.Packet, scapy.base_classes.SetGen[scapy.packet.Packet], scapy.plist._PacketList[scapy.packet.Packet]], iface: Optional[Union[scapy.interfaces.NetworkInterface, str]] = None, iface_hint: Union[None, str] = None, socket: Optional[scapy.supersocket.SuperSocket] = None, **kargs: Any) Optional[scapy.plist.PacketList][source]
Send packets at layer 2
- Parameters
x – the packets
inter – time (in s) between two packets (default 0)
loop – send packet indefinetly (default 0)
count – number of packets to send (default None=1)
verbose – verbose mode (default None=conf.verbose)
realtime – check that a packet was sent before sending the next one
return_packets – return the sent packets
socket – the socket to use (default is conf.L3socket(kargs))
iface – the interface to send the packets on
monitor – (not on linux) send in monitor mode
- Returns
None
- send_reply(reply: scapy.layers.l2.ARP) None[source]
- class scapy.layers.l2.ARPingResult(res=None, name='ARPing', stats=None)[source]
Bases:
scapy.plist.SndRcvList
- class scapy.layers.l2.CookedLinux(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PKTTYPE | LLADDRTYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | LLADDRLEN | SRC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PROTO | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. CookedLinuxCookedLinux fields pkttype
0lladdrtype
512lladdrlen
0src
b''proto
2048
- class scapy.layers.l2.DestMACField(name: str)[source]
Bases:
scapy.fields.MACField- i2h(pkt: Optional[scapy.layers.l2.Ether], x: Optional[str]) str[source]
- i2m(pkt: Optional[scapy.layers.l2.Ether], x: Optional[str]) bytes[source]
- class scapy.layers.l2.Dot1AD(*args: Any, **kargs: Any)[source]
Bases:
scapy.layers.l2.Dot1Q- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PRIO|I| VLAN | TYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. Dot1ADDot1AD fields prio
BitField(3 bits)0id
BitField(1 bit)0vlan
BitField(12 bits)1type
0
- class scapy.layers.l2.Dot1Q(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- answers(other: scapy.packet.Packet) int[source]
- default_payload_class(pay: bytes) Type[scapy.packet.Packet][source]
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PRIO|I| VLAN | TYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. Dot1QDot1Q fields prio
BitField(3 bits)0id
BitField(1 bit)0vlan
BitField(12 bits)1type
0
- class scapy.layers.l2.Dot3(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- answers(other: scapy.layers.l2.Ether) int[source]
- classmethod dispatch_hook(_pkt: Optional[Any] = None, *args: Any, **kargs: Any) Type[scapy.packet.Packet][source]
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | DST | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | SRC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | LEN | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. Dot3Dot3 fields dst
Nonesrc
Nonelen
None
- class scapy.layers.l2.Ether(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- answers(other: scapy.packet.Packet) int[source]
- classmethod dispatch_hook(_pkt: Optional[bytes] = None, *args: Any, **kargs: Any) Type[scapy.packet.Packet][source]
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | DST | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | SRC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | TYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. EtherEther fields dst
Nonesrc
Nonetype
36864
- class scapy.layers.l2.GRE(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- deprecated_fields: Dict[str, Tuple[str, str]] = {'seqence_number': ('sequence_number', '2.4.4')}
- classmethod dispatch_hook(_pkt: Optional[Any] = None, *args: Any, **kargs: Any) Type[scapy.packet.Packet][source]
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |C|R|K|S|S|RECUR| FLAGS |VERSI| PROTO | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | CHKSUM | OFFSET | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | KEY | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SEQUENCE NUMBER | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. GREGRE fields chksum_present
BitField(1 bit)0routing_present
BitField(1 bit)0key_present
BitField(1 bit)0seqnum_present
BitField(1 bit)0strict_route_source
BitField(1 bit)0recursion_control
BitField(3 bits)0flags
BitField(5 bits)0version
BitField(3 bits)0proto
0chksum
XShortField(Cond)Noneoffset
XShortField(Cond)Nonekey
XIntField(Cond)Nonesequence_number
XIntField(Cond)None
- class scapy.layers.l2.GRE_PPTP(*args: Any, **kargs: Any)[source]
Bases:
scapy.layers.l2.GREEnhanced GRE header used with PPTP RFC 2637
- aliastypes
- deprecated_fields: Dict[str, Tuple[str, str]] = {'seqence_number': ('sequence_number', '2.4.4')}
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ |C|R|K|S|S|RECUR|A| FLAGS |VERSI| PROTO | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PAYLOAD LEN | CALL ID | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | SEQUENCE NUMBER | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ACK NUMBER | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. GRE_PPTPGRE_PPTP fields chksum_present
BitField(1 bit)0routing_present
BitField(1 bit)0key_present
BitField(1 bit)1seqnum_present
BitField(1 bit)0strict_route_source
BitField(1 bit)0recursion_control
BitField(3 bits)0acknum_present
BitField(1 bit)0flags
BitField(4 bits)0version
BitField(3 bits)1proto
34827payload_len
Nonecall_id
Nonesequence_number
XIntField(Cond)Noneack_number
XIntField(Cond)None
- class scapy.layers.l2.GRErouting(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ADDRESS FAMILY | SRE OFFSET | SRE LEN | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | ROUTING INFO | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. GREroutingGRErouting fields address_family
0SRE_offset
0SRE_len
Nonerouting_info
b''
- payload_guess
Possible sublayers:
GRErouting,Raw
- class scapy.layers.l2.LLC(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- class scapy.layers.l2.LoIntEnumField(name: str, default: Optional[int], enum: Dict[int, str])[source]
Bases:
scapy.fields.IntEnumField- i2m(pkt: Optional[scapy.packet.Packet], x: Optional[Union[List[int], int]]) int[source]
- m2i(pkt: Optional[scapy.packet.Packet], x: int) int[source]
- class scapy.layers.l2.Loopback(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet*BSD loopback layer
- aliastypes
- class scapy.layers.l2.MPacketPreamble(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PREAMBLE | FCS | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. MPacketPreambleMPacketPreamble fields preamble
b''fcs
0
- class scapy.layers.l2.Neighbor[source]
Bases:
object- register_l3(l2: Type[scapy.packet.Packet], l3: Type[scapy.packet.Packet], resolve_method: Callable[[scapy.packet.Packet, scapy.packet.Packet], Optional[str]]) None[source]
- resolve(l2inst: scapy.layers.l2.Ether, l3inst: scapy.packet.Packet) Optional[str][source]
- class scapy.layers.l2.SNAP(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | OUI | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | CODE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. SNAPSNAP fields OUI
0code
0
- class scapy.layers.l2.STP(*args: Any, **kargs: Any)[source]
Bases:
scapy.packet.Packet- aliastypes
- fields_desc
Display RFC-like schema
0 1 2 3 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | PROTO | VERSION | BPDUTYPE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | BPDUFLAGS | ROOTID | ROOTMAC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | PATHCOST | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | BRIDGEID | BRIDGEMAC | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ + | | + +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | PORTID | AGE | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | MAXAGE | HELLOTIME | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ | | FWDDELAY | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ Fig. STPSTP fields proto
0version
0bpdutype
0bpduflags
0rootid
0rootmac
'00:00:00:00:00:00'pathcost
0bridgeid
0bridgemac
'00:00:00:00:00:00'portid
0age
1maxage
20hellotime
2fwddelay
15
- class scapy.layers.l2.SourceMACField(name: str, getif: Optional[Any] = None)[source]
Bases:
scapy.fields.MACField- getif
- i2h(pkt: Optional[scapy.packet.Packet], x: Optional[str]) str[source]
- i2m(pkt: Optional[scapy.layers.l2.Ether], x: Optional[Any]) bytes[source]
- scapy.layers.l2.arpcachepoison(target: str, victim: str, interval: int = 60) None[source]
Poison target’s cache with (your MAC,victim’s IP) couple arpcachepoison(target, victim, [interval=60]) -> None
- scapy.layers.l2.arping(net: str, timeout: int = 2, cache: int = 0, verbose: Optional[int] = None, **kargs: Any) Tuple[scapy.layers.l2.ARPingResult, scapy.plist.PacketList][source]
Send ARP who-has requests to determine which hosts are up arping(net, [cache=0,] [iface=conf.iface,] [verbose=conf.verb]) -> None Set cache=True if you want arping to modify internal ARP-Cache
- scapy.layers.l2.arpleak(target: str, plen: int = 255, hwlen: int = 255, **kargs: Any) Tuple[scapy.plist.SndRcvList, scapy.plist.PacketList][source]
Exploit ARP leak flaws, like NetBSD-SA2017-002.
https://ftp.netbsd.org/pub/NetBSD/security/advisories/NetBSD-SA2017-002.txt.asc
- scapy.layers.l2.etherleak(target: str, **kargs: Any) Tuple[scapy.plist.SndRcvList, scapy.plist.PacketList][source]
Exploit Etherleak flaw
- scapy.layers.l2.getmacbyip(ip: str, chainCC: int = 0) Optional[str][source]
Return MAC address corresponding to a given IP address
- scapy.layers.l2.is_promisc(ip: str, fake_bcast: str = 'ff:ff:00:00:00:00', **kargs: Any) bool[source]
Try to guess if target is in Promisc mode. The target is provided by its ip.
- scapy.layers.l2.l2_register_l3(l2: scapy.packet.Packet, l3: scapy.packet.Packet) Optional[str][source]
- scapy.layers.l2.l2_register_l3_arp(l2: Type[scapy.packet.Packet], l3: Type[scapy.packet.Packet]) Optional[str][source]
- scapy.layers.l2.promiscping(net: str, timeout: int = 2, fake_bcast: str = 'ff:ff:ff:ff:ff:fe', **kargs: Any) Tuple[scapy.layers.l2.ARPingResult, scapy.plist.PacketList][source]
Send ARP who-has requests to determine which hosts are in promiscuous mode promiscping(net, iface=conf.iface)