]> git.ipfire.org Git - thirdparty/suricata.git/commitdiff
Remove pcapinfo output
authorEric Leblond <eric@regit.org>
Sat, 14 Jun 2014 10:16:17 +0000 (12:16 +0200)
committerVictor Julien <victor@inliniac.net>
Fri, 18 Jul 2014 13:16:31 +0000 (15:16 +0200)
EVE logging is a really good substitute for pcapinfo. Suriwire is
now supporting EVE output so it is not anymore necessary to have
pcapinfo in Suricata.

src/Makefile.am
src/alert-pcapinfo.c [deleted file]
src/alert-pcapinfo.h [deleted file]
src/suricata.c
suricata.yaml.in

index fd143269a1dcb7ee658ca95fd95cf21c00193a13..6917a9c9b2095a59e012261e42ce38e00e0c3cfb 100644 (file)
@@ -9,7 +9,6 @@ bin_PROGRAMS = suricata
 suricata_SOURCES = \
 alert-debuglog.c alert-debuglog.h \
 alert-fastlog.c alert-fastlog.h \
-alert-pcapinfo.c alert-pcapinfo.h \
 alert-prelude.c alert-prelude.h \
 alert-syslog.c alert-syslog.h \
 alert-unified2-alert.c alert-unified2-alert.h \
diff --git a/src/alert-pcapinfo.c b/src/alert-pcapinfo.c
deleted file mode 100644 (file)
index 121b191..0000000
+++ /dev/null
@@ -1,231 +0,0 @@
-/* Copyright (C) 2011-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.
- */
-
-/**
- * \file
- *
- * \author Eric Leblond <eric@regit.org>
- *
- * Logs alerts in a line based text format suitable for interaction
- * with wireshark or another pcap file analysis tools.
- *
- * The format of the logging is:
- *  Packet number:GID of matching signature:SID of signature:REV of signature:Flow:To Server:To Client:0:0:Signature Message
- * The two zeros are reserved for upcoming usage (probably byte start
- * and byte end of payload)
- */
-
-#include "suricata-common.h"
-#include "debug.h"
-#include "detect.h"
-#include "flow.h"
-#include "conf.h"
-
-#include "threads.h"
-#include "tm-threads.h"
-#include "threadvars.h"
-#include "util-debug.h"
-
-#include "util-unittest.h"
-#include "util-unittest-helper.h"
-
-#include "detect.h"
-#include "detect-parse.h"
-#include "detect-engine.h"
-#include "detect-engine-mpm.h"
-#include "detect-reference.h"
-#include "util-classification-config.h"
-
-#include "output.h"
-#include "alert-pcapinfo.h"
-
-#include "util-privs.h"
-#include "util-print.h"
-#include "util-proto-name.h"
-#include "util-optimize.h"
-#include "util-logopenfile.h"
-
-#define DEFAULT_LOG_FILENAME "alert-pcapinfo.log"
-/* We need a new file for each pcap */
-#define DEFAULT_PCAPINFO_MODE_APPEND "no"
-
-#define MODULE_NAME "AlertPcapInfo"
-
-typedef struct AlertPcapInfoThread_ {
-    /** LogFileCtx has the pointer to the file and a mutex to allow multithreading */
-    LogFileCtx* file_ctx;
-} AlertPcapInfoThread;
-
-static TmEcode AlertPcapInfoThreadInit(ThreadVars *t, void *initdata, void **data)
-{
-    AlertPcapInfoThread *aft = SCMalloc(sizeof(AlertPcapInfoThread));
-    if (unlikely(aft == NULL))
-        return TM_ECODE_FAILED;
-    memset(aft, 0, sizeof(AlertPcapInfoThread));
-    if(initdata == NULL)
-    {
-        SCLogDebug("Error getting context for AlertPcapInfo.  \"initdata\" argument NULL");
-        SCFree(aft);
-        return TM_ECODE_FAILED;
-    }
-    /** Use the Ouptut Context (file pointer and mutex) */
-    aft->file_ctx = ((OutputCtx *)initdata)->data;
-
-    *data = (void *)aft;
-    return TM_ECODE_OK;
-}
-
-static TmEcode AlertPcapInfoThreadDeinit(ThreadVars *t, void *data)
-{
-    AlertPcapInfoThread *aft = (AlertPcapInfoThread *)data;
-    if (aft == NULL) {
-        return TM_ECODE_OK;
-    }
-
-    /* clear memory */
-    memset(aft, 0, sizeof(AlertPcapInfoThread));
-
-    SCFree(aft);
-    return TM_ECODE_OK;
-}
-
-static void AlertPcapInfoExitPrintStats(ThreadVars *tv, void *data) {
-    AlertPcapInfoThread *aft = (AlertPcapInfoThread *)data;
-    if (aft == NULL) {
-        return;
-    }
-
-    SCLogInfo("(%s) Alerts %" PRIu64 "", tv->name, aft->file_ctx->alerts);
-}
-
-static void AlertPcapInfoDeInitCtx(OutputCtx *output_ctx)
-{
-    LogFileCtx *logfile_ctx = (LogFileCtx *)output_ctx->data;
-    LogFileFreeCtx(logfile_ctx);
-    SCFree(output_ctx);
-}
-
-/** \brief Read the config set the file pointer, open the file
- *  \param file_ctx pointer to a created LogFileCtx using LogFileNewCtx()
- *  \param filename name of log file
- *  \param mode append mode (bool)
- *  \return -1 if failure, 0 if succesful
- * */
-static int AlertPcapInfoOpenFileCtx(LogFileCtx *file_ctx, const char *filename,
-                                    const char *mode)
-{
-    char log_path[PATH_MAX];
-    char *log_dir;
-
-    log_dir = ConfigGetLogDirectory();
-
-    snprintf(log_path, PATH_MAX, "%s/%s", log_dir, filename);
-
-    if (ConfValIsTrue(mode)) {
-        file_ctx->fp = fopen(log_path, "a");
-    } else {
-        file_ctx->fp = fopen(log_path, "w");
-    }
-
-    if (file_ctx->fp == NULL) {
-        SCLogError(SC_ERR_FOPEN, "failed to open %s: %s", log_path,
-                strerror(errno));
-        return -1;
-    }
-
-    return 0;
-}
-
-/**
- * \brief Create a new LogFileCtx for "fast" output style.
- * \param conf The configuration node for this output.
- * \return A LogFileCtx pointer on success, NULL on failure.
- */
-static OutputCtx *AlertPcapInfoInitCtx(ConfNode *conf)
-{
-    LogFileCtx *logfile_ctx = LogFileNewCtx();
-    if (logfile_ctx == NULL) {
-        SCLogDebug("AlertPcapInfoInitCtx2: Could not create new LogFileCtx");
-        return NULL;
-    }
-
-    const char *filename = ConfNodeLookupChildValue(conf, "filename");
-    if (filename == NULL)
-        filename = DEFAULT_LOG_FILENAME;
-
-    const char *mode = ConfNodeLookupChildValue(conf, "append");
-    if (mode == NULL)
-        mode = DEFAULT_PCAPINFO_MODE_APPEND;
-
-    if (AlertPcapInfoOpenFileCtx(logfile_ctx, filename, mode) < 0) {
-        LogFileFreeCtx(logfile_ctx);
-        return NULL;
-    }
-
-    OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
-    if (unlikely(output_ctx == NULL))
-        return NULL;
-    output_ctx->data = logfile_ctx;
-    output_ctx->DeInit = AlertPcapInfoDeInitCtx;
-
-    SCLogInfo("Fast log output initialized, filename: %s", filename);
-
-    return output_ctx;
-}
-
-static int AlertPcapInfoCondition(ThreadVars *tv, const Packet *p) {
-    return ((p->pcap_cnt != 0 && p->alerts.cnt > 0) ? TRUE : FALSE);
-}
-
-static int AlertPcapInfoLogger(ThreadVars *tv, void *thread_data, const Packet *p) {
-    AlertPcapInfoThread *aft = (AlertPcapInfoThread *)thread_data;
-    int i;
-
-    /* logging is useless if we don't have pcap number */
-    if ((p->pcap_cnt != 0) && (p->alerts.cnt > 0)) {
-        SCMutexLock(&aft->file_ctx->fp_mutex);
-        /* only count logged alert */
-        aft->file_ctx->alerts += p->alerts.cnt;
-        for (i = 0; i < p->alerts.cnt; i++) {
-            const PacketAlert *pa = &p->alerts.alerts[i];
-
-            fprintf(aft->file_ctx->fp, "%" PRIu64 ":%" PRIu32 ":%" PRIu32 ":%d:%d:%d:%d:0:0:%s\n",
-                    p->pcap_cnt, pa->s->gid, pa->s->id, pa->s->rev,
-                    pa->flags & (PACKET_ALERT_FLAG_STATE_MATCH|PACKET_ALERT_FLAG_STREAM_MATCH) ? 1 : 0,
-                    p->flowflags & FLOW_PKT_TOSERVER ? 1 : 0,
-                    p->flowflags & FLOW_PKT_TOCLIENT ? 1 : 0,
-                    pa->s->msg);
-        }
-        SCMutexUnlock(&aft->file_ctx->fp_mutex);
-    }
-
-    return 0;
-}
-
-void TmModuleAlertPcapInfoRegister (void) {
-    tmm_modules[TMM_ALERTPCAPINFO].name = MODULE_NAME;
-    tmm_modules[TMM_ALERTPCAPINFO].ThreadInit = AlertPcapInfoThreadInit;
-    tmm_modules[TMM_ALERTPCAPINFO].Func = NULL;
-    tmm_modules[TMM_ALERTPCAPINFO].ThreadExitPrintStats = AlertPcapInfoExitPrintStats;
-    tmm_modules[TMM_ALERTPCAPINFO].ThreadDeinit = AlertPcapInfoThreadDeinit;
-    tmm_modules[TMM_ALERTPCAPINFO].RegisterTests = NULL;
-    tmm_modules[TMM_ALERTPCAPINFO].cap_flags = 0;
-    tmm_modules[TMM_ALERTPCAPINFO].flags = TM_FLAG_LOGAPI_TM;
-
-    OutputRegisterPacketModule(MODULE_NAME, "pcap-info",
-        AlertPcapInfoInitCtx, AlertPcapInfoLogger, AlertPcapInfoCondition);
-}
diff --git a/src/alert-pcapinfo.h b/src/alert-pcapinfo.h
deleted file mode 100644 (file)
index 9f4118f..0000000
+++ /dev/null
@@ -1,29 +0,0 @@
-/* Copyright (C) 2011-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.
- */
-
-/**
- * \file
- *
- * \author Eric Leblond <eric@regit.org>
- */
-
-#ifndef __ALERT_PCAPINFO_H__
-#define __ALERT_PCAPINFO_H__
-
-void TmModuleAlertPcapInfoRegister (void);
-
-#endif /* __ALERT_PCAPINFO_H__ */
index 54e44611e40ce9c94d2ed5bdd4a2e5ac9c26ba6a..76e919ab433528889a372508266c5372863c2e82 100644 (file)
@@ -77,7 +77,6 @@
 #include "alert-debuglog.h"
 #include "alert-prelude.h"
 #include "alert-syslog.h"
-#include "alert-pcapinfo.h"
 #include "output-json-alert.h"
 
 #include "log-droplog.h"
@@ -844,8 +843,6 @@ void RegisterAllModules()
     TmModuleAlertSyslogRegister();
     /* unified2 log */
     TmModuleUnified2AlertRegister();
-    /* pcap info log */
-    TmModuleAlertPcapInfoRegister();
     /* drop log */
     TmModuleLogDropLogRegister();
     TmModuleJsonDropLogRegister();
index 811dce760846cf032c8653f560fd3e7b1675d153..65b7a50bf7bcd4bff6e63ccdc7f8ba2c723f5e0a 100644 (file)
@@ -162,13 +162,6 @@ outputs:
       append: yes
       #filetype: regular # 'regular', 'unix_stream' or 'unix_dgram'
 
-  # a line based log to used with pcap file study.
-  # this module is dedicated to offline pcap parsing (empty output
-  # if used with another kind of input). It can interoperate with
-  # pcap parser like wireshark via the suriwire plugin.
-  - pcap-info:
-      enabled: no
-
   # Packet log... log packets in pcap format. 3 modes of operation: "normal"
   # "multi" and "sguil".
   #