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(SCJsonBuilder *js, htp_tx_t *tx)
198 {
199  /* hostname */
200  if (htp_tx_request_hostname(tx) != NULL) {
201  SCJbSetStringFromBytes(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  SCJbSetUint(js, "http_port", htp_tx_request_port_number(tx));
213  }
214 
215  /* uri */
216  if (htp_tx_request_uri(tx) != NULL) {
217  SCJbSetStringFromBytes(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  SCJbSetStringFromBytes(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  SCJbSetStringFromBytes(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  uint32_t len = (uint32_t)htp_header_value_len(h_content_type);
242  const uint8_t *p = memchr(htp_header_value_ptr(h_content_type), ';', len);
243  if (p != NULL)
244  len = (uint32_t)(p - htp_header_value_ptr(h_content_type));
245  SCJbSetStringFromBytes(
246  js, "http_content_type", htp_header_value_ptr(h_content_type), len);
247  }
248  const htp_header_t *h_content_range = htp_tx_response_header(tx, "content-range");
249  if (h_content_range != NULL) {
250  SCJbOpenObject(js, "content_range");
251  SCJbSetStringFromBytes(js, "raw", htp_header_value_ptr(h_content_range),
252  (uint32_t)htp_header_value_len(h_content_range));
253  HTTPContentRange crparsed;
254  if (HTPParseContentRange(htp_header_value(h_content_range), &crparsed) == 0) {
255  if (crparsed.start >= 0)
256  SCJbSetUint(js, "start", crparsed.start);
257  if (crparsed.end >= 0)
258  SCJbSetUint(js, "end", crparsed.end);
259  if (crparsed.size >= 0)
260  SCJbSetUint(js, "size", crparsed.size);
261  }
262  SCJbClose(js);
263  }
264  }
265 }
266 
267 static void EveHttpLogJSONExtended(SCJsonBuilder *js, htp_tx_t *tx)
268 {
269  /* referer */
270  const htp_header_t *h_referer = NULL;
271  if (htp_tx_request_headers(tx) != NULL) {
272  h_referer = htp_tx_request_header(tx, "referer");
273  }
274  if (h_referer != NULL) {
275  SCJbSetStringFromBytes(js, "http_refer", htp_header_value_ptr(h_referer),
276  (uint32_t)htp_header_value_len(h_referer));
277  }
278 
279  /* method */
280  if (htp_tx_request_method(tx) != NULL) {
281  SCJbSetStringFromBytes(js, "http_method", bstr_ptr(htp_tx_request_method(tx)),
282  (uint32_t)bstr_len(htp_tx_request_method(tx)));
283  }
284 
285  /* protocol */
286  if (htp_tx_request_protocol(tx) != NULL) {
287  SCJbSetStringFromBytes(js, "protocol", bstr_ptr(htp_tx_request_protocol(tx)),
288  (uint32_t)bstr_len(htp_tx_request_protocol(tx)));
289  }
290 
291  /* response status */
292  const int resp = htp_tx_response_status_number(tx);
293  if (resp > 0) {
294  SCJbSetUint(js, "status", (uint32_t)resp);
295  } else if (htp_tx_response_status(tx) != NULL) {
296  SCJbSetStringFromBytes(js, "status_string", bstr_ptr(htp_tx_response_status(tx)),
297  (uint32_t)bstr_len(htp_tx_response_status(tx)));
298  }
299 
300  const htp_header_t *h_location = htp_tx_response_header(tx, "location");
301  if (h_location != NULL) {
302  SCJbSetStringFromBytes(js, "redirect", htp_header_value_ptr(h_location),
303  (uint32_t)htp_header_value_len(h_location));
304  }
305 
306  /* length */
307  SCJbSetUint(js, "length", htp_tx_response_message_len(tx));
308 }
309 
310 static void EveHttpLogJSONHeaders(
311  SCJsonBuilder *js, uint32_t direction, htp_tx_t *tx, LogHttpFileCtx *http_ctx)
312 {
313  const htp_headers_t *headers = direction & LOG_HTTP_REQ_HEADERS ? htp_tx_request_headers(tx)
314  : htp_tx_response_headers(tx);
315  char name[MAX_SIZE_HEADER_NAME] = {0};
316  char value[MAX_SIZE_HEADER_VALUE] = {0};
317  size_t n = htp_headers_size(headers);
318  SCJsonBuilderMark mark = { 0, 0, 0 };
319  SCJbGetMark(js, &mark);
320  bool array_empty = true;
321  SCJbOpenArray(js, direction & LOG_HTTP_REQ_HEADERS ? "request_headers" : "response_headers");
322  for (size_t i = 0; i < n; i++) {
323  const htp_header_t *h = htp_headers_get_index(headers, i);
324  if ((http_ctx->flags & direction) == 0 && http_ctx->fields != 0) {
325  bool tolog = false;
326  for (HttpField f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
327  if ((http_ctx->fields & (1ULL << f)) != 0) {
328  /* prevent logging a field twice if extended logging is
329  enabled */
330  if (((http_ctx->flags & LOG_HTTP_EXTENDED) == 0) ||
331  ((http_ctx->flags & LOG_HTTP_EXTENDED) !=
332  (http_fields[f].flags & LOG_HTTP_EXTENDED))) {
333  if (bstr_cmp_c_nocase(htp_header_name(h), http_fields[f].htp_field)) {
334  tolog = true;
335  break;
336  }
337  }
338  }
339  }
340  if (!tolog) {
341  continue;
342  }
343  }
344  array_empty = false;
345  SCJbStartObject(js);
346  size_t size_name = htp_header_name_len(h) < MAX_SIZE_HEADER_NAME - 1
347  ? htp_header_name_len(h)
348  : MAX_SIZE_HEADER_NAME - 1;
349  memcpy(name, htp_header_name_ptr(h), size_name);
350  name[size_name] = '\0';
351  SCJbSetString(js, "name", name);
352  size_t size_value = htp_header_value_len(h) < MAX_SIZE_HEADER_VALUE - 1
353  ? htp_header_value_len(h)
354  : MAX_SIZE_HEADER_VALUE - 1;
355  memcpy(value, htp_header_value_ptr(h), size_value);
356  value[size_value] = '\0';
357  SCJbSetString(js, "value", value);
358  SCJbClose(js);
359  }
360  if (array_empty) {
361  SCJbRestoreMark(js, &mark);
362  } else {
363  // Close array.
364  SCJbClose(js);
365  }
366 }
367 
368 static void BodyPrintableBuffer(SCJsonBuilder *js, HtpBody *body, const char *key)
369 {
370  if (body->sb != NULL && body->sb->region.buf != NULL) {
371  const uint8_t *body_data;
372  uint32_t body_data_len;
373  uint64_t body_offset;
374 
375  if (StreamingBufferGetData(body->sb, &body_data,
376  &body_data_len, &body_offset) == 0) {
377  return;
378  }
379 
380  SCJbSetPrintAsciiString(js, key, body_data, body_data_len);
381  }
382 }
383 
384 void EveHttpLogJSONBodyPrintable(SCJsonBuilder *js, Flow *f, uint64_t tx_id)
385 {
386  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
387  if (htp_state) {
388  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
389  if (tx) {
390  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
391  BodyPrintableBuffer(js, &htud->request_body, "http_request_body_printable");
392  BodyPrintableBuffer(js, &htud->response_body, "http_response_body_printable");
393  }
394  }
395 }
396 
397 static void BodyBase64Buffer(SCJsonBuilder *js, HtpBody *body, const char *key)
398 {
399  if (body->sb != NULL && body->sb->region.buf != NULL) {
400  const uint8_t *body_data;
401  uint32_t body_data_len;
402  uint64_t body_offset;
403 
404  if (StreamingBufferGetData(body->sb, &body_data,
405  &body_data_len, &body_offset) == 0) {
406  return;
407  }
408 
409  SCJbSetBase64(js, key, body_data, body_data_len);
410  }
411 }
412 
413 void EveHttpLogJSONBodyBase64(SCJsonBuilder *js, Flow *f, uint64_t tx_id)
414 {
415  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
416  if (htp_state) {
417  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
418  if (tx) {
419  HtpTxUserData *htud = (HtpTxUserData *)htp_tx_get_user_data(tx);
420  BodyBase64Buffer(js, &htud->request_body, "http_request_body");
421  BodyBase64Buffer(js, &htud->response_body, "http_response_body");
422  }
423  }
424 }
425 
426 /* JSON format logging */
427 static void EveHttpLogJSON(JsonHttpLogThread *aft, SCJsonBuilder *js, htp_tx_t *tx, uint64_t tx_id)
428 {
429  LogHttpFileCtx *http_ctx = aft->httplog_ctx;
430  SCJbOpenObject(js, "http");
431 
432  EveHttpLogJSONBasic(js, tx);
433  if (http_ctx->flags & LOG_HTTP_EXTENDED)
434  EveHttpLogJSONExtended(js, tx);
435  if (http_ctx->flags & LOG_HTTP_REQ_HEADERS || http_ctx->fields != 0)
436  EveHttpLogJSONHeaders(js, LOG_HTTP_REQ_HEADERS, tx, http_ctx);
437  if (http_ctx->flags & LOG_HTTP_RES_HEADERS || http_ctx->fields != 0)
438  EveHttpLogJSONHeaders(js, LOG_HTTP_RES_HEADERS, tx, http_ctx);
439 
440  SCJbClose(js);
441 }
442 
443 static int JsonHttpLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f, void *alstate, void *txptr, uint64_t tx_id)
444 {
445  SCEnter();
446 
447  htp_tx_t *tx = txptr;
448  JsonHttpLogThread *jhl = (JsonHttpLogThread *)thread_data;
449 
450  SCJsonBuilder *js = CreateEveHeaderWithTxId(
451  p, LOG_DIR_FLOW, "http", NULL, tx_id, jhl->httplog_ctx->eve_ctx);
452  if (unlikely(js == NULL))
453  return TM_ECODE_OK;
454 
455  SCLogDebug("got a HTTP request and now logging !!");
456 
457  EveHttpLogJSON(jhl, js, tx, tx_id);
458  HttpXFFCfg *xff_cfg = jhl->httplog_ctx->xff_cfg != NULL ?
460 
461  /* xff header */
462  if ((xff_cfg != NULL) && !(xff_cfg->flags & XFF_DISABLED) && p->flow != NULL) {
463  int have_xff_ip = 0;
464  char buffer[XFF_MAXLEN];
465 
466  have_xff_ip = HttpXFFGetIPFromTx(p->flow, tx_id, xff_cfg, buffer, XFF_MAXLEN);
467 
468  if (have_xff_ip) {
469  if (xff_cfg->flags & XFF_EXTRADATA) {
470  SCJbSetString(js, "xff", buffer);
471  }
472  else if (xff_cfg->flags & XFF_OVERWRITE) {
473  if (p->flowflags & FLOW_PKT_TOCLIENT) {
474  SCJbSetString(js, "dest_ip", buffer);
475  } else {
476  SCJbSetString(js, "src_ip", buffer);
477  }
478  }
479  }
480  }
481 
482  OutputJsonBuilderBuffer(tv, p, p->flow, js, jhl->ctx);
483  SCJbFree(js);
484 
486 }
487 
488 bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, SCJsonBuilder *js)
489 {
490  HtpState *htp_state = (HtpState *)FlowGetAppState(f);
491  if (htp_state) {
492  htp_tx_t *tx = AppLayerParserGetTx(IPPROTO_TCP, ALPROTO_HTTP1, htp_state, tx_id);
493 
494  if (tx) {
495  EveHttpLogJSONBasic(js, tx);
496  EveHttpLogJSONExtended(js, tx);
497  return true;
498  }
499  }
500 
501  return false;
502 }
503 
504 static void OutputHttpLogDeinitSub(OutputCtx *output_ctx)
505 {
506  LogHttpFileCtx *http_ctx = output_ctx->data;
507  if (http_ctx->xff_cfg) {
508  SCFree(http_ctx->xff_cfg);
509  }
510  SCFree(http_ctx);
511  SCFree(output_ctx);
512 }
513 
514 static OutputInitResult OutputHttpLogInitSub(SCConfNode *conf, OutputCtx *parent_ctx)
515 {
516  OutputInitResult result = { NULL, false };
517  OutputJsonCtx *ojc = parent_ctx->data;
518 
519  LogHttpFileCtx *http_ctx = SCCalloc(1, sizeof(LogHttpFileCtx));
520  if (unlikely(http_ctx == NULL))
521  return result;
522  memset(http_ctx, 0x00, sizeof(*http_ctx));
523 
524  OutputCtx *output_ctx = SCCalloc(1, sizeof(OutputCtx));
525  if (unlikely(output_ctx == NULL)) {
526  SCFree(http_ctx);
527  return result;
528  }
529 
530  http_ctx->flags = LOG_HTTP_DEFAULT;
531  http_ctx->eve_ctx = ojc;
532 
533  if (conf) {
534  const char *extended = SCConfNodeLookupChildValue(conf, "extended");
535 
536  if (extended != NULL) {
537  if (SCConfValIsTrue(extended)) {
538  http_ctx->flags = LOG_HTTP_EXTENDED;
539  }
540  }
541 
542  const char *all_headers = SCConfNodeLookupChildValue(conf, "dump-all-headers");
543  if (all_headers != NULL) {
544  if (strncmp(all_headers, "both", 4) == 0) {
545  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
546  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
547  } else if (strncmp(all_headers, "request", 7) == 0) {
548  http_ctx->flags |= LOG_HTTP_REQ_HEADERS;
549  } else if (strncmp(all_headers, "response", 8) == 0) {
550  http_ctx->flags |= LOG_HTTP_RES_HEADERS;
551  }
552  }
553  SCConfNode *custom;
554  if ((custom = SCConfNodeLookupChild(conf, "custom")) != NULL) {
555  if ((http_ctx->flags & (LOG_HTTP_REQ_HEADERS | LOG_HTTP_RES_HEADERS)) ==
557  SCLogWarning("No need for custom as dump-all-headers is already present");
558  }
559  SCConfNode *field;
560  TAILQ_FOREACH (field, &custom->head, next) {
561  HttpField f;
562  for (f = HTTP_FIELD_ACCEPT; f < HTTP_FIELD_SIZE; f++) {
563  if ((strcmp(http_fields[f].config_field, field->val) == 0) ||
564  (strcasecmp(http_fields[f].htp_field, field->val) == 0)) {
565  http_ctx->fields |= (1ULL << f);
566  break;
567  }
568  }
569  }
570  }
571  }
572 
573  if (conf != NULL && SCConfNodeLookupChild(conf, "xff") != NULL) {
574  http_ctx->xff_cfg = SCCalloc(1, sizeof(HttpXFFCfg));
575  if (http_ctx->xff_cfg != NULL) {
576  HttpXFFGetCfg(conf, http_ctx->xff_cfg);
577  }
578  } else if (ojc->xff_cfg) {
579  http_ctx->parent_xff_cfg = ojc->xff_cfg;
580  }
581 
582  output_ctx->data = http_ctx;
583  output_ctx->DeInit = OutputHttpLogDeinitSub;
584 
585  /* enable the logger for the app layer */
587 
588  result.ctx = output_ctx;
589  result.ok = true;
590  return result;
591 }
592 
593 static TmEcode JsonHttpLogThreadInit(ThreadVars *t, const void *initdata, void **data)
594 {
595  JsonHttpLogThread *aft = SCCalloc(1, sizeof(JsonHttpLogThread));
596  if (unlikely(aft == NULL))
597  return TM_ECODE_FAILED;
598 
599  if(initdata == NULL)
600  {
601  SCLogDebug("Error getting context for EveLogHTTP. \"initdata\" argument NULL");
602  goto error_exit;
603  }
604 
605  /* Use the Output Context (file pointer and mutex) */
606  aft->httplog_ctx = ((OutputCtx *)initdata)->data; //TODO
607 
608  aft->ctx = CreateEveThreadCtx(t, aft->httplog_ctx->eve_ctx);
609  if (!aft->ctx) {
610  goto error_exit;
611  }
612 
613  *data = (void *)aft;
614  return TM_ECODE_OK;
615 
616 error_exit:
617  SCFree(aft);
618  return TM_ECODE_FAILED;
619 }
620 
621 static TmEcode JsonHttpLogThreadDeinit(ThreadVars *t, void *data)
622 {
623  JsonHttpLogThread *aft = (JsonHttpLogThread *)data;
624  if (aft == NULL) {
625  return TM_ECODE_OK;
626  }
627 
628  FreeEveThreadCtx(aft->ctx);
629 
630  /* clear memory */
631  memset(aft, 0, sizeof(JsonHttpLogThread));
632 
633  SCFree(aft);
634  return TM_ECODE_OK;
635 }
636 
638 {
639  /* register as child of eve-log */
640  OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonHttpLog", "eve-log.http",
641  OutputHttpLogInitSub, ALPROTO_HTTP1, JsonHttpLogger, JsonHttpLogThreadInit,
642  JsonHttpLogThreadDeinit);
643 }
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
len
uint8_t len
Definition: app-layer-dnp3.h:2
SCConfValIsTrue
int SCConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:551
HTTP_FIELD_CONTENT_LOCATION
@ HTTP_FIELD_CONTENT_LOCATION
Definition: output-json-http.c:109
JsonHttpLogThread_
Definition: output-json-http.c:64
OutputJsonCtx_::xff_cfg
HttpXFFCfg * xff_cfg
Definition: output-json.h:79
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
HtpBody_::sb
StreamingBuffer * sb
Definition: app-layer-htp.h:134
HttpXFFGetCfg
void HttpXFFGetCfg(SCConfNode *conf, HttpXFFCfg *result)
Function to return XFF configuration from a configuration node.
Definition: app-layer-htp-xff.c:202
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
EveHttpLogJSONBodyPrintable
void EveHttpLogJSONBodyPrintable(SCJsonBuilder *js, Flow *f, uint64_t tx_id)
Definition: output-json-http.c:384
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:279
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:75
Flow_
Flow data structure.
Definition: flow.h:348
LogHttpFileCtx
struct LogHttpFileCtx_ LogHttpFileCtx
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:164
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:406
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:1813
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
OutputJsonBuilderBuffer
void OutputJsonBuilderBuffer(ThreadVars *tv, const Packet *p, Flow *f, SCJsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:997
SCConfNodeLookupChildValue
const char * SCConfNodeLookupChildValue(const SCConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:824
Packet_::flowflags
uint8_t flowflags
Definition: decode.h:532
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:82
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
EveHttpAddMetadata
bool EveHttpAddMetadata(const Flow *f, uint64_t tx_id, SCJsonBuilder *js)
Definition: output-json-http.c:488
HtpState_
Definition: app-layer-htp.h:181
JsonHttpLogThread_::httplog_ctx
LogHttpFileCtx * httplog_ctx
Definition: output-json-http.c:65
HTTP_FIELD_CACHE_CONTROL
@ HTTP_FIELD_CACHE_CONTROL
Definition: output-json-http.c:87
OutputCtx_::data
void * data
Definition: tm-modules.h:91
config_field
const char * config_field
Definition: output-json-http.c:138
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:81
JsonHttpLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-http.c:67
OutputCtx_
Definition: tm-modules.h:88
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:83
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
HTTPContentRange
struct HTTPContentRange HTTPContentRange
Definition: app-layer-htp-range.h:26
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
SCAppLayerParserRegisterLogger
void SCAppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:477
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
util-print.h
HTTP_FIELD_RANGE
@ HTTP_FIELD_RANGE
Definition: output-json-http.c:94
SCEnter
#define SCEnter(...)
Definition: util-debug.h:281
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:259
HTTP_FIELD_ACCEPT_ENCODING
@ HTTP_FIELD_ACCEPT_ENCODING
Definition: output-json-http.c:83
LOG_DIR_FLOW
@ LOG_DIR_FLOW
Definition: output-eve-bindgen.h:33
app-layer-parser.h
HTTP_FIELD_SERVER
@ HTTP_FIELD_SERVER
Definition: output-json-http.c:123
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:501
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:80
name
const char * name
Definition: tm-threads.c:2163
HttpXFFCfg_
Definition: app-layer-htp-xff.h:41
util-proto-name.h
FLOW_PKT_TOCLIENT
#define FLOW_PKT_TOCLIENT
Definition: flow.h:226
HtpTxUserData_::response_body
HtpBody response_body
Definition: app-layer-htp.h:165
AppLayerParserGetTx
void * AppLayerParserGetTx(uint8_t ipproto, AppProto alproto, void *alstate, uint64_t tx_id)
Definition: app-layer-parser.c:1095
HTTP_FIELD_CONTENT_MD5
@ HTTP_FIELD_CONTENT_MD5
Definition: output-json-http.c:110
SCConfNodeLookupChild
SCConfNode * SCConfNodeLookupChild(const SCConfNode *node, const char *name)
Lookup a child configuration node by name.
Definition: conf.c:796
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:546
HtpBody_
Definition: app-layer-htp.h:130
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:94
LOG_HTTP_REQ_HEADERS
#define LOG_HTTP_REQ_HEADERS
Definition: output-json-http.c:77
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
http_fields
struct @136 http_fields[]
CreateEveHeaderWithTxId
SCJsonBuilder * CreateEveHeaderWithTxId(const Packet *p, enum SCOutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, uint64_t tx_id, OutputJsonCtx *eve_ctx)
Definition: output-json.c:935
HTTP_FIELD_VARY
@ HTTP_FIELD_VARY
Definition: output-json-http.c:128
HtpTxUserData_
Definition: app-layer-htp.h:151
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
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:485
HttpXFFCfg_::flags
uint8_t flags
Definition: app-layer-htp-xff.h:42
EveHttpLogJSONBodyBase64
void EveHttpLogJSONBodyBase64(SCJsonBuilder *js, Flow *f, uint64_t tx_id)
Definition: output-json-http.c:413
SCFree
#define SCFree(p)
Definition: util-mem.h:61
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
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:637
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
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:285
SCConfNode_
Definition: conf.h:37
SCConfNode_::val
char * val
Definition: conf.h:39
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