Metadata-Version: 2.1
Name: pwntools
Version: 4.8.0
Summary: Pwntools CTF framework and exploit development library.
Home-page: https://pwntools.com
Author: Gallopsled et al.
Author-email: pwntools-users@googlegroups.com
License: Mostly MIT, some GPL/BSD, see LICENSE-pwntools.txt
Download-URL: https://github.com/Gallopsled/pwntools/releases
Keywords: pwntools exploit ctf capture the flag binary wargame overflow stack heap defcon
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Security
Classifier: Topic :: Software Development :: Assemblers
Classifier: Topic :: Software Development :: Debuggers
Classifier: Topic :: Software Development :: Disassemblers
Classifier: Topic :: Software Development :: Embedded Systems
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: System :: System Shells
Classifier: Topic :: Utilities
Requires-Python: >=2.7
License-File: LICENSE-pwntools.txt

pwntools - CTF toolkit
======================

.. figure:: https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true
   :alt: pwntools logo

   pwntools logo

|PyPI| |Docs| |Travis| |GitHub Workflow Status (branch)| |Coveralls|
|MIT License| |Discord| |Twitter|

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.

.. code:: 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

.. code:: 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

.. |PyPI| image:: https://img.shields.io/pypi/v/pwntools?style=flat
   :target: https://pypi.python.org/pypi/pwntools/
.. |Docs| image:: https://readthedocs.org/projects/pwntools/badge/?version=stable
   :target: https://docs.pwntools.com/
.. |Travis| image:: https://img.shields.io/travis/Gallopsled/pwntools/dev?logo=Travis
   :target: https://travis-ci.org/Gallopsled/pwntools
.. |GitHub Workflow Status (branch)| image:: https://img.shields.io/github/workflow/status/Gallopsled/pwntools/Continuous%20Integration/dev?logo=GitHub
   :target: https://github.com/Gallopsled/pwntools/actions?query=workflow%3A%22Continuous+Integration%22+branch%3Adev
.. |Coveralls| image:: https://img.shields.io/coveralls/github/Gallopsled/pwntools/dev?logo=coveralls
   :target: https://coveralls.io/github/Gallopsled/pwntools?branch=dev
.. |MIT License| image:: https://img.shields.io/badge/license-MIT-blue.svg?style=flat
   :target: http://choosealicense.com/licenses/mit/
.. |Discord| image:: https://img.shields.io/discord/809590285687980052?label=Discord&style=plastic
   :target: https://discord.gg/96VA2zvjCB
.. |Twitter| image:: https://img.shields.io/twitter/follow/Pwntools
   :target: https://twitter.com/pwntools


