suricata
output-json-template.c
Go to the documentation of this file.
1 /* Copyright (C) 2015-2020 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  * TODO: Update \author in this file and in output-json-template.h.
20  * TODO: Remove SCLogNotice statements, or convert to debug.
21  * TODO: Implement your app-layers logging.
22  */
23 
24 /**
25  * \file
26  *
27  * \author FirstName LastName <yourname@domain>
28  *
29  * Implement JSON/eve logging app-layer Template.
30  */
31 
32 #include "suricata-common.h"
33 #include "debug.h"
34 #include "detect.h"
35 #include "pkt-var.h"
36 #include "conf.h"
37 
38 #include "threads.h"
39 #include "threadvars.h"
40 #include "tm-threads.h"
41 
42 #include "util-unittest.h"
43 #include "util-buffer.h"
44 #include "util-debug.h"
45 #include "util-byte.h"
46 
47 #include "output.h"
48 #include "output-json.h"
49 
50 #include "app-layer.h"
51 #include "app-layer-parser.h"
52 
53 #include "app-layer-template.h"
54 #include "output-json-template.h"
55 
56 typedef struct LogTemplateFileCtx_ {
58  uint32_t flags;
60 
61 typedef struct LogTemplateLogThread_ {
66 
67 static int JsonTemplateLogger(ThreadVars *tv, void *thread_data,
68  const Packet *p, Flow *f, void *state, void *tx, uint64_t tx_id)
69 {
70  TemplateTransaction *templatetx = tx;
71  LogTemplateLogThread *thread = thread_data;
72 
73  SCLogNotice("Logging template transaction %"PRIu64".", templatetx->tx_id);
74 
75  JsonBuilder *js = CreateEveHeader(p, LOG_DIR_PACKET, "template", NULL);
76  if (unlikely(js == NULL)) {
77  return TM_ECODE_FAILED;
78  }
79 
80  jb_open_object(js, "template");
81 
82  /* Log the request buffer. */
83  if (templatetx->request_buffer != NULL) {
84  jb_set_string_from_bytes(js, "request", templatetx->request_buffer,
85  templatetx->request_buffer_len);
86  }
87 
88  /* Log the response buffer. */
89  if (templatetx->response_buffer != NULL) {
90  jb_set_string_from_bytes(js, "response", templatetx->response_buffer,
91  templatetx->response_buffer_len);
92  }
93 
94  /* Close template. */
95  jb_close(js);
96 
97  MemBufferReset(thread->buffer);
98  OutputJsonBuilderBuffer(js, thread->file_ctx, &thread->buffer);
99 
100  jb_free(js);
101  return TM_ECODE_OK;
102 }
103 
104 static void OutputTemplateLogDeInitCtxSub(OutputCtx *output_ctx)
105 {
106  LogTemplateFileCtx *templatelog_ctx = (LogTemplateFileCtx *)output_ctx->data;
107  SCFree(templatelog_ctx);
108  SCFree(output_ctx);
109 }
110 
111 static OutputInitResult OutputTemplateLogInitSub(ConfNode *conf,
112  OutputCtx *parent_ctx)
113 {
114  OutputInitResult result = { NULL, false };
115  OutputJsonCtx *ajt = parent_ctx->data;
116 
117  LogTemplateFileCtx *templatelog_ctx = SCCalloc(1, sizeof(*templatelog_ctx));
118  if (unlikely(templatelog_ctx == NULL)) {
119  return result;
120  }
121  templatelog_ctx->file_ctx = ajt->file_ctx;
122 
123  OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
124  if (unlikely(output_ctx == NULL)) {
125  SCFree(templatelog_ctx);
126  return result;
127  }
128  output_ctx->data = templatelog_ctx;
129  output_ctx->DeInit = OutputTemplateLogDeInitCtxSub;
130 
131  SCLogNotice("Template log sub-module initialized.");
132 
134 
135  result.ctx = output_ctx;
136  result.ok = true;
137  return result;
138 }
139 
140 static TmEcode JsonTemplateLogThreadInit(ThreadVars *t, const void *initdata, void **data)
141 {
142  LogTemplateLogThread *thread = SCCalloc(1, sizeof(*thread));
143  if (unlikely(thread == NULL)) {
144  return TM_ECODE_FAILED;
145  }
146 
147  if (initdata == NULL) {
148  SCLogDebug("Error getting context for EveLogTemplate. \"initdata\" is NULL.");
149  goto error_exit;
150  }
151 
153  if (unlikely(thread->buffer == NULL)) {
154  goto error_exit;
155  }
156 
157  thread->templatelog_ctx = ((OutputCtx *)initdata)->data;
158  thread->file_ctx = LogFileEnsureExists(thread->templatelog_ctx->file_ctx, t->id);
159  if (!thread->file_ctx) {
160  goto error_exit;
161  }
162  *data = (void *)thread;
163 
164  return TM_ECODE_OK;
165 
166 error_exit:
167  if (thread->buffer != NULL) {
168  MemBufferFree(thread->buffer);
169  }
170  SCFree(thread);
171  return TM_ECODE_FAILED;
172 }
173 
174 static TmEcode JsonTemplateLogThreadDeinit(ThreadVars *t, void *data)
175 {
176  LogTemplateLogThread *thread = (LogTemplateLogThread *)data;
177  if (thread == NULL) {
178  return TM_ECODE_OK;
179  }
180  if (thread->buffer != NULL) {
181  MemBufferFree(thread->buffer);
182  }
183  SCFree(thread);
184  return TM_ECODE_OK;
185 }
186 
188 {
189  /* TEMPLATE_START_REMOVE */
190  if (ConfGetNode("app-layer.protocols.template") == NULL) {
191  return;
192  }
193  /* TEMPLATE_END_REMOVE */
194  /* Register as an eve sub-module. */
195  OutputRegisterTxSubModule(LOGGER_JSON_TEMPLATE, "eve-log", "JsonTemplateLog",
196  "eve-log.template", OutputTemplateLogInitSub, ALPROTO_TEMPLATE,
197  JsonTemplateLogger, JsonTemplateLogThreadInit,
198  JsonTemplateLogThreadDeinit, NULL);
199 
200  SCLogNotice("Template JSON logger registered.");
201 }
LogTemplateLogThread_::templatelog_ctx
LogTemplateFileCtx * templatelog_ctx
Definition: output-json-template-rust.c:63
util-byte.h
LogTemplateLogThread_::buffer
MemBuffer * buffer
Definition: output-json-template-rust.c:65
tm-threads.h
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:298
ConfGetNode
ConfNode * ConfGetNode(const char *name)
Get a ConfNode by name.
Definition: conf.c:175
JSON_OUTPUT_BUFFER_SIZE
#define JSON_OUTPUT_BUFFER_SIZE
Definition: output-json.h:63
threads.h
OutputJsonCtx_
Definition: output-json.h:101
Flow_
Flow data structure.
Definition: flow.h:347
LogFileCtx_
Definition: util-logopenfile.h:60
LogTemplateLogThread
struct LogTemplateLogThread_ LogTemplateLogThread
OutputJsonBuilderBuffer
int OutputJsonBuilderBuffer(JsonBuilder *js, LogFileCtx *file_ctx, MemBuffer **buffer)
Definition: output-json.c:978
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:81
util-unittest.h
OutputCtx_::data
void * data
Definition: tm-modules.h:81
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:80
OutputCtx_
Definition: tm-modules.h:78
util-debug.h
LOGGER_JSON_TEMPLATE
@ LOGGER_JSON_TEMPLATE
Definition: suricata-common.h:468
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:44
CreateEveHeader
JsonBuilder * CreateEveHeader(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr)
Definition: output-json.c:846
output-json-template.h
output-json.h
TemplateTransaction::response_buffer_len
uint32_t response_buffer_len
Definition: app-layer-template.h:49
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:456
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
pkt-var.h
LogFileEnsureExists
LogFileCtx * LogFileEnsureExists(LogFileCtx *parent_ctx, int thread_id)
LogFileEnsureExists() Ensure a log file context for the thread exists.
Definition: util-logopenfile.c:659
OutputInitResult_::ok
bool ok
Definition: output.h:45
app-layer-parser.h
ThreadVars_::id
int id
Definition: threadvars.h:87
TemplateTransaction::request_buffer
uint8_t * request_buffer
Definition: app-layer-template.h:45
Packet_
Definition: decode.h:414
conf.h
TmEcode
TmEcode
Definition: tm-threads-common.h:79
MemBuffer_
Definition: util-buffer.h:27
TemplateTransaction
Definition: app-layer-template.h:37
MemBufferReset
#define MemBufferReset(mem_buffer)
Reset the mem buffer.
Definition: util-buffer.h:42
TemplateTransaction::response_buffer
uint8_t * response_buffer
Definition: app-layer-template.h:48
OutputInitResult_
Definition: output.h:43
TemplateTransaction::request_buffer_len
uint32_t request_buffer_len
Definition: app-layer-template.h:46
LOG_DIR_PACKET
@ LOG_DIR_PACKET
Definition: output-json.h:39
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:84
LogTemplateFileCtx_
Definition: output-json-template-rust.c:57
MemBufferFree
void MemBufferFree(MemBuffer *buffer)
Definition: util-buffer.c:82
LogTemplateFileCtx_::flags
uint32_t flags
Definition: output-json-template-rust.c:59
TemplateTransaction::tx_id
uint64_t tx_id
Definition: app-layer-template.h:39
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:409
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:29
threadvars.h
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
app-layer-template.h
LogTemplateLogThread_::file_ctx
LogFileCtx * file_ctx
Definition: output-json-template-rust.c:64
util-buffer.h
ALPROTO_TEMPLATE
@ ALPROTO_TEMPLATE
Definition: app-layer-protos.h:56
OutputJsonCtx_::file_ctx
LogFileCtx * file_ctx
Definition: output-json.h:102
LogTemplateLogThread_
Definition: output-json-template-rust.c:62
JsonTemplateLogRegister
void JsonTemplateLogRegister(void)
Definition: output-json-template.c:187
SCLogNotice
#define SCLogNotice(...)
Macro used to log NOTICE messages.
Definition: util-debug.h:232
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
MemBufferCreateNew
MemBuffer * MemBufferCreateNew(uint32_t size)
Definition: util-buffer.c:32
debug.h
output.h
LogTemplateFileCtx_::file_ctx
LogFileCtx * file_ctx
Definition: output-json-template-rust.c:58
LogTemplateFileCtx
struct LogTemplateFileCtx_ LogTemplateFileCtx
app-layer.h