Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add a basic man page.

  • Loading branch information...
commit 4b7ef221783c4ecb6ae59476bce746e66321ebf9 1 parent 1f2a2ee
@jedisct1 authored
View
1  .gitignore
@@ -18,6 +18,7 @@ install-sh
libtool
ltmain.sh
m4
+man/6jack.8.html
missing
src/*.dSYM
src/*.o
View
4 Makefile.am
@@ -5,5 +5,5 @@ AUTOMAKE_OPTIONS = gnu
dist_doc_DATA = README.markdown
SUBDIRS = \
- src
-
+ src \
+ man
View
4 configure.ac
@@ -29,6 +29,7 @@ AC_PROG_CC_C99
AC_USE_SYSTEM_EXTENSIONS
CPPFLAGS="$CPPFLAGS -D_XPG4_2=1 -D_GNU_SOURCE=1"
AC_PROG_LIBTOOL
+AC_PATH_PROG([RONN], [ronn])
CFLAGS="$CFLAGS -fvisibility=hidden"
@@ -84,5 +85,6 @@ AC_ARG_WITH(debug,
AC_SUBST([MAINT])
AC_CONFIG_FILES([Makefile
- src/Makefile])
+ src/Makefile
+ man/Makefile])
AC_OUTPUT
View
83 man/6jack.8
@@ -0,0 +1,83 @@
+.\" generated with Ronn/v0.7.3
+.\" http://github.com/rtomayko/ronn/tree/0.7.3
+.
+.TH "6JACK" "8" "June 2011" "" ""
+.
+.SH "NAME"
+\fB6jack\fR \- A framework for analyzing/testing/fuzzing network applications
+.
+.SH "SYNOPSIS"
+\fB6jack\fR \fIfilter\fR \fIcommand\fR [\fIargs\fR]
+.
+.SH "DESCRIPTION"
+\fB6Jack\fR runs \fIcommand\fR and diverts calls to common network\-related functions to a filter as \fBmessagepack\fR serialized objects\.
+.
+.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\.
+.
+.P
+\fBPost\-filters\fR can inspect and alter the content after the actual call\. In particular, \fBpost\-filters\fR can change return codes and the \fBerrno\fR value in order to simulate failures\.
+.
+.SH "OPTIONS"
+\fIcommand\fR is the name of the command to run\.
+.
+.P
+\fIfilter\fR is the absolute path to an application that receives a stream of \fBmessagepack\fR serialized objects on \fBstdin\fR and for every object, should push a serialized reply to \fBstdout\fR\.
+.
+.SH "DIVERTED FUNCTIONS"
+.
+.IP "\(bu" 4
+bind(2)
+.
+.IP "\(bu" 4
+close(2)
+.
+.IP "\(bu" 4
+connect(2)
+.
+.IP "\(bu" 4
+read(2)
+.
+.IP "\(bu" 4
+recv(2)
+.
+.IP "\(bu" 4
+recvfrom(2)
+.
+.IP "\(bu" 4
+recvmsg(2)
+.
+.IP "\(bu" 4
+send(2)
+.
+.IP "\(bu" 4
+sendmsg(2)
+.
+.IP "\(bu" 4
+sendto(2)
+.
+.IP "\(bu" 4
+socket(2)
+.
+.IP "\(bu" 4
+write(2)
+.
+.IP "" 0
+.
+.SH "ENVIRONMENT"
+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\.
+.
+.SH "SECURITY CONSIDERATIONS"
+\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
+.
+.SH "SEE ALSO"
+\fBMessagePack\fR home page: \fBhttp://msgpack\.org/\fR
View
66 man/6jack.8.md
@@ -0,0 +1,66 @@
+6jack(8) -- A framework for analyzing/testing/fuzzing network applications
+==========================================================================
+
+## SYNOPSIS
+
+`6jack` <filter> <command> [<args>]
+
+## DESCRIPTION
+
+**6Jack** runs <command> and diverts calls to common network-related
+functions to a filter as **messagepack** serialized objects.
+
+**Pre-filters** can inspect and alter the content prior to calling the
+actual function. A **pre-filter** can also totally bypass the actual call,
+in order to simulate a call without actually hitting the network.
+
+**Post-filters** can inspect and alter the content after the actual call.
+In particular, **post-filters** can change return codes and the `errno`
+value in order to simulate failures.
+
+## OPTIONS
+
+<command> is the name of the command to run.
+
+<filter> is the absolute path to an application that receives a stream of
+**messagepack** serialized objects on `stdin` and for every object, should
+push a serialized reply to `stdout`.
+
+## DIVERTED FUNCTIONS
+
+ * bind(2)
+ * close(2)
+ * connect(2)
+ * read(2)
+ * recv(2)
+ * recvfrom(2)
+ * recvmsg(2)
+ * send(2)
+ * sendmsg(2)
+ * sendto(2)
+ * socket(2)
+ * write(2)
+
+## ENVIRONMENT
+
+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.
+
+## SECURITY CONSIDERATIONS
+
+**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`
+
+## SEE ALSO
+
+**MessagePack** home page: `http://msgpack.org/`
+
View
13 man/Makefile.am
@@ -0,0 +1,13 @@
+man_MANS = \
+ 6jack.8
+
+CLEANFILES= \
+ 6jack.8.html
+
+EXTRA_DIST= \
+ 6jack.8 \
+ 6jack.8.md
+
+6jack.8: 6jack.8.md
+ $(RONN) 6jack.8.md
+
View
2  src/Makefile.am
@@ -42,7 +42,7 @@ lib6jack_la_SOURCES = \
msgpack-extensions.c \
msgpack-extensions.h \
utils.c \
-lautoma utils.h
+ utils.h
lib6jack_la_LDFLAGS = \
$(AM_LDFLAGS) \
Please sign in to comment.
Something went wrong with that request. Please try again.