Examples/Mainpage.dox

   1 /** \mainpage Examples
   2
   3     \ref sniffer
   4 */
   5
   6 /** \page sniffer Sniffer: A simple example application
   7
   8     \dontinclude Sniffer.cc
   9
  10     The Sniffer application is a simple command line network sniffer like \c tcpdump or \c
  11     tethereal. The application uses a packet socket to read Ethernet packets from the \c eth0
  12     interface and dumps the parsed packets out to the standard output.
  13
  14     To try out the example application, check out the library, go to the \c Sniffer
  15     directory and execute
  16
  17     <pre>
  18     # scons -u
  19     # ./sniffer loop
  20     < Hit Ctrl-C when you've seen enough >
  21     # ./sniffer scheduler
  22     < Hit Ctrl-C when you've seen enough >
  23     </pre>
  24
  25     We will now look at the code which is found in \c Sniffer.cc in the \c Sniffer directory. The
  26     code starts out by including the necessary headers
  27
  28     \skip // Custom includes
  29     \until membind
  30
  31     (The additional includes found in the source but not shown here are part of a short-time fix
  32     which will be removed as soon as possible). The example application now contains a helper
  33     routine to produce a packet hexdump. We will skip this routine here. The example includes two
  34     implementations, one using blocking calls and a while loop, the other using the senf::Scheduler
  35     for asynchronous event notification. They are implemented in \c loop_main() and \c
  36     scheduler_main(). They will be documented below. For now, we skip these implementations and go
  37     straight to the \c main() function
  38
  39     \skip int main(
  40     \until return 1;
  41     \until }
  42
  43     This routine simply interprets the first command line argument and dispatches to the required
  44     implementation.
  45
  46     Now lets go back and study each implementation in detail.
  47
  48     \dontinclude Sniffer.cc
  49
  50     \section example_loop A Blocking Implementation
  51
  52     This implementation is found in the \c loop_main function.
  53
  54     \skip loop_main
  55     \until try
  56
  57     We catch all exceptions in a \c try block. This is good for a deliverable binary. When debugging
  58     the application, it might be better to let the exception \c abort the execution so you can get a
  59     backtrace of the exception origin in the debugger.
  60
  61     We now create a packet socket and bind it to the \c eth0 interface. A packet socket is a linux
  62     specific type of socket which returns ethernet packets directly from the network wire. By
  63     uncommenting the last line, you may switch the interface into promiscuous mode.
  64
  65     We will now read packets from the socket forever, that is until the user hits Ctrl-C
  66
  67     \skip while
  68     \until read
  69
  70     The next step is, to parse the data read from the socket as an Ethernet packet
  71
  72     \until ;
  73
  74     Lets digest this line step by step: We declare a variable named \c packet as a smart pointer to
  75     an \c EthernetPacket instance. \c ptr is a typedef member of all Packet classes for the
  76     corresponding smart pointer type. We then initialize this pointer with a call to the static \c
  77     create member of the \c Packet class. This member takes the type of Packet to parse as a
  78     template argument. We pass \c EthernetPacket here. The function takes an iterator range as an
  79     argument, and we pass it the complete packet just read by giving the range \c begin() to \c
  80     end() of our just read \c data string.
  81
  82     The next step is to write out the packet to the standard output
  83
  84     \until \n\n
  85
  86     The \c dump call will write out a complete representation of the parsed packet data. The Packet
  87     library will \e not try to interpret payload data as long as no exact indication of the payload
  88     type is available (example: A UDP Payload is not parsed further unless you explicitly tell the
  89     library, how to parse it).  Tools like \c tethereal guess the payload type by checking port
  90     numbers and the payload data, however this is not advisable for a general purpose packet
  91     library.
  92
  93     The next line, \c hexdump, will write out the \e last packet component. Packets are managed as a
  94     chain of headers. The last header is normally a \c DataPacket holding the payload data.
  95
  96     That's it. We finish of by catching the exception and giving as much detail as possible if an
  97     exception is caught
  98
  99     \until ;
 100     \until }
 101     \until }
 102
 103     The \c prettyName function from the \c Utils library is used, to get a nice, printable
 104     representation of the \e dynamic type of the exception instance. It is an interface to the g++
 105     demangler. This is necessary since the \c name member of the C++ \c type_info instance is a
 106     mangled name in \c g++.
 107
 108     That's it for the simple blocking implementation.
 109
 110     \section example_scheduler Using the Scheduler
 111
 112     However, we have another one which uses the Scheduler. We do this as it will be most of the
 113     time: We define a class which manages reading the packets and dumping them out.
 114
 115     \until }
 116
 117     The class constructor binds the socket defined as a data member to the correct interface.
 118
 119     \until add
 120
 121     The public \c run() member is called to run the sniffer.  It first adds the socket to the
 122     Scheduler. The \c add() call takes two Arguments, the socket to bind to (which can be a lot of
 123     things and must not necessarily be a socket instance) and callback to call, whenever there is an
 124     event on that socket. A third argument may be specified to restrict the events, on which the
 125     function is called, here we have left out this argument which defaults to
 126     senf::Scheduler::EV_ALL.
 127
 128     The callback is specified as a <a
 129     href="http://www.boost.org/doc/html/function.html">Boost.Function</a> object. We use the \c
 130     senf::membind helper from the Utils library to build such a function object. This helper takes
 131     an arbitrary class member and binds it to a specific instance.
 132
 133     \until }
 134
 135     Calling the Schedulers \c process() method will start the event loop. This call does not return
 136     (ok, it does return in special cases if \c senf::Scheduler::terminate() is called which does not
 137     apply here).
 138
 139     \until {
 140
 141     The \c dumpPacket() member is called by the scheduler whenever an event on the socket is
 142     encountered. The scheduler always passes two arguments: The socket and an event id which
 143     identifies the type of event which triggered the call.
 144
 145     \until };
 146
 147     The body is absolutely identical to the body of the \c while loop of the blocking
 148     implementation. However, the scheduler guarantees, that a read on the socket will not block if
 149     the socket is triggered to be readable (even if the socket is not set to non-blocking mode).
 150
 151     We now only need to provide the \c scheduler_main() function to run this code
 152
 153     \until 0;
 154     \until }
 155
 156     This function is straight forward. The exception handling is the same as in \c loop_main(). The
 157     code then just creates a \c Sniffer instance and calls it's \c run() member.
 158
 159     \see \ref components \n
 160          \ref build \n
 161          <a href="../../Socket/doc/html/index.html"><b>libSocket API reference</b></a> \n
 162          <a href="../../Packets/doc/html/index.html"><b>libPackets API reference</b></a> \n
 163          <a href="../../Utils/doc/html/index.html"><b>libUtils API reference</b></a>
 164  */
 165
 166
 167 \f
 168 // Local Variables:
 169 // mode: c++
 170 // fill-column: 100
 171 // c-file-style: "senf"
 172 // indent-tabs-mode: nil
 173 // ispell-local-dictionary: "american"
 174 // mode: flyspell
 175 // mode: auto-fill
 176 // End: