Skip to content

Commit

Permalink
6Jack -> 6jack + add FTP download address.
Browse files Browse the repository at this point in the history
  • Loading branch information
jedisct1 committed Jun 20, 2011
1 parent 2d2d7e9 commit e6d0025
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 22 deletions.
22 changes: 12 additions & 10 deletions README.markdown
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
6Jack
6jack
=====

A framework for analyzing/testing/fuzzing network applications.

Releases can be downloaded from: http://download.pureftpd.org/6jack/

## DESCRIPTION

**6Jack** runs a command, intercepts calls to common network-related
**6jack** runs a command, intercepts calls to common network-related
functions and pass them through a filter as **MessagePack** serialized
objects.

Expand All @@ -29,7 +31,7 @@ objects.
| +-----+
V

**6Jack** is especially suitable for:
**6jack** is especially suitable for:

* __Writing tests for clients and servers__:
Tests for networked applications are ofte limited to sending a bunch
Expand All @@ -40,21 +42,21 @@ objects.
How do you test for that? For example, how often does your test suite
actually include tests for cases like "quota exceeded" or "no space left
on device"?
6Jack makes it easy to simulate this kind of failure, without having
6jack makes it easy to simulate this kind of failure, without having
to patch your existing software.

* __Debugging and reverse engineering protocols__:
**tcpdump** is a super powerful tool. However, it has been designed to
log incoming and outgoing packets.
**6Jack** can alter the data sent from and to system calls. It can
**6jack** can alter the data sent from and to system calls. It can
help you understand what's going on over the wire by modifying stuff
and observing the impact.

* __Sketching filtering proxies__

* __Fuzzying__

**6Jack** works at application level. It's a simple library that gets
**6jack** works at application level. It's a simple library that gets
preloaded before the actual application.

**Pre-filters** can inspect and alter the content prior to calling the
Expand Down Expand Up @@ -109,7 +111,7 @@ upper case, and logs every object to `stderr`:
end

Other examples are available
[in the example-filters directory](https://github.com/jedisct1/6Jack/tree/master/example-filters).
[in the example-filters directory](https://github.com/jedisct1/6jack/tree/master/example-filters).

## COMMON PROPERTIES

Expand Down Expand Up @@ -286,7 +288,7 @@ Additional properties that can be added to replies for all functions

* `data`:
A raw **MessagePack** with the data to be send.
**6Jack** makes it appear as a single blob even though it might
**6jack** makes it appear as a single blob even though it might
actually be fragmented in multiple vectors.

* __Out__:
Expand Down Expand Up @@ -364,7 +366,7 @@ Additional properties that can be added to replies for all functions

* `data`:
Make as if this data had been read instead of the real data. The
size shouldn't exceed `nbyte`. **6Jack** will automatically
size shouldn't exceed `nbyte`. **6jack** will automatically
fragment it across multiple vectors if needed.

### recvfrom()
Expand Down Expand Up @@ -514,7 +516,7 @@ When a `SIXJACK_BYPASS` environment variable is defined, calls are not
diverted to the filter any more.

An application is free to set and unset `SIXJACK_BYPASS`, in order to
explicitly disable **6Jack** in some sections.
explicitly disable **6jack** in some sections.

## SAMPLE OUTPUT

Expand Down
15 changes: 9 additions & 6 deletions man/6jack.8
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,10 @@
\fB6jack\fR \fIfilter\fR \fIcommand\fR [\fIargs\fR]
.
.SH "DESCRIPTION"
\fB6Jack\fR runs a command, intercepts calls to common network\-related functions and pass them through a filter as \fBMessagePack\fR serialized objects\.
\fB6jack\fR runs a command, intercepts calls to common network\-related functions and pass them through a filter as \fBMessagePack\fR serialized objects\.
.
.P
\fB6Jack\fR works at application level\. It\'s a simple library that gets preloaded before the actual application\.
\fB6jack\fR works at application level\. It\'s a simple library that gets preloaded before the actual application\.
.
.P
\fBPre\-filters\fR can inspect and alter the content prior to calling the actual function\. A \fBpre\-filter\fR can also totally bypass the actual call, in order to simulate a call without actually hitting the network\.
Expand Down Expand Up @@ -71,19 +71,22 @@ write(2)
When a \fBSIXJACK_BYPASS\fR environment variable is defined, calls are not diverted to the filter any more\.
.
.P
An application is free to set and unset \fBSIXJACK_BYPASS\fR, in order to explicitly disable \fB6Jack\fR in some sections\.
An application is free to set and unset \fBSIXJACK_BYPASS\fR, in order to explicitly disable \fB6jack\fR in some sections\.
.
.SH "RETURN VALUES"
\fB6Jack\fR returns the exit value of \fIcommand\fR after completion\.
\fB6jack\fR returns the exit value of \fIcommand\fR after completion\.
.
.SH "SECURITY CONSIDERATIONS"
\fB6Jack\fR has been designed as a tool for testing applications\.
\fB6jack\fR has been designed as a tool for testing applications\.
.
.P
It is not suitable for running in a production environment or with untrusted data / filters\.
.
.SH "WWW"
\fB6Jack\fR is hosted on Github: \fBhttps://github\.com/jedisct1/6jack\fR
\fB6jack\fR is hosted on Github: \fBhttps://github\.com/jedisct1/6jack\fR
.
.P
Releases can be downloaded from: http://download\.pureftpd\.org/6jack/
.
.SH "SEE ALSO"
\fBMessagePack\fR home page: \fBhttp://msgpack\.org/\fR
14 changes: 8 additions & 6 deletions man/6jack.8.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@

## DESCRIPTION

**6Jack** runs a command, intercepts calls to common network-related
**6jack** runs a command, intercepts calls to common network-related
functions and pass them through a filter as **MessagePack** serialized
objects.

**6Jack** works at application level. It's a simple library that gets
**6jack** works at application level. It's a simple library that gets
preloaded before the actual application.

**Pre-filters** can inspect and alter the content prior to calling the
Expand Down Expand Up @@ -51,22 +51,24 @@ When a `SIXJACK_BYPASS` environment variable is defined, calls are not
diverted to the filter any more.

An application is free to set and unset `SIXJACK_BYPASS`, in order to
explicitly disable **6Jack** in some sections.
explicitly disable **6jack** in some sections.

## RETURN VALUES

**6Jack** returns the exit value of <command> after completion.
**6jack** returns the exit value of <command> after completion.

## SECURITY CONSIDERATIONS

**6Jack** has been designed as a tool for testing applications.
**6jack** has been designed as a tool for testing applications.

It is not suitable for running in a production environment or with
untrusted data / filters.

## WWW

**6Jack** is hosted on Github: `https://github.com/jedisct1/6jack`
**6jack** is hosted on Github: `https://github.com/jedisct1/6jack`

Releases can be downloaded from: http://download.pureftpd.org/6jack/

## SEE ALSO

Expand Down

0 comments on commit e6d0025

Please sign in to comment.