scapy README

The project's README from github.com/secdev/scapy. As one markdown file: README.md.

Scapy   Scapy

Scapy unit tests Codecov Status Codacy Badge PyPI Version License: GPL v2 Join the chat at https://gitter.im/secdev/scapy

Scapy is a powerful Python-based interactive packet manipulation program and library.

It is able to forge or decode packets of a wide number of protocols, send them on the wire, capture them, store or read them using pcap files, match requests and replies, and much more. It is designed to allow fast packet prototyping by using default values that work.

It can easily handle most classical tasks like scanning, tracerouting, probing, unit tests, attacks or network discovery (it can replace hping, 85% of nmap, arpspoof, arp-sk, arping, tcpdump, wireshark, p0f, etc.). It also performs very well at a lot of other specific tasks that most other tools can't handle, like sending invalid frames, injecting your own 802.11 frames, combining techniques (VLAN hopping+ARP cache poisoning, VoIP decoding on WEP protected channel, ...), etc.

Scapy supports Python 3.7+. It's intended to be cross platform, and runs on many different platforms (Linux, OSX, *BSD, and Windows).

Getting started

Scapy is usable either as a shell or as a library. For further details, please head over to Getting started with Scapy, which is part of the documentation.

Shell demo

Scapy install demo

Scapy can easily be used as an interactive shell to interact with the network. The following example shows how to send an ICMP Echo Request message to github.com, then display the reply source IP address:

sudo ./run_scapy
Welcome to Scapy
>>> p = IP(dst="github.com")/ICMP()
>>> r = sr1(p)
Begin emission:
.Finished to send 1 packets.
*
Received 2 packets, got 1 answers, remaining 0 packets
>>> r[IP].src
'192.30.253.113'

Resources

The documentation contains more advanced use cases, and examples.

Other useful resources:

Installation

Scapy works without any external Python modules on Linux and BSD like operating systems. On Windows, you need to install some mandatory dependencies as described in the documentation.

On most systems, using Scapy is as simple as running the following commands:

git clone https://github.com/secdev/scapy
cd scapy
./run_scapy

To benefit from all Scapy features, such as plotting, you might want to install Python modules, such as matplotlib or cryptography. See the documentation and follow the instructions to install them.

Packaging status

Packaging status

License

Scapy's code, tests and tools are licensed under GPL v2. The documentation (everything unless marked otherwise in doc/, and except the logo) is licensed under CC BY-NC-SA 2.5.

Contributing

Want to contribute? Great! Please take a few minutes to read this!

scapy (secdev/scapy)

Searching Database…

12.6K ·GitHub
Что это такое?Scapy — это интерактивная программа и библиотека на Python для работы с сетевыми пакетами: она позволяет формировать, декодировать, отправлять, перехватывать и анализировать пакеты.
Это командная оболочка или библиотека Python?И то, и другое: Scapy работает как интерактивная оболочка для живой работы с пакетами в сети, а тот же код можно импортировать как библиотеку в собственные скрипты на Python.
Как начать пользоваться?Установите его и запустите оболочку Scapy напрямую или импортируйте scapy в свои скрипты на Python; основы описаны на странице документации «Getting started» и в учебнике «Scapy in 20 minutes».
Нужны ли дополнительные пакеты Python, чтобы всё работало?Базовое создание и перехват пакетов работают без внешних модулей на Linux и BSD, но для дополнительных возможностей, например построения графиков, нужны сторонние библиотеки, такие как matplotlib или cryptography.
Работает ли он сразу после установки в Windows?Не сразу: в Windows сначала нужно установить несколько обязательных зависимостей, описанных в документации, и только после этого Scapy начнёт работать.
На каких операционных системах он работает?Scapy кроссплатформенный: он работает на Linux, macOS, BSD и Windows и поддерживает Python 3.7 и новее.
Какие существующие инструменты может заменить Scapy?Он может заменить hping, значительную часть возможностей nmap, arpspoof, arp-sk, arping, tcpdump, wireshark и p0f во многих классических сетевых задачах.
Для каких задач он подходит помимо простого перехвата трафика?Сканирование, traceroute, зондирование, модульное тестирование, создание собственных атак и обнаружение сетевых устройств, а также продвинутые приёмы: отправку некорректных кадров, внедрение сырых кадров 802.11 или сочетание VLAN hopping с отравлением ARP-кэша.
Где найти практические примеры, чтобы научиться?В документации есть руководство «Getting started», интерактивный учебник «Scapy in 20 minutes», короткая демонстрационная интерактивная сессия и отдельные ноутбуки для HTTP/2 и TLS.
What are similar projects?sniffnet, brook, masscan, ecapture, thc-hydra, fq, impacket, netshoot
Creator
secdev
Size
85.6 MB
Stars
12.6K
Age
11y
Commits · 90 Days