mirror of https://github.com/OISF/suricata
filestore v1: remove
File store v1 has been deprecated and was scheduled for removal by June 2020. Log an error if a file-store configuration is loaded without version set to 2.pull/4976/head
parent
5a98035bac
commit
ca88e4d0e3
@ -1,719 +0,0 @@
|
||||
/* Copyright (C) 2007-2013 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 Victor Julien <victor@inliniac.net>
|
||||
*
|
||||
*/
|
||||
|
||||
#include "suricata-common.h"
|
||||
#include "debug.h"
|
||||
#include "detect.h"
|
||||
#include "pkt-var.h"
|
||||
#include "conf.h"
|
||||
|
||||
#include "threadvars.h"
|
||||
#include "tm-modules.h"
|
||||
|
||||
#include "threads.h"
|
||||
|
||||
#include "app-layer-parser.h"
|
||||
|
||||
#include "detect-filemagic.h"
|
||||
|
||||
#include "stream.h"
|
||||
|
||||
#include "util-print.h"
|
||||
#include "util-unittest.h"
|
||||
#include "util-privs.h"
|
||||
#include "util-debug.h"
|
||||
#include "util-atomic.h"
|
||||
#include "util-file.h"
|
||||
#include "util-time.h"
|
||||
#include "util-misc.h"
|
||||
|
||||
#include "output.h"
|
||||
|
||||
#include "log-filestore.h"
|
||||
#include "util-logopenfile.h"
|
||||
|
||||
#include "app-layer-htp.h"
|
||||
#include "app-layer-smtp.h"
|
||||
#include "util-decode-mime.h"
|
||||
#include "util-memcmp.h"
|
||||
#include "stream-tcp-reassemble.h"
|
||||
|
||||
#define MODULE_NAME "LogFilestoreLog"
|
||||
|
||||
static char g_logfile_base_dir[PATH_MAX] = "/tmp";
|
||||
static char g_working_file_suffix[PATH_MAX] = ".tmp";
|
||||
|
||||
SC_ATOMIC_DECLARE(uint32_t, filestore_open_file_cnt); /**< Atomic counter of simultaneously open files */
|
||||
|
||||
typedef struct LogFilestoreLogThread_ {
|
||||
LogFileCtx *file_ctx;
|
||||
/** LogFilestoreCtx has the pointer to the file and a mutex to allow multithreading */
|
||||
uint32_t file_cnt;
|
||||
uint16_t counter_max_hits;
|
||||
} LogFilestoreLogThread;
|
||||
|
||||
static uint64_t LogFilestoreOpenFilesCounter(void)
|
||||
{
|
||||
uint64_t fcopy = SC_ATOMIC_GET(filestore_open_file_cnt);
|
||||
return fcopy;
|
||||
}
|
||||
|
||||
static void LogFilestoreMetaGetUri(FILE *fp, const Packet *p, const File *ff)
|
||||
{
|
||||
HtpState *htp_state = (HtpState *)p->flow->alstate;
|
||||
if (htp_state != NULL) {
|
||||
htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP, htp_state, ff->txid);
|
||||
if (tx != NULL) {
|
||||
HtpTxUserData *tx_ud = htp_tx_get_user_data(tx);
|
||||
if (tx_ud->request_uri_normalized != NULL) {
|
||||
PrintRawUriFp(fp, bstr_ptr(tx_ud->request_uri_normalized),
|
||||
bstr_len(tx_ud->request_uri_normalized));
|
||||
}
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
fprintf(fp, "<unknown>");
|
||||
}
|
||||
|
||||
static void LogFilestoreMetaGetHost(FILE *fp, const Packet *p, const File *ff)
|
||||
{
|
||||
HtpState *htp_state = (HtpState *)p->flow->alstate;
|
||||
if (htp_state != NULL) {
|
||||
htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP, htp_state, ff->txid);
|
||||
if (tx != NULL && tx->request_hostname != NULL) {
|
||||
PrintRawUriFp(fp, (uint8_t *)bstr_ptr(tx->request_hostname),
|
||||
bstr_len(tx->request_hostname));
|
||||
return;
|
||||
}
|
||||
}
|
||||
|
||||
fprintf(fp, "<unknown>");
|
||||
}
|
||||
|
||||
static void LogFilestoreMetaGetReferer(FILE *fp, const Packet *p, const File *ff)
|
||||
{
|
||||
HtpState *htp_state = (HtpState *)p->flow->alstate;
|
||||
if (htp_state != NULL) {
|
||||
htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP, htp_state, ff->txid);
|
||||
if (tx != NULL) {
|
||||
htp_header_t *h = NULL;
|
||||
h = (htp_header_t *)htp_table_get_c(tx->request_headers,
|
||||
"Referer");
|
||||
if (h != NULL) {
|
||||
PrintRawUriFp(fp, (uint8_t *)bstr_ptr(h->value),
|
||||
bstr_len(h->value));
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fprintf(fp, "<unknown>");
|
||||
}
|
||||
|
||||
static void LogFilestoreMetaGetUserAgent(FILE *fp, const Packet *p, const File *ff)
|
||||
{
|
||||
HtpState *htp_state = (HtpState *)p->flow->alstate;
|
||||
if (htp_state != NULL) {
|
||||
htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP, htp_state, ff->txid);
|
||||
if (tx != NULL) {
|
||||
htp_header_t *h = NULL;
|
||||
h = (htp_header_t *)htp_table_get_c(tx->request_headers,
|
||||
"User-Agent");
|
||||
if (h != NULL) {
|
||||
PrintRawUriFp(fp, (uint8_t *)bstr_ptr(h->value),
|
||||
bstr_len(h->value));
|
||||
return;
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
fprintf(fp, "<unknown>");
|
||||
}
|
||||
|
||||
static void LogFilestoreMetaGetSmtp(FILE *fp, const Packet *p, const File *ff)
|
||||
{
|
||||
SMTPState *state = (SMTPState *) p->flow->alstate;
|
||||
if (state != NULL) {
|
||||
SMTPTransaction *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_SMTP, state, ff->txid);
|
||||
if (tx == NULL || tx->msg_tail == NULL)
|
||||
return;
|
||||
|
||||
/* Message Id */
|
||||
if (tx->msg_tail->msg_id != NULL) {
|
||||
fprintf(fp, "MESSAGE-ID: ");
|
||||
PrintRawUriFp(fp, (uint8_t *) tx->msg_tail->msg_id, tx->msg_tail->msg_id_len);
|
||||
fprintf(fp, "\n");
|
||||
}
|
||||
|
||||
/* Sender */
|
||||
MimeDecField *field = MimeDecFindField(tx->msg_tail, "from");
|
||||
if (field != NULL) {
|
||||
fprintf(fp, "SENDER: ");
|
||||
PrintRawUriFp(fp, (uint8_t *) field->value, field->value_len);
|
||||
fprintf(fp, "\n");
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
/** \brief switch to write meta file
|
||||
*/
|
||||
static int g_file_write_meta = 1;
|
||||
|
||||
static void FileWriteMetaDisable(void)
|
||||
{
|
||||
g_file_write_meta = 0;
|
||||
}
|
||||
|
||||
static int FileWriteMeta(void)
|
||||
{
|
||||
return g_file_write_meta;
|
||||
}
|
||||
|
||||
static uint32_t g_file_store_max_open_files = 0;
|
||||
|
||||
static void FileSetMaxOpenFiles(uint32_t count)
|
||||
{
|
||||
g_file_store_max_open_files = count;
|
||||
}
|
||||
|
||||
static uint32_t FileGetMaxOpenFiles(void)
|
||||
{
|
||||
return g_file_store_max_open_files;
|
||||
}
|
||||
|
||||
static int g_file_store_include_pid = 0;
|
||||
|
||||
static void FileIncludePidEnable(void)
|
||||
{
|
||||
g_file_store_include_pid = 1;
|
||||
}
|
||||
|
||||
static int FileIncludePid(void)
|
||||
{
|
||||
return g_file_store_include_pid;
|
||||
}
|
||||
|
||||
static void LogFilestoreLogCreateMetaFile(const Packet *p, const File *ff, char *base_filename, int ipver) {
|
||||
if (!FileWriteMeta())
|
||||
return;
|
||||
|
||||
char metafilename[PATH_MAX] = "";
|
||||
if (snprintf(metafilename, sizeof(metafilename), "%s.meta%s", base_filename,
|
||||
g_working_file_suffix) == sizeof(metafilename))
|
||||
return;
|
||||
|
||||
FILE *fp = fopen(metafilename, "w+");
|
||||
if (fp != NULL) {
|
||||
char timebuf[64];
|
||||
|
||||
CreateTimeString(&p->ts, timebuf, sizeof(timebuf));
|
||||
|
||||
fprintf(fp, "TIME: %s\n", timebuf);
|
||||
if (p->pcap_cnt > 0) {
|
||||
fprintf(fp, "PCAP PKT NUM: %"PRIu64"\n", p->pcap_cnt);
|
||||
}
|
||||
|
||||
char srcip[46], dstip[46];
|
||||
Port sp, dp;
|
||||
switch (ipver) {
|
||||
case AF_INET:
|
||||
PrintInet(AF_INET, (const void *)GET_IPV4_SRC_ADDR_PTR(p), srcip, sizeof(srcip));
|
||||
PrintInet(AF_INET, (const void *)GET_IPV4_DST_ADDR_PTR(p), dstip, sizeof(dstip));
|
||||
break;
|
||||
case AF_INET6:
|
||||
PrintInet(AF_INET6, (const void *)GET_IPV6_SRC_ADDR(p), srcip, sizeof(srcip));
|
||||
PrintInet(AF_INET6, (const void *)GET_IPV6_DST_ADDR(p), dstip, sizeof(dstip));
|
||||
break;
|
||||
default:
|
||||
strlcpy(srcip, "<unknown>", sizeof(srcip));
|
||||
strlcpy(dstip, "<unknown>", sizeof(dstip));
|
||||
break;
|
||||
}
|
||||
sp = p->sp;
|
||||
dp = p->dp;
|
||||
|
||||
fprintf(fp, "SRC IP: %s\n", srcip);
|
||||
fprintf(fp, "DST IP: %s\n", dstip);
|
||||
fprintf(fp, "PROTO: %" PRIu32 "\n", p->proto);
|
||||
if (PKT_IS_TCP(p) || PKT_IS_UDP(p)) {
|
||||
fprintf(fp, "SRC PORT: %" PRIu16 "\n", sp);
|
||||
fprintf(fp, "DST PORT: %" PRIu16 "\n", dp);
|
||||
}
|
||||
|
||||
fprintf(fp, "APP PROTO: %s\n",
|
||||
AppProtoToString(p->flow->alproto));
|
||||
|
||||
/* Only applicable to HTTP traffic */
|
||||
if (p->flow->alproto == ALPROTO_HTTP) {
|
||||
fprintf(fp, "HTTP URI: ");
|
||||
LogFilestoreMetaGetUri(fp, p, ff);
|
||||
fprintf(fp, "\n");
|
||||
fprintf(fp, "HTTP HOST: ");
|
||||
LogFilestoreMetaGetHost(fp, p, ff);
|
||||
fprintf(fp, "\n");
|
||||
fprintf(fp, "HTTP REFERER: ");
|
||||
LogFilestoreMetaGetReferer(fp, p, ff);
|
||||
fprintf(fp, "\n");
|
||||
fprintf(fp, "HTTP USER AGENT: ");
|
||||
LogFilestoreMetaGetUserAgent(fp, p, ff);
|
||||
fprintf(fp, "\n");
|
||||
} else if (p->flow->alproto == ALPROTO_SMTP) {
|
||||
/* Only applicable to SMTP */
|
||||
LogFilestoreMetaGetSmtp(fp, p, ff);
|
||||
}
|
||||
|
||||
fprintf(fp, "FILENAME: ");
|
||||
PrintRawUriFp(fp, ff->name, ff->name_len);
|
||||
fprintf(fp, "\n");
|
||||
|
||||
fclose(fp);
|
||||
}
|
||||
}
|
||||
|
||||
static void LogFilestoreLogCloseMetaFile(const File *ff)
|
||||
{
|
||||
char pid_expression[PATH_MAX] = "";
|
||||
if (FileIncludePid())
|
||||
snprintf(pid_expression, sizeof(pid_expression), ".%d", getpid());
|
||||
char final_filename[PATH_MAX] = "";
|
||||
if (snprintf(final_filename, sizeof(final_filename), "%s/file%s.%u",
|
||||
g_logfile_base_dir, pid_expression, ff->file_store_id) == sizeof(final_filename))
|
||||
return;
|
||||
char final_metafilename[PATH_MAX] = "";
|
||||
if (snprintf(final_metafilename, sizeof(final_metafilename),
|
||||
"%s.meta", final_filename) == sizeof(final_metafilename))
|
||||
return;
|
||||
char working_metafilename[PATH_MAX] = "";
|
||||
if (snprintf(working_metafilename, sizeof(working_metafilename),
|
||||
"%s%s", final_metafilename, g_working_file_suffix) == sizeof(working_metafilename))
|
||||
return;
|
||||
|
||||
FILE *fp = fopen(working_metafilename, "a");
|
||||
if (fp != NULL) {
|
||||
#ifdef HAVE_MAGIC
|
||||
fprintf(fp, "MAGIC: %s\n",
|
||||
ff->magic ? ff->magic : "<unknown>");
|
||||
#endif
|
||||
switch (ff->state) {
|
||||
case FILE_STATE_CLOSED:
|
||||
fprintf(fp, "STATE: CLOSED\n");
|
||||
#ifdef HAVE_NSS
|
||||
if (ff->flags & FILE_MD5) {
|
||||
fprintf(fp, "MD5: ");
|
||||
size_t x;
|
||||
for (x = 0; x < sizeof(ff->md5); x++) {
|
||||
fprintf(fp, "%02x", ff->md5[x]);
|
||||
}
|
||||
fprintf(fp, "\n");
|
||||
}
|
||||
if (ff->flags & FILE_SHA1) {
|
||||
fprintf(fp, "SHA1: ");
|
||||
size_t x;
|
||||
for (x = 0; x < sizeof(ff->sha1); x++) {
|
||||
fprintf(fp, "%02x", ff->sha1[x]);
|
||||
}
|
||||
fprintf(fp, "\n");
|
||||
}
|
||||
if (ff->flags & FILE_SHA256) {
|
||||
fprintf(fp, "SHA256: ");
|
||||
size_t x;
|
||||
for (x = 0; x < sizeof(ff->sha256); x++) {
|
||||
fprintf(fp, "%02x", ff->sha256[x]);
|
||||
}
|
||||
fprintf(fp, "\n");
|
||||
}
|
||||
#endif
|
||||
break;
|
||||
case FILE_STATE_TRUNCATED:
|
||||
fprintf(fp, "STATE: TRUNCATED\n");
|
||||
break;
|
||||
case FILE_STATE_ERROR:
|
||||
fprintf(fp, "STATE: ERROR\n");
|
||||
break;
|
||||
default:
|
||||
fprintf(fp, "STATE: UNKNOWN\n");
|
||||
break;
|
||||
}
|
||||
fprintf(fp, "SIZE: %"PRIu64"\n", FileTrackedSize(ff));
|
||||
|
||||
fclose(fp);
|
||||
} else {
|
||||
SCLogInfo("opening %s failed: %s", working_metafilename,
|
||||
strerror(errno));
|
||||
}
|
||||
}
|
||||
|
||||
static void LogFilestoreFinalizeFiles(const File *ff) {
|
||||
char pid_expression[PATH_MAX] = "";
|
||||
if (FileIncludePid())
|
||||
snprintf(pid_expression, sizeof(pid_expression), ".%d", getpid());
|
||||
char final_filename[PATH_MAX] = "";
|
||||
if (snprintf(final_filename, sizeof(final_filename), "%s/file%s.%u",
|
||||
g_logfile_base_dir, pid_expression, ff->file_store_id) == sizeof(final_filename))
|
||||
return;
|
||||
char working_filename[PATH_MAX] = "";
|
||||
if (snprintf(working_filename, sizeof(working_filename), "%s%s",
|
||||
final_filename, g_working_file_suffix) == sizeof(working_filename))
|
||||
return;
|
||||
|
||||
if (rename(working_filename, final_filename) != 0) {
|
||||
SCLogWarning(SC_WARN_RENAMING_FILE, "renaming file %s to %s failed",
|
||||
working_filename, final_filename);
|
||||
return;
|
||||
}
|
||||
if (FileWriteMeta()) {
|
||||
LogFilestoreLogCloseMetaFile(ff);
|
||||
char final_metafilename[PATH_MAX] = "";
|
||||
if (snprintf(final_metafilename, sizeof(final_metafilename),
|
||||
"%s.meta", final_filename) == sizeof(final_metafilename))
|
||||
return;
|
||||
char working_metafilename[PATH_MAX] = "";
|
||||
if (snprintf(working_metafilename, sizeof(working_metafilename),
|
||||
"%s%s", final_metafilename, g_working_file_suffix) == sizeof(working_metafilename))
|
||||
return;
|
||||
|
||||
if (rename(working_metafilename, final_metafilename) != 0) {
|
||||
SCLogWarning(SC_WARN_RENAMING_FILE,
|
||||
"renaming metafile %s to %s failed", working_metafilename,
|
||||
final_metafilename);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
static int LogFilestoreLogger(ThreadVars *tv, void *thread_data, const Packet *p,
|
||||
File *ff, const uint8_t *data, uint32_t data_len, uint8_t flags, uint8_t dir)
|
||||
{
|
||||
SCEnter();
|
||||
LogFilestoreLogThread *aft = (LogFilestoreLogThread *)thread_data;
|
||||
char filename[PATH_MAX] = "";
|
||||
int file_fd = -1;
|
||||
int ipver = -1;
|
||||
|
||||
/* no flow, no htp state */
|
||||
if (p->flow == NULL) {
|
||||
SCReturnInt(TM_ECODE_OK);
|
||||
}
|
||||
|
||||
if (PKT_IS_IPV4(p)) {
|
||||
ipver = AF_INET;
|
||||
} else if (PKT_IS_IPV6(p)) {
|
||||
ipver = AF_INET6;
|
||||
} else {
|
||||
return 0;
|
||||
}
|
||||
|
||||
SCLogDebug("ff %p, data %p, data_len %u", ff, data, data_len);
|
||||
|
||||
char pid_expression[PATH_MAX] = "";
|
||||
if (FileIncludePid())
|
||||
snprintf(pid_expression, sizeof(pid_expression), ".%d", getpid());
|
||||
char base_filename[PATH_MAX] = "";
|
||||
if (snprintf(base_filename, sizeof(base_filename), "%s/file%s.%u",
|
||||
g_logfile_base_dir, pid_expression, ff->file_store_id) == sizeof(base_filename))
|
||||
return -1;
|
||||
if (snprintf(filename, sizeof(filename), "%s%s", base_filename,
|
||||
g_working_file_suffix) == sizeof(filename))
|
||||
return -1;
|
||||
|
||||
if (flags & OUTPUT_FILEDATA_FLAG_OPEN) {
|
||||
aft->file_cnt++;
|
||||
|
||||
/* create a .meta file that contains time, src/dst/sp/dp/proto */
|
||||
LogFilestoreLogCreateMetaFile(p, ff, base_filename, ipver);
|
||||
|
||||
if (SC_ATOMIC_GET(filestore_open_file_cnt) < FileGetMaxOpenFiles()) {
|
||||
SC_ATOMIC_ADD(filestore_open_file_cnt, 1);
|
||||
ff->fd = open(filename, O_CREAT | O_TRUNC | O_NOFOLLOW | O_WRONLY, 0644);
|
||||
if (ff->fd == -1) {
|
||||
SCLogDebug("failed to create file");
|
||||
return -1;
|
||||
}
|
||||
file_fd = ff->fd;
|
||||
} else {
|
||||
file_fd = open(filename, O_CREAT | O_TRUNC | O_NOFOLLOW | O_WRONLY, 0644);
|
||||
if (file_fd == -1) {
|
||||
SCLogDebug("failed to create file");
|
||||
return -1;
|
||||
}
|
||||
if (FileGetMaxOpenFiles() > 0) {
|
||||
StatsIncr(tv, aft->counter_max_hits);
|
||||
}
|
||||
ff->fd = -1;
|
||||
}
|
||||
/* we can get called with a NULL ffd when we need to close */
|
||||
} else if (data != NULL) {
|
||||
if (ff->fd == -1) {
|
||||
file_fd = open(filename, O_APPEND | O_NOFOLLOW | O_WRONLY);
|
||||
if (file_fd == -1) {
|
||||
SCLogDebug("failed to open file %s: %s", filename, strerror(errno));
|
||||
return -1;
|
||||
}
|
||||
} else {
|
||||
file_fd = ff->fd;
|
||||
}
|
||||
}
|
||||
|
||||
if (file_fd != -1) {
|
||||
ssize_t r = write(file_fd, (const void *)data, (size_t)data_len);
|
||||
if (r == -1) {
|
||||
SCLogDebug("write failed: %s", strerror(errno));
|
||||
if (ff->fd != -1) {
|
||||
SC_ATOMIC_SUB(filestore_open_file_cnt, 1);
|
||||
}
|
||||
ff->fd = -1;
|
||||
}
|
||||
if (ff->fd == -1) {
|
||||
close(file_fd);
|
||||
}
|
||||
}
|
||||
|
||||
if (flags & OUTPUT_FILEDATA_FLAG_CLOSE) {
|
||||
if (ff->fd != -1) {
|
||||
close(ff->fd);
|
||||
ff->fd = -1;
|
||||
SC_ATOMIC_SUB(filestore_open_file_cnt, 1);
|
||||
}
|
||||
LogFilestoreFinalizeFiles(ff);
|
||||
}
|
||||
|
||||
return 0;
|
||||
}
|
||||
|
||||
static TmEcode LogFilestoreLogThreadInit(ThreadVars *t, const void *initdata, void **data)
|
||||
{
|
||||
LogFilestoreLogThread *aft = SCMalloc(sizeof(LogFilestoreLogThread));
|
||||
if (unlikely(aft == NULL))
|
||||
return TM_ECODE_FAILED;
|
||||
memset(aft, 0, sizeof(LogFilestoreLogThread));
|
||||
|
||||
if (initdata == NULL)
|
||||
{
|
||||
SCLogDebug("Error getting context for LogFileStore. \"initdata\" argument NULL");
|
||||
SCFree(aft);
|
||||
return TM_ECODE_FAILED;
|
||||
}
|
||||
|
||||
/* Use the Ouptut Context (file pointer and mutex) */
|
||||
aft->file_ctx = ((OutputCtx *)initdata)->data;
|
||||
|
||||
struct stat stat_buf;
|
||||
if (stat(g_logfile_base_dir, &stat_buf) != 0) {
|
||||
int ret;
|
||||
// coverity[toctou : FALSE]
|
||||
ret = SCMkDir(g_logfile_base_dir, S_IRWXU|S_IXGRP|S_IRGRP);
|
||||
if (ret != 0) {
|
||||
int err = errno;
|
||||
if (err != EEXIST) {
|
||||
SCLogError(SC_ERR_LOGDIR_CONFIG,
|
||||
"Cannot create file drop directory %s: %s",
|
||||
g_logfile_base_dir, strerror(err));
|
||||
exit(EXIT_FAILURE);
|
||||
}
|
||||
} else {
|
||||
SCLogInfo("Created file drop directory %s",
|
||||
g_logfile_base_dir);
|
||||
}
|
||||
|
||||
}
|
||||
|
||||
aft->counter_max_hits = StatsRegisterCounter("file_store.open_files_max_hit", t);
|
||||
|
||||
*data = (void *)aft;
|
||||
return TM_ECODE_OK;
|
||||
}
|
||||
|
||||
static TmEcode LogFilestoreLogThreadDeinit(ThreadVars *t, void *data)
|
||||
{
|
||||
LogFilestoreLogThread *aft = (LogFilestoreLogThread *)data;
|
||||
if (aft == NULL) {
|
||||
return TM_ECODE_OK;
|
||||
}
|
||||
|
||||
/* clear memory */
|
||||
memset(aft, 0, sizeof(LogFilestoreLogThread));
|
||||
|
||||
SCFree(aft);
|
||||
return TM_ECODE_OK;
|
||||
}
|
||||
|
||||
static void LogFilestoreLogExitPrintStats(ThreadVars *tv, void *data)
|
||||
{
|
||||
LogFilestoreLogThread *aft = (LogFilestoreLogThread *)data;
|
||||
if (aft == NULL) {
|
||||
return;
|
||||
}
|
||||
|
||||
SCLogInfo("(%s) Files extracted %" PRIu32 "", tv->name, aft->file_cnt);
|
||||
}
|
||||
|
||||
/**
|
||||
* \internal
|
||||
*
|
||||
* \brief deinit the log ctx and write out the waldo
|
||||
*
|
||||
* \param output_ctx output context to deinit
|
||||
*/
|
||||
static void LogFilestoreLogDeInitCtx(OutputCtx *output_ctx)
|
||||
{
|
||||
LogFileCtx *logfile_ctx = (LogFileCtx *)output_ctx->data;
|
||||
LogFileFreeCtx(logfile_ctx);
|
||||
SCFree(output_ctx);
|
||||
|
||||
}
|
||||
|
||||
/** \brief Create a new http log LogFilestoreCtx.
|
||||
* \param conf Pointer to ConfNode containing this loggers configuration.
|
||||
* \return NULL if failure, LogFilestoreCtx* to the file_ctx if succesful
|
||||
* */
|
||||
static OutputInitResult LogFilestoreLogInitCtx(ConfNode *conf)
|
||||
{
|
||||
OutputInitResult result = { NULL, false };
|
||||
|
||||
intmax_t version = 0;
|
||||
if (ConfGetChildValueInt(conf, "version", &version)) {
|
||||
if (version > 1) {
|
||||
result.ok = true;
|
||||
return result;
|
||||
}
|
||||
}
|
||||
|
||||
if (RunModeOutputFiledataEnabled()) {
|
||||
SCLogWarning(SC_ERR_NOT_SUPPORTED,
|
||||
"A file data logger is already enabled. Filestore (v1) "
|
||||
"will not be enabled.");
|
||||
return result;
|
||||
}
|
||||
|
||||
SCLogWarning(SC_WARN_DEPRECATED,
|
||||
"File-store v1 has been deprecated and will be removed by "
|
||||
"June 2020. Please update to file-store v2.");
|
||||
|
||||
OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
|
||||
if (unlikely(output_ctx == NULL))
|
||||
return result;
|
||||
|
||||
output_ctx->data = NULL;
|
||||
output_ctx->DeInit = LogFilestoreLogDeInitCtx;
|
||||
|
||||
const char *s_default_log_dir = NULL;
|
||||
s_default_log_dir = ConfigGetLogDirectory();
|
||||
|
||||
const char *s_base_dir = NULL;
|
||||
s_base_dir = ConfNodeLookupChildValue(conf, "log-dir");
|
||||
if (s_base_dir == NULL || strlen(s_base_dir) == 0) {
|
||||
strlcpy(g_logfile_base_dir,
|
||||
s_default_log_dir, sizeof(g_logfile_base_dir));
|
||||
} else {
|
||||
if (PathIsAbsolute(s_base_dir)) {
|
||||
strlcpy(g_logfile_base_dir,
|
||||
s_base_dir, sizeof(g_logfile_base_dir));
|
||||
} else {
|
||||
snprintf(g_logfile_base_dir, sizeof(g_logfile_base_dir),
|
||||
"%s/%s", s_default_log_dir, s_base_dir);
|
||||
}
|
||||
}
|
||||
|
||||
const char *force_filestore = ConfNodeLookupChildValue(conf, "force-filestore");
|
||||
if (force_filestore != NULL && ConfValIsTrue(force_filestore)) {
|
||||
FileForceFilestoreEnable();
|
||||
SCLogInfo("forcing filestore of all files");
|
||||
}
|
||||
|
||||
const char *force_magic = ConfNodeLookupChildValue(conf, "force-magic");
|
||||
if (force_magic != NULL && ConfValIsTrue(force_magic)) {
|
||||
FileForceMagicEnable();
|
||||
SCLogInfo("forcing magic lookup for stored files");
|
||||
}
|
||||
|
||||
const char *write_meta = ConfNodeLookupChildValue(conf, "write-meta");
|
||||
if (write_meta != NULL && !ConfValIsTrue(write_meta)) {
|
||||
FileWriteMetaDisable();
|
||||
SCLogInfo("File-store output will not write meta files");
|
||||
}
|
||||
|
||||
FileForceHashParseCfg(conf);
|
||||
SCLogInfo("storing files in %s", g_logfile_base_dir);
|
||||
|
||||
const char *stream_depth_str = ConfNodeLookupChildValue(conf, "stream-depth");
|
||||
if (stream_depth_str != NULL && strcmp(stream_depth_str, "no")) {
|
||||
uint32_t stream_depth = 0;
|
||||
if (ParseSizeStringU32(stream_depth_str,
|
||||
&stream_depth) < 0) {
|
||||
SCLogError(SC_ERR_SIZE_PARSE, "Error parsing "
|
||||
"file-store.stream-depth "
|
||||
"from conf file - %s. Killing engine",
|
||||
stream_depth_str);
|
||||
exit(EXIT_FAILURE);
|
||||
} else {
|
||||
FileReassemblyDepthEnable(stream_depth);
|
||||
}
|
||||
}
|
||||
|
||||
const char *file_count_str = ConfNodeLookupChildValue(conf, "max-open-files");
|
||||
if (file_count_str != NULL) {
|
||||
uint32_t file_count = 0;
|
||||
if (ParseSizeStringU32(file_count_str,
|
||||
&file_count) < 0) {
|
||||
SCLogError(SC_ERR_SIZE_PARSE, "Error parsing "
|
||||
"file-store.max-open-files "
|
||||
"from conf file - %s. Killing engine",
|
||||
stream_depth_str);
|
||||
exit(EXIT_FAILURE);
|
||||
} else {
|
||||
if (file_count != 0) {
|
||||
FileSetMaxOpenFiles(file_count);
|
||||
SCLogInfo("file-store will keep a max of %d simultaneously"
|
||||
" open files", file_count);
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
const char *include_pid = ConfNodeLookupChildValue(conf, "include-pid");
|
||||
if (include_pid != NULL && ConfValIsTrue(include_pid)) {
|
||||
FileIncludePidEnable();
|
||||
SCLogInfo("enabling pid as a part of all file names");
|
||||
}
|
||||
|
||||
StatsRegisterGlobalCounter("file_store.open_files",
|
||||
LogFilestoreOpenFilesCounter);
|
||||
|
||||
result.ctx = output_ctx;
|
||||
result.ok = true;
|
||||
SCReturnCT(result, "OutputInitResult");
|
||||
}
|
||||
|
||||
void LogFilestoreRegister (void)
|
||||
{
|
||||
OutputRegisterFiledataModule(LOGGER_FILE_STORE, MODULE_NAME, "file",
|
||||
LogFilestoreLogInitCtx, LogFilestoreLogger, LogFilestoreLogThreadInit,
|
||||
LogFilestoreLogThreadDeinit, LogFilestoreLogExitPrintStats);
|
||||
OutputRegisterFiledataModule(LOGGER_FILE_STORE, MODULE_NAME, "file-store",
|
||||
LogFilestoreLogInitCtx, LogFilestoreLogger, LogFilestoreLogThreadInit,
|
||||
LogFilestoreLogThreadDeinit, LogFilestoreLogExitPrintStats);
|
||||
|
||||
SC_ATOMIC_INIT(filestore_open_file_cnt);
|
||||
SC_ATOMIC_SET(filestore_open_file_cnt, 0);
|
||||
SCLogDebug("registered");
|
||||
}
|
@ -1,30 +0,0 @@
|
||||
/* Copyright (C) 2007-2011 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 Victor Julien <victor@inliniac.net>
|
||||
*/
|
||||
|
||||
#ifndef __LOG_FILESTORE_H__
|
||||
#define __LOG_FILESTORE_H__
|
||||
|
||||
void LogFilestoreRegister(void);
|
||||
void LogFilestoreInitConfig(void);
|
||||
|
||||
#endif /* __LOG_FILELOG_H__ */
|
Loading…
Reference in New Issue