suricata
output-json-template.c
Go to the documentation of this file.
1 /* Copyright (C) 2015 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_ {
63  uint32_t count;
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  json_t *js = CreateJSONHeader(p, LOG_DIR_PACKET, "template");
76  if (unlikely(js == NULL)) {
77  return TM_ECODE_FAILED;
78  }
79 
80  json_t *templatejs = json_object();
81  if (unlikely(templatejs == NULL)) {
82  goto error;
83  }
84 
85  /* Convert the request buffer to a string then log. */
86  char *request_buffer = BytesToString(templatetx->request_buffer,
87  templatetx->request_buffer_len);
88  if (request_buffer != NULL) {
89  json_object_set_new(templatejs, "request", json_string(request_buffer));
90  SCFree(request_buffer);
91  }
92 
93  /* Convert the response buffer to a string then log. */
94  char *response_buffer = BytesToString(templatetx->response_buffer,
95  templatetx->response_buffer_len);
96  if (response_buffer != NULL) {
97  json_object_set_new(templatejs, "response",
98  json_string(response_buffer));
99  SCFree(response_buffer);
100  }
101 
102  json_object_set_new(js, "template", templatejs);
103 
104  MemBufferReset(thread->buffer);
105  OutputJSONBuffer(js, thread->templatelog_ctx->file_ctx, &thread->buffer);
106 
107  json_decref(js);
108  return TM_ECODE_OK;
109 
110 error:
111  json_decref(js);
112  return TM_ECODE_FAILED;
113 }
114 
115 static void OutputTemplateLogDeInitCtxSub(OutputCtx *output_ctx)
116 {
117  LogTemplateFileCtx *templatelog_ctx = (LogTemplateFileCtx *)output_ctx->data;
118  SCFree(templatelog_ctx);
119  SCFree(output_ctx);
120 }
121 
122 static OutputInitResult OutputTemplateLogInitSub(ConfNode *conf,
123  OutputCtx *parent_ctx)
124 {
125  OutputInitResult result = { NULL, false };
126  OutputJsonCtx *ajt = parent_ctx->data;
127 
128  LogTemplateFileCtx *templatelog_ctx = SCCalloc(1, sizeof(*templatelog_ctx));
129  if (unlikely(templatelog_ctx == NULL)) {
130  return result;
131  }
132  templatelog_ctx->file_ctx = ajt->file_ctx;
133 
134  OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
135  if (unlikely(output_ctx == NULL)) {
136  SCFree(templatelog_ctx);
137  return result;
138  }
139  output_ctx->data = templatelog_ctx;
140  output_ctx->DeInit = OutputTemplateLogDeInitCtxSub;
141 
142  SCLogNotice("Template log sub-module initialized.");
143 
145 
146  result.ctx = output_ctx;
147  result.ok = true;
148  return result;
149 }
150 
151 static TmEcode JsonTemplateLogThreadInit(ThreadVars *t, const void *initdata, void **data)
152 {
153  LogTemplateLogThread *thread = SCCalloc(1, sizeof(*thread));
154  if (unlikely(thread == NULL)) {
155  return TM_ECODE_FAILED;
156  }
157 
158  if (initdata == NULL) {
159  SCLogDebug("Error getting context for EveLogTemplate. \"initdata\" is NULL.");
160  SCFree(thread);
161  return TM_ECODE_FAILED;
162  }
163 
165  if (unlikely(thread->buffer == NULL)) {
166  SCFree(thread);
167  return TM_ECODE_FAILED;
168  }
169 
170  thread->templatelog_ctx = ((OutputCtx *)initdata)->data;
171  *data = (void *)thread;
172 
173  return TM_ECODE_OK;
174 }
175 
176 static TmEcode JsonTemplateLogThreadDeinit(ThreadVars *t, void *data)
177 {
178  LogTemplateLogThread *thread = (LogTemplateLogThread *)data;
179  if (thread == NULL) {
180  return TM_ECODE_OK;
181  }
182  if (thread->buffer != NULL) {
183  MemBufferFree(thread->buffer);
184  }
185  SCFree(thread);
186  return TM_ECODE_OK;
187 }
188 
190 {
191  /* TEMPLATE_START_REMOVE */
192  if (ConfGetNode("app-layer.protocols.template") == NULL) {
193  return;
194  }
195  /* TEMPLATE_END_REMOVE */
196  /* Register as an eve sub-module. */
197  OutputRegisterTxSubModule(LOGGER_JSON_TEMPLATE, "eve-log", "JsonTemplateLog",
198  "eve-log.template", OutputTemplateLogInitSub, ALPROTO_TEMPLATE,
199  JsonTemplateLogger, JsonTemplateLogThreadInit,
200  JsonTemplateLogThreadDeinit, NULL);
201 
202  SCLogNotice("Template JSON logger registered.");
203 }
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
BytesToString
char * BytesToString(const uint8_t *bytes, size_t nbytes)
Turn byte array into string.
Definition: util-byte.c:41
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:176
JSON_OUTPUT_BUFFER_SIZE
#define JSON_OUTPUT_BUFFER_SIZE
Definition: output-json.h:44
threads.h
OutputJsonCtx_
Definition: output-json.h:78
Flow_
Flow data structure.
Definition: flow.h:343
LogFileCtx_
Definition: util-logopenfile.h:52
LogTemplateLogThread
struct LogTemplateLogThread_ LogTemplateLogThread
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:79
util-unittest.h
OutputCtx_::data
void * data
Definition: tm-modules.h:81
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:78
OutputCtx_
Definition: tm-modules.h:78
util-debug.h
LOGGER_JSON_TEMPLATE
@ LOGGER_JSON_TEMPLATE
Definition: suricata-common.h:467
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:42
output-json-template.h
output-json.h
TemplateTransaction::response_buffer_len
uint32_t response_buffer_len
Definition: app-layer-template.h:50
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:471
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:58
pkt-var.h
OutputInitResult_::ok
bool ok
Definition: output.h:43
app-layer-parser.h
TemplateTransaction::request_buffer
uint8_t * request_buffer
Definition: app-layer-template.h:43
Packet_
Definition: decode.h:411
conf.h
TmEcode
TmEcode
Definition: tm-threads-common.h:77
MemBuffer_
Definition: util-buffer.h:27
TemplateTransaction
Definition: app-layer-template.h:35
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:49
OutputInitResult_
Definition: output.h:41
TemplateTransaction::request_buffer_len
uint32_t request_buffer_len
Definition: app-layer-template.h:44
LOG_DIR_PACKET
@ LOG_DIR_PACKET
Definition: output-json.h:37
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:84
LogTemplateFileCtx_
Definition: output-json-template-rust.c:57
CreateJSONHeader
json_t * CreateJSONHeader(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type)
Definition: output-json.c:710
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:37
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
threadvars.h
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
app-layer-template.h
util-buffer.h
ALPROTO_TEMPLATE
@ ALPROTO_TEMPLATE
Definition: app-layer-protos.h:55
OutputJsonCtx_::file_ctx
LogFileCtx * file_ctx
Definition: output-json.h:79
OutputJSONBuffer
int OutputJSONBuffer(json_t *js, LogFileCtx *file_ctx, MemBuffer **buffer)
Definition: output-json.c:809
LogTemplateLogThread_
Definition: output-json-template-rust.c:62
JsonTemplateLogRegister
void JsonTemplateLogRegister(void)
Definition: output-json-template.c:189
SCLogNotice
#define SCLogNotice(...)
Macro used to log NOTICE messages.
Definition: util-debug.h:232
LogTemplateLogThread_::count
uint32_t count
Definition: output-json-template-rust.c:64
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