Welcome to Scapy’s documentation!

Version

2.4.4.dev122

Release

2.4.4.

Date

Oct 25, 2020

This document is under a Creative Commons Attribution - Non-Commercial - Share Alike 2.5 license.

General documentation

• Introduction
  • About Scapy
  • What makes Scapy so special
  • Quick demo
  • Learning Python
• Download and Installation
  • Overview
  • Scapy versions
  • Installing Scapy v2.x
  • Optional Dependencies
  • Platform-specific instructions
  • Build the documentation offline
• Usage
  • Starting Scapy
  • Interactive tutorial
  • Simple one-liners
  • Recipes
• Advanced usage
  • ASN.1 and SNMP
  • Automata
  • PipeTools
• Scapy routing
  • List interfaces
  • IPv4 routes
  • IPv6 routes
  • Get router IP address
  • Get local IP / IP of an interface
  • Get local MAC / MAC of an interface
  • Get MAC by IP

Extend scapy

• Build your own tools
  • Using Scapy in your tools
  • Extending Scapy with add-ons
• Adding new protocols
  • Simple example
  • Layers
  • Dissecting
  • Building
  • Fields
  • Design patterns
• Calling Scapy functions
  • UDP checksum

Layer-specific documentation

• Automotive
  • Overview
  • CAN Layer
  • CAN Calibration Protocol (CCP)
  • ISOTP
  • ISOTP Sockets
  • UDS
  • GMLAN
  • ECU Utility examples
  • SOME/IP and SOME/IP SD messages
  • OBD
  • Test-Setup Tutorials
• Bluetooth
  • What is Bluetooth?
  • First steps
  • Working with Bluetooth Low Energy
  • Apple/iBeacon broadcast frames
• HTTP
  • HTTP 1.X
  • HTTP 2.X
• Netflow
  • Netflow V1
  • Netflow V5
  • NetflowV9 / IPfix
• PROFINET IO RTC
  • RTC data packet
  • RTC packet
• SCTP
  • Enabling dynamic addressing reconfiguration and chunk authentication capabilities
• TCP
  • Using the kernel’s TCP stack
  • Scapy’s TCP client automaton
  • Use external projects

About

• Troubleshooting
  • FAQ
  • Getting help
• Scapy development
  • Project organization
  • How to contribute
  • Improve the documentation
  • Testing with UTScapy
  • Releasing Scapy
• Credits

API Reference

• Scapy API reference
  • scapy.asn1
    • scapy.asn1.asn1
    • scapy.asn1.ber
    • scapy.asn1.mib
  • scapy.contrib
    • scapy.contrib.automotive
      • scapy.contrib.automotive.bmw
      • scapy.contrib.automotive.gm
      • scapy.contrib.automotive.obd
      • scapy.contrib.automotive.volkswagen
      • scapy.contrib.automotive.ccp
      • scapy.contrib.automotive.ecu
      • scapy.contrib.automotive.enumerator
      • scapy.contrib.automotive.someip
      • scapy.contrib.automotive.uds
    • scapy.contrib.altbeacon
    • scapy.contrib.aoe
    • scapy.contrib.avs
    • scapy.contrib.bfd
    • scapy.contrib.bgp
    • scapy.contrib.bier
    • scapy.contrib.bp
    • scapy.contrib.carp
    • scapy.contrib.cdp
    • scapy.contrib.chdlc
    • scapy.contrib.coap
    • scapy.contrib.concox
    • scapy.contrib.dce_rpc
    • scapy.contrib.diameter
    • scapy.contrib.dtp
      • DTP Scapy Extension
    • scapy.contrib.eddystone
    • scapy.contrib.eigrp
      • EIGRP Scapy Extension
    • scapy.contrib.enipTCP
    • scapy.contrib.erspan
    • scapy.contrib.ethercat
      • EtherCat automation protocol
    • scapy.contrib.etherip
    • scapy.contrib.exposure_notification
    • scapy.contrib.geneve
    • scapy.contrib.gtp
    • scapy.contrib.gtp_v2
    • scapy.contrib.homeplugav
    • scapy.contrib.homepluggp
    • scapy.contrib.homeplugsg
    • scapy.contrib.http2
    • scapy.contrib.ibeacon
    • scapy.contrib.icmp_extensions
    • scapy.contrib.ife
      • IFE - ForCES Inter-FE LFB type
    • scapy.contrib.igmp
    • scapy.contrib.igmpv3
    • scapy.contrib.ikev2
    • scapy.contrib.isis
      • IS-IS Scapy Extension
    • scapy.contrib.isotp
    • scapy.contrib.lacp
    • scapy.contrib.ldp
    • scapy.contrib.lldp
      • LLDP - Link Layer Discovery Protocol
    • scapy.contrib.loraphy2wan
    • scapy.contrib.ltp
    • scapy.contrib.mac_control
      • MACControl
    • scapy.contrib.macsec
    • scapy.contrib.modbus
    • scapy.contrib.mount
    • scapy.contrib.mpls
    • scapy.contrib.mqtt
    • scapy.contrib.mqttsn
    • scapy.contrib.nfs
    • scapy.contrib.nlm
    • scapy.contrib.nsh
    • scapy.contrib.oncrpc
    • scapy.contrib.opc_da
    • scapy.contrib.openflow
    • scapy.contrib.openflow3
    • scapy.contrib.ospf
    • scapy.contrib.pfcp
    • scapy.contrib.pim
    • scapy.contrib.pnio
    • scapy.contrib.pnio_dcp
    • scapy.contrib.pnio_rpc
    • scapy.contrib.portmap
    • scapy.contrib.ppi_cace
    • scapy.contrib.ppi_geotag
    • scapy.contrib.ripng
    • scapy.contrib.roce
    • scapy.contrib.rpl
      • RPL
    • scapy.contrib.rpl_metrics
    • scapy.contrib.rsvp
    • scapy.contrib.rtr
    • scapy.contrib.sdnv
    • scapy.contrib.sebek
    • scapy.contrib.send
    • scapy.contrib.skinny
    • scapy.contrib.socks
    • scapy.contrib.spbm
    • scapy.contrib.tacacs
    • scapy.contrib.tzsp
      • TZSP - TaZmen Sniffer Protocol
    • scapy.contrib.ubberlogger
    • scapy.contrib.vqp
    • scapy.contrib.vtp
      • VTP Scapy Extension
    • scapy.contrib.wireguard
    • scapy.contrib.wpa_eapol
  • scapy.layers
    • scapy.layers.tls
      • scapy.layers.tls.crypto
      • scapy.layers.tls.all
      • scapy.layers.tls.automaton
      • scapy.layers.tls.automaton_cli
      • scapy.layers.tls.automaton_srv
      • scapy.layers.tls.basefields
      • scapy.layers.tls.cert
      • scapy.layers.tls.extensions
      • scapy.layers.tls.handshake
      • scapy.layers.tls.handshake_sslv2
      • scapy.layers.tls.keyexchange
      • scapy.layers.tls.keyexchange_tls13
      • scapy.layers.tls.record
      • scapy.layers.tls.record_sslv2
      • scapy.layers.tls.record_tls13
      • scapy.layers.tls.session
      • scapy.layers.tls.tools
    • scapy.layers.bluetooth
    • scapy.layers.bluetooth4LE
    • scapy.layers.can
    • scapy.layers.clns
      • CLNS Extension
    • scapy.layers.dhcp
    • scapy.layers.dhcp6
    • scapy.layers.dns
    • scapy.layers.dot11
    • scapy.layers.dot15d4
    • scapy.layers.eap
    • scapy.layers.gprs
    • scapy.layers.hsrp
    • scapy.layers.http
    • scapy.layers.inet
    • scapy.layers.inet6
    • scapy.layers.ipsec
      • IPsec layer
    • scapy.layers.ir
    • scapy.layers.isakmp
    • scapy.layers.l2
    • scapy.layers.l2tp
    • scapy.layers.llmnr
    • scapy.layers.lltd
    • scapy.layers.mgcp
    • scapy.layers.mobileip
    • scapy.layers.netbios
    • scapy.layers.netflow
    • scapy.layers.ntp
    • scapy.layers.pflog
    • scapy.layers.ppi
    • scapy.layers.ppp
    • scapy.layers.pptp
    • scapy.layers.radius
    • scapy.layers.rip
    • scapy.layers.rtp
    • scapy.layers.sctp
    • scapy.layers.sixlowpan
      • 6LoWPAN Protocol Stack
    • scapy.layers.skinny
    • scapy.layers.smb
    • scapy.layers.smb2
    • scapy.layers.snmp
    • scapy.layers.tftp
    • scapy.layers.usb
    • scapy.layers.vrrp
    • scapy.layers.vxlan
    • scapy.layers.x509
    • scapy.layers.zigbee
  • scapy.ansmachine
  • scapy.as_resolvers
  • scapy.asn1fields
  • scapy.asn1packet
  • scapy.automaton
  • scapy.autorun
  • scapy.base_classes
  • scapy.compat
  • scapy.config
  • scapy.consts
  • scapy.dadict
  • scapy.data
  • scapy.error
  • scapy.extlib
  • scapy.fields
  • scapy.interfaces
  • scapy.main
  • scapy.packet
  • scapy.pipetool
  • scapy.plist
  • scapy.pton_ntop
  • scapy.route
  • scapy.route6
  • scapy.scapypipes
  • scapy.sendrecv
  • scapy.sessions
  • scapy.supersocket
  • scapy.themes
  • scapy.utils
  • scapy.utils6
  • scapy.volatile