suricata
output-json-http.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  * Implements HTTP JSON logging portion of the engine.
24  */
25 
26 #include "suricata-common.h"
27 #include "detect.h"
28 #include "pkt-var.h"
29 #include "conf.h"
30 
31 #include "threads.h"
32 #include "threadvars.h"
33 #include "tm-threads.h"
34 
35 #include "util-print.h"
36 #include "util-unittest.h"
37 
38 #include "util-debug.h"
39 
40 #include "output.h"
41 #include "app-layer-htp.h"
42 #include "app-layer-htp-file.h"
43 #include "app-layer-htp-xff.h"
44 #include "app-layer.h"
45 #include "app-layer-parser.h"
46 #include "util-privs.h"
47 #include "util-buffer.h"
48 #include "util-proto-name.h"
49 #include "util-logopenfile.h"
50 #include "util-time.h"
51 #include "output-json.h"
52 #include "output-json-alert.h"
53 #include "output-json-http.h"
54 #include "util-byte.h"
55 
56 typedef struct LogHttpFileCtx_ {
57  uint32_t flags; /** Store mode */
58  uint64_t fields;/** Store fields */
63 
64 typedef struct JsonHttpLogThread_ {
66  uint32_t uri_cnt;
69 
70 #define MAX_SIZE_HEADER_NAME 256
71 #define MAX_SIZE_HEADER_VALUE 2048
72 
73 #define LOG_HTTP_DEFAULT 0
74 #define LOG_HTTP_EXTENDED 1
75 #define LOG_HTTP_REQUEST 2 /* request field */
76 #define LOG_HTTP_ARRAY 4 /* require array handling */
77 #define LOG_HTTP_REQ_HEADERS 8
78 #define LOG_HTTP_RES_HEADERS 16
79 
80 typedef enum {
136 
137 struct {
138  const char *config_field;
139  const char *htp_field;
140  uint32_t flags;
141 } http_fields[] = {
142  { "accept", "accept", LOG_HTTP_REQUEST },
143  { "accept_charset", "accept-charset", LOG_HTTP_REQUEST },
144  { "accept_encoding", "accept-encoding", LOG_HTTP_REQUEST },
145  { "accept_language", "accept-language", LOG_HTTP_REQUEST },
146  { "accept_datetime", "accept-datetime", LOG_HTTP_REQUEST },
147  { "authorization", "authorization", LOG_HTTP_REQUEST },
148  { "cache_control", "cache-control", LOG_HTTP_REQUEST },
149  { "cookie", "cookie", LOG_HTTP_REQUEST | LOG_HTTP_ARRAY },
150  { "from", "from", LOG_HTTP_REQUEST },
151  { "max_forwards", "max-forwards", LOG_HTTP_REQUEST },
152  { "origin", "origin", LOG_HTTP_REQUEST },
153  { "pragma", "pragma", LOG_HTTP_REQUEST },
154  { "proxy_authorization", "proxy-authorization", LOG_HTTP_REQUEST },
155  { "range", "range", LOG_HTTP_REQUEST },
156  { "te", "te", LOG_HTTP_REQUEST },
157  { "via", "via", LOG_HTTP_REQUEST },
158  { "x_requested_with", "x-requested-with", LOG_HTTP_REQUEST },
159  { "dnt", "dnt", LOG_HTTP_REQUEST },
160  { "x_forwarded_proto", "x-forwarded-proto", LOG_HTTP_REQUEST },
161  { "x_authenticated_user", "x-authenticated-user", LOG_HTTP_REQUEST },
162  { "x_flash_version", "x-flash-version", LOG_HTTP_REQUEST },
163  { "accept_range", "accept-range", 0 },
164  { "age", "age", 0 },
165  { "allow", "allow", 0 },
166  { "connection", "connection", 0 },
167  { "content_encoding", "content-encoding", 0 },
168  { "content_language", "content-language", 0 },
169  { "content_length", "content-length", 0 },
170  { "content_location", "content-location", 0 },
171  { "content_md5", "content-md5", 0 },
172  { "content_range", "content-range", 0 },
173  { "content_type", "content-type", 0 },
174  { "date", "date", 0 },
175  { "etag", "etags", 0 },
176  { "expires", "expires", 0 },
177  { "last_modified", "last-modified", 0 },
178  { "link", "link", 0 },
179  { "location", "location", 0 },
180  { "proxy_authenticate", "proxy-authenticate", 0 },
181  { "referer", "referer", LOG_HTTP_EXTENDED },
182  { "refresh", "refresh", 0 },
183  { "retry_after", "retry-after", 0 },
184  { "server", "server", 0 },
185  { "set_cookie", "set-cookie", 0 },
186  { "trailer", "trailer", 0 },
187  { "transfer_encoding", "transfer-encoding", 0 },
188  { "upgrade", "upgrade", 0 },
189  { "vary", "vary", 0 },
190  { "warning", "warning", 0 },
191  { "www_authenticate", "www-authenticate", 0 },
192  { "true_client_ip", "true-client-ip", LOG_HTTP_REQUEST },
193  { "org_src_ip", "org-src-ip", LOG_HTTP_REQUEST },
194  { "x_bluecoat_via", "x-bluecoat-via", LOG_HTTP_REQUEST },
195 };
196 
197 static void EveHttpLogJSONBasic(JsonBuilder *js, htp_tx_t *tx)
198 {
199  /* hostname */
200  if (tx->request_hostname != NULL) {
201  jb_set_string_from_bytes(js, "hostname", bstr_ptr(tx->request_hostname),
202  (uint32_t)bstr_len(tx->request_hostname));
203  }
204 
205  /* port */
206  /* NOTE: this field will be set ONLY if the port is present in the
207  * hostname. It may be present in the header "Host" or in the URL.
208  * There is no connection (from the suricata point of view) between this
209  * port and the TCP destination port of the flow.
210  */
211  if (tx->request_port_number >= 0) {
212  jb_set_uint(js, "http_port", tx->request_port_number);
213  }
214 
215  /* uri */
216  if (tx->request_uri != NULL) {
217  jb_set_string_from_bytes(
218  js, "url", bstr_ptr(tx->request_uri), (uint32_t)bstr_len(tx->request_uri));
219  }
220 
221  if (tx->request_headers != NULL) {
222  /* user agent */
223  htp_header_t *h_user_agent = htp_table_get_c(tx->request_headers, "user-agent");
224  if (h_user_agent != NULL) {
225  jb_set_string_from_bytes(js, "http_user_agent", bstr_ptr(h_user_agent->value),
226  (uint32_t)bstr_len(h_user_agent->value));
227  }
228 
229  /* x-forwarded-for */
230  htp_header_t *h_x_forwarded_for = htp_table_get_c(tx->request_headers, "x-forwarded-for");
231  if (h_x_forwarded_for != NULL) {
232  jb_set_string_from_bytes(js, "xff", bstr_ptr(h_x_forwarded_for->value),
233  (uint32_t)bstr_len(h_x_forwarded_for->value));
234  }
235  }
236 
237  /* content-type */
238  if (tx->response_headers != NULL) {
239  htp_header_t *h_content_type = htp_table_get_c(tx->response_headers, "content-type");
240  if (h_content_type != NULL) {
241  const size_t size = bstr_len(h_content_type->value) * 2 + 1;
242  char string[size];
243  BytesToStringBuffer(bstr_ptr(h_content_type->value), bstr_len(h_content_type->value), string, size);
244  char *p = strchr(string, ';');
245  if (p != NULL)
246  *p = '\0';
247  jb_set_string(js, "http_content_type", string);
248  }
249  htp_header_t *h_content_range = htp_table_get_c(tx->response_headers, "content-range");
250  if (h_content_range != NULL) {
251  jb_open_object(js, "content_range");
252  jb_set_string_from_bytes(js, "raw", bstr_ptr(h_content_range->value),
253  (uint32_t)bstr_len(h_content_range->value));
254  HTTPContentRange crparsed;
255  if (HTPParseContentRange(h_content_range->value, &crparsed) == 0) {
256  if (crparsed.start >= 0)
257  jb_set_uint(js, "start", crparsed.start);
258  if (crparsed.end >= 0)
259  jb_set_uint(js, "end", crparsed.end);
260  if (crparsed.size >= 0)
261  jb_set_uint(js, "size", crparsed.size);
262  }
263  jb_close(js);
264  }
265  }
266 }
267 
268 static void EveHttpLogJSONExtended(JsonBuilder *js, htp_tx_t *tx)
269 {
270  /* referer */
271  htp_header_t *h_referer = NULL;
272  if (tx->request_headers != NULL) {
273  h_referer = htp_table_get_c(tx->request_headers, "referer");
274  }
275  if (h_referer != NULL) {
276  jb_set_string_from_bytes(
277  js, "http_refer", bstr_ptr(h_referer->value), (uint32_t)bstr_len(h_referer->value));
278  }
279 
280  /* method */
281  if (tx->request_method != NULL) {
282  jb_set_string_from_bytes(js, "http_method", bstr_ptr(tx->request_method),
283  (uint32_t)bstr_len(tx->request_method));
284  }
285 
286  /* protocol */
287  if (tx->request_protocol != NULL) {
288  jb_set_string_from_bytes(js, "protocol", bstr_ptr(tx->request_protocol),
289  (uint32_t)bstr_len(tx->request_protocol));
290  }
291 
292  /* response status: from libhtp:
293  * "Response status code, available only if we were able to parse it, HTP_STATUS_INVALID
294  * otherwise. HTP_STATUS_UNKNOWN until parsing is attempted" .*/
295  const int resp = tx->response_status_number;
296  if (resp > 0) {
297  jb_set_uint(js, "status", (uint32_t)resp);
298  } else if (tx->response_status != NULL) {
299  const size_t status_size = bstr_len(tx->response_status) * 2 + 1;
300  char status_string[status_size];
301  BytesToStringBuffer(bstr_ptr(tx->response_status), bstr_len(tx->response_status),
302  status_string, status_size);
303  unsigned int val = strtoul(status_string, NULL, 10);
304  jb_set_uint(js, "status", val);
305  }
306 
307  htp_header_t *h_location = htp_table_get_c(tx->response_headers, "location");
308  if (h_location != NULL) {
309  jb_set_string_from_bytes(
310  js, "redirect", bstr_ptr(h_location->value), (uint32_t)bstr_len(h_location->value));
311  }
312 
313  /* length */
314  jb_set_uint(js, "length", tx->response_message_len);
315 }
316 
317 static void EveHttpLogJSONHeaders(
318  JsonBuilder *js, uint32_t direction, htp_tx_t *tx, LogHttpFileCtx *http_ctx)
319 {
320  htp_table_t * headers = direction & LOG_HTTP_REQ_HEADERS ?
321  tx->request_headers : tx->response_headers;
322  char name[MAX_SIZE_HEADER_NAME] = {0};
323  char value[MAX_SIZE_HEADER_VALUE] = {0};
324  size_t n = htp_table_size(headers);
325  JsonBuilderMark mark = { 0, 0, 0 };
326  jb_get_mark(js, &mark);
327  bool array_empty = true;
328  jb_open_array(js, direction & LOG_HTTP_REQ_HEADERS ? "request_headers" : "response_headers");
329  for (size_t i = 0; i < n; i++) {
330  htp_header_t *h = htp_table_get_index(headers, i, NULL);
331  if ((http_ctx->flags & direction) == 0 && http_ctx->fields != 0) {
332  bool tolog = false;
333  for (HttpField f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
334  if ((http_ctx->fields & (1ULL << f)) != 0) {
335  /* prevent logging a field twice if extended logging is
336  enabled */
337  if (((http_ctx->flags & LOG_HTTP_EXTENDED) == 0) ||
338  ((http_ctx->flags & LOG_HTTP_EXTENDED) !=
339  (http_fields[f].flags & LOG_HTTP_EXTENDED))) {
340  if (bstr_cmp_c_nocase(h->name, http_fields[f].htp_field) == 0) {
341  tolog = true;
342  break;
343  }
344  }
345  }
346  }
347  if (!tolog) {
348  continue;
349  }
350  }
351  array_empty = false;
352  jb_start_object(js);
353  size_t size_name = bstr_len(h->name) < MAX_SIZE_HEADER_NAME - 1 ?
354  bstr_len(h->name) : MAX_SIZE_HEADER_NAME - 1;
355  memcpy(name, bstr_ptr(h->name), size_name);
356  name[size_name] = '\0';
357  jb_set_string(js, "name", name);
358  size_t size_value = bstr_len(h->value) < MAX_SIZE_HEADER_VALUE - 1 ?
359  bstr_len(h->value) : MAX_SIZE_HEADER_VALUE - 1;
360  memcpy(value, bstr_ptr(h->value), size_value);
361  value[size_value] = '\0';
362  jb_set_string(js, "value", value);
363  jb_close(js);
364  }
365  if (array_empty) {
366  jb_restore_mark(js, &mark);
367  } else {
368  // Close array.
369  jb_close(js);
370  }
371 }
372 
373 static void BodyPrintableBuffer(JsonBuilder *js, HtpBody *body, const char *key)
374 {
375  if (body->sb != NULL && body->sb->region.buf != NULL) {
376  uint32_t offset = 0;
377  const uint8_t *body_data;
378  uint32_t body_data_len;
379  uint64_t body_offset;
380 
381  if (StreamingBufferGetData(body->sb, &body_data,
382  &body_data_len, &body_offset) == 0) {
383  return;
384  }
385 
386  uint8_t printable_buf[body_data_len + 1];
387  PrintStringsToBuffer(printable_buf, &offset, body_data_len + 1, body_data, body_data_len);
388  if (offset > 0) {
389  jb_set_string(js, key, (char *)printable_buf);
390  }
391  }
392 }
393 
394 void EveHttpLogJSONBodyPrintable(JsonBuilder *js, Flow *f, uint64_t tx_id)
395 {
396  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
397  if (htp_state) {
398  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
399  if (tx) {
400  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
401  if (htud != NULL) {
402  BodyPrintableBuffer(js, &htud->request_body, "http_request_body_printable");
403  BodyPrintableBuffer(js, &htud->response_body, "http_response_body_printable");
404  }
405  }
406  }
407 }
408 
409 static void BodyBase64Buffer(JsonBuilder *js, HtpBody *body, const char *key)
410 {
411  if (body->sb != NULL && body->sb->region.buf != NULL) {
412  const uint8_t *body_data;
413  uint32_t body_data_len;
414  uint64_t body_offset;
415 
416  if (StreamingBufferGetData(body->sb, &body_data,
417  &body_data_len, &body_offset) == 0) {
418  return;
419  }
420 
421  jb_set_base64(js, key, body_data, body_data_len);
422  }
423 }
424 
425 void EveHttpLogJSONBodyBase64(JsonBuilder *js, Flow *f, uint64_t tx_id)
426 {
427  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
428  if (htp_state) {
429  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
430  if (tx) {
431  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
432  if (htud != NULL) {
433  BodyBase64Buffer(js, &htud->request_body, "http_request_body");
434  BodyBase64Buffer(js, &htud->response_body, "http_response_body");
435  }
436  }
437  }
438 }
439 
440 /* JSON format logging */
441 static void EveHttpLogJSON(JsonHttpLogThread *aft, JsonBuilder *js, htp_tx_t *tx, uint64_t tx_id)
442 {
443  LogHttpFileCtx *http_ctx = aft->httplog_ctx;
444  jb_open_object(js, "http");
445 
446  EveHttpLogJSONBasic(js, tx);
447  if (http_ctx->flags & LOG_HTTP_EXTENDED)
448  EveHttpLogJSONExtended(js, tx);
449  if (http_ctx->flags & LOG_HTTP_REQ_HEADERS || http_ctx->fields != 0)
450  EveHttpLogJSONHeaders(js, LOG_HTTP_REQ_HEADERS, tx, http_ctx);
451  if (http_ctx->flags & LOG_HTTP_RES_HEADERS || http_ctx->fields != 0)
452  EveHttpLogJSONHeaders(js, LOG_HTTP_RES_HEADERS, tx, http_ctx);
453 
454  jb_close(js);
455 }
456 
457 static int JsonHttpLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f, void *alstate, void *txptr, uint64_t tx_id)
458 {
459  SCEnter();
460 
461  htp_tx_t *tx = txptr;
462  JsonHttpLogThread *jhl = (JsonHttpLogThread *)thread_data;
463 
464  JsonBuilder *js = CreateEveHeaderWithTxId(
465  p, LOG_DIR_FLOW, "http", NULL, tx_id, jhl->httplog_ctx->eve_ctx);
466  if (unlikely(js == NULL))
467  return TM_ECODE_OK;
468 
469  SCLogDebug("got a HTTP request and now logging !!");
470 
471  EveHttpLogJSON(jhl, js, tx, tx_id);
472  HttpXFFCfg *xff_cfg = jhl->httplog_ctx->xff_cfg != NULL ?
474 
475  /* xff header */
476  if ((xff_cfg != NULL) && !(xff_cfg->flags & XFF_DISABLED) && p->flow != NULL) {
477  int have_xff_ip = 0;
478  char buffer[XFF_MAXLEN];
479 
480  have_xff_ip = HttpXFFGetIPFromTx(p->flow, tx_id, xff_cfg, buffer, XFF_MAXLEN);
481 
482  if (have_xff_ip) {
483  if (xff_cfg->flags & XFF_EXTRADATA) {
484  jb_set_string(js, "xff", buffer);
485  }
486  else if (xff_cfg->flags & XFF_OVERWRITE) {
487  if (p->flowflags & FLOW_PKT_TOCLIENT) {
488  jb_set_string(js, "dest_ip", buffer);
489  } else {
490  jb_set_string(js, "src_ip", buffer);
491  }
492  }
493  }
494  }
495 
496  OutputJsonBuilderBuffer(js, jhl->ctx);
497  jb_free(js);
498 
500 }
501 
502 bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
503 {
504  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
505  if (htp_state) {
506  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
507 
508  if (tx) {
509  EveHttpLogJSONBasic(js, tx);
510  EveHttpLogJSONExtended(js, tx);
511  return true;
512  }
513  }
514 
515  return false;
516 }
517 
518 static void OutputHttpLogDeinitSub(OutputCtx *output_ctx)
519 {
520  LogHttpFileCtx *http_ctx = output_ctx->data;
521  if (http_ctx->xff_cfg) {
522  SCFree(http_ctx->xff_cfg);
523  }
524  SCFree(http_ctx);
525  SCFree(output_ctx);
526 }
527 
528 static OutputInitResult OutputHttpLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
529 {
530  OutputInitResult result = { NULL, false };
531  OutputJsonCtx *ojc = parent_ctx->data;
532 
533  LogHttpFileCtx *http_ctx = SCCalloc(1, sizeof(LogHttpFileCtx));
534  if (unlikely(http_ctx == NULL))
535  return result;
536  memset(http_ctx, 0x00, sizeof(*http_ctx));
537 
538  OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
539  if (unlikely(output_ctx == NULL)) {
540  SCFree(http_ctx);
541  return result;
542  }
543 
544  http_ctx->flags = LOG_HTTP_DEFAULT;
545  http_ctx->eve_ctx = ojc;
546 
547  if (conf) {
548  const char *extended = ConfNodeLookupChildValue(conf, "extended");
549 
550  if (extended != NULL) {
551  if (ConfValIsTrue(extended)) {
552  http_ctx->flags = LOG_HTTP_EXTENDED;
553  }
554  }
555 
556  const char *all_headers = ConfNodeLookupChildValue(conf, "dump-all-headers");
557  if (all_headers != NULL) {
558  if (strncmp(all_headers, "both", 4) == 0) {
559  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
560  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
561  } else if (strncmp(all_headers, "request", 7) == 0) {
562  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
563  } else if (strncmp(all_headers, "response", 8) == 0) {
564  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
565  }
566  }
567  ConfNode *custom;
568  if ((custom = ConfNodeLookupChild(conf, "custom")) != NULL) {
569  if ((http_ctx->flags & (LOG_HTTP_REQ_HEADERS | LOG_HTTP_RES_HEADERS)) ==
571  SCLogWarning("No need for custom as dump-all-headers is already present");
572  }
573  ConfNode *field;
574  TAILQ_FOREACH (field, &custom->head, next) {
575  HttpField f;
576  for (f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
577  if ((strcmp(http_fields[f].config_field, field->val) == 0) ||
578  (strcasecmp(http_fields[f].htp_field, field->val) == 0)) {
579  http_ctx->fields |= (1ULL << f);
580  break;
581  }
582  }
583  }
584  }
585  }
586 
587  if (conf != NULL && ConfNodeLookupChild(conf, "xff") != NULL) {
588  http_ctx->xff_cfg = SCCalloc(1, sizeof(HttpXFFCfg));
589  if (http_ctx->xff_cfg != NULL) {
590  HttpXFFGetCfg(conf, http_ctx->xff_cfg);
591  }
592  } else if (ojc->xff_cfg) {
593  http_ctx->parent_xff_cfg = ojc->xff_cfg;
594  }
595 
596  output_ctx->data = http_ctx;
597  output_ctx->DeInit = OutputHttpLogDeinitSub;
598 
599  /* enable the logger for the app layer */
601 
602  result.ctx = output_ctx;
603  result.ok = true;
604  return result;
605 }
606 
607 static TmEcode JsonHttpLogThreadInit(ThreadVars *t, const void *initdata, void **data)
608 {
609  JsonHttpLogThread *aft = SCCalloc(1, sizeof(JsonHttpLogThread));
610  if (unlikely(aft == NULL))
611  return TM_ECODE_FAILED;
612 
613  if(initdata == NULL)
614  {
615  SCLogDebug("Error getting context for EveLogHTTP. \"initdata\" argument NULL");
616  goto error_exit;
617  }
618 
619  /* Use the Output Context (file pointer and mutex) */
620  aft->httplog_ctx = ((OutputCtx *)initdata)->data; //TODO
621 
622  aft->ctx = CreateEveThreadCtx(t, aft->httplog_ctx->eve_ctx);
623  if (!aft->ctx) {
624  goto error_exit;
625  }
626 
627  *data = (void *)aft;
628  return TM_ECODE_OK;
629 
630 error_exit:
631  SCFree(aft);
632  return TM_ECODE_FAILED;
633 }
634 
635 static TmEcode JsonHttpLogThreadDeinit(ThreadVars *t, void *data)
636 {
637  JsonHttpLogThread *aft = (JsonHttpLogThread *)data;
638  if (aft == NULL) {
639  return TM_ECODE_OK;
640  }
641 
642  FreeEveThreadCtx(aft->ctx);
643 
644  /* clear memory */
645  memset(aft, 0, sizeof(JsonHttpLogThread));
646 
647  SCFree(aft);
648  return TM_ECODE_OK;
649 }
650 
652 {
653  /* register as child of eve-log */
654  OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonHttpLog", "eve-log.http",
655  OutputHttpLogInitSub, ALPROTO_HTTP1, JsonHttpLogger, JsonHttpLogThreadInit,
656  JsonHttpLogThreadDeinit);
657 }
XFF_MAXLEN
#define XFF_MAXLEN
Definition: app-layer-htp-xff.h:39
util-byte.h
tm-threads.h
HTTP_FIELD_SIZE
@ HTTP_FIELD_SIZE
Definition: output-json-http.c:134
HTTP_FIELD_CONTENT_LOCATION
@ HTTP_FIELD_CONTENT_LOCATION
Definition: output-json-http.c:109
JsonHttpLogThread_
Definition: output-json-http.c:64
EveHttpLogJSONBodyPrintable
void EveHttpLogJSONBodyPrintable(JsonBuilder *js, Flow *f, uint64_t tx_id)
Definition: output-json-http.c:394
OutputJsonCtx_::xff_cfg
HttpXFFCfg * xff_cfg
Definition: output-json.h:85
offset
uint64_t offset
Definition: util-streaming-buffer.h:0
XFF_EXTRADATA
#define XFF_EXTRADATA
Definition: app-layer-htp-xff.h:31
MAX_SIZE_HEADER_NAME
#define MAX_SIZE_HEADER_NAME
Definition: output-json-http.c:70
ConfNode_::val
char * val
Definition: conf.h:34
HtpBody_::sb
StreamingBuffer * sb
Definition: app-layer-htp.h:189
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
HTTP_FIELD_ALLOW
@ HTTP_FIELD_ALLOW
Definition: output-json-http.c:104
HTTP_FIELD_ACCEPT_RANGES
@ HTTP_FIELD_ACCEPT_RANGES
Definition: output-json-http.c:102
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
HTTP_FIELD_X_FLASH_VERSION
@ HTTP_FIELD_X_FLASH_VERSION
Definition: output-json-http.c:101
FreeEveThreadCtx
void FreeEveThreadCtx(OutputJsonThreadCtx *ctx)
Definition: output-json-common.c:58
HTTP_FIELD_REFERRER
@ HTTP_FIELD_REFERRER
Definition: output-json-http.c:120
MAX_SIZE_HEADER_VALUE
#define MAX_SIZE_HEADER_VALUE
Definition: output-json-http.c:71
threads.h
OutputJsonCtx_
Definition: output-json.h:81
Flow_
Flow data structure.
Definition: flow.h:356
LogHttpFileCtx
struct LogHttpFileCtx_ LogHttpFileCtx
OutputJsonBuilderBuffer
int OutputJsonBuilderBuffer(JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:958
LOG_HTTP_ARRAY
#define LOG_HTTP_ARRAY
Definition: output-json-http.c:76
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:252
HTTP_FIELD_EXPIRES
@ HTTP_FIELD_EXPIRES
Definition: output-json-http.c:115
CreateEveThreadCtx
OutputJsonThreadCtx * CreateEveThreadCtx(ThreadVars *t, OutputJsonCtx *ctx)
Definition: output-json-common.c:29
HtpTxUserData_::request_body
HtpBody request_body
Definition: app-layer-htp.h:219
OutputRegisterTxSubModule
void OutputRegisterTxSubModule(LoggerId id, const char *parent_name, const char *name, const char *conf_name, OutputInitSubFunc InitFunc, AppProto alproto, TxLogger TxLogFunc, ThreadInitFunc ThreadInit, ThreadDeinitFunc ThreadDeinit)
Definition: output.c:377
HTTP_FIELD_FROM
@ HTTP_FIELD_FROM
Definition: output-json-http.c:89
HTTP_FIELD_CONTENT_ENCODING
@ HTTP_FIELD_CONTENT_ENCODING
Definition: output-json-http.c:106
HTTP_FIELD_WWW_AUTHENTICATE
@ HTTP_FIELD_WWW_AUTHENTICATE
Definition: output-json-http.c:130
StreamingBufferGetData
int StreamingBufferGetData(const StreamingBuffer *sb, const uint8_t **data, uint32_t *data_len, uint64_t *stream_offset)
Definition: util-streaming-buffer.c:1786
HTTP_FIELD_WARNING
@ HTTP_FIELD_WARNING
Definition: output-json-http.c:129
HTTP_FIELD_COOKIE
@ HTTP_FIELD_COOKIE
Definition: output-json-http.c:88
HTTP_FIELD_CONTENT_LENGTH
@ HTTP_FIELD_CONTENT_LENGTH
Definition: output-json-http.c:108
util-privs.h
LogHttpFileCtx_::xff_cfg
HttpXFFCfg * xff_cfg
Definition: output-json-http.c:59
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:506
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:81
HTTP_FIELD_ETAG
@ HTTP_FIELD_ETAG
Definition: output-json-http.c:114
HTTP_FIELD_X_BLUECOAT_VIA
@ HTTP_FIELD_X_BLUECOAT_VIA
Definition: output-json-http.c:133
util-unittest.h
HTTP_FIELD_AGE
@ HTTP_FIELD_AGE
Definition: output-json-http.c:103
HTPParseContentRange
int HTPParseContentRange(bstr *rawvalue, HTTPContentRange *range)
Definition: app-layer-htp-file.c:96
EveHttpAddMetadata
bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
Definition: output-json-http.c:502
HtpState_
Definition: app-layer-htp.h:238
JsonHttpLogThread_::httplog_ctx
LogHttpFileCtx * httplog_ctx
Definition: output-json-http.c:65
ConfValIsTrue
int ConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:536
HTTP_FIELD_CACHE_CONTROL
@ HTTP_FIELD_CACHE_CONTROL
Definition: output-json-http.c:87
OutputCtx_::data
void * data
Definition: tm-modules.h:87
config_field
const char * config_field
Definition: output-json-http.c:138
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:80
PrintStringsToBuffer
void PrintStringsToBuffer(uint8_t *dst_buf, uint32_t *dst_buf_offset_ptr, uint32_t dst_buf_size, const uint8_t *src_buf, const uint32_t src_buf_len)
Definition: util-print.c:194
JsonHttpLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-http.c:67
OutputCtx_
Definition: tm-modules.h:84
app-layer-htp-xff.h
JsonHttpLogThread_::uri_cnt
uint32_t uri_cnt
Definition: output-json-http.c:66
app-layer-htp-file.h
OutputJsonThreadCtx_
Definition: output-json.h:89
HTTP_FIELD_RETRY_AFTER
@ HTTP_FIELD_RETRY_AFTER
Definition: output-json-http.c:122
HTTP_FIELD_UPGRADE
@ HTTP_FIELD_UPGRADE
Definition: output-json-http.c:127
HTTP_FIELD_CONTENT_RANGE
@ HTTP_FIELD_CONTENT_RANGE
Definition: output-json-http.c:111
HTTP_FIELD_ACCEPT
@ HTTP_FIELD_ACCEPT
Definition: output-json-http.c:81
HTTP_FIELD_PRAGMA
@ HTTP_FIELD_PRAGMA
Definition: output-json-http.c:92
HTTP_FIELD_ACCEPT_LANGUAGE
@ HTTP_FIELD_ACCEPT_LANGUAGE
Definition: output-json-http.c:84
HTTP_FIELD_LOCATION
@ HTTP_FIELD_LOCATION
Definition: output-json-http.c:118
HTTP_FIELD_DATE
@ HTTP_FIELD_DATE
Definition: output-json-http.c:113
app-layer-htp.h
LOG_HTTP_DEFAULT
#define LOG_HTTP_DEFAULT
Definition: output-json-http.c:73
HTTP_FIELD_ORIGIN
@ HTTP_FIELD_ORIGIN
Definition: output-json-http.c:91
util-debug.h
htp_field
const char * htp_field
Definition: output-json-http.c:139
HTTP_FIELD_ORG_SRC_IP
@ HTTP_FIELD_ORG_SRC_IP
Definition: output-json-http.c:132
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:47
HTTP_FIELD_LAST_MODIFIED
@ HTTP_FIELD_LAST_MODIFIED
Definition: output-json-http.c:116
HTTP_FIELD_AUTHORIZATION
@ HTTP_FIELD_AUTHORIZATION
Definition: output-json-http.c:86
output-json.h
LOG_HTTP_REQUEST
#define LOG_HTTP_REQUEST
Definition: output-json-http.c:75
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:457
util-print.h
HTTP_FIELD_RANGE
@ HTTP_FIELD_RANGE
Definition: output-json-http.c:94
SCEnter
#define SCEnter(...)
Definition: util-debug.h:271
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
pkt-var.h
HttpField
HttpField
Definition: output-json-http.c:80
HTTP_FIELD_LINK
@ HTTP_FIELD_LINK
Definition: output-json-http.c:117
util-time.h
OutputInitResult_::ok
bool ok
Definition: output.h:48
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
HTTP_FIELD_ACCEPT_ENCODING
@ HTTP_FIELD_ACCEPT_ENCODING
Definition: output-json-http.c:83
EveHttpLogJSONBodyBase64
void EveHttpLogJSONBodyBase64(JsonBuilder *js, Flow *f, uint64_t tx_id)
Definition: output-json-http.c:425
app-layer-parser.h
HTTP_FIELD_SERVER
@ HTTP_FIELD_SERVER
Definition: output-json-http.c:123
CreateEveHeaderWithTxId
JsonBuilder * CreateEveHeaderWithTxId(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, uint64_t tx_id, OutputJsonCtx *eve_ctx)
Definition: output-json.c:902
HTTP_FIELD_CONNECTION
@ HTTP_FIELD_CONNECTION
Definition: output-json-http.c:105
HTTP_FIELD_TE
@ HTTP_FIELD_TE
Definition: output-json-http.c:95
HTTP_FIELD_SET_COOKIE
@ HTTP_FIELD_SET_COOKIE
Definition: output-json-http.c:124
Packet_
Definition: decode.h:475
http_fields
struct @129 http_fields[]
StreamingBufferRegion_::buf
uint8_t * buf
Definition: util-streaming-buffer.h:85
conf.h
HTTP_FIELD_TRAILER
@ HTTP_FIELD_TRAILER
Definition: output-json-http.c:125
XFF_OVERWRITE
#define XFF_OVERWRITE
Definition: app-layer-htp-xff.h:33
TmEcode
TmEcode
Definition: tm-threads-common.h:79
HttpXFFCfg_
Definition: app-layer-htp-xff.h:41
util-proto-name.h
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:233
HtpTxUserData_::response_body
HtpBody response_body
Definition: app-layer-htp.h:220
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1087
HTTP_FIELD_CONTENT_MD5
@ HTTP_FIELD_CONTENT_MD5
Definition: output-json-http.c:110
ConfNodeLookupChild
ConfNode * ConfNodeLookupChild(const ConfNode *node, const char *name)
Lookup a child configuration node by name.
Definition: conf.c:781
HTTP_FIELD_DNT
@ HTTP_FIELD_DNT
Definition: output-json-http.c:98
OutputInitResult_
Definition: output.h:46
Packet_::flow
struct Flow_ * flow
Definition: decode.h:514
HtpBody_
Definition: app-layer-htp.h:185
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:90
LOG_HTTP_REQ_HEADERS
#define LOG_HTTP_REQ_HEADERS
Definition: output-json-http.c:77
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:30
HTTP_FIELD_PROXY_AUTHORIZATION
@ HTTP_FIELD_PROXY_AUTHORIZATION
Definition: output-json-http.c:93
JsonHttpLogThread
struct JsonHttpLogThread_ JsonHttpLogThread
HTTP_FIELD_VARY
@ HTTP_FIELD_VARY
Definition: output-json-http.c:128
HtpTxUserData_
Definition: app-layer-htp.h:206
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
HTTP_FIELD_TRUE_CLIENT_IP
@ HTTP_FIELD_TRUE_CLIENT_IP
Definition: output-json-http.c:131
output-json-alert.h
threadvars.h
LOG_DIR_FLOW
@ LOG_DIR_FLOW
Definition: output-json.h:38
HTTP_FIELD_CONTENT_LANGUAGE
@ HTTP_FIELD_CONTENT_LANGUAGE
Definition: output-json-http.c:107
LOGGER_JSON_TX
@ LOGGER_JSON_TX
Definition: suricata-common.h:468
HttpXFFCfg_::flags
uint8_t flags
Definition: app-layer-htp-xff.h:42
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
util-logopenfile.h
LogHttpFileCtx_::fields
uint64_t fields
Definition: output-json-http.c:58
HTTP_FIELD_X_FORWARDED_PROTO
@ HTTP_FIELD_X_FORWARDED_PROTO
Definition: output-json-http.c:99
util-buffer.h
BytesToStringBuffer
void BytesToStringBuffer(const uint8_t *bytes, size_t nbytes, char *outstr, size_t outlen)
Turn byte array into string.
Definition: util-byte.c:85
HTTP_FIELD_MAX_FORWARDS
@ HTTP_FIELD_MAX_FORWARDS
Definition: output-json-http.c:90
LOG_HTTP_EXTENDED
#define LOG_HTTP_EXTENDED
Definition: output-json-http.c:74
HTTP_FIELD_TRANSFER_ENCODING
@ HTTP_FIELD_TRANSFER_ENCODING
Definition: output-json-http.c:126
JsonHttpLogRegister
void JsonHttpLogRegister(void)
Definition: output-json-http.c:651
HTTP_FIELD_ACCEPT_DATETIME
@ HTTP_FIELD_ACCEPT_DATETIME
Definition: output-json-http.c:85
HTTP_FIELD_VIA
@ HTTP_FIELD_VIA
Definition: output-json-http.c:96
HttpXFFGetCfg
void HttpXFFGetCfg(ConfNode *conf, HttpXFFCfg *result)
Function to return XFF configuration from a configuration node.
Definition: app-layer-htp-xff.c:205
LogHttpFileCtx_::eve_ctx
OutputJsonCtx * eve_ctx
Definition: output-json-http.c:61
HTTP_FIELD_ACCEPT_CHARSET
@ HTTP_FIELD_ACCEPT_CHARSET
Definition: output-json-http.c:82
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
HTTP_FIELD_REFRESH
@ HTTP_FIELD_REFRESH
Definition: output-json-http.c:121
HTTP_FIELD_PROXY_AUTHENTICATE
@ HTTP_FIELD_PROXY_AUTHENTICATE
Definition: output-json-http.c:119
HTTP_FIELD_CONTENT_TYPE
@ HTTP_FIELD_CONTENT_TYPE
Definition: output-json-http.c:112
output-json-http.h
LogHttpFileCtx_::flags
uint32_t flags
Definition: log-httplog.c:85
HTTP_FIELD_X_AUTHENTICATED_USER
@ HTTP_FIELD_X_AUTHENTICATED_USER
Definition: output-json-http.c:100
flags
uint32_t flags
Definition: output-json-http.c:140
StreamingBuffer_::region
StreamingBufferRegion region
Definition: util-streaming-buffer.h:109
LogHttpFileCtx_
Definition: log-httplog.c:83
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:275
XFF_DISABLED
#define XFF_DISABLED
Definition: app-layer-htp-xff.h:29
HTTP_FIELD_X_REQUESTED_WITH
@ HTTP_FIELD_X_REQUESTED_WITH
Definition: output-json-http.c:97
LOG_HTTP_RES_HEADERS
#define LOG_HTTP_RES_HEADERS
Definition: output-json-http.c:78
output.h
app-layer.h
LogHttpFileCtx_::parent_xff_cfg
HttpXFFCfg * parent_xff_cfg
Definition: output-json-http.c:60
ConfNodeLookupChildValue
const char * ConfNodeLookupChildValue(const ConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:809