Welcome to Scapy’s documentation!

Version:

2.6.1.dev82

Release:

2.6.1

Date:

May 22, 2025

Scapy’s documentation 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 network stack
  • Interfaces list
  • IPv4 routes
  • IPv6 routes
  • Get default gateway IP address
  • Get the IP of an interface
  • Get the MAC of an interface
  • Get MAC address of the next hop to reach an 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

• Layers
  • Automotive-specific Documentation
  • Bluetooth
  • DCE/RPC & [MS-RPCE]
  • .NET Protocols
  • GSSAPI
  • HTTP
  • Kerberos
  • LDAP
  • Netflow
  • PROFINET IO RTC
  • SCTP
  • SMB
  • TCP
  • TUN / TAP Interfaces

About

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

API Reference

• Scapy API reference