scapy.layers.inet

IPv4 (Internet Protocol v4).

class scapy.layers.inet.DestIPField(name, default)[source]

Bases: scapy.fields.IPField, scapy.fields.DestField

bindings = {<class 'scapy.layers.inet.UDP'>: [('224.0.0.251', {'dport': 5353}), ('224.0.0.2', {'dport': 1985})], <class 'scapy.contrib.ospf.OSPF_Hdr'>: [('224.0.0.5', {})]}
i2h(pkt, x)[source]
i2m(pkt, x)[source]
class scapy.layers.inet.ICMP(_pkt, /, *, type=8, code=0, chksum=None, id=0, seq=0, ts_ori=60364942, ts_rx=60364942, ts_tx=60364942, gw='0.0.0.0', ptr=0, reserved=0, length=0, addr_mask='0.0.0.0', nexthopmtu=0, unused=None)[source]

Bases: scapy.packet.Packet

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      TYPE     |      CODE     |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               ID              |              SEQ              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS ORI                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS RX                             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS TX                             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                               GW                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      PTR      |    RESERVED   |     LENGTH    |   ADDR MASK   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
|                                               |   NEXTHOPMTU  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               |             UNUSED            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                            Fig. ICMP
ICMP fields

type

ByteEnumField

8

code

MultiEnumField (Depends on 8)

0

chksum

XShortField

None

id

XShortField (Cond)

0

seq

XShortField (Cond)

0

ts_ori

ICMPTimeStampField (Cond)

60364942

ts_rx

ICMPTimeStampField (Cond)

60364942

ts_tx

ICMPTimeStampField (Cond)

60364942

gw

IPField (Cond)

'0.0.0.0'

ptr

ByteField (Cond)

0

reserved

ByteField (Cond)

0

length

ByteField (Cond)

0

addr_mask

IPField (Cond)

'0.0.0.0'

nexthopmtu

ShortField (Cond)

0

unused

MultipleTypeField (ShortField, IntField, StrFixedLenField)

b''
guess_payload_class(payload)[source]
hashret()[source]
mysummary()[source]
post_build(p, pay)[source]
class scapy.layers.inet.ICMPEcho_am(self)[source]

Bases: scapy.ansmachine.AnsweringMachine

Responds to ICMP Echo-Requests (ping)

function_name = 'icmpechod'
is_request(req)[source]
make_reply(req)[source]
print_reply(req, reply)[source]
class scapy.layers.inet.ICMPTimeStampField(name, default)[source]

Bases: scapy.fields.IntField

any2i(pkt, val)[source]
i2repr(pkt, val)[source]
re_hmsm = re.compile('([0-2]?[0-9])[Hh:](([0-5]?[0-9])([Mm:]([0-5]?[0-9])([sS:.]([0-9]{0,3}))?)?)?$')
class scapy.layers.inet.ICMPerror(_pkt, /, *, type=8, code=0, chksum=None, id=0, seq=0, ts_ori=60364942, ts_rx=60364942, ts_tx=60364942, gw='0.0.0.0', ptr=0, reserved=0, length=0, addr_mask='0.0.0.0', nexthopmtu=0, unused=None)[source]

Bases: scapy.layers.inet.ICMP

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      TYPE     |      CODE     |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               ID              |              SEQ              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS ORI                            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS RX                             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                             TS TX                             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                               GW                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      PTR      |    RESERVED   |     LENGTH    |   ADDR MASK   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ +-+-+-+-+-+-+-+-+
|                                               |   NEXTHOPMTU  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               |             UNUSED            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                          Fig. ICMPerror
ICMPerror fields

type

ByteEnumField

8

code

MultiEnumField (Depends on 8)

0

chksum

XShortField

None

id

XShortField (Cond)

0

seq

XShortField (Cond)

0

ts_ori

ICMPTimeStampField (Cond)

60364942

ts_rx

ICMPTimeStampField (Cond)

60364942

ts_tx

ICMPTimeStampField (Cond)

60364942

gw

IPField (Cond)

'0.0.0.0'

ptr

ByteField (Cond)

0

reserved

ByteField (Cond)

0

length

ByteField (Cond)

0

addr_mask

IPField (Cond)

'0.0.0.0'

nexthopmtu

ShortField (Cond)

0

unused

MultipleTypeField (ShortField, IntField, StrFixedLenField)

b''
mysummary()[source]
post_dissection(pkt)[source]
class scapy.layers.inet.IP(_pkt, /, *, version=4, ihl=None, tos=0, len=None, id=1, flags=<Flag 0 ()>, frag=0, ttl=64, proto=0, chksum=None, src=None, dst=None, options=[])[source]

Bases: scapy.packet.Packet, scapy.layers.inet.IPTools

aliastypes
answers(other)[source]
extract_padding(s)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|VERSION|  IHL  |      TOS      |              LEN              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               ID              |FLAGS|           FRAG          |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      TTL      |     PROTO     |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              SRC                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              DST                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            OPTIONS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                             Fig. IP
IP fields

version

BitField (4 bits)

4

ihl

BitField (4 bits)

None

tos

XByteField

0

len

ShortField

None

id

ShortField

1

flags

FlagsField

<Flag 0 ()>

frag

BitField (13 bits)

0

ttl

ByteField

64

proto

ByteEnumField

0

chksum

XShortField

None

src

SourceIPField

None

dst

DestIPField

None

options

PacketListField

[]
fragment(fragsize=1480)[source]

Fragment IP datagrams

hashret()[source]
mysummary()[source]
payload_guess

Possible sublayers: CARP, EIGRP, EtherIP, IGMP, IGMPv3, MPLS, OSPF_Hdr, PIMv2Hdr, RSVP, ICMP, IP, TCP, UDP, IPv6, AH, ESP, GRE, SCTP

post_build(p, pay)[source]
route()[source]
scapy.layers.inet.IPID_count(lst, funcID=<function <lambda>>, funcpres=<function <lambda>>)[source]

Identify IP id values classes in a list of packets

lst: a list of packets funcID: a function that returns IP id values funcpres: a function used to summarize packets

class scapy.layers.inet.IPOption(_pkt, /, *, copy_flag=0, optclass=0, option=0, length=None, value=b'')[source]

Bases: scapy.packet.Packet

aliastypes
classmethod dispatch_hook(pkt=None, *args, **kargs)[source]
extract_padding(p)[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|OPT|  OPTION |     LENGTH    |             VALUE             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                          Fig. IPOption
IPOption fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

0

length

FieldLenField

None

value

StrLenField

b''
classmethod register_variant()[source]
registered_ip_options = {0: <class 'scapy.layers.inet.IPOption_EOL'>, 1: <class 'scapy.layers.inet.IPOption_NOP'>, 2: <class 'scapy.layers.inet.IPOption_Security'>, 3: <class 'scapy.layers.inet.IPOption_LSRR'>, 4: <class 'scapy.layers.inet.IPOption_Timestamp'>, 7: <class 'scapy.layers.inet.IPOption_RR'>, 8: <class 'scapy.layers.inet.IPOption_Stream_Id'>, 9: <class 'scapy.layers.inet.IPOption_SSRR'>, 11: <class 'scapy.layers.inet.IPOption_MTU_Probe'>, 12: <class 'scapy.layers.inet.IPOption_MTU_Reply'>, 18: <class 'scapy.layers.inet.IPOption_Traceroute'>, 19: <class 'scapy.layers.inet.IPOption_Address_Extension'>, 20: <class 'scapy.layers.inet.IPOption_Router_Alert'>, 21: <class 'scapy.layers.inet.IPOption_SDBM'>}
class scapy.layers.inet.IPOption_Address_Extension(_pkt, /, *, copy_flag=1, optclass=0, option=19, length=10, src_ext='0.0.0.0', dst_ext='0.0.0.0')[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |            SRC EXT            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                               |            DST EXT            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                               |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                 Fig. IPOption_Address_Extension
IPOption_Address_Extension fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

19

length

ByteField

10

src_ext

IPField

'0.0.0.0'

dst_ext

IPField

'0.0.0.0'
class scapy.layers.inet.IPOption_EOL(_pkt, /, *, copy_flag=0, optclass=0, option=0)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |
+-+-+-+-+-+-+-+-+

                        Fig. IPOption_EOL
IPOption_EOL fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

0
class scapy.layers.inet.IPOption_LSRR(_pkt, /, *, copy_flag=1, optclass=0, option=3, length=None, pointer=4, routers=[])[source]

Bases: scapy.layers.inet.IPOption_RR

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |    POINTER    |    ROUTERS    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               |
+-+-+-+-+-+-+-+-+

                        Fig. IPOption_LSRR
IPOption_LSRR fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

3

length

FieldLenField

None

pointer

ByteField

4

routers

FieldListField

[]
class scapy.layers.inet.IPOption_MTU_Probe(_pkt, /, *, copy_flag=0, optclass=0, option=11, length=4, mtu=0)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |              MTU              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                     Fig. IPOption_MTU_Probe
IPOption_MTU_Probe fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

11

length

ByteField

4

mtu

ShortField

0
class scapy.layers.inet.IPOption_MTU_Reply(_pkt, /, *, copy_flag=0, optclass=0, option=12, length=4, mtu=0)[source]

Bases: scapy.layers.inet.IPOption_MTU_Probe

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |              MTU              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                     Fig. IPOption_MTU_Reply
IPOption_MTU_Reply fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

12

length

ByteField

4

mtu

ShortField

0
class scapy.layers.inet.IPOption_NOP(_pkt, /, *, copy_flag=0, optclass=0, option=1)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |
+-+-+-+-+-+-+-+-+

                        Fig. IPOption_NOP
IPOption_NOP fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

1
class scapy.layers.inet.IPOption_RR(_pkt, /, *, copy_flag=0, optclass=0, option=7, length=None, pointer=4, routers=[])[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |    POINTER    |    ROUTERS    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               |
+-+-+-+-+-+-+-+-+

                         Fig. IPOption_RR
IPOption_RR fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

7

length

FieldLenField

None

pointer

ByteField

4

routers

FieldListField

[]
get_current_router()[source]
class scapy.layers.inet.IPOption_Router_Alert(_pkt, /, *, copy_flag=1, optclass=0, option=20, length=4, alert=0)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |             ALERT             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                    Fig. IPOption_Router_Alert
IPOption_Router_Alert fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

20

length

ByteField

4

alert

ShortEnumField

0
class scapy.layers.inet.IPOption_SDBM(_pkt, /, *, copy_flag=1, optclass=0, option=21, length=None, addresses=[])[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |           ADDRESSES           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                        Fig. IPOption_SDBM
IPOption_SDBM fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

21

length

FieldLenField

None

addresses

FieldListField

[]
class scapy.layers.inet.IPOption_SSRR(_pkt, /, *, copy_flag=1, optclass=0, option=9, length=None, pointer=4, routers=[])[source]

Bases: scapy.layers.inet.IPOption_RR

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |    POINTER    |    ROUTERS    |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               |
+-+-+-+-+-+-+-+-+

                        Fig. IPOption_SSRR
IPOption_SSRR fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

9

length

FieldLenField

None

pointer

ByteField

4

routers

FieldListField

[]
class scapy.layers.inet.IPOption_Security(_pkt, /, *, copy_flag=1, optclass=0, option=2, length=11, security=0, compartment=0, handling_restrictions=0, transmission_control_code=b'xxx')[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |            SECURITY           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|          COMPARTMENT          |     HANDLING RESTRICTIONS     |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|   TRANSMISSION CONTROL CODE   |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                      Fig. IPOption_Security
IPOption_Security fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

2

length

ByteField

11

security

ShortField

0

compartment

ShortField

0

handling_restrictions

ShortField

0

transmission_control_code

StrFixedLenField

b'xxx'
class scapy.layers.inet.IPOption_Stream_Id(_pkt, /, *, copy_flag=1, optclass=0, option=8, length=4, security=0)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |            SECURITY           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                     Fig. IPOption_Stream_Id
IPOption_Stream_Id fields

copy_flag

BitField (1 bit)

1

optclass

BitEnumField

0

option

BitEnumField

8

length

ByteField

4

security

ShortField

0
class scapy.layers.inet.IPOption_Timestamp(_pkt, /, *, copy_flag=0, optclass=2, option=4, length=None, pointer=9, oflw=0, flg=1, internet_address='0.0.0.0', timestamp=0)[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |    POINTER    |  OFLW |  FLG  |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                        INTERNET ADDRESS                       |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                           TIMESTAMP                           |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                     Fig. IPOption_Timestamp
IPOption_Timestamp fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

2

option

BitEnumField

4

length

ByteField

None

pointer

ByteField

9

oflw

BitField (4 bits)

0

flg

BitEnumField

1

internet_address

IPField (Cond)

'0.0.0.0'

timestamp

IntField

0
post_build(p, pay)[source]
class scapy.layers.inet.IPOption_Traceroute(_pkt, /, *, copy_flag=0, optclass=0, option=18, length=12, id=0, outbound_hops=0, return_hops=0, originator_ip='0.0.0.0')[source]

Bases: scapy.layers.inet.IPOption

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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|C|OPT|  OPTION |     LENGTH    |               ID              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|         OUTBOUND HOPS         |          RETURN HOPS          |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                         ORIGINATOR IP                         |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                     Fig. IPOption_Traceroute
IPOption_Traceroute fields

copy_flag

BitField (1 bit)

0

optclass

BitEnumField

0

option

BitEnumField

18

length

ByteField

12

id

ShortField

0

outbound_hops

ShortField

0

return_hops

ShortField

0

originator_ip

IPField

'0.0.0.0'
class scapy.layers.inet.IPTools[source]

Bases: object

Add more powers to a class with an “src” attribute.

hops()[source]
ottl()[source]
whois()[source]

whois the source and print the output

class scapy.layers.inet.IPerror(_pkt, /, *, version=4, ihl=None, tos=0, len=None, id=1, flags=<Flag 0 ()>, frag=0, ttl=64, proto=0, chksum=None, src=None, dst=None, options=[])[source]

Bases: scapy.layers.inet.IP

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|VERSION|  IHL  |      TOS      |              LEN              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|               ID              |FLAGS|           FRAG          |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|      TTL      |     PROTO     |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              SRC                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              DST                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            OPTIONS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                           Fig. IPerror
IPerror fields

version

BitField (4 bits)

4

ihl

BitField (4 bits)

None

tos

XByteField

0

len

ShortField

None

id

ShortField

1

flags

FlagsField

<Flag 0 ()>

frag

BitField (13 bits)

0

ttl

ByteField

64

proto

ByteEnumField

0

chksum

XShortField

None

src

SourceIPField

None

dst

DestIPField

None

options

PacketListField

[]
mysummary()[source]
payload_guess

Possible sublayers: ICMPerror, IPerror, TCPerror, UDPerror

class scapy.layers.inet.RandTCPOptions(size=None)[source]

Bases: scapy.volatile.VolatileValue

class scapy.layers.inet.TCP(_pkt, /, *, sport=20, dport=80, seq=0, ack=0, dataofs=None, reserved=0, flags=<Flag 2 (S)>, window=8192, chksum=None, urgptr=0, options=b'')[source]

Bases: scapy.packet.Packet

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             SPORT             |             DPORT             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              SEQ                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              ACK                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|DATAOFS|RESER|      FLAGS      |             WINDOW            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             CHKSUM            |             URGPTR            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            OPTIONS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                             Fig. TCP
TCP fields

sport

ShortEnumField

20

dport

ShortEnumField

80

seq

IntField

0

ack

IntField

0

dataofs

BitField (4 bits)

None

reserved

BitField (3 bits)

0

flags

FlagsField

<Flag 2 (S)>

window

ShortField

8192

chksum

XShortField

None

urgptr

ShortField

0

options

TCPOptionsField

b''
hashret()[source]
mysummary()[source]
payload_guess

Possible sublayers: HSFZ, DoIP, SOMEIP, BGP, CRX1New, DiamG, ENIPTCP, LDP, ModbusADURequest, ModbusADUResponse, MQTT, OpenFlow, RTR, Skinny, SOCKS, TacacsHeader, DNS, HTTP, UDP, NBTSession, PPTP, Skinny

post_build(p, pay)[source]
class scapy.layers.inet.TCPOptionsField(name, default, fmt='H', remain=0)[source]

Bases: scapy.fields.StrField

getfield(pkt, s)[source]
i2h(pkt, x)[source]
i2m(pkt, x)[source]
islist = 1
m2i(pkt, x)[source]
randval()[source]
class scapy.layers.inet.TCP_client(self, ip, port, *args, **kargs)[source]

Bases: scapy.automaton.Automaton

Creates a TCP Client Automaton. This automaton will handle TCP 3-way handshake.

Usage: the easiest usage is to use it as a SuperSocket.
>>> a = TCP_client.tcplink(HTTP, "www.google.com", 80)
>>> a.send(HTTPRequest())
>>> a.recv()
Parameters

  • ip – the ip to connect to

  • port –

CLOSED(*args, **kargs)[source]
ESTABLISHED(*args, **kargs)[source]
LAST_ACK(*args, **kargs)[source]
START(*args, **kargs)[source]
STOP(*args, **kargs)[source]
STOP_SENT_FIN_ACK(*args, **kargs)[source]
SYN_SENT(*args, **kargs)[source]
ack_of_fin_received(pkt)[source]
actions = {'ack_of_fin_received': [], 'connect': [<function TCP_client.send_syn>], 'fin_received': [<function TCP_client.send_finack>], 'incoming_data_received': [<function TCP_client.receive_data>], 'outgoing_data_received': [<function TCP_client.send_data>], 'reset_received': [], 'stop_ack_timeout': [], 'stop_fin_received': [<function TCP_client.stop_send_ack>], 'stop_requested': [<function TCP_client.stop_send_finack>], 'syn_ack_timeout': [], 'synack_received': [<function TCP_client.send_ack_of_synack>]}
conditions = {'CLOSED': [], 'ESTABLISHED': [], 'LAST_ACK': [], 'START': [<function TCP_client.connect>], 'STOP': [<function TCP_client.stop_requested>], 'STOP_SENT_FIN_ACK': [], 'SYN_SENT': []}
connect()[source]
fin_received(pkt)[source]
incoming_data_received(pkt)[source]
initial_states = [<function ATMT.state.<locals>.deco.<locals>._state_wrapper>]
ioevents = {'CLOSED': [], 'ESTABLISHED': [<function TCP_client.outgoing_data_received>], 'LAST_ACK': [], 'START': [], 'STOP': [], 'STOP_SENT_FIN_ACK': [], 'SYN_SENT': []}
ionames = ['tcp']
iosupersockets = [<function TCP_client.outgoing_data_received>]
master_filter(pkt)[source]
outgoing_data_received(fd)[source]
parse_args(ip, port, *args, **kargs)[source]
receive_data(pkt)[source]
recv_conditions = {'CLOSED': [], 'ESTABLISHED': [<function TCP_client.incoming_data_received>, <function TCP_client.reset_received>, <function TCP_client.fin_received>], 'LAST_ACK': [<function TCP_client.ack_of_fin_received>], 'START': [], 'STOP': [], 'STOP_SENT_FIN_ACK': [<function TCP_client.stop_fin_received>], 'SYN_SENT': [<function TCP_client.synack_received>]}
reset_received(pkt)[source]
send_ack_of_synack(pkt)[source]
send_data(d)[source]
send_finack(pkt)[source]
send_syn()[source]
states = {'CLOSED': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'ESTABLISHED': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'LAST_ACK': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'START': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'STOP': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'STOP_SENT_FIN_ACK': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>, 'SYN_SENT': <function ATMT.state.<locals>.deco.<locals>._state_wrapper>}
stop_ack_timeout()[source]
stop_fin_received(pkt)[source]
stop_requested()[source]
stop_send_ack(pkt)[source]
stop_send_finack()[source]
stop_states = [<function ATMT.state.<locals>.deco.<locals>._state_wrapper>]
syn_ack_timeout()[source]
synack_received(pkt)[source]
timeout = {'CLOSED': [(None, None)], 'ESTABLISHED': [(None, None)], 'LAST_ACK': [(None, None)], 'START': [(None, None)], 'STOP': [(None, None)], 'STOP_SENT_FIN_ACK': [(1, <function TCP_client.stop_ack_timeout>), (None, None)], 'SYN_SENT': [(1, <function TCP_client.syn_ack_timeout>), (None, None)]}
class scapy.layers.inet.TCPerror(_pkt, /, *, sport=20, dport=80, seq=0, ack=0, dataofs=None, reserved=0, flags=<Flag 2 (S)>, window=8192, chksum=None, urgptr=0, options=b'')[source]

Bases: scapy.layers.inet.TCP

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             SPORT             |             DPORT             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              SEQ                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|                              ACK                              |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|DATAOFS|RESER|      FLAGS      |             WINDOW            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             CHKSUM            |             URGPTR            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|            OPTIONS            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                          Fig. TCPerror
TCPerror fields

sport

ShortEnumField

20

dport

ShortEnumField

80

seq

IntField

0

ack

IntField

0

dataofs

BitField (4 bits)

None

reserved

BitField (3 bits)

0

flags

FlagsField

<Flag 2 (S)>

window

ShortField

8192

chksum

XShortField

None

urgptr

ShortField

0

options

TCPOptionsField

b''
mysummary()[source]
post_dissection(pkt)[source]
class scapy.layers.inet.TracerouteResult(res=None, name='Traceroute', stats=None)[source]

Bases: scapy.plist.SndRcvList

get_trace()[source]
graph(ASres=<scapy.as_resolvers.AS_resolver_multi object>, padding=0, **kargs)[source]

x.graph(ASres=conf.AS_resolver, other args): ASres=None : no AS resolver => no clustering ASres=AS_resolver() : default whois AS resolver (riswhois.ripe.net) ASres=AS_resolver_cymru(): use whois.cymru.com whois database ASres=AS_resolver(server=”whois.ra.net”) type: output type (svg, ps, gif, jpg, etc.), passed to dot’s “-T” option # noqa: E501 target: filename or redirect. Defaults pipe to Imagemagick’s display program # noqa: E501 prog: which graphviz program to use

graphASres
graphdef
graphpadding
hloc
make_graph(ASres=None, padding=0)[source]
nloc
padding
show()[source]
trace3D(join=True)[source]

Give a 3D representation of the traceroute. right button: rotate the scene middle button: zoom shift-left button: move the scene left button on a ball: toggle IP displaying double-click button on a ball: scan ports 21,22,23,25,80 and 443 and display the result

trace3D_notebook()[source]

Same than trace3D, used when ran from Jupyter notebooks

world_trace()[source]

Display traceroute results on a world map.

class scapy.layers.inet.UDP(_pkt, /, *, sport=53, dport=53, len=None, chksum=None)[source]

Bases: scapy.packet.Packet

aliastypes
answers(other)[source]
extract_padding(s)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             SPORT             |             DPORT             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|              LEN              |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                             Fig. UDP
UDP fields

sport

ShortEnumField

53

dport

ShortEnumField

53

len

ShortField

None

chksum

XShortField

None
hashret()[source]
mysummary()[source]
payload_guess

Possible sublayers: DoIP, SOMEIP, BFD, BIFT, CoAP, CRX1New, GENEVE, GTPHeader, GTP_U_Header, IKEv2, KNX, LDP, LTP, MPLS, MQTTSN, PFCP, ProfinetIO, RIPng, BTH, SebekHead, SOCKS5UDP, VQP, Wireguard, BOOTP, _dhcp6_dispatcher, DNS, HSRP, ESP, L2TP, _LLMNR, MGCP, MobileIP, NBNSHeader, NBTDatagram, NetflowHeader, NTP, Radius, RIP, SNMP, TFTP, VXLAN, ZEP2

post_build(p, pay)[source]
class scapy.layers.inet.UDPerror(_pkt, /, *, sport=53, dport=53, len=None, chksum=None)[source]

Bases: scapy.layers.inet.UDP

aliastypes
answers(other)[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
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|             SPORT             |             DPORT             |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
|              LEN              |             CHKSUM            |
+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

                          Fig. UDPerror
UDPerror fields

sport

ShortEnumField

53

dport

ShortEnumField

53

len

ShortField

None

chksum

XShortField

None
mysummary()[source]
post_dissection(pkt)[source]
scapy.layers.inet.defrag(plist) → ([not fragmented], [defragmented],[source]

[ [bad fragments], [bad fragments], … ])

scapy.layers.inet.defragment(plist) → plist defragmented as much as possible[source]
scapy.layers.inet.fragleak(target, sport=123, dport=123, timeout=0.2, onlyasc=0, count=None)[source]
scapy.layers.inet.fragleak2(target, timeout=0.4, onlyasc=0, count=None)[source]
scapy.layers.inet.fragment(pkt, fragsize=1480)[source]

Fragment a big IP datagram

scapy.layers.inet.in4_chksum(proto, u, p)[source]

As Specified in RFC 2460 - 8.1 Upper-Layer Checksums

Performs IPv4 Upper Layer checksum computation. Provided parameters are: - ‘proto’ : value of upper layer protocol - ‘u’ : IP upper layer instance - ‘p’ : the payload of the upper layer provided as a string

scapy.layers.inet.inet_register_l3(l2, l3)[source]
scapy.layers.inet.overlap_frag(p, overlap, fragsize=8, overlap_fragsize=None)[source]

Build overlapping fragments to bypass NIPS

p: the original packet overlap: the overlapping data fragsize: the fragment size of the packet overlap_fragsize: the fragment size of the overlapping packet

scapy.layers.inet.report_ports(target, ports)[source]

portscan a target and output a LaTeX table report_ports(target, ports) -> string

scapy.layers.inet.traceroute(target, dport=80, minttl=1, maxttl=30, sport=<RandShort>, l4=None, filter=None, timeout=2, verbose=None, **kargs)[source]

Instant TCP traceroute

Parameters

  • target – hostnames or IP addresses

  • dport – TCP destination port (default is 80)

  • minttl – minimum TTL (default is 1)

  • maxttl – maximum TTL (default is 30)

  • sport – TCP source port (default is random)

  • l4 – use a Scapy packet instead of TCP

  • filter – BPF filter applied to received packets

  • timeout – time to wait for answers (default is 2s)

  • verbose – detailed output

Returns

an TracerouteResult, and a list of unanswered packets

scapy.layers.inet.traceroute_map(ips, **kargs)[source]

Util function to call traceroute on multiple targets, then show the different paths on a map.

Parameters

  • ips – a list of IPs on which traceroute will be called

  • kargs – (optional) kwargs, passed to traceroute