]> git.stg.codes - stg.git/blob - projects/stargazer/plugins/capture/cap_nf/cap_nf.h
More clear plugin API
[stg.git] / projects / stargazer / plugins / capture / cap_nf / cap_nf.h
1 /*
2  *    This program is free software; you can redistribute it and/or modify
3  *    it under the terms of the GNU General Public License as published by
4  *    the Free Software Foundation; either version 2 of the License, or
5  *    (at your option) any later version.
6  *
7  *    This program is distributed in the hope that it will be useful,
8  *    but WITHOUT ANY WARRANTY; without even the implied warranty of
9  *    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
10  *    GNU General Public License for more details.
11  *
12  *    You should have received a copy of the GNU General Public License
13  *    along with this program; if not, write to the Free Software
14  *    Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
15  */
16
17 /*
18 Date: 16.05.2008
19 */
20
21 /*
22 * Author : Maxim Mamontov <faust@stg.dp.ua>
23 */
24
25 /*
26 $Revision: 1.5 $
27 $Date: 2009/12/13 12:56:07 $
28 $Author: faust $
29 */
30 #ifndef __CAP_NF_H__
31 #define __CAP_NF_H__
32
33 #include <pthread.h>
34
35 #include <string>
36
37 #include "stg/os_int.h"
38 #include "stg/plugin.h"
39 #include "stg/module_settings.h"
40
41 #define VERSION "CAP_NF v. 0.4"
42 #define START_POS 10
43 #define STOP_POS 10
44
45 class USERS;
46 class USER;
47 class TARIFFS;
48 class ADMINS;
49 class TRAFFCOUNTER;
50 class STORE;
51 class SETTINGS;
52
53 struct NF_HEADER {
54     uint16_t version;   // Protocol version
55     uint16_t count;     // Flows count
56     uint32_t uptime;    // System uptime
57     uint32_t timestamp; // UNIX timestamp
58     uint32_t nsecs;     // Residual nanoseconds
59     uint32_t flowSeq;   // Sequence counter
60     uint8_t  eType;     // Engine type
61     uint8_t  eID;       // Engine ID
62     uint16_t sInterval; // Sampling mode and interval
63 } __attribute__ ((packed));
64
65 struct NF_DATA {
66     uint32_t srcAddr;   // Flow source address
67     uint32_t dstAddr;   // Flow destination address
68     uint32_t nextHop;   // IP addres on next hop router
69     uint16_t inSNMP;    // SNMP index of input iface
70     uint16_t outSNMP;   // SNMP index of output iface
71     uint32_t packets;   // Packets in flow
72     uint32_t octets;    // Total number of bytes in flow
73     uint32_t timeStart; // Uptime on first packet in flow
74     uint32_t timeFinish;// Uptime on last packet in flow
75     uint16_t srcPort;   // Flow source port
76     uint16_t dstPort;   // Flow destination port
77     uint8_t  pad1;      // 1-byte padding
78     uint8_t  TCPFlags;  // Cumulative OR of TCP flags
79     uint8_t  proto;     // IP protocol type (tcp, udp, etc.)
80     uint8_t  tos;       // IP Type of Service (ToS)
81     uint16_t srcAS;     // Source BGP autonomous system number
82     uint16_t dstAS;     // Destination BGP autonomus system number
83     uint8_t  srcMask;   // Source address mask in "slash" notation
84     uint8_t  dstMask;   // Destination address mask in "slash" notation
85     uint16_t pad2;      // 2-byte padding
86 } __attribute__ ((packed));
87
88 #define BUF_SIZE (sizeof(NF_HEADER) + 30 * sizeof(NF_DATA))
89
90 class NF_CAP : public PLUGIN {
91 public:
92     NF_CAP();
93     ~NF_CAP();
94
95     void            SetTraffcounter(TRAFFCOUNTER * tc) { traffCnt = tc; }
96     void            SetSettings(const MODULE_SETTINGS & s) { settings = s; }
97     int             ParseSettings();
98
99     int             Start();
100     int             Stop();
101     int             Reload() { return 0; }
102     bool            IsRunning() { return runningTCP || runningUDP; }
103     const std::string & GetStrError() const { return errorStr; }
104     const std::string GetVersion() const { return VERSION; }
105     uint16_t        GetStartPosition() const { return START_POS; }
106     uint16_t        GetStopPosition() const { return STOP_POS; }
107
108 private:
109     TRAFFCOUNTER * traffCnt;
110     MODULE_SETTINGS settings;
111     pthread_t tidTCP;
112     pthread_t tidUDP;
113     bool runningTCP;
114     bool runningUDP;
115     bool stoppedTCP;
116     bool stoppedUDP;
117     uint16_t portT;
118     uint16_t portU;
119     int sockTCP;
120     int sockUDP;
121     mutable std::string errorStr;
122
123     static void * RunUDP(void *);
124     static void * RunTCP(void *);
125     void ParseBuffer(uint8_t *, int);
126
127     bool OpenTCP();
128     bool OpenUDP();
129     void CloseTCP() { close(sockTCP); }
130     void CloseUDP() { close(sockUDP); }
131
132     bool WaitPackets(int sd) const;
133 };
134
135 extern "C" PLUGIN * GetPlugin();
136
137 #endif