# pwntools - CTF toolkit
![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true)
[![PyPI](https://img.shields.io/pypi/v/pwntools?style=flat)](https://pypi.python.org/pypi/pwntools/)
[![Docs](https://readthedocs.org/projects/pwntools/badge/?version=stable)](https://docs.pwntools.com/)
[![GitHub Workflow Status (dev)](https://img.shields.io/github/actions/workflow/status/Gallopsled/pwntools/ci.yml?branch=dev&logo=GitHub)](https://github.com/Gallopsled/pwntools/actions/workflows/ci.yml?query=branch%3Adev)
[![Coveralls](https://img.shields.io/coveralls/github/Gallopsled/pwntools/dev?logo=coveralls)](https://coveralls.io/github/Gallopsled/pwntools?branch=dev)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)
[![Packaging status](https://img.shields.io/repology/repositories/python:pwntools)](https://repology.org/project/python:pwntools/versions)
[![Discord](https://img.shields.io/discord/809590285687980052?label=Discord&style=plastic)](https://discord.gg/96VA2zvjCB)
[![Twitter](https://img.shields.io/twitter/follow/Pwntools)](https://twitter.com/pwntools)
Pwntools is a CTF framework and exploit development library. Written in Python, it is designed for rapid prototyping and development, and intended to make exploit writing as simple as possible.
```python
from pwn import *
context(arch = 'i386', os = 'linux')
r = remote('exploitme.example.com', 31337)
# EXPLOIT CODE GOES HERE
r.send(asm(shellcraft.sh()))
r.interactive()
```
# Documentation
Our documentation is available at [docs.pwntools.com](https://docs.pwntools.com/)
A series of tutorials is also [available online](https://github.com/Gallopsled/pwntools-tutorial#readme)
To get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/Gallopsled/pwntools-write-ups).
# Installation
Pwntools is best supported on 64-bit Ubuntu LTS releases (14.04, 16.04, 18.04, and 20.04). Most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.).
Python3 is suggested, but Pwntools still works with Python 2.7. Most of the functionality of pwntools is self-contained and Python-only. You should be able to get running quickly with
```sh
apt-get update
apt-get install python3 python3-pip python3-dev git libssl-dev libffi-dev build-essential
python3 -m pip install --upgrade pip
python3 -m pip install --upgrade pwntools
```
However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://docs.pwntools.com/en/stable/install.html).
# Contribution
See [CONTRIBUTING.md](CONTRIBUTING.md)
# Contact and Community
If you have any questions not worthy of a [bug report](https://github.com/Gallopsled/pwntools/issues), join the Discord server at https://discord.gg/96VA2zvjCB
Raw data
{
"_id": null,
"home_page": null,
"name": "pwntools",
"maintainer": null,
"docs_url": null,
"requires_python": ">=2.7",
"maintainer_email": null,
"keywords": "pwntools, exploit, ctf, capture, the, flag, binary, wargame, overflow, stack, heap, defcon",
"author": null,
"author_email": "\"Gallopsled et al.\" <pwntools-users@googlegroups.com>",
"download_url": "https://files.pythonhosted.org/packages/24/72/f26dd3713ac1cbe7c451a7ae9e586096deb1a2da5218e308881a4d13c3d4/pwntools-4.13.1.tar.gz",
"platform": null,
"description": "# pwntools - CTF toolkit\n![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true)\n\n[![PyPI](https://img.shields.io/pypi/v/pwntools?style=flat)](https://pypi.python.org/pypi/pwntools/)\n[![Docs](https://readthedocs.org/projects/pwntools/badge/?version=stable)](https://docs.pwntools.com/)\n[![GitHub Workflow Status (dev)](https://img.shields.io/github/actions/workflow/status/Gallopsled/pwntools/ci.yml?branch=dev&logo=GitHub)](https://github.com/Gallopsled/pwntools/actions/workflows/ci.yml?query=branch%3Adev)\n[![Coveralls](https://img.shields.io/coveralls/github/Gallopsled/pwntools/dev?logo=coveralls)](https://coveralls.io/github/Gallopsled/pwntools?branch=dev)\n[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)\n[![Packaging status](https://img.shields.io/repology/repositories/python:pwntools)](https://repology.org/project/python:pwntools/versions)\n[![Discord](https://img.shields.io/discord/809590285687980052?label=Discord&style=plastic)](https://discord.gg/96VA2zvjCB)\n[![Twitter](https://img.shields.io/twitter/follow/Pwntools)](https://twitter.com/pwntools)\n\nPwntools is a CTF framework and exploit development library. Written in Python, it is designed for rapid prototyping and development, and intended to make exploit writing as simple as possible.\n\n```python\nfrom pwn import *\ncontext(arch = 'i386', os = 'linux')\n\nr = remote('exploitme.example.com', 31337)\n# EXPLOIT CODE GOES HERE\nr.send(asm(shellcraft.sh()))\nr.interactive()\n```\n\n# Documentation\n\nOur documentation is available at [docs.pwntools.com](https://docs.pwntools.com/)\n\nA series of tutorials is also [available online](https://github.com/Gallopsled/pwntools-tutorial#readme)\n\nTo get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/Gallopsled/pwntools-write-ups).\n\n# Installation\n\nPwntools is best supported on 64-bit Ubuntu LTS releases (14.04, 16.04, 18.04, and 20.04). Most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.). \n\nPython3 is suggested, but Pwntools still works with Python 2.7. Most of the functionality of pwntools is self-contained and Python-only. You should be able to get running quickly with\n\n```sh\napt-get update\napt-get install python3 python3-pip python3-dev git libssl-dev libffi-dev build-essential\npython3 -m pip install --upgrade pip\npython3 -m pip install --upgrade pwntools\n```\n\n\nHowever, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://docs.pwntools.com/en/stable/install.html).\n\n\n# Contribution\n\nSee [CONTRIBUTING.md](CONTRIBUTING.md)\n\n# Contact and Community\nIf you have any questions not worthy of a [bug report](https://github.com/Gallopsled/pwntools/issues), join the Discord server at https://discord.gg/96VA2zvjCB\n",
"bugtrack_url": null,
"license": "Mostly MIT, some GPL/BSD, see LICENSE-pwntools.txt",
"summary": "Pwntools CTF framework and exploit development library.",
"version": "4.13.1",
"project_urls": {
"download": "https://github.com/Gallopsled/pwntools/releases",
"homepage": "https://pwntools.com"
},
"split_keywords": [
"pwntools",
" exploit",
" ctf",
" capture",
" the",
" flag",
" binary",
" wargame",
" overflow",
" stack",
" heap",
" defcon"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f7a53a8e96f787cbe644aff525108c6c52ddf0140fa8174f8b32bdcc555fe0ff",
"md5": "aca974539533bd1a21c08504a1324535",
"sha256": "2f910a15204bfbc05f62948e796a15dae3e8c386447536947638b5dd028de23f"
},
"downloads": -1,
"filename": "pwntools-4.13.1-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "aca974539533bd1a21c08504a1324535",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=2.7",
"size": 11905563,
"upload_time": "2024-09-29T21:57:58",
"upload_time_iso_8601": "2024-09-29T21:57:58.657748Z",
"url": "https://files.pythonhosted.org/packages/f7/a5/3a8e96f787cbe644aff525108c6c52ddf0140fa8174f8b32bdcc555fe0ff/pwntools-4.13.1-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2472f26dd3713ac1cbe7c451a7ae9e586096deb1a2da5218e308881a4d13c3d4",
"md5": "73aa089ac4789e36b46919e539552b76",
"sha256": "b3322725fb5031dc30965e3855073608d9abf74d2abf97a72c67d44aadfce37c"
},
"downloads": -1,
"filename": "pwntools-4.13.1.tar.gz",
"has_sig": false,
"md5_digest": "73aa089ac4789e36b46919e539552b76",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=2.7",
"size": 5476226,
"upload_time": "2024-09-29T21:58:01",
"upload_time_iso_8601": "2024-09-29T21:58:01.625118Z",
"url": "https://files.pythonhosted.org/packages/24/72/f26dd3713ac1cbe7c451a7ae9e586096deb1a2da5218e308881a4d13c3d4/pwntools-4.13.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-29 21:58:01",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Gallopsled",
"github_project": "pwntools",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "pwntools"
}