suricata
output-tx.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2022 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 Victor Julien <victor@inliniac.net>
22  *
23  * AppLayer TX Logger Output registration functions
24  */
25 
26 #include "suricata-common.h"
27 #include "output.h"
28 #include "output-tx.h"
29 #include "stream.h"
30 #include "app-layer.h"
31 #include "app-layer-parser.h"
32 #include "util-profiling.h"
33 #include "util-validate.h"
34 
35 /** per thread data for this module, contains a list of per thread
36  * data for the packet loggers. */
37 typedef struct OutputTxLoggerThreadData_ {
38  /* thread local data from file api */
40  /* thread local data from filedata api */
44 
45 /* logger instance, a module + a output ctx,
46  * it's perfectly valid that have multiple instances of the same
47  * log module (e.g. http.log) with different output ctx'. */
48 typedef struct OutputTxLogger_ {
52  void *initdata;
54  const char *name;
56  uint32_t id;
59  TmEcode (*ThreadInit)(ThreadVars *, const void *, void **);
62 
63 static OutputTxLogger **list = NULL;
64 
68 {
69  if (list == NULL) {
70  list = SCCalloc(ALPROTO_MAX, sizeof(OutputTxLogger *));
71  if (unlikely(list == NULL)) {
72  SCLogError("Failed to allocate OutputTx list");
73  return -1;
74  }
75  }
76 
78  SCLogDebug(
79  "%s logger not enabled: protocol %s is disabled", name, AppProtoToString(alproto));
80  return -1;
81  }
82  OutputTxLogger *op = SCCalloc(1, sizeof(*op));
83  if (op == NULL)
84  return -1;
85 
86  op->alproto = alproto;
87  op->LogFunc = LogFunc;
89  op->initdata = initdata;
90  op->name = name;
91  op->logger_id = id;
92  op->ThreadInit = ThreadInit;
94 
95  if (alproto == ALPROTO_UNKNOWN) {
96  op->tc_log_progress = 0;
97  } else if (tc_log_progress < 0) {
98  op->tc_log_progress =
100  STREAM_TOCLIENT);
101  } else {
103  }
104 
105  if (alproto == ALPROTO_UNKNOWN) {
106  op->ts_log_progress = 0;
107  } else if (ts_log_progress < 0) {
108  op->ts_log_progress =
110  STREAM_TOSERVER);
111  } else {
113  }
114 
115  if (list[alproto] == NULL) {
116  op->id = 1;
117  list[alproto] = op;
118  } else {
119  OutputTxLogger *t = list[alproto];
120  while (t->next)
121  t = t->next;
122  if (t->id * 2ULL > UINT32_MAX) {
123  FatalError("Too many loggers registered.");
124  }
125  op->id = t->id * 2;
126  t->next = op;
127  }
128 
129  SCLogDebug("OutputRegisterTxLogger happy");
130  return 0;
131 }
132 
133 extern bool g_file_logger_enabled;
134 extern bool g_filedata_logger_enabled;
135 
136 /** \brief run the per tx file logging
137  * \todo clean up various end of tx/stream etc indicators
138  */
139 static inline void OutputTxLogFiles(ThreadVars *tv, OutputFileLoggerThreadData *file_td,
140  OutputFiledataLoggerThreadData *filedata_td, Packet *p, Flow *f, void *tx,
141  const uint64_t tx_id, AppLayerTxData *txd, const bool tx_complete, const bool ts_ready,
142  const bool tc_ready, const bool ts_eof, const bool tc_eof, const bool eof)
143 {
144  uint8_t packet_dir;
145  uint8_t opposing_dir;
146  bool packet_dir_ready;
147  const bool opposing_dir_ready = eof;
148  bool opposing_tx_ready;
149  if (p->flowflags & FLOW_PKT_TOSERVER) {
150  packet_dir = STREAM_TOSERVER;
151  opposing_dir = STREAM_TOCLIENT;
152  packet_dir_ready = eof | ts_ready | ts_eof;
153  opposing_tx_ready = tc_ready;
154  } else if (p->flowflags & FLOW_PKT_TOCLIENT) {
155  packet_dir = STREAM_TOCLIENT;
156  opposing_dir = STREAM_TOSERVER;
157  packet_dir_ready = eof | tc_ready | tc_eof;
158  opposing_tx_ready = ts_ready;
159  } else {
160  abort();
161  }
162 
163  SCLogDebug("eof %d ts_ready %d ts_eof %d", eof, ts_ready, ts_eof);
164  SCLogDebug("eof %d tc_ready %d tc_eof %d", eof, tc_ready, tc_eof);
165 
166  SCLogDebug("packet dir %s opposing %s packet_dir_ready %d opposing_dir_ready %d",
167  packet_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT",
168  opposing_dir == STREAM_TOSERVER ? "TOSERVER" : "TOCLIENT", packet_dir_ready,
169  opposing_dir_ready);
170 
171  AppLayerGetFileState app_files = AppLayerParserGetTxFiles(f, tx, packet_dir);
172  FileContainer *ffc = app_files.fc;
173  AppLayerGetFileState app_files_opposing = AppLayerParserGetTxFiles(f, tx, opposing_dir);
174  FileContainer *ffc_opposing = app_files_opposing.fc;
175 
176  /* see if opposing side is finished: if no file support in this direction, of is not
177  * files and tx is done for opposing dir. */
178  bool opposing_finished =
179  ffc_opposing == NULL || (ffc_opposing->head == NULL && opposing_tx_ready);
180  SCLogDebug("opposing_finished %d ffc_opposing %p ffc_opposing->head %p opposing_tx_ready %d",
181  opposing_finished, ffc_opposing, ffc_opposing ? ffc_opposing->head : NULL,
182  opposing_tx_ready);
183 
184  if (ffc || ffc_opposing)
185  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
186  " ffc %p ffc_opposing %p tx_complete %d",
187  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
188 
189  if (ffc) {
190  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | eof;
191  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
192  SCLogDebug("tx: calling files: ffc %p head %p file_close %d file_trunc %d", ffc, ffc->head,
193  file_close, file_trunc);
194  if (filedata_td && txd->files_opened > txd->files_stored)
195  OutputFiledataLogFfc(tv, filedata_td, p, app_files, tx, tx_id, txd, packet_dir,
196  file_close, file_trunc, packet_dir);
197  if (file_td && txd->files_opened > txd->files_logged)
199  tv, file_td, p, ffc, tx, tx_id, txd, file_close, file_trunc, packet_dir);
200  }
201  /* if EOF and we support files, do a final write out */
202  if (opposing_dir_ready && ffc_opposing != NULL) {
203  const bool file_close = ((p->flags & PKT_PSEUDO_STREAM_END)) | tx_complete | eof;
204  const bool file_trunc = StreamTcpReassembleDepthReached(p) | eof;
205  opposing_finished = true;
206  SCLogDebug("tx: calling for opposing direction files: file_close:%s file_trunc:%s",
207  file_close ? "true" : "false", file_trunc ? "true" : "false");
208  if (filedata_td && txd->files_opened > txd->files_stored)
209  OutputFiledataLogFfc(tv, filedata_td, p, app_files_opposing, tx, tx_id, txd,
210  opposing_dir, file_close, file_trunc, opposing_dir);
211  if (file_td && txd->files_opened > txd->files_logged)
212  OutputFileLogFfc(tv, file_td, p, ffc_opposing, tx, tx_id, txd, file_close, file_trunc,
213  opposing_dir);
214  }
215 
216  const bool tx_done = packet_dir_ready && opposing_finished;
217  SCLogDebug("tx_done %d packet_dir_ready %d opposing_finished %d", tx_done, packet_dir_ready,
218  opposing_finished);
219 
220  /* if not a file tx or if tx is done, set logger flags so tx can move on */
221  const bool is_file_tx = (ffc != NULL || ffc_opposing != NULL);
222  if (!is_file_tx || tx_done) {
223  SCLogDebug("is_file_tx %d tx_done %d", is_file_tx, tx_done);
224  if (file_td) {
225  txd->logged.flags |= BIT_U32(LOGGER_FILE);
226  SCLogDebug("setting LOGGER_FILE => %08x", txd->logged.flags);
227  }
228  if (filedata_td) {
229  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
230  SCLogDebug("setting LOGGER_FILEDATA => %08x", txd->logged.flags);
231  }
232  } else {
233  SCLogDebug("pcap_cnt %" PRIu64 " flow %p tx %p tx_id %" PRIu64
234  " NOT SETTING FILE FLAGS ffc %p ffc_opposing %p tx_complete %d",
235  p->pcap_cnt, f, tx, tx_id, ffc, ffc_opposing, tx_complete);
236  }
237 }
238 
239 static void OutputTxLogList0(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data, Packet *p,
240  Flow *f, void *tx, const uint64_t tx_id)
241 {
242  const OutputTxLogger *logger = list[ALPROTO_UNKNOWN];
243  const OutputLoggerThreadStore *store = op_thread_data->store[ALPROTO_UNKNOWN];
244 
245  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
246  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
247  DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
248 
249  while (logger && store) {
250  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
251 
252  SCLogDebug("logger %p", logger);
253 
254  /* always invoke "wild card" tx loggers */
255  SCLogDebug("Logging tx_id %"PRIu64" to logger %d", tx_id, logger->logger_id);
257  logger->LogFunc(tv, store->thread_data, p, f, f->alstate, tx, tx_id);
259 
260  logger = logger->next;
261  store = store->next;
262 
263  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
264  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
265  }
266 }
267 
268 struct Ctx {
269  uint32_t tx_logged_old;
270  uint32_t tx_logged;
271 };
272 
273 static void OutputTxLogCallLoggers(ThreadVars *tv, OutputTxLoggerThreadData *op_thread_data,
274  const OutputTxLogger *logger, const OutputLoggerThreadStore *store, Packet *p, Flow *f,
275  void *alstate, void *tx, const uint64_t tx_id, const AppProto alproto, const bool eof,
276  const int tx_progress_ts, const int tx_progress_tc, struct Ctx *ctx)
277 {
278  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
279  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
280  // DEBUG_VALIDATE_BUG_ON(logger == NULL && store == NULL);
281 
282  while (logger && store) {
283  DEBUG_VALIDATE_BUG_ON(logger->LogFunc == NULL);
284  DEBUG_VALIDATE_BUG_ON(logger->alproto != alproto);
285 
286  SCLogDebug("logger %p, Alproto %d LogCondition %p, ts_log_progress %d "
287  "tc_log_progress %d",
288  logger, logger->alproto, logger->LogCondition, logger->ts_log_progress,
289  logger->tc_log_progress);
290  if ((ctx->tx_logged_old & BIT_U32(logger->logger_id)) == 0) {
291  SCLogDebug("alproto match %d, logging tx_id %" PRIu64, logger->alproto, tx_id);
292 
293  SCLogDebug("pcap_cnt %" PRIu64 ", tx_id %" PRIu64 " logger %d. EOF %s", p->pcap_cnt,
294  tx_id, logger->logger_id, eof ? "true" : "false");
295 
296  if (eof) {
297  SCLogDebug("EOF, so log now");
298  } else {
299  if (logger->LogCondition) {
300  if (!logger->LogCondition(tv, p, alstate, tx, tx_id)) {
301  SCLogDebug("conditions not met, not logging");
302  goto next_logger;
303  }
304  } else {
305  if (tx_progress_tc < logger->tc_log_progress) {
306  SCLogDebug("progress not far enough, not logging");
307  goto next_logger;
308  }
309 
310  if (tx_progress_ts < logger->ts_log_progress) {
311  SCLogDebug("progress not far enough, not logging");
312  goto next_logger;
313  }
314  }
315  }
316 
317  SCLogDebug("Logging tx_id %" PRIu64 " to logger %d", tx_id, logger->logger_id);
319  logger->LogFunc(tv, store->thread_data, p, f, alstate, tx, tx_id);
321 
322  ctx->tx_logged |= BIT_U32(logger->logger_id);
323  }
324 
325  next_logger:
326  logger = logger->next;
327  store = store->next;
328 
329  DEBUG_VALIDATE_BUG_ON(logger == NULL && store != NULL);
330  DEBUG_VALIDATE_BUG_ON(logger != NULL && store == NULL);
331  }
332 }
333 
334 static TmEcode OutputTxLog(ThreadVars *tv, Packet *p, void *thread_data)
335 {
336  DEBUG_VALIDATE_BUG_ON(thread_data == NULL);
337  if (p->flow == NULL)
338  return TM_ECODE_OK;
339  if (!PKT_IS_PSEUDOPKT(p) && p->app_update_direction == 0 &&
340  ((PKT_IS_TOSERVER(p) && (p->flow->flags & FLOW_TS_APP_UPDATED) == 0) ||
341  (PKT_IS_TOCLIENT(p) && (p->flow->flags & FLOW_TC_APP_UPDATED) == 0))) {
342  SCLogDebug("not pseudo, no app update: skip");
343  return TM_ECODE_OK;
344  }
345  if ((p->flags & PKT_STREAM_EST) == 0 && p->proto == IPPROTO_TCP) {
346  return TM_ECODE_OK;
347  }
348  SCLogDebug("pseudo, or app update: run output");
349 
350  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
351 
352  Flow * const f = p->flow;
353  const uint8_t ipproto = f->proto;
354  const AppProto alproto = f->alproto;
355  SCLogDebug("pcap_cnt %u tx logging %u/%s", (uint32_t)p->pcap_cnt, alproto,
356  AppProtoToString(alproto));
357 
358  const bool file_logging_active = (op_thread_data->file || op_thread_data->filedata);
359  if (!file_logging_active) {
360  if (list[alproto] == NULL && list[ALPROTO_UNKNOWN] == NULL) {
361  SCLogDebug("bail");
362  /* No child loggers registered. */
363  return TM_ECODE_OK;
364  }
365  if (AppLayerParserProtocolHasLogger(ipproto, alproto) == 0)
366  goto end;
367  }
368  void *alstate = f->alstate;
369  if (alstate == NULL) {
370  SCLogDebug("no alstate");
371  goto end;
372  }
373  const LoggerId logger_expectation = AppLayerParserProtocolGetLoggerBits(ipproto, alproto);
374  if (logger_expectation == 0) {
375  SCLogDebug("bail: logger_expectation %u. LOGGER_FILE %u LOGGER_FILEDATA %u",
376  logger_expectation, LOGGER_FILE, LOGGER_FILEDATA);
377  goto end;
378  }
379  SCLogDebug("pcap_cnt %" PRIu64, p->pcap_cnt);
380 
381  const bool last_pseudo = (p->flowflags & FLOW_PKT_LAST_PSEUDO) != 0;
382  const bool ts_eof = AppLayerParserStateIssetFlag(f->alparser, APP_LAYER_PARSER_EOF_TS) != 0;
383  const bool tc_eof = AppLayerParserStateIssetFlag(f->alparser, APP_LAYER_PARSER_EOF_TC) != 0;
384 
385  const bool eof = last_pseudo || (ts_eof && tc_eof);
386  SCLogDebug("eof %d last_pseudo %d ts_eof %d tc_eof %d", eof, last_pseudo, ts_eof, tc_eof);
387 
388  const uint8_t ts_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOSERVER);
389  const uint8_t tc_disrupt_flags = FlowGetDisruptionFlags(f, STREAM_TOCLIENT);
390  SCLogDebug("ts_disrupt_flags %02x tc_disrupt_flags %02x", ts_disrupt_flags, tc_disrupt_flags);
391  const uint64_t total_txs = AppLayerParserGetTxCnt(f, alstate);
392  uint64_t tx_id = AppLayerParserGetTransactionLogId(f->alparser);
393  uint64_t max_id = tx_id;
394  int logged = 0;
395  bool gap = false;
396  const bool support_files = AppLayerParserSupportsFiles(ipproto, alproto);
397  const uint8_t pkt_dir = STREAM_FLAGS_FOR_PACKET(p);
398 
399  SCLogDebug("pcap_cnt %" PRIu64 ": tx_id %" PRIu64 " total_txs %" PRIu64, p->pcap_cnt, tx_id,
400  total_txs);
401 
402  AppLayerGetTxIteratorFunc IterFunc = AppLayerGetTxIterator(ipproto, alproto);
404  memset(&state, 0, sizeof(state));
405 
406  const int complete_ts =
407  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOSERVER);
408  const int complete_tc =
409  AppLayerParserGetStateProgressCompletionStatus(alproto, STREAM_TOCLIENT);
410  while (1) {
411  AppLayerGetTxIterTuple ires = IterFunc(ipproto, alproto, alstate, tx_id, total_txs, &state);
412  if (ires.tx_ptr == NULL)
413  break;
414  void * const tx = ires.tx_ptr;
415  tx_id = ires.tx_id;
416  SCLogDebug("STARTING tx_id %" PRIu64 ", tx %p", tx_id, tx);
417 
418  AppLayerTxData *txd = AppLayerParserGetTxData(ipproto, alproto, tx);
419  if (unlikely(txd == NULL)) {
420  SCLogDebug("NO TXD");
421  /* make sure this tx, which can't be properly logged is skipped */
422  logged = 1;
423  max_id = tx_id;
424  goto next_tx;
425  }
426 
427  const int tx_progress_ts =
428  AppLayerParserGetStateProgress(ipproto, alproto, tx, ts_disrupt_flags);
429  const int tx_progress_tc =
430  AppLayerParserGetStateProgress(ipproto, alproto, tx, tc_disrupt_flags);
431  const bool tx_complete = (tx_progress_ts == complete_ts && tx_progress_tc == complete_tc);
432 
433  SCLogDebug("file_thread_data %p filedata_thread_data %p", op_thread_data->file,
434  op_thread_data->filedata);
435 
436  if (file_logging_active) {
437  if (AppLayerParserIsFileTx(txd)) { // need to process each tx that might be a file tx,
438  // even if there are not files (yet)
439  const bool ts_ready = (tx_progress_ts == complete_ts);
440  const bool tc_ready = (tx_progress_tc == complete_tc);
441  SCLogDebug("ts_ready %d tc_ready %d", ts_ready, tc_ready);
442 
443  const bool eval_files = ts_ready | tc_ready | tx_complete | ts_eof | tc_eof | eof;
444 
445  SCLogDebug("eval_files: %u, ts_ready %u, tc_ready %u, tx_complete %u, ts_eof %u, "
446  "tc_eof %u, eof %u",
447  eval_files, ts_ready, tc_ready, tx_complete, ts_eof, tc_eof, eof);
448  SCLogDebug("txd->file_tx & pkt_dir: %02x & %02x -> %02x", txd->file_tx, pkt_dir,
449  (txd->file_tx & pkt_dir));
450 
451  /* call only for the correct direction, except when it looks anything like a end of
452  * transaction or end of stream. Since OutputTxLogFiles has complicated logic around
453  * that, we just leave it to that function to sort things out for now. */
454  if (eval_files || AppLayerParserIsFileTxInDir(txd, pkt_dir)) {
455  OutputTxLogFiles(tv, op_thread_data->file, op_thread_data->filedata, p, f, tx,
456  tx_id, txd, tx_complete, ts_ready, tc_ready, ts_eof, tc_eof, eof);
457  }
458  } else if (support_files) {
459  if (op_thread_data->file) {
460  txd->logged.flags |= BIT_U32(LOGGER_FILE);
461  SCLogDebug("not a file_tx: setting LOGGER_FILE => %08x", txd->logged.flags);
462  }
463  if (op_thread_data->filedata) {
464  txd->logged.flags |= BIT_U32(LOGGER_FILEDATA);
465  SCLogDebug("not a file_tx: setting LOGGER_FILEDATA => %08x", txd->logged.flags);
466  }
467  }
468  }
469  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
470  if (!txd->updated_tc && !txd->updated_ts && !(tx_progress_ts == complete_ts) &&
471  !(tx_progress_tc == complete_tc) && !ts_eof && !tc_eof) {
472  gap = true;
473  goto next_tx;
474  }
475 
476  if (list[ALPROTO_UNKNOWN] != 0) {
477  OutputTxLogList0(tv, op_thread_data, p, f, tx, tx_id);
478  if (list[alproto] == NULL)
479  goto next_tx;
480  }
481 
482  SCLogDebug("tx %p/%" PRIu64 " txd %p: log_flags %x logger_expectation %x", tx, tx_id, txd,
483  txd->config.log_flags, logger_expectation);
484  if (txd->config.log_flags & BIT_U8(CONFIG_TYPE_TX)) {
485  SCLogDebug("SKIP tx %p/%"PRIu64, tx, tx_id);
486  // so that AppLayerParserTransactionsCleanup can clean this tx
487  txd->logged.flags |= logger_expectation;
488  goto next_tx;
489  }
490 
491  if (txd->logged.flags == logger_expectation) {
492  SCLogDebug("fully logged");
493  /* tx already fully logged */
494  goto next_tx;
495  }
496 
497  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, txd->logged.flags);
498  const OutputTxLogger *logger = list[alproto];
499  const OutputLoggerThreadStore *store = op_thread_data->store[alproto];
500  struct Ctx ctx = { .tx_logged = txd->logged.flags, .tx_logged_old = txd->logged.flags };
501  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
502 
503  OutputTxLogCallLoggers(tv, op_thread_data, logger, store, p, f, alstate, tx, tx_id, alproto,
504  eof, tx_progress_ts, tx_progress_tc, &ctx);
505 
506  SCLogDebug("logger: expect %08x, have %08x", logger_expectation, ctx.tx_logged);
507  if (ctx.tx_logged != ctx.tx_logged_old) {
508  SCLogDebug("logger: storing %08x (was %08x)", ctx.tx_logged, ctx.tx_logged_old);
509  DEBUG_VALIDATE_BUG_ON(txd == NULL);
510  txd->logged.flags |= ctx.tx_logged;
511  }
512 
513  /* If all loggers logged set a flag and update the last tx_id
514  * that was logged.
515  *
516  * If not all loggers were logged we flag that there was a gap
517  * so any subsequent transactions in this loop don't increase
518  * the maximum ID that was logged. */
519  if (!gap && ctx.tx_logged == logger_expectation) {
520  SCLogDebug("no gap %d, %08x == %08x", gap, ctx.tx_logged, logger_expectation);
521  logged = 1;
522  max_id = tx_id;
523  SCLogDebug("max_id %" PRIu64, max_id);
524  } else {
525  gap = true;
526  }
527 next_tx:
528  if (!ires.has_next)
529  break;
530  tx_id++;
531  }
532 
533  /* Update the last ID that has been logged with all
534  * transactions before it. */
535  if (logged) {
536  SCLogDebug("updating log tx_id %"PRIu64, max_id);
538  }
539 
540 end:
541  return TM_ECODE_OK;
542 }
543 
544 /** \brief thread init for the tx logger
545  * This will run the thread init functions for the individual registered
546  * loggers */
547 static TmEcode OutputTxLogThreadInit(ThreadVars *tv, const void *_initdata, void **data)
548 {
550  SCCalloc(1, sizeof(*td) + ALPROTO_MAX * sizeof(OutputLoggerThreadStore *));
551  if (td == NULL)
552  return TM_ECODE_FAILED;
553 
554  *data = (void *)td;
555  SCLogDebug("OutputTxLogThreadInit happy (*data %p)", *data);
556 
557  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
558  OutputTxLogger *logger = list[alproto];
559  while (logger) {
560  if (logger->ThreadInit) {
561  void *retptr = NULL;
562  if (logger->ThreadInit(tv, logger->initdata, &retptr) == TM_ECODE_OK) {
563  OutputLoggerThreadStore *ts = SCCalloc(1, sizeof(*ts));
564  /* todo */ BUG_ON(ts == NULL);
565 
566  /* store thread handle */
567  ts->thread_data = retptr;
568 
569  if (td->store[alproto] == NULL) {
570  td->store[alproto] = ts;
571  } else {
572  OutputLoggerThreadStore *tmp = td->store[alproto];
573  while (tmp->next != NULL)
574  tmp = tmp->next;
575  tmp->next = ts;
576  }
577 
578  SCLogDebug("%s is now set up", logger->name);
579  }
580  }
581 
582  logger = logger->next;
583  }
584  }
585 
586  if (g_file_logger_enabled) {
587  if (OutputFileLogThreadInit(tv, &td->file) != TM_ECODE_OK) {
588  FatalError("failed to set up file thread data");
589  }
590  }
593  FatalError("failed to set up filedata thread data");
594  }
595  }
596 
597  SCLogDebug("file_thread_data %p filedata_thread_data %p", td->file, td->filedata);
598 
599  return TM_ECODE_OK;
600 }
601 
602 static TmEcode OutputTxLogThreadDeinit(ThreadVars *tv, void *thread_data)
603 {
604  OutputTxLoggerThreadData *op_thread_data = (OutputTxLoggerThreadData *)thread_data;
605 
606  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
607  OutputLoggerThreadStore *store = op_thread_data->store[alproto];
608  OutputTxLogger *logger = list[alproto];
609 
610  while (logger && store) {
611  if (logger->ThreadDeinit) {
612  logger->ThreadDeinit(tv, store->thread_data);
613  }
614 
615  OutputLoggerThreadStore *next_store = store->next;
616  SCFree(store);
617  store = next_store;
618  logger = logger->next;
619  }
620  }
621 
622  if (op_thread_data->file) {
623  OutputFileLogThreadDeinit(tv, op_thread_data->file);
624  }
625  if (op_thread_data->filedata) {
626  OutputFiledataLogThreadDeinit(tv, op_thread_data->filedata);
627  }
628 
629  SCFree(op_thread_data);
630  return TM_ECODE_OK;
631 }
632 
633 static uint32_t OutputTxLoggerGetActiveCount(void)
634 {
635  uint32_t cnt = 0;
636  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
637  for (OutputTxLogger *p = list[alproto]; p != NULL; p = p->next) {
638  cnt++;
639  }
640  }
641 
642  if (g_file_logger_enabled) {
643  cnt++;
644  SCLogDebug("g_file_logger_enabled");
645  }
647  cnt++;
648  SCLogDebug("g_filedata_logger_enabled");
649  }
650 
651  return cnt;
652 }
653 
654 
656 {
657  BUG_ON(list);
658  list = SCCalloc(ALPROTO_MAX, sizeof(OutputTxLogger *));
659  if (unlikely(list == NULL)) {
660  FatalError("Failed to allocate OutputTx list");
661  }
662  OutputRegisterRootLogger(OutputTxLogThreadInit, OutputTxLogThreadDeinit, OutputTxLog,
663  OutputTxLoggerGetActiveCount);
664 }
665 
667 {
668  // called in different places because of unix socket mode, and engine-analysis mode
669  if (list == NULL) {
670  return;
671  }
672  for (AppProto alproto = 0; alproto < ALPROTO_MAX; alproto++) {
673  OutputTxLogger *logger = list[alproto];
674  while (logger) {
675  OutputTxLogger *next_logger = logger->next;
676  SCFree(logger);
677  logger = next_logger;
678  }
679  list[alproto] = NULL;
680  }
681  SCFree(list);
682  list = NULL;
683 }
PKT_IS_TOCLIENT
#define PKT_IS_TOCLIENT(p)
Definition: decode.h:235
OutputFiledataLogThreadInit
TmEcode OutputFiledataLogThreadInit(ThreadVars *tv, OutputFiledataLoggerThreadData **data)
thread init for the filedata logger This will run the thread init functions for the individual regist...
Definition: output-filedata.c:200
OutputTxLogger_::alproto
AppProto alproto
Definition: output-tx.c:49
Packet_::proto
uint8_t proto
Definition: decode.h:497
FileContainer_
Definition: util-file.h:113
output-tx.h
ts
uint64_t ts
Definition: source-erf-file.c:55
OutputLoggerThreadStore_
Definition: output.h:33
AppLayerParserIsEnabled
int AppLayerParserIsEnabled(AppProto alproto)
simple way to globally test if a alproto is registered and fully enabled in the configuration.
Definition: app-layer-parser.c:1512
OutputTxLoggerRegister
void OutputTxLoggerRegister(void)
Definition: output-tx.c:655
AppLayerParserProtocolHasLogger
int AppLayerParserProtocolHasLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1522
OutputFileLoggerThreadData_
Definition: output-file.h:33
AppLayerParserSetTransactionLogId
void AppLayerParserSetTransactionLogId(AppLayerParserState *pstate, uint64_t tx_id)
Definition: app-layer-parser.c:689
CONFIG_TYPE_TX
@ CONFIG_TYPE_TX
Definition: util-config.h:36
PKT_IS_PSEUDOPKT
#define PKT_IS_PSEUDOPKT(p)
return 1 if the packet is a pseudo packet
Definition: decode.h:1319
FLOW_PKT_LAST_PSEUDO
#define FLOW_PKT_LAST_PSEUDO
Definition: flow.h:241
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
OutputTxLogger_::tc_log_progress
int tc_log_progress
Definition: output-tx.c:57
StreamTcpReassembleDepthReached
int StreamTcpReassembleDepthReached(Packet *p)
check if stream in pkt direction has depth reached
Definition: stream-tcp-reassemble.c:615
LOGGER_FILEDATA
@ LOGGER_FILEDATA
Definition: suricata-common.h:470
OutputTxShutdown
void OutputTxShutdown(void)
Definition: output-tx.c:666
Ctx
Definition: output-tx.c:268
OutputRegisterRootLogger
void OutputRegisterRootLogger(ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit, OutputLogFunc LogFunc, OutputGetActiveCountFunc ActiveCntFunc)
Definition: output.c:779
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
Packet_::pcap_cnt
uint64_t pcap_cnt
Definition: decode.h:594
AppLayerGetTxIterator
AppLayerGetTxIteratorFunc AppLayerGetTxIterator(const uint8_t ipproto, const AppProto alproto)
Definition: app-layer-parser.c:674
Flow_::proto
uint8_t proto
Definition: flow.h:378
Ctx::tx_logged
uint32_t tx_logged
Definition: output-tx.c:270
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:81
AppLayerParserGetStateProgress
int AppLayerParserGetStateProgress(uint8_t ipproto, AppProto alproto, void *alstate, uint8_t flags)
get the progress value for a tx/protocol
Definition: app-layer-parser.c:1072
Packet_::flags
uint32_t flags
Definition: decode.h:512
Flow_
Flow data structure.
Definition: flow.h:356
OutputFiledataLogThreadDeinit
TmEcode OutputFiledataLogThreadDeinit(ThreadVars *tv, OutputFiledataLoggerThreadData *op_thread_data)
Definition: output-filedata.c:246
LoggerId
LoggerId
Definition: suricata-common.h:460
AppLayerParserGetTransactionLogId
uint64_t AppLayerParserGetTransactionLogId(AppLayerParserState *pstate)
Definition: app-layer-parser.c:682
AppProtoToString
const char * AppProtoToString(AppProto alproto)
Maps the ALPROTO_*, to its string equivalent.
Definition: app-layer-protos.c:75
ctx
struct Thresholds ctx
AppLayerParserSupportsFiles
bool AppLayerParserSupportsFiles(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1154
logged
int logged
Definition: app-layer-htp.h:1
FLOW_TC_APP_UPDATED
#define FLOW_TC_APP_UPDATED
Definition: flow.h:119
AppLayerParserGetStateProgressCompletionStatus
int AppLayerParserGetStateProgressCompletionStatus(AppProto alproto, uint8_t direction)
Definition: app-layer-parser.c:1101
g_filedata_logger_enabled
bool g_filedata_logger_enabled
Definition: output-filedata.c:37
OutputLoggerThreadStore_::next
struct OutputLoggerThreadStore_ * next
Definition: output.h:35
FLOW_PKT_TOSERVER
#define FLOW_PKT_TOSERVER
Definition: flow.h:232
TxLogger
int(* TxLogger)(ThreadVars *, void *thread_data, const Packet *, Flow *f, void *state, void *tx, uint64_t tx_id)
Transaction logger function pointer type.
Definition: output-tx.h:34
OutputTxLogger_::ThreadInit
TmEcode(* ThreadInit)(ThreadVars *, const void *, void **)
Definition: output-tx.c:59
OutputTxLogger_::logger_id
LoggerId logger_id
Definition: output-tx.c:55
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:506
APP_LAYER_PARSER_EOF_TS
#define APP_LAYER_PARSER_EOF_TS
Definition: app-layer-parser.h:39
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:81
ALPROTO_MAX
@ ALPROTO_MAX
Definition: app-layer-protos.h:76
OutputTxLogger_::ThreadDeinit
TmEcode(* ThreadDeinit)(ThreadVars *, void *)
Definition: output-tx.c:60
Ctx::tx_logged_old
uint32_t tx_logged_old
Definition: output-tx.c:269
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:80
AppLayerParserGetTxFiles
AppLayerGetFileState AppLayerParserGetTxFiles(const Flow *f, void *tx, const uint8_t direction)
Definition: app-layer-parser.c:854
OutputTxLoggerThreadData
struct OutputTxLoggerThreadData_ OutputTxLoggerThreadData
OutputLoggerThreadStore_::thread_data
void * thread_data
Definition: output.h:34
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:480
PKT_IS_TOSERVER
#define PKT_IS_TOSERVER(p)
Definition: decode.h:234
OutputFileLogThreadDeinit
TmEcode OutputFileLogThreadDeinit(ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data)
Definition: output-file.c:211
OutputTxLoggerThreadData_::filedata
OutputFiledataLoggerThreadData * filedata
Definition: output-tx.c:41
BIT_U32
#define BIT_U32(n)
Definition: suricata-common.h:400
PKT_PSEUDO_STREAM_END
#define PKT_PSEUDO_STREAM_END
Definition: decode.h:1268
OutputTxLogger_::next
struct OutputTxLogger_ * next
Definition: output-tx.c:53
STREAM_FLAGS_FOR_PACKET
#define STREAM_FLAGS_FOR_PACKET(p)
Definition: stream.h:30
FileContainer_::head
File * head
Definition: util-file.h:114
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
ThreadInitFunc
TmEcode(* ThreadInitFunc)(ThreadVars *, const void *, void **)
Definition: tm-modules.h:39
app-layer-parser.h
SCOutputRegisterTxLogger
int SCOutputRegisterTxLogger(LoggerId id, const char *name, AppProto alproto, TxLogger LogFunc, void *initdata, int tc_log_progress, int ts_log_progress, TxLoggerCondition LogCondition, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
Register a transaction logger.
Definition: output-tx.c:65
BUG_ON
#define BUG_ON(x)
Definition: suricata-common.h:300
util-profiling.h
stream.h
OutputTxLogger_::ts_log_progress
int ts_log_progress
Definition: output-tx.c:58
AppLayerGetTxIterState
Definition: app-layer-parser.h:143
Packet_
Definition: decode.h:475
APP_LAYER_PARSER_EOF_TC
#define APP_LAYER_PARSER_EOF_TC
Definition: app-layer-parser.h:40
TmEcode
TmEcode
Definition: tm-threads-common.h:79
OutputTxLogger_::LogCondition
TxLoggerCondition LogCondition
Definition: output-tx.c:51
OutputFiledataLoggerThreadData_
Definition: output-filedata.h:34
OutputFiledataLogFfc
void OutputFiledataLogFfc(ThreadVars *tv, OutputFiledataLoggerThreadData *td, Packet *p, AppLayerGetFileState files, void *txv, const uint64_t tx_id, AppLayerTxData *txd, const uint8_t call_flags, const bool file_close, const bool file_trunc, const uint8_t dir)
Definition: output-filedata.c:124
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:233
OutputTxLoggerThreadData_::store
OutputLoggerThreadStore * store[]
Definition: output-tx.c:42
TxLoggerCondition
bool(* TxLoggerCondition)(ThreadVars *, const Packet *, void *state, void *tx, uint64_t tx_id)
Transaction logger condition function pointer type.
Definition: output-tx.h:41
PACKET_PROFILING_LOGGER_END
#define PACKET_PROFILING_LOGGER_END(p, id)
Definition: util-profiling.h:240
AppLayerTxData
struct AppLayerTxData AppLayerTxData
Definition: detect.h:1372
cnt
uint32_t cnt
Definition: tmqh-packetpool.h:7
Packet_::flow
struct Flow_ * flow
Definition: decode.h:514
BIT_U8
#define BIT_U8(n)
Definition: suricata-common.h:398
suricata-common.h
OutputTxLogger
struct OutputTxLogger_ OutputTxLogger
Packet_::app_update_direction
uint8_t app_update_direction
Definition: decode.h:509
FLOW_TS_APP_UPDATED
#define FLOW_TS_APP_UPDATED
Definition: flow.h:118
OutputFileLogFfc
void OutputFileLogFfc(ThreadVars *tv, OutputFileLoggerThreadData *op_thread_data, Packet *p, FileContainer *ffc, void *txv, const uint64_t tx_id, AppLayerTxData *txd, const bool file_close, const bool file_trunc, uint8_t dir)
Definition: output-file.c:96
AppLayerParserGetTxData
AppLayerTxData * AppLayerParserGetTxData(uint8_t ipproto, AppProto alproto, void *tx)
Definition: app-layer-parser.c:1164
FatalError
#define FatalError(...)
Definition: util-debug.h:502
OutputTxLoggerThreadData_::file
OutputFileLoggerThreadData * file
Definition: output-tx.c:39
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
OutputFileLogThreadInit
TmEcode OutputFileLogThreadInit(ThreadVars *tv, OutputFileLoggerThreadData **data)
thread init for the file logger This will run the thread init functions for the individual registered...
Definition: output-file.c:164
util-validate.h
LOGGER_FILE
@ LOGGER_FILE
Definition: suricata-common.h:469
Packet_::next
struct Packet_ * next
Definition: decode.h:603
OutputTxLogger_::LogFunc
TxLogger LogFunc
Definition: output-tx.c:50
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
SCFree
#define SCFree(p)
Definition: util-mem.h:61
Flow_::alstate
void * alstate
Definition: flow.h:481
Flow_::flags
uint32_t flags
Definition: flow.h:426
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
OutputTxLogger_
Definition: output-tx.c:48
OutputTxLogger_::initdata
void * initdata
Definition: output-tx.c:52
PACKET_PROFILING_LOGGER_START
#define PACKET_PROFILING_LOGGER_START(p, id)
Definition: util-profiling.h:233
OutputTxLogger_::name
const char * name
Definition: output-tx.c:54
AppLayerParserProtocolGetLoggerBits
LoggerId AppLayerParserProtocolGetLoggerBits(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:1530
AppLayerGetTxIteratorFunc
AppLayerGetTxIterTuple(* AppLayerGetTxIteratorFunc)(const uint8_t ipproto, const AppProto alproto, void *alstate, uint64_t min_tx_id, uint64_t max_tx_id, AppLayerGetTxIterState *state)
tx iterator prototype
Definition: app-layer-parser.h:152
FlowGetDisruptionFlags
uint8_t FlowGetDisruptionFlags(const Flow *f, uint8_t flags)
get 'disruption' flags: GAP/DEPTH/PASS
Definition: flow.c:1140
AppLayerParserStateIssetFlag
uint16_t AppLayerParserStateIssetFlag(AppLayerParserState *pstate, uint16_t flag)
Definition: app-layer-parser.c:1767
g_file_logger_enabled
bool g_file_logger_enabled
Definition: output-file.c:39
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:455
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
OutputTxLogger_::id
uint32_t id
Definition: output-tx.c:56
AppLayerParserGetTxCnt
uint64_t AppLayerParserGetTxCnt(const Flow *f, void *alstate)
Definition: app-layer-parser.c:1087
DEBUG_VALIDATE_BUG_ON
#define DEBUG_VALIDATE_BUG_ON(exp)
Definition: util-validate.h:102
output.h
PKT_STREAM_EST
#define PKT_STREAM_EST
Definition: decode.h:1263
ThreadDeinitFunc
TmEcode(* ThreadDeinitFunc)(ThreadVars *, void *)
Definition: tm-modules.h:40
OutputTxLoggerThreadData_
Definition: output-tx.c:37
app-layer.h