Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
5 additions
and
51 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,57 +1,11 @@ | ||
# pwntools - CTF toolkit | ||
![pwntools logo](https://github.com/Gallopsled/pwntools/blob/stable/docs/source/logo.png?raw=true) | ||
|
||
[![Docs](https://readthedocs.org/projects/pwntools/badge/?version=stable)](https://docs.pwntools.com/) | ||
[![PyPI](https://img.shields.io/badge/pypi-v3.8.0-green.svg?style=flat)](https://pypi.python.org/pypi/pwntools/) | ||
[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg)](https://travis-ci.org/Gallopsled/pwntools) | ||
[![Coveralls](https://img.shields.io/coveralls/Gallopsled/pwntools/dev.svg)](https://coveralls.io/github/Gallopsled/pwntools?branch=dev) | ||
[![Twitter](https://img.shields.io/badge/twitter-pwntools-4099FF.svg?style=flat)](https://twitter.com/pwntools) | ||
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/) | ||
# Pwntools - CTF toolkit | ||
|
||
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() | ||
``` | ||
|
||
# Try It Now! | ||
|
||
You can now do a live demo of Pwntools, [right in your browser](https://demo.pwntools.com). | ||
|
||
# Documentation | ||
|
||
Our documentation is available at [docs.pwntools.com](https://docs.pwntools.com/) | ||
|
||
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 LTE releases (12.04, 14.04, and 16.04). Most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.). Python 2.7 is required. | ||
|
||
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 python2.7 python-pip python-dev git libssl-dev libffi-dev build-essential | ||
pip install --upgrade pip | ||
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). | ||
|
||
# Forked and modified | ||
|
||
# Contribution | ||
Modified to optimize I/O display. Helps a lot on reviewing the I/O sequence. | ||
|
||
See [CONTRIBUTING.md](CONTRIBUTING.md) | ||
# Available new API | ||
|
||
# Contact | ||
If you have any questions not worthy of a [bug report](https://github.com/Gallopsled/pwntools/issues), feel free to ping us | ||
at [`#pwntools` on Freenode](irc://irc.freenode.net/pwntools) and ask away. | ||
Click [here](https://kiwiirc.com/client/irc.freenode.net/pwntools) to connect. | ||
There is also a [mailing list](https://groups.google.com/forum/#!forum/pwntools-users) for higher latency discussion. | ||
... |