suricata.h

Go to the documentation of this file.

/* Copyright (C) 2007-2014 Open Information Security Foundation
 *
 * You can copy, redistribute or modify this Program under the terms of
 * the GNU General Public License version 2 as published by the Free
 * Software Foundation.
 *
 * 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 General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * version 2 along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
 * 02110-1301, USA.
 */
 
/** \mainpage Doxygen documentation
 *
 * \section intro_sec Introduction
 *
 * The Suricata Engine is an Open Source Next Generation Intrusion Detection
 * and Prevention Engine. This engine is not intended to just replace or
 * emulate the existing tools in the industry, but will bring new ideas and
 * technologies to the field.
 *
 * \section dev_doc Developer documentation
 *
 * You've reach the automatically generated documentation of Suricata. This
 * document contains information about architecture and code structure. It
 * is attended for developers wanting to understand or contribute to Suricata.
 *
 * \subsection modules Modules
 *
 * Documentation is generate from comments placed in all parts of the code.
 * But you will also find some groups describing specific functional parts:
 *  - \ref decode
 *  - \ref httplayer
 *  - \ref sigstate
 *  - \ref threshold
 *
 * \section archi Architecture
 *
 * \subsection datastruct Data structures
 *
 * Regarding matching, there is three main data structures which are:
 *  - ::Packet: Data relative to an individual packet with information about
 *  linked structure such as the ::Flow the ::Packet belongs to.
 *  - ::Flow: Information about a flow for example a TCP session
 *
 *  \subsection runmode Running mode
 *
 *  Suricata is multithreaded and running modes define how the different
 *  threads are working together. You can see util-runmodes.c for example
 *  of running mode.
 */
 
/**
 * \file
 *
 * \author Victor Julien <victor@inliniac.net>
 */
 
#ifndef SURICATA_SURICATA_H
#define SURICATA_SURICATA_H
 
#ifdef __cplusplus
extern "C"
{
#endif
 
#include "suricata-common.h"
 
/* the name of our binary */
#define PROG_NAME "Suricata"
#define PROG_VER PACKAGE_VERSION
 
/* workaround SPlint error (don't know __gnuc_va_list) */
#ifdef S_SPLINT_S
#  include <err.h>
#  define CONFIG_DIR "/etc/suricata"
#endif
 
#define DEFAULT_CONF_FILE CONFIG_DIR "/suricata.yaml"
 
#define DEFAULT_PID_DIR LOCAL_STATE_DIR "/run/"
#define DEFAULT_PID_BASENAME "suricata.pid"
#define DEFAULT_PID_FILENAME DEFAULT_PID_DIR DEFAULT_PID_BASENAME
 
#define DOC_URL "https://docs.suricata.io/en/"
const char *GetDocURL(void);
 
/* runtime engine control flags */
#define SURICATA_STOP    (1 << 0)   /**< gracefully stop the engine: process all
                                     outstanding packets first */
#define SURICATA_DONE    (1 << 2)   /**< packets capture ended */
 
/* Engine stage/status*/
enum {
    SURICATA_INIT = 0,
    SURICATA_RUNTIME,
    SURICATA_DEINIT
};
 
/* Engine is acting as */
enum EngineMode {
    ENGINE_MODE_UNKNOWN,
    ENGINE_MODE_IDS,
    /* order matters, we need to be able to do IPS is true for >= ENGINE_MODE_IPS */
    ENGINE_MODE_IPS,
    ENGINE_MODE_FIREWALL,
};
 
/* superset of IPS mode */
void EngineModeSetFirewall(void);
void EngineModeSetIPS(void);
void EngineModeSetIDS(void);
int EngineModeIsUnknown(void);
bool EngineModeIsFirewall(void);
int EngineModeIsIPS(void);
int EngineModeIsIDS(void);
 
/* Box is acting as router */
enum {
    SURI_HOST_IS_SNIFFER_ONLY,
    SURI_HOST_IS_ROUTER,
};
 
#define IS_SURI_HOST_MODE_SNIFFER_ONLY(host_mode) ((host_mode) == SURI_HOST_IS_SNIFFER_ONLY)
 
#include "runmodes.h"
 
typedef struct SCInstance_ {
    enum SCRunModes run_mode;
    enum SCRunModes aux_run_mode;
 
    char pcap_dev[128];
    char *sig_file;
    bool sig_file_exclusive;
    char *pid_filename;
    char *regex_arg;
    char *firewall_rule_file;
    bool firewall_rule_file_exclusive;
    /* is firewall mode enabled */
    bool is_firewall;
 
    char *keyword_info;
    char *runmode_custom_mode;
#ifndef OS_WIN32
    const char *user_name;
    const char *group_name;
    bool do_setuid;
    bool do_setgid;
#endif /* OS_WIN32 */
    uint32_t userid;
    uint32_t groupid;
 
    bool system;
    bool set_logdir;
    bool set_datadir;
    bool unix_socket_enabled;
 
    bool install_signal_handlers; /**< Install default signal handlers */
 
    int delayed_detect;
    int disabled_detect;
    int daemon;
    int offline;
    int verbose;
    int checksum_validation;
    int output_flush_interval;
 
    struct timeval start_time;
 
    const char *log_dir;
    const char *progname; /**< pointer to argv[0] */
    const char *conf_filename;
    const char **additional_configs;
    char *strict_rule_parsing_string;
 
    const char *capture_plugin_name;
    const char *capture_plugin_args;
} SCInstance;
 
 
/* memset to zeros, and mutex init! */
void GlobalsInitPreConfig(void);
 
extern volatile uint8_t suricata_ctl_flags;
extern int g_disable_randomness;
extern uint16_t g_vlan_mask;
extern uint16_t g_livedev_mask;
extern uint8_t g_recurlvl_mask;
 
/* Flag to disable hashing (almost) globally. */
extern bool g_disable_hashing;
 
void EngineStop(void);
void EngineDone(void);
 
#ifdef UNITTESTS
int RunmodeIsUnittests(void);
#else
#define RunmodeIsUnittests() 0
#endif
 
/**
 * \brief Get the current run mode.
 */
SCRunMode SCRunmodeGet(void);
 
/**
 * \brief Set the current run mode.
 *
 * Mainly exposed outside of suricata.c as a unit-test helper.
 */
void SCRunmodeSet(SCRunMode run_mode);
 
/**
 * \brief Enable default signal handlers.
 */
void SCEnableDefaultSignalHandlers(void);
 
int SuriHasSigFile(void);
 
void SuricataPreInit(const char *progname);
void SuricataInit(void);
void SuricataPostInit(void);
void SuricataMainLoop(void);
void SuricataShutdown(void);
int InitGlobal(void);
void GlobalsDestroy(void);
int PostConfLoadedSetup(SCInstance *suri);
void PostConfLoadedDetectSetup(SCInstance *suri);
int SCFinalizeRunMode(void);
TmEcode SCParseCommandLine(int argc, char **argv);
int SCStartInternalRunMode(int argc, char **argv);
TmEcode SCLoadYamlConfig(void);
 
void PreRunInit(const int runmode);
void PreRunPostPrivsDropInit(const int runmode);
void PostRunDeinit(const int runmode, struct timeval *start_time);
void RegisterAllModules(void);
 
#ifdef OS_WIN32
int WindowsInitService(int argc, char **argv);
#endif
 
const char *GetProgramVersion(void);
 
#ifdef __cplusplus
}
#endif
 
#endif /* SURICATA_SURICATA_H */