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