suricata
output-json-file.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2021 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 /**
19  * \file
20  *
21  * \author Tom DeCanio <td@npulsetech.com>
22  *
23  * Log files we track.
24  *
25  */
26 
27 #include "suricata-common.h"
28 #include "detect.h"
29 #include "pkt-var.h"
30 #include "conf.h"
31 
32 #include "threadvars.h"
33 #include "tm-modules.h"
34 
35 #include "threads.h"
36 
37 #include "app-layer-parser.h"
38 
39 #include "detect-filemagic.h"
40 
41 #include "stream.h"
42 
43 #include "util-print.h"
44 #include "util-unittest.h"
45 #include "util-privs.h"
46 #include "util-debug.h"
47 #include "util-atomic.h"
48 #include "util-file.h"
49 #include "util-time.h"
50 #include "util-buffer.h"
51 #include "util-byte.h"
52 #include "util-validate.h"
53 
54 #include "util-logopenfile.h"
55 
56 #include "output.h"
57 #include "output-json.h"
58 #include "output-json-file.h"
59 #include "output-json-http.h"
60 #include "output-json-smtp.h"
62 #include "output-json-nfs.h"
63 #include "output-json-smb.h"
64 
65 #include "app-layer-htp.h"
66 #include "app-layer-htp-xff.h"
67 #include "util-memcmp.h"
68 #include "stream-tcp-reassemble.h"
69 
70 typedef struct OutputFileCtx_ {
71  uint32_t file_cnt;
76 
77 typedef struct JsonFileLogThread_ {
81 
82 JsonBuilder *JsonBuildFileInfoRecord(const Packet *p, const File *ff, void *tx,
83  const uint64_t tx_id, const bool stored, uint8_t dir, HttpXFFCfg *xff_cfg,
84  OutputJsonCtx *eve_ctx)
85 {
87 
88  switch(dir) {
89  case STREAM_TOCLIENT:
90  fdir = LOG_DIR_FLOW_TOCLIENT;
91  break;
92  case STREAM_TOSERVER:
93  fdir = LOG_DIR_FLOW_TOSERVER;
94  break;
95  default:
97  break;
98  }
99 
101  JsonAddrInfoInit(p, fdir, &addr);
102 
103  /* Overwrite address info with XFF if needed. */
104  int have_xff_ip = 0;
105  char xff_buffer[XFF_MAXLEN];
106  if ((xff_cfg != NULL) && !(xff_cfg->flags & XFF_DISABLED)) {
107  if (FlowGetAppProtocol(p->flow) == ALPROTO_HTTP1) {
108  have_xff_ip = HttpXFFGetIPFromTx(p->flow, tx_id, xff_cfg, xff_buffer, XFF_MAXLEN);
109  }
110  if (have_xff_ip && xff_cfg->flags & XFF_OVERWRITE) {
111  if (p->flowflags & FLOW_PKT_TOCLIENT) {
112  strlcpy(addr.dst_ip, xff_buffer, JSON_ADDR_LEN);
113  } else {
114  strlcpy(addr.src_ip, xff_buffer, JSON_ADDR_LEN);
115  }
116  have_xff_ip = 0;
117  }
118  }
119 
120  JsonBuilder *js = CreateEveHeader(p, fdir, "fileinfo", &addr, eve_ctx);
121  if (unlikely(js == NULL))
122  return NULL;
123 
124  JsonBuilderMark mark = { 0, 0, 0 };
126  switch (p->flow->alproto) {
127  case ALPROTO_HTTP1:
128  jb_open_object(js, "http");
129  EveHttpAddMetadata(p->flow, tx_id, js);
130  jb_close(js);
131  break;
132  case ALPROTO_SMTP:
133  jb_get_mark(js, &mark);
134  jb_open_object(js, "smtp");
135  if (EveSMTPAddMetadata(p->flow, tx_id, js)) {
136  jb_close(js);
137  } else {
138  jb_restore_mark(js, &mark);
139  }
140  jb_get_mark(js, &mark);
141  jb_open_object(js, "email");
142  if (EveEmailAddMetadata(p->flow, tx_id, js)) {
143  jb_close(js);
144  } else {
145  jb_restore_mark(js, &mark);
146  }
147  break;
148  case ALPROTO_NFS:
149  /* rpc */
150  jb_get_mark(js, &mark);
151  jb_open_object(js, "rpc");
152  if (EveNFSAddMetadataRPC(p->flow, tx_id, js)) {
153  jb_close(js);
154  } else {
155  jb_restore_mark(js, &mark);
156  }
157  /* nfs */
158  jb_get_mark(js, &mark);
159  jb_open_object(js, "nfs");
160  if (EveNFSAddMetadata(p->flow, tx_id, js)) {
161  jb_close(js);
162  } else {
163  jb_restore_mark(js, &mark);
164  }
165  break;
166  case ALPROTO_SMB:
167  jb_get_mark(js, &mark);
168  jb_open_object(js, "smb");
169  if (EveSMBAddMetadata(p->flow, tx_id, js)) {
170  jb_close(js);
171  } else {
172  jb_restore_mark(js, &mark);
173  }
174  break;
175  default:
177  if (al && al->LogTx) {
178  void *state = FlowGetAppState(p->flow);
179  if (state) {
180  tx = AppLayerParserGetTx(p->flow->proto, p->flow->alproto, state, tx_id);
181  if (tx) {
182  jb_get_mark(js, &mark);
183  if (!al->LogTx(tx, js)) {
184  jb_restore_mark(js, &mark);
185  }
186  }
187  }
188  }
189  break;
190  }
191 
192  jb_set_string(js, "app_proto", AppProtoToString(p->flow->alproto));
193 
194  jb_open_object(js, "fileinfo");
195  if (stored) {
196  // the file has just been stored on disk cf OUTPUT_FILEDATA_FLAG_CLOSE
197  // but the flag is not set until the loggers have been called
198  EveFileInfo(js, ff, tx_id, ff->flags | FILE_STORED);
199  } else {
200  EveFileInfo(js, ff, tx_id, ff->flags);
201  }
202  jb_close(js);
203 
204  /* xff header */
205  if (have_xff_ip && xff_cfg->flags & XFF_EXTRADATA) {
206  jb_set_string(js, "xff", xff_buffer);
207  }
208 
209  return js;
210 }
211 
212 /**
213  * \internal
214  * \brief Write meta data on a single line json record
215  */
216 static void FileWriteJsonRecord(ThreadVars *tv, JsonFileLogThread *aft, const Packet *p,
217  const File *ff, void *tx, const uint64_t tx_id, uint8_t dir, OutputJsonCtx *eve_ctx)
218 {
219  HttpXFFCfg *xff_cfg = aft->filelog_ctx->xff_cfg != NULL ? aft->filelog_ctx->xff_cfg
220  : aft->filelog_ctx->parent_xff_cfg;
221  JsonBuilder *js = JsonBuildFileInfoRecord(p, ff, tx, tx_id, false, dir, xff_cfg, eve_ctx);
222  if (unlikely(js == NULL)) {
223  return;
224  }
225 
226  OutputJsonBuilderBuffer(tv, p, p->flow, js, aft->ctx);
227  jb_free(js);
228 }
229 
230 static int JsonFileLogger(ThreadVars *tv, void *thread_data, const Packet *p, const File *ff,
231  void *tx, const uint64_t tx_id, uint8_t dir)
232 {
233  SCEnter();
234  JsonFileLogThread *aft = (JsonFileLogThread *)thread_data;
235 
236  BUG_ON(ff->flags & FILE_LOGGED);
237 
238  SCLogDebug("ff %p", ff);
239 
240  FileWriteJsonRecord(tv, aft, p, ff, tx, tx_id, dir, aft->filelog_ctx->eve_ctx);
241  return 0;
242 }
243 
244 
245 static TmEcode JsonFileLogThreadInit(ThreadVars *t, const void *initdata, void **data)
246 {
247  JsonFileLogThread *aft = SCCalloc(1, sizeof(JsonFileLogThread));
248  if (unlikely(aft == NULL))
249  return TM_ECODE_FAILED;
250 
251  if(initdata == NULL)
252  {
253  SCLogDebug("Error getting context for EveLogFile. \"initdata\" argument NULL");
254  goto error_exit;
255  }
256 
257  /* Use the Output Context (file pointer and mutex) */
258  aft->filelog_ctx = ((OutputCtx *)initdata)->data;
259  aft->ctx = CreateEveThreadCtx(t, aft->filelog_ctx->eve_ctx);
260  if (!aft->ctx) {
261  goto error_exit;
262  }
263 
264  *data = (void *)aft;
265  return TM_ECODE_OK;
266 
267 error_exit:
268  SCFree(aft);
269  return TM_ECODE_FAILED;
270 }
271 
272 static TmEcode JsonFileLogThreadDeinit(ThreadVars *t, void *data)
273 {
274  JsonFileLogThread *aft = (JsonFileLogThread *)data;
275  if (aft == NULL) {
276  return TM_ECODE_OK;
277  }
278 
279  FreeEveThreadCtx(aft->ctx);
280 
281  /* clear memory */
282  memset(aft, 0, sizeof(JsonFileLogThread));
283 
284  SCFree(aft);
285  return TM_ECODE_OK;
286 }
287 
288 static void OutputFileLogDeinitSub(OutputCtx *output_ctx)
289 {
290  OutputFileCtx *ff_ctx = output_ctx->data;
291  if (ff_ctx->xff_cfg != NULL) {
292  SCFree(ff_ctx->xff_cfg);
293  }
294  SCFree(ff_ctx);
295  SCFree(output_ctx);
296 }
297 
298 /** \brief Create a new http log LogFileCtx.
299  * \param conf Pointer to ConfNode containing this loggers configuration.
300  * \return NULL if failure, LogFileCtx* to the file_ctx if succesful
301  * */
302 static OutputInitResult OutputFileLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
303 {
304  OutputInitResult result = { NULL, false };
305  OutputJsonCtx *ojc = parent_ctx->data;
306 
307  OutputFileCtx *output_file_ctx = SCCalloc(1, sizeof(OutputFileCtx));
308  if (unlikely(output_file_ctx == NULL))
309  return result;
310 
311  OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
312  if (unlikely(output_ctx == NULL)) {
313  SCFree(output_file_ctx);
314  return result;
315  }
316 
317  if (conf) {
318  const char *force_filestore = ConfNodeLookupChildValue(conf, "force-filestore");
319  if (force_filestore != NULL && ConfValIsTrue(force_filestore)) {
321  SCLogConfig("forcing filestore of all files");
322  }
323 
324  const char *force_magic = ConfNodeLookupChildValue(conf, "force-magic");
325  if (force_magic != NULL && ConfValIsTrue(force_magic)) {
327  SCLogConfig("forcing magic lookup for logged files");
328  }
329 
330  FileForceHashParseCfg(conf);
331  }
332 
333  if (conf != NULL && ConfNodeLookupChild(conf, "xff") != NULL) {
334  output_file_ctx->xff_cfg = SCCalloc(1, sizeof(HttpXFFCfg));
335  if (output_file_ctx->xff_cfg != NULL) {
336  HttpXFFGetCfg(conf, output_file_ctx->xff_cfg);
337  }
338  } else if (ojc->xff_cfg) {
339  output_file_ctx->parent_xff_cfg = ojc->xff_cfg;
340  }
341 
342  output_file_ctx->eve_ctx = ojc;
343  output_ctx->data = output_file_ctx;
344  output_ctx->DeInit = OutputFileLogDeinitSub;
345 
347  result.ctx = output_ctx;
348  result.ok = true;
349  return result;
350 }
351 
353 {
354  /* register as child of eve-log */
355  OutputRegisterFileSubModule(LOGGER_JSON_FILE, "eve-log", "JsonFileLog", "eve-log.files",
356  OutputFileLogInitSub, JsonFileLogger, JsonFileLogThreadInit, JsonFileLogThreadDeinit);
357 }
XFF_MAXLEN
#define XFF_MAXLEN
Definition: app-layer-htp-xff.h:39
util-byte.h
EveSMTPAddMetadata
bool EveSMTPAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
Definition: output-json-smtp.c:96
OutputJsonCtx_::xff_cfg
HttpXFFCfg * xff_cfg
Definition: output-json.h:85
XFF_EXTRADATA
#define XFF_EXTRADATA
Definition: app-layer-htp-xff.h:31
FileForceTrackingEnable
void FileForceTrackingEnable(void)
Definition: util-file.c:161
OutputFileCtx_::eve_ctx
OutputJsonCtx * eve_ctx
Definition: output-json-file.c:74
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
JsonFileLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-file.c:79
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
FreeEveThreadCtx
void FreeEveThreadCtx(OutputJsonThreadCtx *ctx)
Definition: output-json-common.c:58
Flow_::proto
uint8_t proto
Definition: flow.h:378
SCEveJsonSimpleGetLogger
EveJsonSimpleAppLayerLogger * SCEveJsonSimpleGetLogger(AppProto alproto)
Definition: output.c:836
threads.h
OutputJsonCtx_
Definition: output-json.h:81
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
Definition: app-layer-protos.c:75
JsonFileLogRegister
void JsonFileLogRegister(void)
Definition: output-json-file.c:352
OutputJsonBuilderBuffer
void OutputJsonBuilderBuffer(ThreadVars *tv, const Packet *p, Flow *f, JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:958
EveNFSAddMetadata
bool EveNFSAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *jb)
Definition: output-json-nfs.c:62
CreateEveThreadCtx
OutputJsonThreadCtx * CreateEveThreadCtx(ThreadVars *t, OutputJsonCtx *ctx)
Definition: output-json-common.c:29
json_addr_info_zero
const JsonAddrInfo json_addr_info_zero
Definition: output-json.c:81
tm-modules.h
EveFileInfo
void EveFileInfo(JsonBuilder *jb, const File *ff, const uint64_t tx_id, const uint16_t flags)
Definition: output-json.c:124
util-privs.h
stream-tcp-reassemble.h
FileForceMagicEnable
void FileForceMagicEnable(void)
Definition: util-file.c:98
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:507
OutputFileCtx_::xff_cfg
HttpXFFCfg * xff_cfg
Definition: output-json-file.c:72
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:81
OutputRegisterFileSubModule
void OutputRegisterFileSubModule(LoggerId id, const char *parent_name, const char *name, const char *conf_name, OutputInitSubFunc InitFunc, SCFileLogger FileLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
Register a file output sub-module.
Definition: output.c:393
util-unittest.h
EveHttpAddMetadata
bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
Definition: output-json-http.c:498
ConfValIsTrue
int ConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:536
OutputCtx_::data
void * data
Definition: tm-modules.h:87
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:80
OutputCtx_
Definition: tm-modules.h:84
app-layer-htp-xff.h
strlcpy
size_t strlcpy(char *dst, const char *src, size_t siz)
Definition: util-strlcpyu.c:43
OutputJsonThreadCtx_
Definition: output-json.h:89
util-memcmp.h
app-layer-htp.h
util-debug.h
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:47
LOGGER_JSON_FILE
@ LOGGER_JSON_FILE
Definition: suricata-common.h:484
output-json.h
ALPROTO_SMTP
@ ALPROTO_SMTP
Definition: app-layer-protos.h:32
output-json-file.h
CreateEveHeader
JsonBuilder * CreateEveHeader(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, OutputJsonCtx *eve_ctx)
Definition: output-json.c:806
util-print.h
detect-filemagic.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
pkt-var.h
util-atomic.h
output-json-email-common.h
util-time.h
OutputInitResult_::ok
bool ok
Definition: output.h:48
app-layer-parser.h
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:300
stream.h
JsonAddrInfo_
Definition: output-json.h:47
Packet_
Definition: decode.h:476
conf.h
XFF_OVERWRITE
#define XFF_OVERWRITE
Definition: app-layer-htp-xff.h:33
JsonBuildFileInfoRecord
JsonBuilder * JsonBuildFileInfoRecord(const Packet *p, const File *ff, void *tx, const uint64_t tx_id, const bool stored, uint8_t dir, HttpXFFCfg *xff_cfg, OutputJsonCtx *eve_ctx)
Definition: output-json-file.c:82
TmEcode
TmEcode
Definition: tm-threads-common.h:79
EveNFSAddMetadataRPC
bool EveNFSAddMetadataRPC(const Flow *f, uint64_t tx_id, JsonBuilder *jb)
Definition: output-json-nfs.c:50
HttpXFFCfg_
Definition: app-layer-htp-xff.h:41
LOG_DIR_FLOW_TOCLIENT
@ LOG_DIR_FLOW_TOCLIENT
Definition: output-json.h:39
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:233
EveJsonSimpleAppLayerLogger
Definition: output.h:166
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1094
ConfNodeLookupChild
ConfNode * ConfNodeLookupChild(const ConfNode *node, const char *name)
Lookup a child configuration node by name.
Definition: conf.c:781
File_::flags
uint16_t flags
Definition: util-file.h:80
util-file.h
File_
Definition: util-file.h:79
OutputInitResult_
Definition: output.h:46
Packet_::flow
struct Flow_ * flow
Definition: decode.h:515
EveEmailAddMetadata
bool EveEmailAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
Definition: output-json-email-common.c:191
suricata-common.h
FileForceFilestoreEnable
void FileForceFilestoreEnable(void)
Definition: util-file.c:92
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:90
EveJsonSimpleAppLayerLogger::LogTx
EveJsonSimpleTxLogFunc LogTx
Definition: output.h:167
JSON_ADDR_LEN
#define JSON_ADDR_LEN
Definition: output-json.h:43
output-json-nfs.h
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:30
FILE_STORED
#define FILE_STORED
Definition: util-file.h:56
JsonFileLogThread_
Definition: output-json-file.c:77
FileForceHashParseCfg
void FileForceHashParseCfg(ConfNode *conf)
Function to parse forced file hashing configuration.
Definition: util-file.c:170
OutputJsonLogDirection
OutputJsonLogDirection
Definition: output-json.h:36
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
threadvars.h
util-validate.h
LOG_DIR_FLOW
@ LOG_DIR_FLOW
Definition: output-json.h:38
SCLogConfig
struct SCLogConfig_ SCLogConfig
Holds the config state used by the logging api.
JsonAddrInfo_::src_ip
char src_ip[JSON_ADDR_LEN]
Definition: output-json.h:48
HttpXFFCfg_::flags
uint8_t flags
Definition: app-layer-htp-xff.h:42
FILE_LOGGED
#define FILE_LOGGED
Definition: util-file.h:53
LOG_DIR_FLOW_TOSERVER
@ LOG_DIR_FLOW_TOSERVER
Definition: output-json.h:40
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
util-logopenfile.h
util-buffer.h
JsonAddrInfo_::dst_ip
char dst_ip[JSON_ADDR_LEN]
Definition: output-json.h:49
JsonFileLogThread
struct JsonFileLogThread_ JsonFileLogThread
JsonAddrInfoInit
void JsonAddrInfoInit(const Packet *p, enum OutputJsonLogDirection dir, JsonAddrInfo *addr)
Definition: output-json.c:459
HttpXFFGetCfg
void HttpXFFGetCfg(ConfNode *conf, HttpXFFCfg *result)
Function to return XFF configuration from a configuration node.
Definition: app-layer-htp-xff.c:205
output-json-smb.h
ALPROTO_SMB
@ ALPROTO_SMB
Definition: app-layer-protos.h:37
OutputFileCtx_
Definition: output-json-file.c:70
HttpXFFGetIPFromTx
int HttpXFFGetIPFromTx(const Flow *f, uint64_t tx_id, HttpXFFCfg *xff_cfg, char *dstbuf, int dstbuflen)
Function to return XFF IP if any in the selected transaction. The caller needs to lock the flow.
Definition: app-layer-htp-xff.c:116
output-json-smtp.h
output-json-http.h
EveSMBAddMetadata
bool EveSMBAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *jb)
Definition: output-json-smb.c:34
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:455
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
OutputFileCtx
struct OutputFileCtx_ OutputFileCtx
XFF_DISABLED
#define XFF_DISABLED
Definition: app-layer-htp-xff.h:29
JsonFileLogThread_::filelog_ctx
OutputFileCtx * filelog_ctx
Definition: output-json-file.c:78
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:102
ALPROTO_NFS
@ ALPROTO_NFS
Definition: app-layer-protos.h:45
OutputFileCtx_::file_cnt
uint32_t file_cnt
Definition: output-json-file.c:71
output.h
OutputFileCtx_::parent_xff_cfg
HttpXFFCfg * parent_xff_cfg
Definition: output-json-file.c:73
ConfNodeLookupChildValue
const char * ConfNodeLookupChildValue(const ConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:809