scapy


Namescapy JSON
Version 2.6.1 PyPI version JSON
download
home_pageNone
SummaryScapy: interactive packet manipulation tool
upload_time2024-11-05 08:43:23
maintainerPierre LALET, Gabriel POTTER, Guillaume VALADON, Nils WEISS
docs_urlNone
authorPhilippe BIONDI
requires_python<4,>=3.7
licenseGPL-2.0-only
keywords network
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI
coveralls test coverage No coveralls.
            # <img src="https://github.com/secdev/scapy/raw/master/doc/scapy/graphics/scapy_logo.png" width="64" valign="middle" alt="Scapy" />&nbsp;&nbsp; Scapy

[![PyPI Version](https://img.shields.io/pypi/v/scapy.svg)](https://pypi.python.org/pypi/scapy/)
[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](LICENSE)

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](https://scapy.readthedocs.io/en/latest/introduction.html), which is part of the documentation.

### Shell demo

![Scapy install demo](https://secdev.github.io/files/doc/animation-scapy-install.svg)

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:

```python
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](https://scapy.readthedocs.io/en/latest/) contains more
advanced use cases, and examples.

Other useful resources:

-   [Scapy in 20 minutes](https://github.com/secdev/scapy/blob/master/doc/notebooks/Scapy%20in%2015%20minutes.ipynb)
-   [Interactive tutorial](https://scapy.readthedocs.io/en/latest/usage.html#interactive-tutorial) (part of the documentation)
-   [The quick demo: an interactive session](https://scapy.readthedocs.io/en/latest/introduction.html#quick-demo) (some examples may be outdated)
-   [HTTP/2 notebook](https://github.com/secdev/scapy/blob/master/doc/notebooks/HTTP_2_Tuto.ipynb)
-   [TLS notebooks](https://github.com/secdev/scapy/blob/master/doc/notebooks/tls)

## [Installation](https://scapy.readthedocs.io/en/latest/installation.html)

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](http://scapy.readthedocs.io/en/latest/installation.html#windows).

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

```bash
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](http://scapy.readthedocs.io/en/latest/installation.html) and
follow the instructions to install them.

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "scapy",
    "maintainer": "Pierre LALET, Gabriel POTTER, Guillaume VALADON, Nils WEISS",
    "docs_url": null,
    "requires_python": "<4,>=3.7",
    "maintainer_email": null,
    "keywords": "network",
    "author": "Philippe BIONDI",
    "author_email": null,
    "download_url": "https://files.pythonhosted.org/packages/df/2f/035d3888f26d999e9680af8c7ddb7ce4ea0fd8d0e01c000de634c22dcf13/scapy-2.6.1.tar.gz",
    "platform": null,
    "description": "# <img src=\"https://github.com/secdev/scapy/raw/master/doc/scapy/graphics/scapy_logo.png\" width=\"64\" valign=\"middle\" alt=\"Scapy\" />&nbsp;&nbsp; Scapy\n\n[![PyPI Version](https://img.shields.io/pypi/v/scapy.svg)](https://pypi.python.org/pypi/scapy/)\n[![License: GPL v2](https://img.shields.io/badge/License-GPL%20v2-blue.svg)](LICENSE)\n\nScapy is a powerful Python-based interactive packet manipulation program and\nlibrary.\n\nIt is able to forge or decode packets of a wide number of protocols, send them\non the wire, capture them, store or read them using pcap files, match requests\nand replies, and much more. It is designed to allow fast packet prototyping by\nusing default values that work.\n\nIt can easily handle most classical tasks like scanning, tracerouting, probing,\nunit tests, attacks or network discovery (it can replace `hping`, 85% of `nmap`,\n`arpspoof`, `arp-sk`, `arping`, `tcpdump`, `wireshark`, `p0f`, etc.). It also\nperforms very well at a lot of other specific tasks that most other tools can't\nhandle, like sending invalid frames, injecting your own 802.11 frames, combining\ntechniques (VLAN hopping+ARP cache poisoning, VoIP decoding on WEP protected\nchannel, ...), etc.\n\nScapy supports Python 3.7+. It's intended to\nbe cross platform, and runs on many different platforms (Linux, OSX,\n\\*BSD, and Windows).\n\n## Getting started\n\nScapy is usable either as a **shell** or as a **library**.\nFor further details, please head over to [Getting started with Scapy](https://scapy.readthedocs.io/en/latest/introduction.html), which is part of the documentation.\n\n### Shell demo\n\n![Scapy install demo](https://secdev.github.io/files/doc/animation-scapy-install.svg)\n\nScapy can easily be used as an interactive shell to interact with the network.\nThe following example shows how to send an ICMP Echo Request message to\n`github.com`, then display the reply source IP address:\n\n```python\nsudo ./run_scapy\nWelcome to Scapy\n>>> p = IP(dst=\"github.com\")/ICMP()\n>>> r = sr1(p)\nBegin emission:\n.Finished to send 1 packets.\n*\nReceived 2 packets, got 1 answers, remaining 0 packets\n>>> r[IP].src\n'192.30.253.113'\n```\n\n### Resources\n\nThe [documentation](https://scapy.readthedocs.io/en/latest/) contains more\nadvanced use cases, and examples.\n\nOther useful resources:\n\n-   [Scapy in 20 minutes](https://github.com/secdev/scapy/blob/master/doc/notebooks/Scapy%20in%2015%20minutes.ipynb)\n-   [Interactive tutorial](https://scapy.readthedocs.io/en/latest/usage.html#interactive-tutorial) (part of the documentation)\n-   [The quick demo: an interactive session](https://scapy.readthedocs.io/en/latest/introduction.html#quick-demo) (some examples may be outdated)\n-   [HTTP/2 notebook](https://github.com/secdev/scapy/blob/master/doc/notebooks/HTTP_2_Tuto.ipynb)\n-   [TLS notebooks](https://github.com/secdev/scapy/blob/master/doc/notebooks/tls)\n\n## [Installation](https://scapy.readthedocs.io/en/latest/installation.html)\n\nScapy works without any external Python modules on Linux and BSD like operating\nsystems. On Windows, you need to install some mandatory dependencies as\ndescribed in [the\ndocumentation](http://scapy.readthedocs.io/en/latest/installation.html#windows).\n\nOn most systems, using Scapy is as simple as running the following commands:\n\n```bash\ngit clone https://github.com/secdev/scapy\ncd scapy\n./run_scapy\n```\n\nTo benefit from all Scapy features, such as plotting, you might want to install\nPython modules, such as `matplotlib` or `cryptography`. See the\n[documentation](http://scapy.readthedocs.io/en/latest/installation.html) and\nfollow the instructions to install them.\n",
    "bugtrack_url": null,
    "license": "GPL-2.0-only",
    "summary": "Scapy: interactive packet manipulation tool",
    "version": "2.6.1",
    "project_urls": {
        "Changelog": "https://github.com/secdev/scapy/releases",
        "Documentation": "https://scapy.readthedocs.io",
        "Download": "https://github.com/secdev/scapy/tarball/master",
        "Homepage": "https://scapy.net",
        "Source Code": "https://github.com/secdev/scapy"
    },
    "split_keywords": [
        "network"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4b348695b43af99d0c796e4b7933a0d7df8925f43a8abdd0ff0f6297beb4de3a",
                "md5": "10dc60e065160b2ea7e6a43b000e415b",
                "sha256": "88a998572049b511a1f3e44f4aa7c62dd39c6ea2aa1bb58434f503956641789d"
            },
            "downloads": -1,
            "filename": "scapy-2.6.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "10dc60e065160b2ea7e6a43b000e415b",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4,>=3.7",
            "size": 2420670,
            "upload_time": "2024-11-05T08:43:21",
            "upload_time_iso_8601": "2024-11-05T08:43:21.285600Z",
            "url": "https://files.pythonhosted.org/packages/4b/34/8695b43af99d0c796e4b7933a0d7df8925f43a8abdd0ff0f6297beb4de3a/scapy-2.6.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "df2f035d3888f26d999e9680af8c7ddb7ce4ea0fd8d0e01c000de634c22dcf13",
                "md5": "b8951038f22c9ec447538be8b08ac503",
                "sha256": "7600d7e2383c853e5c3a6e05d37e17643beebf2b3e10d7914dffcc3bc3c6e6c5"
            },
            "downloads": -1,
            "filename": "scapy-2.6.1.tar.gz",
            "has_sig": false,
            "md5_digest": "b8951038f22c9ec447538be8b08ac503",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4,>=3.7",
            "size": 2247754,
            "upload_time": "2024-11-05T08:43:23",
            "upload_time_iso_8601": "2024-11-05T08:43:23.488263Z",
            "url": "https://files.pythonhosted.org/packages/df/2f/035d3888f26d999e9680af8c7ddb7ce4ea0fd8d0e01c000de634c22dcf13/scapy-2.6.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-11-05 08:43:23",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "secdev",
    "github_project": "scapy",
    "travis_ci": true,
    "coveralls": false,
    "github_actions": true,
    "appveyor": true,
    "tox": true,
    "lcname": "scapy"
}
        
Elapsed time: 0.33890s