suricata
suricata.h
Go to the documentation of this file.
1 /* Copyright (C) 2007-2014 Open Information Security Foundation
2  *
3  * You can copy, redistribute or modify this Program under the terms of
4  * the GNU General Public License version 2 as published by the Free
5  * Software Foundation.
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  * version 2 along with this program; if not, write to the Free Software
14  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
15  * 02110-1301, USA.
16  */
17 
18 /** \mainpage Doxygen documentation
19  *
20  * \section intro_sec Introduction
21  *
22  * The Suricata Engine is an Open Source Next Generation Intrusion Detection
23  * and Prevention Engine. This engine is not intended to just replace or
24  * emulate the existing tools in the industry, but will bring new ideas and
25  * technologies to the field.
26  *
27  * \section dev_doc Developer documentation
28  *
29  * You've reach the automatically generated documentation of Suricata. This
30  * document contains information about architecture and code structure. It
31  * is attended for developers wanting to understand or contribute to Suricata.
32  *
33  * \subsection modules Modules
34  *
35  * Documentation is generate from comments placed in all parts of the code.
36  * But you will also find some groups describing specific functional parts:
37  * - \ref decode
38  * - \ref httplayer
39  * - \ref sigstate
40  * - \ref threshold
41  *
42  * \section archi Architecture
43  *
44  * \subsection datastruct Data structures
45  *
46  * Regarding matching, there is three main data structures which are:
47  * - ::Packet: Data relative to an individual packet with information about
48  * linked structure such as the ::Flow the ::Packet belongs to.
49  * - ::Flow: Information about a flow for example a TCP session
50  *
51  * \subsection runmode Running mode
52  *
53  * Suricata is multithreaded and running modes define how the different
54  * threads are working together. You can see util-runmodes.c for example
55  * of running mode.
56  */
57 
58 /**
59  * \file
60  *
61  * \author Victor Julien <victor@inliniac.net>
62  */
63 
64 #ifndef SURICATA_SURICATA_H
65 #define SURICATA_SURICATA_H
66 
67 #ifdef __cplusplus
68 extern "C"
69 {
70 #endif
71 
72 #include "suricata-common.h"
73 
74 /* the name of our binary */
75 #define PROG_NAME "Suricata"
76 #define PROG_VER PACKAGE_VERSION
77 
78 /* workaround SPlint error (don't know __gnuc_va_list) */
79 #ifdef S_SPLINT_S
80 # include <err.h>
81 # define CONFIG_DIR "/etc/suricata"
82 #endif
83 
84 #define DEFAULT_CONF_FILE CONFIG_DIR "/suricata.yaml"
85 
86 #define DEFAULT_PID_DIR LOCAL_STATE_DIR "/run/"
87 #define DEFAULT_PID_BASENAME "suricata.pid"
88 #define DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME
89 
90 #define DOC_URL "https://docs.suricata.io/en/"
91 const char *GetDocURL(void);
92 
93 /* runtime engine control flags */
94 #define SURICATA_STOP (1 << 0) /**< gracefully stop the engine: process all
95  outstanding packets first */
96 #define SURICATA_DONE (1 << 2) /**< packets capture ended */
97 
98 /* Engine stage/status*/
99 enum {
103 };
104 
105 /* Engine is acting as */
110 };
111 
112 void EngineModeSetIPS(void);
113 void EngineModeSetIDS(void);
114 int EngineModeIsUnknown(void);
115 int EngineModeIsIPS(void);
116 int EngineModeIsIDS(void);
117 
118 /* Box is acting as router */
119 enum {
122 };
123 
124 #define IS_SURI_HOST_MODE_SNIFFER_ONLY(host_mode) ((host_mode) == SURI_HOST_IS_SNIFFER_ONLY)
125 
126 #include "runmodes.h"
127 
128 typedef struct SCInstance_ {
129  enum SCRunModes run_mode;
131 
132  char pcap_dev[128];
133  char *sig_file;
136  char *regex_arg;
139 
142 #ifndef OS_WIN32
143  const char *user_name;
144  const char *group_name;
145  bool do_setuid;
146  bool do_setgid;
147 #endif /* OS_WIN32 */
148  uint32_t userid;
149  uint32_t groupid;
150 
151  bool system;
155 
158  int daemon;
159  int offline;
160  int verbose;
163 
164  struct timeval start_time;
165 
166  const char *log_dir;
167  const char *progname; /**< pointer to argv[0] */
168  const char *conf_filename;
169  const char **additional_configs;
171 
172  const char *capture_plugin_name;
173  const char *capture_plugin_args;
175 
176 
177 /* memset to zeros, and mutex init! */
178 void GlobalsInitPreConfig(void);
179 
180 extern volatile uint8_t suricata_ctl_flags;
181 extern int g_disable_randomness;
182 extern uint16_t g_vlan_mask;
183 extern uint16_t g_livedev_mask;
184 extern uint8_t g_recurlvl_mask;
185 
186 /* Flag to disable hashing (almost) globally. */
187 extern bool g_disable_hashing;
188 
189 void EngineStop(void);
190 void EngineDone(void);
191 
192 #ifdef UNITTESTS
193 int RunmodeIsUnittests(void);
194 #else
195 #define RunmodeIsUnittests() 0
196 #endif
197 
198 /**
199  * \brief Get the current run mode.
200  */
201 SCRunMode SCRunmodeGet(void);
202 
203 /**
204  * \brief Set the current run mode.
205  *
206  * Mainly exposed outside of suricata.c as a unit-test helper.
207  */
208 void SCRunmodeSet(SCRunMode run_mode);
209 
210 int SuriHasSigFile(void);
211 
212 void SuricataPreInit(const char *progname);
213 void SuricataInit(void);
214 void SuricataPostInit(void);
215 void SuricataMainLoop(void);
216 void SuricataShutdown(void);
217 int InitGlobal(void);
218 void GlobalsDestroy(void);
221 int SCFinalizeRunMode(void);
222 TmEcode SCParseCommandLine(int argc, char **argv);
223 int SCStartInternalRunMode(int argc, char **argv);
225 
226 void PreRunInit(const int runmode);
227 void PreRunPostPrivsDropInit(const int runmode);
228 void PostRunDeinit(const int runmode, struct timeval *start_time);
229 void RegisterAllModules(void);
230 
231 #ifdef OS_WIN32
232 int WindowsInitService(int argc, char **argv);
233 #endif
234 
235 const char *GetProgramVersion(void);
236 
237 #ifdef __cplusplus
238 }
239 #endif
240 
241 #endif /* SURICATA_SURICATA_H */
SCRunMode
enum SCRunModes SCRunMode
SCRunmodeSet
void SCRunmodeSet(SCRunMode run_mode)
Set the current run mode.
Definition: suricata.c:271
SCInstance_::run_mode
enum SCRunModes run_mode
Definition: suricata.h:129
SCInstance_::firewall_rule_file
char * firewall_rule_file
Definition: suricata.h:137
g_disable_hashing
bool g_disable_hashing
Definition: suricata.c:213
SCInstance_::groupid
uint32_t groupid
Definition: suricata.h:149
SCInstance_::aux_run_mode
enum SCRunModes aux_run_mode
Definition: suricata.h:130
SCInstance_::daemon
int daemon
Definition: suricata.h:158
SCInstance_::checksum_validation
int checksum_validation
Definition: suricata.h:161
SCInstance_::do_setuid
bool do_setuid
Definition: suricata.h:145
SCInstance_::start_time
struct timeval start_time
Definition: suricata.h:164
g_vlan_mask
uint16_t g_vlan_mask
Definition: suricata.c:201
g_livedev_mask
uint16_t g_livedev_mask
Definition: suricata.c:205
SCInstance_::do_setgid
bool do_setgid
Definition: suricata.h:146
SCInstance
struct SCInstance_ SCInstance
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:257
SCInstance_::group_name
const char * group_name
Definition: suricata.h:144
SCInstance_::runmode_custom_mode
char * runmode_custom_mode
Definition: suricata.h:141
SURICATA_INIT
@ SURICATA_INIT
Definition: suricata.h:100
SURICATA_DEINIT
@ SURICATA_DEINIT
Definition: suricata.h:102
SURICATA_RUNTIME
@ SURICATA_RUNTIME
Definition: suricata.h:101
SCInstance_::userid
uint32_t userid
Definition: suricata.h:148
InitGlobal
int InitGlobal(void)
Global initialization common to all runmodes.
Definition: suricata.c:2890
ENGINE_MODE_IPS
@ ENGINE_MODE_IPS
Definition: suricata.h:109
EngineStop
void EngineStop(void)
make sure threads can stop the engine by calling this function. Purpose: pcap file mode needs to be a...
Definition: suricata.c:452
SCInstance_::output_flush_interval
int output_flush_interval
Definition: suricata.h:162
PreRunPostPrivsDropInit
void PreRunPostPrivsDropInit(const int runmode)
Definition: suricata.c:2261
SCInstance_::conf_filename
const char * conf_filename
Definition: suricata.h:168
SCLoadYamlConfig
TmEcode SCLoadYamlConfig(void)
Definition: suricata.c:965
SCRunModes
SCRunModes
Definition: runmodes.h:27
SCInstance_::capture_plugin_name
const char * capture_plugin_name
Definition: suricata.h:172
EngineMode
EngineMode
Definition: suricata.h:106
SCInstance_::set_datadir
bool set_datadir
Definition: suricata.h:153
SuricataShutdown
void SuricataShutdown(void)
Definition: suricata.c:3023
SCInstance_::capture_plugin_args
const char * capture_plugin_args
Definition: suricata.h:173
EngineModeIsIPS
int EngineModeIsIPS(void)
Definition: suricata.c:234
EngineDone
void EngineDone(void)
Used to indicate that the current task is done.
Definition: suricata.c:463
ENGINE_MODE_UNKNOWN
@ ENGINE_MODE_UNKNOWN
Definition: suricata.h:107
SURI_HOST_IS_ROUTER
@ SURI_HOST_IS_ROUTER
Definition: suricata.h:121
PostConfLoadedDetectSetup
void PostConfLoadedDetectSetup(SCInstance *suri)
Definition: suricata.c:2567
GlobalsInitPreConfig
void GlobalsInitPreConfig(void)
Definition: suricata.c:364
SCInstance_::unix_socket_enabled
bool unix_socket_enabled
Definition: suricata.h:154
SCInstance_::delayed_detect
int delayed_detect
Definition: suricata.h:156
SCInstance_::progname
const char * progname
Definition: suricata.h:167
SCInstance_::pcap_dev
char pcap_dev[128]
Definition: suricata.h:132
GlobalsDestroy
void GlobalsDestroy(void)
Definition: suricata.c:372
SCInstance_::user_name
const char * user_name
Definition: suricata.h:143
SCInstance_::offline
int offline
Definition: suricata.h:159
SuricataMainLoop
void SuricataMainLoop(void)
Definition: suricata.c:2847
GetProgramVersion
const char * GetProgramVersion(void)
get string with program version
Definition: suricata.c:1139
EngineModeSetIDS
void EngineModeSetIDS(void)
Definition: suricata.c:251
SCInstance_::verbose
int verbose
Definition: suricata.h:160
TmEcode
TmEcode
Definition: tm-threads-common.h:80
SCInstance_::additional_configs
const char ** additional_configs
Definition: suricata.h:169
SCInstance_::set_logdir
bool set_logdir
Definition: suricata.h:152
SCInstance_::log_dir
const char * log_dir
Definition: suricata.h:166
runmodes.h
EngineModeSetIPS
void EngineModeSetIPS(void)
Definition: suricata.c:246
g_recurlvl_mask
uint8_t g_recurlvl_mask
Definition: suricata.c:209
SuricataInit
void SuricataInit(void)
Definition: suricata.c:2937
SCStartInternalRunMode
int SCStartInternalRunMode(int argc, char **argv)
Definition: suricata.c:2331
SCInstance_::strict_rule_parsing_string
char * strict_rule_parsing_string
Definition: suricata.h:170
suricata-common.h
EngineModeIsUnknown
int EngineModeIsUnknown(void)
Definition: suricata.c:229
SCInstance_::sig_file
char * sig_file
Definition: suricata.h:133
PreRunInit
void PreRunInit(const int runmode)
Definition: suricata.c:2232
SCInstance_::system
bool system
Definition: suricata.h:151
SCInstance_::pid_filename
char * pid_filename
Definition: suricata.h:135
PostRunDeinit
void PostRunDeinit(const int runmode, struct timeval *start_time)
clean up / shutdown code for packet modes
Definition: suricata.c:2277
SCFinalizeRunMode
int SCFinalizeRunMode(void)
Definition: suricata.c:2393
SURI_HOST_IS_SNIFFER_ONLY
@ SURI_HOST_IS_SNIFFER_ONLY
Definition: suricata.h:120
SuricataPostInit
void SuricataPostInit(void)
Definition: suricata.c:3034
EngineModeIsIDS
int EngineModeIsIDS(void)
Definition: suricata.c:240
SCInstance_::firewall_rule_file_exclusive
bool firewall_rule_file_exclusive
Definition: suricata.h:138
SuricataPreInit
void SuricataPreInit(const char *progname)
Definition: suricata.c:2928
SCInstance_
Definition: suricata.h:128
SCRunmodeGet
SCRunMode SCRunmodeGet(void)
Get the current run mode.
Definition: suricata.c:266
SCInstance_::disabled_detect
int disabled_detect
Definition: suricata.h:157
ENGINE_MODE_IDS
@ ENGINE_MODE_IDS
Definition: suricata.h:108
SCInstance_::sig_file_exclusive
bool sig_file_exclusive
Definition: suricata.h:134
RegisterAllModules
void RegisterAllModules(void)
Definition: suricata.c:900
SCInstance_::regex_arg
char * regex_arg
Definition: suricata.h:136
SCParseCommandLine
TmEcode SCParseCommandLine(int argc, char **argv)
Definition: suricata.c:1322
suricata_ctl_flags
volatile uint8_t suricata_ctl_flags
Definition: suricata.c:171
g_disable_randomness
int g_disable_randomness
Definition: suricata.c:194
SCInstance_::keyword_info
char * keyword_info
Definition: suricata.h:140
SuriHasSigFile
int SuriHasSigFile(void)
Definition: suricata.c:224
GetDocURL
const char * GetDocURL(void)
Definition: suricata.c:1118
PostConfLoadedSetup
int PostConfLoadedSetup(SCInstance *suri)
Definition: suricata.c:2658