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 (htp_tx_request_hostname(tx) != NULL) {
201  jb_set_string_from_bytes(js, "hostname", bstr_ptr(htp_tx_request_hostname(tx)),
202  (uint32_t)bstr_len(htp_tx_request_hostname(tx)));
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 (htp_tx_request_port_number(tx) >= 0) {
212  jb_set_uint(js, "http_port", htp_tx_request_port_number(tx));
213  }
214 
215  /* uri */
216  if (htp_tx_request_uri(tx) != NULL) {
217  jb_set_string_from_bytes(js, "url", bstr_ptr(htp_tx_request_uri(tx)),
218  (uint32_t)bstr_len(htp_tx_request_uri(tx)));
219  }
220 
221  if (htp_tx_request_headers(tx) != NULL) {
222  /* user agent */
223  const htp_header_t *h_user_agent = htp_tx_request_header(tx, "user-agent");
224  if (h_user_agent != NULL) {
225  jb_set_string_from_bytes(js, "http_user_agent", htp_header_value_ptr(h_user_agent),
226  (uint32_t)htp_header_value_len(h_user_agent));
227  }
228 
229  /* x-forwarded-for */
230  const htp_header_t *h_x_forwarded_for = htp_tx_request_header(tx, "x-forwarded-for");
231  if (h_x_forwarded_for != NULL) {
232  jb_set_string_from_bytes(js, "xff", htp_header_value_ptr(h_x_forwarded_for),
233  (uint32_t)htp_header_value_len(h_x_forwarded_for));
234  }
235  }
236 
237  /* content-type */
238  if (htp_tx_response_headers(tx) != NULL) {
239  const htp_header_t *h_content_type = htp_tx_response_header(tx, "content-type");
240  if (h_content_type != NULL) {
241  const size_t size = htp_header_value_len(h_content_type) * 2 + 1;
242  char string[size];
244  htp_header_value_len(h_content_type), 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  const htp_header_t *h_content_range = htp_tx_response_header(tx, "content-range");
251  if (h_content_range != NULL) {
252  jb_open_object(js, "content_range");
253  jb_set_string_from_bytes(js, "raw", htp_header_value_ptr(h_content_range),
254  (uint32_t)htp_header_value_len(h_content_range));
255  HTTPContentRange crparsed;
256  if (HTPParseContentRange(htp_header_value(h_content_range), &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 EveHttpLogJSONExtended(JsonBuilder *js, htp_tx_t *tx)
270 {
271  /* referer */
272  const htp_header_t *h_referer = NULL;
273  if (htp_tx_request_headers(tx) != NULL) {
274  h_referer = htp_tx_request_header(tx, "referer");
275  }
276  if (h_referer != NULL) {
277  jb_set_string_from_bytes(js, "http_refer", htp_header_value_ptr(h_referer),
278  (uint32_t)htp_header_value_len(h_referer));
279  }
280 
281  /* method */
282  if (htp_tx_request_method(tx) != NULL) {
283  jb_set_string_from_bytes(js, "http_method", bstr_ptr(htp_tx_request_method(tx)),
284  (uint32_t)bstr_len(htp_tx_request_method(tx)));
285  }
286 
287  /* protocol */
288  if (htp_tx_request_protocol(tx) != NULL) {
289  jb_set_string_from_bytes(js, "protocol", bstr_ptr(htp_tx_request_protocol(tx)),
290  (uint32_t)bstr_len(htp_tx_request_protocol(tx)));
291  }
292 
293  /* response status */
294  const int resp = htp_tx_response_status_number(tx);
295  if (resp > 0) {
296  jb_set_uint(js, "status", (uint32_t)resp);
297  } else if (htp_tx_response_status(tx) != NULL) {
298  jb_set_string_from_bytes(js, "status_string", bstr_ptr(htp_tx_response_status(tx)),
299  (uint32_t)bstr_len(htp_tx_response_status(tx)));
300  }
301 
302  const htp_header_t *h_location = htp_tx_response_header(tx, "location");
303  if (h_location != NULL) {
304  jb_set_string_from_bytes(js, "redirect", htp_header_value_ptr(h_location),
305  (uint32_t)htp_header_value_len(h_location));
306  }
307 
308  /* length */
309  jb_set_uint(js, "length", htp_tx_response_message_len(tx));
310 }
311 
312 static void EveHttpLogJSONHeaders(
313  JsonBuilder *js, uint32_t direction, htp_tx_t *tx, LogHttpFileCtx *http_ctx)
314 {
315  const htp_headers_t *headers = direction & LOG_HTTP_REQ_HEADERS ? htp_tx_request_headers(tx)
317  char name[MAX_SIZE_HEADER_NAME] = {0};
318  char value[MAX_SIZE_HEADER_VALUE] = {0};
319  size_t n = htp_headers_size(headers);
320  JsonBuilderMark mark = { 0, 0, 0 };
321  jb_get_mark(js, &mark);
322  bool array_empty = true;
323  jb_open_array(js, direction & LOG_HTTP_REQ_HEADERS ? "request_headers" : "response_headers");
324  for (size_t i = 0; i < n; i++) {
325  const htp_header_t *h = htp_headers_get_index(headers, i);
326  if ((http_ctx->flags & direction) == 0 && http_ctx->fields != 0) {
327  bool tolog = false;
328  for (HttpField f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
329  if ((http_ctx->fields & (1ULL << f)) != 0) {
330  /* prevent logging a field twice if extended logging is
331  enabled */
332  if (((http_ctx->flags & LOG_HTTP_EXTENDED) == 0) ||
333  ((http_ctx->flags & LOG_HTTP_EXTENDED) !=
334  (http_fields[f].flags & LOG_HTTP_EXTENDED))) {
335  if (bstr_cmp_c_nocase(htp_header_name(h), http_fields[f].htp_field) == 0) {
336  tolog = true;
337  break;
338  }
339  }
340  }
341  }
342  if (!tolog) {
343  continue;
344  }
345  }
346  array_empty = false;
347  jb_start_object(js);
348  size_t size_name = htp_header_name_len(h) < MAX_SIZE_HEADER_NAME - 1
350  : MAX_SIZE_HEADER_NAME - 1;
351  memcpy(name, htp_header_name_ptr(h), size_name);
352  name[size_name] = '\0';
353  jb_set_string(js, "name", name);
354  size_t size_value = htp_header_value_len(h) < MAX_SIZE_HEADER_VALUE - 1
356  : MAX_SIZE_HEADER_VALUE - 1;
357  memcpy(value, htp_header_value_ptr(h), size_value);
358  value[size_value] = '\0';
359  jb_set_string(js, "value", value);
360  jb_close(js);
361  }
362  if (array_empty) {
363  jb_restore_mark(js, &mark);
364  } else {
365  // Close array.
366  jb_close(js);
367  }
368 }
369 
370 static void BodyPrintableBuffer(JsonBuilder *js, HtpBody *body, const char *key)
371 {
372  if (body->sb != NULL && body->sb->region.buf != NULL) {
373  uint32_t offset = 0;
374  const uint8_t *body_data;
375  uint32_t body_data_len;
376  uint64_t body_offset;
377 
378  if (StreamingBufferGetData(body->sb, &body_data,
379  &body_data_len, &body_offset) == 0) {
380  return;
381  }
382 
383  uint8_t printable_buf[body_data_len + 1];
384  PrintStringsToBuffer(printable_buf, &offset, body_data_len + 1, body_data, body_data_len);
385  if (offset > 0) {
386  jb_set_string(js, key, (char *)printable_buf);
387  }
388  }
389 }
390 
391 void EveHttpLogJSONBodyPrintable(JsonBuilder *js, Flow *f, uint64_t tx_id)
392 {
393  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
394  if (htp_state) {
395  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
396  if (tx) {
397  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
398  if (htud != NULL) {
399  BodyPrintableBuffer(js, &htud->request_body, "http_request_body_printable");
400  BodyPrintableBuffer(js, &htud->response_body, "http_response_body_printable");
401  }
402  }
403  }
404 }
405 
406 static void BodyBase64Buffer(JsonBuilder *js, HtpBody *body, const char *key)
407 {
408  if (body->sb != NULL && body->sb->region.buf != NULL) {
409  const uint8_t *body_data;
410  uint32_t body_data_len;
411  uint64_t body_offset;
412 
413  if (StreamingBufferGetData(body->sb, &body_data,
414  &body_data_len, &body_offset) == 0) {
415  return;
416  }
417 
418  jb_set_base64(js, key, body_data, body_data_len);
419  }
420 }
421 
422 void EveHttpLogJSONBodyBase64(JsonBuilder *js, Flow *f, uint64_t tx_id)
423 {
424  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
425  if (htp_state) {
426  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
427  if (tx) {
428  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
429  if (htud != NULL) {
430  BodyBase64Buffer(js, &htud->request_body, "http_request_body");
431  BodyBase64Buffer(js, &htud->response_body, "http_response_body");
432  }
433  }
434  }
435 }
436 
437 /* JSON format logging */
438 static void EveHttpLogJSON(JsonHttpLogThread *aft, JsonBuilder *js, htp_tx_t *tx, uint64_t tx_id)
439 {
440  LogHttpFileCtx *http_ctx = aft->httplog_ctx;
441  jb_open_object(js, "http");
442 
443  EveHttpLogJSONBasic(js, tx);
444  if (http_ctx->flags & LOG_HTTP_EXTENDED)
445  EveHttpLogJSONExtended(js, tx);
446  if (http_ctx->flags & LOG_HTTP_REQ_HEADERS || http_ctx->fields != 0)
447  EveHttpLogJSONHeaders(js, LOG_HTTP_REQ_HEADERS, tx, http_ctx);
448  if (http_ctx->flags & LOG_HTTP_RES_HEADERS || http_ctx->fields != 0)
449  EveHttpLogJSONHeaders(js, LOG_HTTP_RES_HEADERS, tx, http_ctx);
450 
451  jb_close(js);
452 }
453 
454 static int JsonHttpLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f, void *alstate, void *txptr, uint64_t tx_id)
455 {
456  SCEnter();
457 
458  htp_tx_t *tx = txptr;
459  JsonHttpLogThread *jhl = (JsonHttpLogThread *)thread_data;
460 
461  JsonBuilder *js = CreateEveHeaderWithTxId(
462  p, LOG_DIR_FLOW, "http", NULL, tx_id, jhl->httplog_ctx->eve_ctx);
463  if (unlikely(js == NULL))
464  return TM_ECODE_OK;
465 
466  SCLogDebug("got a HTTP request and now logging !!");
467 
468  EveHttpLogJSON(jhl, js, tx, tx_id);
469  HttpXFFCfg *xff_cfg = jhl->httplog_ctx->xff_cfg != NULL ?
471 
472  /* xff header */
473  if ((xff_cfg != NULL) && !(xff_cfg->flags & XFF_DISABLED) && p->flow != NULL) {
474  int have_xff_ip = 0;
475  char buffer[XFF_MAXLEN];
476 
477  have_xff_ip = HttpXFFGetIPFromTx(p->flow, tx_id, xff_cfg, buffer, XFF_MAXLEN);
478 
479  if (have_xff_ip) {
480  if (xff_cfg->flags & XFF_EXTRADATA) {
481  jb_set_string(js, "xff", buffer);
482  }
483  else if (xff_cfg->flags & XFF_OVERWRITE) {
484  if (p->flowflags & FLOW_PKT_TOCLIENT) {
485  jb_set_string(js, "dest_ip", buffer);
486  } else {
487  jb_set_string(js, "src_ip", buffer);
488  }
489  }
490  }
491  }
492 
493  OutputJsonBuilderBuffer(tv, p, p->flow, js, jhl->ctx);
494  jb_free(js);
495 
497 }
498 
499 bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
500 {
501  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
502  if (htp_state) {
503  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
504 
505  if (tx) {
506  EveHttpLogJSONBasic(js, tx);
507  EveHttpLogJSONExtended(js, tx);
508  return true;
509  }
510  }
511 
512  return false;
513 }
514 
515 static void OutputHttpLogDeinitSub(OutputCtx *output_ctx)
516 {
517  LogHttpFileCtx *http_ctx = output_ctx->data;
518  if (http_ctx->xff_cfg) {
519  SCFree(http_ctx->xff_cfg);
520  }
521  SCFree(http_ctx);
522  SCFree(output_ctx);
523 }
524 
525 static OutputInitResult OutputHttpLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
526 {
527  OutputInitResult result = { NULL, false };
528  OutputJsonCtx *ojc = parent_ctx->data;
529 
530  LogHttpFileCtx *http_ctx = SCCalloc(1, sizeof(LogHttpFileCtx));
531  if (unlikely(http_ctx == NULL))
532  return result;
533  memset(http_ctx, 0x00, sizeof(*http_ctx));
534 
535  OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
536  if (unlikely(output_ctx == NULL)) {
537  SCFree(http_ctx);
538  return result;
539  }
540 
541  http_ctx->flags = LOG_HTTP_DEFAULT;
542  http_ctx->eve_ctx = ojc;
543 
544  if (conf) {
545  const char *extended = ConfNodeLookupChildValue(conf, "extended");
546 
547  if (extended != NULL) {
548  if (ConfValIsTrue(extended)) {
549  http_ctx->flags = LOG_HTTP_EXTENDED;
550  }
551  }
552 
553  const char *all_headers = ConfNodeLookupChildValue(conf, "dump-all-headers");
554  if (all_headers != NULL) {
555  if (strncmp(all_headers, "both", 4) == 0) {
556  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
557  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
558  } else if (strncmp(all_headers, "request", 7) == 0) {
559  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
560  } else if (strncmp(all_headers, "response", 8) == 0) {
561  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
562  }
563  }
564  ConfNode *custom;
565  if ((custom = ConfNodeLookupChild(conf, "custom")) != NULL) {
566  if ((http_ctx->flags & (LOG_HTTP_REQ_HEADERS | LOG_HTTP_RES_HEADERS)) ==
568  SCLogWarning("No need for custom as dump-all-headers is already present");
569  }
570  ConfNode *field;
571  TAILQ_FOREACH (field, &custom->head, next) {
572  HttpField f;
573  for (f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
574  if ((strcmp(http_fields[f].config_field, field->val) == 0) ||
575  (strcasecmp(http_fields[f].htp_field, field->val) == 0)) {
576  http_ctx->fields |= (1ULL << f);
577  break;
578  }
579  }
580  }
581  }
582  }
583 
584  if (conf != NULL && ConfNodeLookupChild(conf, "xff") != NULL) {
585  http_ctx->xff_cfg = SCCalloc(1, sizeof(HttpXFFCfg));
586  if (http_ctx->xff_cfg != NULL) {
587  HttpXFFGetCfg(conf, http_ctx->xff_cfg);
588  }
589  } else if (ojc->xff_cfg) {
590  http_ctx->parent_xff_cfg = ojc->xff_cfg;
591  }
592 
593  output_ctx->data = http_ctx;
594  output_ctx->DeInit = OutputHttpLogDeinitSub;
595 
596  /* enable the logger for the app layer */
598 
599  result.ctx = output_ctx;
600  result.ok = true;
601  return result;
602 }
603 
604 static TmEcode JsonHttpLogThreadInit(ThreadVars *t, const void *initdata, void **data)
605 {
606  JsonHttpLogThread *aft = SCCalloc(1, sizeof(JsonHttpLogThread));
607  if (unlikely(aft == NULL))
608  return TM_ECODE_FAILED;
609 
610  if(initdata == NULL)
611  {
612  SCLogDebug("Error getting context for EveLogHTTP. \"initdata\" argument NULL");
613  goto error_exit;
614  }
615 
616  /* Use the Output Context (file pointer and mutex) */
617  aft->httplog_ctx = ((OutputCtx *)initdata)->data; //TODO
618 
619  aft->ctx = CreateEveThreadCtx(t, aft->httplog_ctx->eve_ctx);
620  if (!aft->ctx) {
621  goto error_exit;
622  }
623 
624  *data = (void *)aft;
625  return TM_ECODE_OK;
626 
627 error_exit:
628  SCFree(aft);
629  return TM_ECODE_FAILED;
630 }
631 
632 static TmEcode JsonHttpLogThreadDeinit(ThreadVars *t, void *data)
633 {
634  JsonHttpLogThread *aft = (JsonHttpLogThread *)data;
635  if (aft == NULL) {
636  return TM_ECODE_OK;
637  }
638 
639  FreeEveThreadCtx(aft->ctx);
640 
641  /* clear memory */
642  memset(aft, 0, sizeof(JsonHttpLogThread));
643 
644  SCFree(aft);
645  return TM_ECODE_OK;
646 }
647 
649 {
650  /* register as child of eve-log */
651  OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonHttpLog", "eve-log.http",
652  OutputHttpLogInitSub, ALPROTO_HTTP1, JsonHttpLogger, JsonHttpLogThreadInit,
653  JsonHttpLogThreadDeinit);
654 }
htp_header_value_len
#define htp_header_value_len(h)
Definition: app-layer-htp-libhtp.h:191
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:391
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
htp_tx_request_uri
#define htp_tx_request_uri(tx)
Definition: app-layer-htp-libhtp.h:172
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:195
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
htp_headers_get_index
#define htp_headers_get_index(headers, index)
Definition: app-layer-htp-libhtp.h:197
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:354
OutputJsonBuilderBuffer
void OutputJsonBuilderBuffer(ThreadVars *tv, const Packet *p, Flow *f, JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:959
LogHttpFileCtx
struct LogHttpFileCtx_ LogHttpFileCtx
htp_tx_request_protocol
#define htp_tx_request_protocol(tx)
Definition: app-layer-htp-libhtp.h:170
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
htp_tx_response_headers
#define htp_tx_response_headers(tx)
Definition: app-layer-htp-libhtp.h:174
htp_tx_response_header
#define htp_tx_response_header(tx, header)
Definition: app-layer-htp-libhtp.h:185
CreateEveThreadCtx
OutputJsonThreadCtx * CreateEveThreadCtx(ThreadVars *t, OutputJsonCtx *ctx)
Definition: output-json-common.c:29
HtpTxUserData_::request_body
HtpBody request_body
Definition: app-layer-htp.h:225
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:1816
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
htp_tx_request_method
#define htp_tx_request_method(tx)
Definition: app-layer-htp-libhtp.h:166
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:507
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:81
HTTP_FIELD_ETAG
@ HTTP_FIELD_ETAG
Definition: output-json-http.c:114
htp_tx_response_status
#define htp_tx_response_status(tx)
Definition: app-layer-htp-libhtp.h:179
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
EveHttpAddMetadata
bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, JsonBuilder *js)
Definition: output-json-http.c:499
HtpState_
Definition: app-layer-htp.h:244
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
htp_headers_size
#define htp_headers_size(headers)
Definition: app-layer-htp-libhtp.h:196
HTTP_FIELD_CACHE_CONTROL
@ HTTP_FIELD_CACHE_CONTROL
Definition: output-json-http.c:87
htp_header_value
#define htp_header_value(h)
Definition: app-layer-htp-libhtp.h:193
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:195
JsonHttpLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-http.c:67
OutputCtx_
Definition: tm-modules.h:84
app-layer-htp-xff.h
htp_headers_t
#define htp_headers_t
Definition: app-layer-htp-libhtp.h:200
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
htp_tx_request_headers
#define htp_tx_request_headers(tx)
Definition: app-layer-htp-libhtp.h:173
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:466
htp_header_name
#define htp_header_name(h)
Definition: app-layer-htp-libhtp.h:190
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:58
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:422
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:903
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
htp_tx_request_hostname
#define htp_tx_request_hostname(tx)
Definition: app-layer-htp-libhtp.h:163
Packet_
Definition: decode.h:476
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
htp_header_value_ptr
#define htp_header_value_ptr(h)
Definition: app-layer-htp-libhtp.h:192
XFF_OVERWRITE
#define XFF_OVERWRITE
Definition: app-layer-htp-xff.h:33
TmEcode
TmEcode
Definition: tm-threads-common.h:79
name
const char * name
Definition: tm-threads.c:2081
HttpXFFCfg_
Definition: app-layer-htp-xff.h:41
util-proto-name.h
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:232
HtpTxUserData_::response_body
HtpBody response_body
Definition: app-layer-htp.h:226
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1092
HTTP_FIELD_CONTENT_MD5
@ HTTP_FIELD_CONTENT_MD5
Definition: output-json-http.c:110
htp_header_name_len
#define htp_header_name_len(h)
Definition: app-layer-htp-libhtp.h:188
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:515
HtpBody_
Definition: app-layer-htp.h:191
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
htp_tx_response_message_len
#define htp_tx_response_message_len(tx)
Definition: app-layer-htp-libhtp.h:178
ALPROTO_HTTP1
@ ALPROTO_HTTP1
Definition: app-layer-protos.h:36
HTTP_FIELD_PROXY_AUTHORIZATION
@ HTTP_FIELD_PROXY_AUTHORIZATION
Definition: output-json-http.c:93
JsonHttpLogThread
struct JsonHttpLogThread_ JsonHttpLogThread
htp_tx_request_port_number
#define htp_tx_request_port_number(tx)
Definition: app-layer-htp-libhtp.h:168
HTTP_FIELD_VARY
@ HTTP_FIELD_VARY
Definition: output-json-http.c:128
HtpTxUserData_
Definition: app-layer-htp.h:212
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
HTPParseContentRange
int HTPParseContentRange(const bstr *rawvalue, HTTPContentRange *range)
Definition: app-layer-htp-file.c:96
HTTP_FIELD_CONTENT_LANGUAGE
@ HTTP_FIELD_CONTENT_LANGUAGE
Definition: output-json-http.c:107
LOGGER_JSON_TX
@ LOGGER_JSON_TX
Definition: suricata-common.h:477
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:648
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:202
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
htp_tx_response_status_number
#define htp_tx_response_status_number(tx)
Definition: app-layer-htp-libhtp.h:180
htp_header_name_ptr
#define htp_header_name_ptr(h)
Definition: app-layer-htp-libhtp.h:189
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
htp_tx_request_header
#define htp_tx_request_header(tx, header)
Definition: app-layer-htp-libhtp.h:184
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