Skip to content

Commit

Permalink
Replace project name references
Browse files Browse the repository at this point in the history
  • Loading branch information
zachriggle committed Jun 30, 2016
1 parent c32ae58 commit 33cdabf
Show file tree
Hide file tree
Showing 29 changed files with 84 additions and 84 deletions.
4 changes: 2 additions & 2 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,5 +11,5 @@ docs/build
build
MANIFEST
dist
binjitsu.egg-info
*.core
*.egg-info
*.core
4 changes: 2 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Github has a great guide for contributing to open source projects:
- [Making a Pull Request](https://guides.github.com/activities/forking/#making-a-pull-request)
- [Huzzah!](https://guides.github.com/activities/forking/#huzzah)

## binjitsu Specifics
## pwntools Specifics

In general, we like to keep things documented. You should add documentation to any new functionality, and update it for any changed functionality. Our docstrings use the [Google Style Python Docstrings](https://sphinxcontrib-napoleon.readthedocs.org/en/latest/example_google.html#example-google).

Expand All @@ -25,6 +25,6 @@ comment on it and then hopefully merge it into master.

## Automated Testing

Pull requests against Binjitsu require at a minimum that no tests have been broken, and ideally each pull request will include new tests to ensure that all of the functionality works as intended.
Pull requests against Pwntools require at a minimum that no tests have been broken, and ideally each pull request will include new tests to ensure that all of the functionality works as intended.

You can find more information on testing in [TESTING.md](TESTING.md).
24 changes: 12 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# binjitsu - CTF toolkit
[![Docs latest](https://readthedocs.org/projects/binjitsu/badge/?version=latest)](https://binjitsu.readthedocs.org/)
[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=master)](https://travis-ci.org/binjitsu/binjitsu)
[![Twitter](https://img.shields.io/badge/twitter-ctfbinjitsu-4099FF.svg?style=flat)](https://twitter.com/ctfbinjitsu)
# pwntools - CTF toolkit
[![Docs latest](https://readthedocs.org/projects/pwntools/badge/?version=latest)](https://pwntools.readthedocs.org/)
[![Travis](https://travis-ci.org/Gallopsled/pwntools.svg?branch=master)](https://travis-ci.org/pwntools/pwntools)
[![Twitter](https://img.shields.io/badge/twitter-ctfpwntools-4099FF.svg?style=flat)](https://twitter.com/ctfpwntools)
[![MIT License](https://img.shields.io/badge/license-MIT-blue.svg?style=flat)](http://choosealicense.com/licenses/mit/)

binjitsu 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.
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 *
Expand All @@ -18,34 +18,34 @@ r.interactive()

# Try It Now!

You can now do a live demo of Binjitsu, [right in your browser](http://demo.pwntools.com). Alternately, you can SSH to the same host, and log in as user `zerocool` with [this private key][key] (password `i_promise_not_to_be_evil`).
You can now do a live demo of Pwntools, [right in your browser](http://demo.pwntools.com). Alternately, you can SSH to the same host, and log in as user `zerocool` with [this private key][key] (password `i_promise_not_to_be_evil`).

It will drop you into a clean, Docker-ized container. There is nothing of value on the VPS, so please don't be evil.

[key]: https://gist.githubusercontent.com/zachriggle/efa2e0080ae6de2e8344/raw/4b503e9db54f009d97477d03d4ba5678471f8ff0/id_rsa

# Origin

binjitsu is a fork of the [`pwntools`](https://github.com/Gallopsled/pwntools) project. For the most part, it's a drop-in replacement, though I've added some functionality of my own which may not be available in the upstream release.
pwntools is a fork of the [`pwntools`](https://github.com/Gallopsled/pwntools) project. For the most part, it's a drop-in replacement, though I've added some functionality of my own which may not be available in the upstream release.

# Documentation
Our documentation is available at [binjitsu.readthedocs.org](https://binjitsu.readthedocs.org/)
Our documentation is available at [pwntools.readthedocs.org](https://pwntools.readthedocs.org/)

To get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/binjitsu/examples).
To get you started, we've provided some example solutions for past CTF challenges in our [write-ups repository](https://github.com/pwntools/examples).

# Installation

binjitsu is best supported on 64-bit Ubuntu 12.04 and 14.04, but most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.). Python 2.7 is required.
pwntools is best supported on 64-bit Ubuntu 12.04 and 14.04, but most functionality should work on any Posix-like distribution (Debian, Arch, FreeBSD, OSX, etc.). Python 2.7 is required.

Most of the functionality of binjitsu is self-contained and Python-only. You should be able to get running quickly with
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
pip install --upgrade git+https://github.com/Gallopsled/pwntools.git
```

However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://binjitsu.readthedocs.org/install.html).
However, some of the features (assembling/disassembling foreign architectures) require non-Python dependencies. For more information, see the [complete installation instructions here](https://pwntools.readthedocs.org/install.html).


# Contribution
Expand Down
2 changes: 1 addition & 1 deletion TESTING.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# Testing

Binjitsu makes extensive use of unit tests and integration tests to ensure everything is in working order, and no regressions occur.
Pwntools makes extensive use of unit tests and integration tests to ensure everything is in working order, and no regressions occur.

## Test Suite

Expand Down
8 changes: 4 additions & 4 deletions docs/Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -85,17 +85,17 @@ qthelp:
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/binjitsu.qhcp"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/pwntools.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/binjitsu.qhc"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/pwntools.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/binjitsu"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/binjitsu"
@echo "# mkdir -p $$HOME/.local/share/devhelp/pwntools"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/pwntools"
@echo "# devhelp"

epub:
Expand Down
10 changes: 5 additions & 5 deletions docs/source/about.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,17 @@
About binjitsu
About pwntools
========================

Whether you're using it to write exploits, or as part
of another software project will dictate how you use it.

Historically binjitsu was used as a sort of exploit-writing DSL. Simply doing
``from pwn import *`` in a previous version of binjitsu would bring all sorts of
Historically pwntools was used as a sort of exploit-writing DSL. Simply doing
``from pwn import *`` in a previous version of pwntools would bring all sorts of
nice side-effects.

When redesigning binjitsu for 2.0, we noticed two contrary goals:
When redesigning pwntools for 2.0, we noticed two contrary goals:

* We would like to have a "normal" python module structure, to allow other
people to familiarize themselves with binjitsu quickly.
people to familiarize themselves with pwntools quickly.
* We would like to have even more side-effects, especially by putting the
terminal in raw-mode.

Expand Down
2 changes: 1 addition & 1 deletion docs/source/commandline.rst
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
Command Line Tools
========================

binjitsu comes with a handful of useful command-line utilities which serve as wrappers for some of the internal functionality.
pwntools comes with a handful of useful command-line utilities which serve as wrappers for some of the internal functionality.

.. toctree::

Expand Down
14 changes: 7 additions & 7 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# -*- coding: utf-8 -*-
#
# binjitsu documentation build configuration file, created by
# pwntools documentation build configuration file, created by
# sphinx-quickstart on Wed May 28 15:00:52 2014.
#
# This file is execfile()d with the current directory set to its containing dir.
Expand Down Expand Up @@ -74,7 +74,7 @@
master_doc = 'index'

# General information about the project.
project = u'binjitsu'
project = u'pwntools'
copyright = u'2015, Zach Riggle'

# The version info for the project you're documenting, acts as replacement for
Expand Down Expand Up @@ -197,7 +197,7 @@
#html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = 'binjitsudoc'
htmlhelp_basename = 'pwntoolsdoc'


# -- Options for LaTeX output --------------------------------------------------
Expand All @@ -216,7 +216,7 @@
# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title, author, documentclass [howto/manual]).
latex_documents = [
('index', 'binjitsu.tex', u'binjitsu Documentation',
('index', 'pwntools.tex', u'pwntools Documentation',
u'2015, Zach Riggle', 'manual'),
]

Expand Down Expand Up @@ -249,7 +249,7 @@
# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
('index', 'binjitsu', u'binjitsu Documentation',
('index', 'pwntools', u'pwntools Documentation',
[u'2015, Zach Riggle'], 1)
]

Expand All @@ -263,8 +263,8 @@
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
('index', 'binjitsu', u'binjitsu Documentation',
u'', 'binjitsu', 'CTF exploit writing toolkit.',
('index', 'pwntools', u'pwntools Documentation',
u'', 'pwntools', 'CTF exploit writing toolkit.',
'Miscellaneous'),
]

Expand Down
6 changes: 3 additions & 3 deletions docs/source/globals.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
``from pwn import *``
========================

The most common way that you'll see binjitsu used is
The most common way that you'll see pwntools used is

>>> from pwn import *

Expand All @@ -15,7 +15,7 @@ This is a quick list of most of the objects and routines imported, in rough orde

- ``context``
- :data:`pwnlib.context.context`
- Responsible for most of the binjitsu convenience settings
- Responsible for most of the pwntools convenience settings
- Set `context.log_level = 'debug'` when troubleshooting your exploit
- Scope-aware, so you can disable logging for a subsection of code via ``pwnlib.context.ContextType.local``
- ``remote``, ``listen``, ``ssh``, ``process``
Expand All @@ -39,7 +39,7 @@ This is a quick list of most of the objects and routines imported, in rough orde
- :mod:`pwnlib.asm`
- Quickly turn assembly into some bytes, or vice-versa, without mucking about
- Supports any architecture for which you have a binutils installed
- Over 20 different architectures have pre-built binaries at `ppa:binjitsu/binutils <https://launchpad.net/~binjitsu/+archive/ubuntu/binutils>`_.
- Over 20 different architectures have pre-built binaries at `ppa:pwntools/binutils <https://launchpad.net/~pwntools/+archive/ubuntu/binutils>`_.
- ``shellcraft``
- :mod:`pwnlib.shellcraft`
- Library of shellcode ready to go
Expand Down
6 changes: 3 additions & 3 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
binjitsu
pwntools
====================================

``binjitsu`` is a CTF framework and exploit development library.
``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.

Expand All @@ -22,7 +22,7 @@ Getting Started
Module Index
------------

Each of the ``binjitsu`` modules is documented here.
Each of the ``pwntools`` modules is documented here.

.. toctree::
:maxdepth: 1
Expand Down
10 changes: 5 additions & 5 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
Installation
============

binjitsu is best supported on Ubuntu 12.04 and 14.04, but most
pwntools is best supported on Ubuntu 12.04 and 14.04, but most
functionality should work on any Posix-like distribution (Debian, Arch,
FreeBSD, OSX, etc.).

Prerequisites
-------------

In order to get the most out of ``binjitsu``, you should have the
In order to get the most out of ``pwntools``, you should have the
following system libraries installed.

.. toctree::
Expand All @@ -20,7 +20,7 @@ following system libraries installed.
Released Version
-----------------

binjitsu is available as a ``pip`` package.
pwntools is available as a ``pip`` package.

.. code-block:: bash
Expand All @@ -30,12 +30,12 @@ binjitsu is available as a ``pip`` package.
Development
--------------

If you are hacking on Binjitsu locally, you'll want to do something like this:
If you are hacking on Pwntools locally, you'll want to do something like this:

.. code-block:: bash
$ git clone https://github.com/Gallopsled/pwntools
$ cd binjitsu
$ cd pwntools
$ pip install -e .
.. _Ubuntu: https://launchpad.net/~pwntools/+archive/ubuntu/binutils
2 changes: 1 addition & 1 deletion docs/source/install/binutils.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Building `binutils` from source takes about 60 seconds on a modern 8-core machin

Ubuntu
^^^^^^^^^^^^^^^^
First, add our `Personal Package Archive repository <http://binutils.binjitsu.com>`__.
First, add our `Personal Package Archive repository <http://binutils.pwntools.com>`__.

.. code-block:: bash
Expand Down
2 changes: 1 addition & 1 deletion docs/source/install/headers.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
Python Development Headers
-----------------------------

Some of binjitsu' Python dependencies require native extensions (for example, Paramiko requires PyCrypto).
Some of pwntools' Python dependencies require native extensions (for example, Paramiko requires PyCrypto).

In order to build these native extensions, the development headers for Python must be installed.

Expand Down
12 changes: 6 additions & 6 deletions docs/source/intro.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,9 @@
Getting Started
========================

To get your feet wet with binjitsu, let's first go through a few examples.
To get your feet wet with pwntools, let's first go through a few examples.

When writing exploits, binjitsu generally follows the "kitchen sink" approach.
When writing exploits, pwntools generally follows the "kitchen sink" approach.

>>> from pwn import *

Expand All @@ -21,7 +21,7 @@ Making Connections
------------------

You need to talk to the challenge binary in order to pwn it, right?
binjitsu makes this stupid simple with its :mod:`pwnlib.tubes` module.
pwntools makes this stupid simple with its :mod:`pwnlib.tubes` module.

This exposes a standard interface to talk to processes, sockets, serial ports,
and all manner of things, along with some nifty helpers for common tasks.
Expand Down Expand Up @@ -91,7 +91,7 @@ A common task for exploit-writing is converting between integers as Python
sees them, and their representation as a sequence of bytes.
Usually folks resort to the built-in ``struct`` module.

binjitsu makes this easier with :mod:`pwnlib.util.packing`. No more remembering
pwntools makes this easier with :mod:`pwnlib.util.packing`. No more remembering
unpacking codes, and littering your code with helper routines.

>>> import struct
Expand Down Expand Up @@ -139,7 +139,7 @@ Additionally, you can use a shorthand to set all of the values at once.
Setting Logging Verbosity
-------------------------

You can control the verbosity of the standard binjitsu logging via ``context``.
You can control the verbosity of the standard pwntools logging via ``context``.

For example, setting

Expand Down Expand Up @@ -170,7 +170,7 @@ But if you do, it's easy to suss out!
5: eb f9 jmp 0x0

However, you shouldn't even need to write your own shellcode most of the
time! binjitsu comes with the :mod:`pwnlib.shellcraft` module, which is
time! pwntools comes with the :mod:`pwnlib.shellcraft` module, which is
loaded with useful time-saving shellcodes.

Let's say that we want to `setreuid(getuid(), getuid())` followed by `dup`ing
Expand Down
6 changes: 3 additions & 3 deletions examples/README.md
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
# Examples
While these examples should all work, they are not very representative of
the binjitsu project.
the pwntools project.

We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
https://binjitsu.readthedocs.org, as this is a better overview of our features.
https://pwntools.readthedocs.org, as this is a better overview of our features.

In no particular order the docstrings for each example:

Expand Down Expand Up @@ -77,7 +77,7 @@ off some proof-of-concepts.
* `remote_gdb_debugging.py`
```
Simple example showing how to use the remote
gdb debugging features available in binjitsu.
gdb debugging features available in pwntools.
```
* `spinners.py`
```
Expand Down
2 changes: 1 addition & 1 deletion examples/android.py
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
from pwn import *

# Tell binjitsu that the target is an Android device
# Tell pwntools that the target is an Android device
context.os='android'
context.arch='aarch64' # or 'arm'

Expand Down
4 changes: 2 additions & 2 deletions examples/gen-README.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

out = '''# Examples
While these examples should all work, they are not very representative of
the binjitsu project.
the pwntools project.
We have a plan to create a separate repository with examples, primarily
exploits. Until we do so, we recommend new users to look at
https://binjitsu.readthedocs.org, as this is a better overview of our features.
https://pwntools.readthedocs.org, as this is a better overview of our features.
In no particular order the docstrings for each example:
Expand Down
Loading

0 comments on commit 33cdabf

Please sign in to comment.