add support for working with capture files (e.g. from tcpdump, ethereal, et.al.)

1 files changed, 55 insertions, 9 deletions

diff --git a/libopie2/opienet/opcap.h b/libopie2/opienet/opcap.h
index c9b0624..6c3ac6d 100644
--- a/libopie2/opienet/opcap.h
+++ b/libopie2/opienet/opcap.h
@@ -1,113 +1,114 @@
 /*
                              This file is part of the Opie Project
                              Copyright (C) 2003 by the Wellenreiter team:
                              Martin J. Muench <mjm@remote-exploit.org>
                              Max Moser <mmo@remote-exploit.org
                              Michael 'Mickey' Lauer <mickey@tm.informatik.uni-frankfurt.de>
               =.
             .=l.
            .>+-=
  _;:,     .>    :=|.         This program is free software; you can
 .> <`_,   >  .   <=          redistribute it and/or  modify it under
 :`=1 )Y*s>-.--   :           the terms of the GNU Library General Public
 .="- .-=="i,     .._         License as published by the Free Software
  - .   .-<_>     .<>         Foundation; either version 2 of the License,
      ._= =}       :          or (at your option) any later version.
     .%`+i>       _;_.
     .i_,=:_.      -<s.       This program is distributed in the hope that
      +  .  -:.       =       it will be useful,  but WITHOUT ANY WARRANTY;
     : ..    .:,     . . .    without even the implied warranty of
     =_        +     =;=|`    MERCHANTABILITY or FITNESS FOR A
   _.=:.       :    :=>`:     PARTICULAR PURPOSE. See the GNU
 ..}^=.=       =       ;      Library General Public License for more
 ++=   -.     .`     .:       details.
  :     =  ...= . :.=-
  -.   .:....=;==+<;          You should have received a copy of the GNU
   -_. . .   )=.  =           Library General Public License along with
     --        :-=`           this library; see the file COPYING.LIB.
                              If not, write to the Free Software Foundation,
                              Inc., 59 Temple Place - Suite 330,
                              Boston, MA 02111-1307, USA.
 
 */
 
 #ifndef OPCAP_H
 #define OPCAP_H
 
 /* LINUX */
 extern "C"  // work around a bpf/pcap conflict in recent headers
 {
     #include <pcap.h>
 }
 #include <netinet/ether.h>
 #include <netinet/ip.h>
 #include <netinet/udp.h>
 #include <netinet/tcp.h>
 #include <time.h>
 
 /* QT */
 #include <qevent.h>
+#include <qfile.h>
 #include <qhostaddress.h>
 #include <qobject.h>
 #include <qstring.h>
 #include <qmap.h>
 
 /* OPIE */
 #include <opie2/onetutils.h>
 #include "802_11_user.h"
 
 /* TYPEDEFS */
 typedef struct timeval timevalstruct;
 typedef struct pcap_pkthdr packetheaderstruct;
 
 /* FORWARDS */
 class OPacketCapturer;
 class QSocketNotifier;
 
 /*======================================================================================
  * OPacket - A frame on the wire
  *======================================================================================*/
 
 class OPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OPacket( int datalink, packetheaderstruct, const unsigned char*, QObject* parent );
     virtual ~OPacket();
 
     timevalstruct timeval() const;
 
     int caplen() const;
     int len() const;
     QString dump( int = 32 ) const;
 
     void updateStats( QMap<QString,int>&, QObjectList* );
 
   private:
     const packetheaderstruct _hdr;  // pcap packet header
     const unsigned char* _data;     // pcap packet data
     const unsigned char* _end;      // end of pcap packet data
 };
 
 /*======================================================================================
  * OEthernetPacket - DLT_EN10MB frame
  *======================================================================================*/
 
 class OEthernetPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OEthernetPacket( const unsigned char*, const struct ether_header*, QObject* parent = 0 );
     virtual ~OEthernetPacket();
 
     OMacAddress sourceAddress() const;
     OMacAddress destinationAddress() const;
     int type() const;
 
   private:
     const struct ether_header* _ether;
 };
 
 
@@ -359,101 +360,146 @@ class OIPPacket : public QObject
   Q_OBJECT
 
   public:
     OIPPacket( const unsigned char*, const struct iphdr*, QObject* parent = 0 );
     virtual ~OIPPacket();
 
     QHostAddress fromIPAddress() const;
     QHostAddress toIPAddress() const;
 
     int tos() const;
     int len() const;
     int id() const;
     int offset() const;
     int ttl() const;
     int protocol() const;
     int checksum() const;
 
   private:
     const struct iphdr* _iphdr;
 };
 
 /*======================================================================================
  * OUDPPacket
  *======================================================================================*/
 
 class OUDPPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OUDPPacket( const unsigned char*, const struct udphdr*, QObject* parent = 0 );
     virtual ~OUDPPacket();
 
     int fromPort() const;
     int toPort() const;
 
   private:
     const struct udphdr* _udphdr;
 };
 
 /*======================================================================================
  * OTCPPacket
  *======================================================================================*/
 
 class OTCPPacket : public QObject
 {
   Q_OBJECT
 
   public:
     OTCPPacket( const unsigned char*, const struct tcphdr*, QObject* parent = 0 );
     virtual ~OTCPPacket();
 
     int fromPort() const;
     int toPort() const;
 
   private:
     const struct tcphdr* _tcphdr;
 };
 
 
 /*======================================================================================
  * OPacketCapturer
  *======================================================================================*/
 
+/**
+ * @brief A class based wrapper for network packet capturing.
+ *
+ * This class is the base of a high-level interface to the well known packet capturing
+ * library libpcap. ...
+ */
 class OPacketCapturer : public QObject
 {
   Q_OBJECT
 
   public:
+    /**
+     * Constructor.
+     */
     OPacketCapturer( QObject* parent = 0, const char* name = 0 );
+    /**
+     * Destructor.
+     */
     ~OPacketCapturer();
-
+    /**
+     * Setting the packet capturer to use blocking IO calls can be useful when
+     * not using the socket notifier, e.g. without an application object.
+     */
     void setBlocking( bool );
+    /**
+     * @returns true if the packet capturer uses blocking IO calls.
+     */
     bool blocking() const;
-
+    /**
+     * Closes the packet capturer. This is automatically done in the destructor.
+     */
     void close();
+    /**
+     * @returns the data link type.
+     * @see <pcap.h> for possible values.
+     */
     int dataLink() const;
+    /**
+     * @returns the filedescriptor of the packet capturer. This is only useful, if
+     * not using the socket notifier, e.g. without an application object.
+     */
     int fileno() const;
+    /**
+     * @returns the next @ref OPacket from the packet capturer.
+     * @note If blocking mode is true then this call might block.
+     */
     OPacket* next();
-    bool open( const QString& name );
+    /**
+     * Open the packet capturer to capture packets in live-mode from @a interface.
+     */
+    bool open( const QString& interface );
+    /**
+     * Open the packet capturer to capture packets in offline-mode from @a file.
+     */
+    bool open( const QFile& file );
+    /**
+     * @returns true if the packet capturer is open
+     */
     bool isOpen() const;
 
     const QMap<QString,int>& statistics() const;
 
   signals:
+    /**
+     * This signal is emitted, when a packet has been received.
+     */
     void receivedPacket( OPacket* );
 
   protected slots:
     void readyToReceive();
 
   protected:
-    QString _name;          // devicename
-    bool _open;             // check this before doing pcap calls
-    pcap_t* _pch;           // pcap library handle
-    QSocketNotifier* _sn;   // socket notifier for main loop
-    mutable char _errbuf[PCAP_ERRBUF_SIZE];
-    QMap<QString, int> _stats; // statistics;
+    QString _name;                                  // devicename
+    bool _open;                                     // check this before doing pcap calls
+    pcap_t* _pch;                                   // pcap library handle
+    QSocketNotifier* _sn;                           // socket notifier for main loop
+    mutable char _errbuf[PCAP_ERRBUF_SIZE];         // holds error strings from libpcap
+    QMap<QString, int> _stats;                      // statistics;
 };
 
 #endif // OPCAP_H