[or-cvs] r11150: clean up tutorial, point out some areas that are still missi (topf/trunk/doc)

[arma at seul.org]

Author: arma
Date: 2007-08-17 13:22:33 -0400 (Fri, 17 Aug 2007)
New Revision: 11150

Modified:
   topf/trunk/doc/tutorial.tex
Log:
clean up tutorial, point out some areas that are still missing


Modified: topf/trunk/doc/tutorial.tex
===================================================================
--- topf/trunk/doc/tutorial.tex	2007-08-17 17:03:48 UTC (rev 11149)
+++ topf/trunk/doc/tutorial.tex	2007-08-17 17:22:33 UTC (rev 11150)
@@ -12,34 +12,43 @@
 \newpage
 \section{Introduction}
 T.O.P.F is a fuzzing Framework written in Ruby and developed to test the
-TOR protocol-suite.  It uses a block-based approch like the famous SPIKE
-fuzzer written by Dave-Aitel.  Block-based means that data is devided into
-so-called blocks that are then processed in a predefined fassion. Compared
+Tor protocol-suite.  It uses a block-based approch like the famous SPIKE
+fuzzer written by Dave-Aitel.  Block-based means that data is divided into
+so-called blocks that are then processed in a predefined fashion. Compared
 to the random byte-flipping that many other fuzzers do, this allows a more
 focused approach on specific vulnerbilities like buffer, format-string
-or integer overflows.  If fuzzing and or ruby sound strange to you,
-you should read into the links listed in the appendix \ref{links}.
+or integer overflows.  If fuzzing and/or ruby sound strange to you,
+you should read into the links listed in Appendix \ref{links}.
 
 \section{Working with T.O.P.F}
 \label{working}
-To use T.O.P.F a few basic steps descriped in this section are nessesary.
+To use T.O.P.F a few basic steps described in this section are necessary.
 \subsection{Setting up a working Environment}
-As my aim is to make the Installation of T.O.P.F as easy as possible
+As my aim is to make the Installation of T.O.P.F as easy as possible,
 a working Ruby Interpreter and a checkout of  the latest T.O.P.F
 trunk should be enough to setup up a working Test-Environment on most
-Systems. If you have any problems or errors you are encouraged to email
+systems. If you have any problems or errors you are encouraged to email
 me to benedikt.boss (at) gmail (dot) com .
 
 \subsubsection{Checking out the current T.O.P.F trunk}
-Checking out T.O.P.F is as simple as starting a "svn co
-https://tor-svn.freehaven.net/svn/topf/trunk" on your command-shell
-of choice.
+Checking out T.O.P.F is as simple as starting a
+\begin{verbatim}
+svn co https://tor-svn.freehaven.net/svn/topf/trunk topf
+\end{verbatim}
+on your command-shell of choice.
 
-\subsection{Writing T.O.P.F Structures}
-As described in \ref{working}, T.O.P.F organizes its data in blocks. These
-blocks can have different types which are described detailled in
-\ref{types}. For example you can use char, signed and unsigned types.
+\subsection{Running the fuzz tests}
 
+... steps to running the tests already in topf svn
+
+... and how to interpret the results
+
+\section{Writing T.O.P.F Structures}
+As described in Section~\ref{working} (yeah? where? -RD), T.O.P.F
+organizes its data in blocks. These blocks can have different types
+which are described in detail in Section~\ref{types}. For example you
+can use char, signed, and unsigned types.
+
 \begin{verbatim}
 #example1.rb
 require "lib/fuzz-generic"
@@ -58,6 +67,7 @@
     pp e
 end
 \end{verbatim}
+
 This creates a Class called "Example" with the fields of a 8*8Bit
 long String, a 8Bit unsigned integer. and the initial values "example"
 and 1 for these.  Next in the begin/end block the programm creates a
@@ -68,7 +78,7 @@
 \subsection{Writing T.O.P.F Tests}
 Tests in the Framework are organized on a field-type base. This means
 that you write tests for a specific field. To generate a Test you must
-create on object Fuzz::Test object and assign a type and code-block to
+create a Fuzz::Test object and assign a type and code-block to
 it. For example if you want to test a char-field and assign many many
 "A"'s to the Field, which is a very common test :), you could write
 something like this:
@@ -110,7 +120,11 @@
 
 \end{verbatim}
 
+\subsection{Some example tests on Tor itself}
 
+[Show a good example of a fuzz test on one of Tor's structs, to
+make things more concrete.]
+
 \subsection{Do the Fuzz!}
 
 \section{T.O.P.F Reference}
@@ -140,8 +154,9 @@
 \subsubsection{pad}
 \subsection{Logger}
 
-\section{Appendix}
-\subsection{Links}
+\appendix
+
+\section{Links}
 \label{links}
 \begin{verbatim}
 http://en.wikipedia.org/wiki/Fuzzing