suricata
output-json-ikev2.c
Go to the documentation of this file.
1 /* Copyright (C) 2018 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 Pierre Chifflier <chifflier@wzdftpd.net>
22  *
23  * Implement JSON/eve logging app-layer IKEv2.
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-unittest.h"
37 #include "util-buffer.h"
38 #include "util-debug.h"
39 #include "util-byte.h"
40 
41 #include "output.h"
42 #include "output-json.h"
43 
44 #include "app-layer.h"
45 #include "app-layer-parser.h"
46 
47 #include "app-layer-ikev2.h"
48 #include "output-json-ikev2.h"
49 
50 #ifdef HAVE_RUST
51 #ifdef HAVE_LIBJANSSON
52 
53 #include "rust.h"
54 #include "rust-ikev2-log-gen.h"
55 
56 typedef struct LogIKEv2FileCtx_ {
57  LogFileCtx *file_ctx;
58  OutputJsonCommonSettings cfg;
59 } LogIKEv2FileCtx;
60 
61 typedef struct LogIKEv2LogThread_ {
62  LogIKEv2FileCtx *ikev2log_ctx;
63  MemBuffer *buffer;
64 } LogIKEv2LogThread;
65 
66 static int JsonIKEv2Logger(ThreadVars *tv, void *thread_data,
67  const Packet *p, Flow *f, void *state, void *tx, uint64_t tx_id)
68 {
69  IKEV2Transaction *ikev2tx = tx;
70  LogIKEv2LogThread *thread = thread_data;
71  json_t *js, *ikev2js;
72 
73  js = CreateJSONHeader((Packet *)p, LOG_DIR_PACKET, "ikev2");
74  if (unlikely(js == NULL)) {
75  return TM_ECODE_FAILED;
76  }
77 
78  JsonAddCommonOptions(&thread->ikev2log_ctx->cfg, p, f, js);
79 
80  ikev2js = rs_ikev2_log_json_response(state, ikev2tx);
81  if (unlikely(ikev2js == NULL)) {
82  goto error;
83  }
84  json_object_set_new(js, "ikev2", ikev2js);
85 
86  MemBufferReset(thread->buffer);
87  OutputJSONBuffer(js, thread->ikev2log_ctx->file_ctx, &thread->buffer);
88 
89  json_decref(js);
90  return TM_ECODE_OK;
91 
92 error:
93  json_decref(js);
94  return TM_ECODE_FAILED;
95 }
96 
97 static void OutputIKEv2LogDeInitCtxSub(OutputCtx *output_ctx)
98 {
99  LogIKEv2FileCtx *ikev2log_ctx = (LogIKEv2FileCtx *)output_ctx->data;
100  SCFree(ikev2log_ctx);
101  SCFree(output_ctx);
102 }
103 
104 static OutputInitResult OutputIKEv2LogInitSub(ConfNode *conf,
105  OutputCtx *parent_ctx)
106 {
107  OutputInitResult result = { NULL, false };
108  OutputJsonCtx *ajt = parent_ctx->data;
109 
110  LogIKEv2FileCtx *ikev2log_ctx = SCCalloc(1, sizeof(*ikev2log_ctx));
111  if (unlikely(ikev2log_ctx == NULL)) {
112  return result;
113  }
114  ikev2log_ctx->file_ctx = ajt->file_ctx;
115  ikev2log_ctx->cfg = ajt->cfg;
116 
117  OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
118  if (unlikely(output_ctx == NULL)) {
119  SCFree(ikev2log_ctx);
120  return result;
121  }
122  output_ctx->data = ikev2log_ctx;
123  output_ctx->DeInit = OutputIKEv2LogDeInitCtxSub;
124 
125  SCLogDebug("IKEv2 log sub-module initialized.");
126 
128 
129  result.ctx = output_ctx;
130  result.ok = true;
131  return result;
132 }
133 
134 static TmEcode JsonIKEv2LogThreadInit(ThreadVars *t, const void *initdata, void **data)
135 {
136  LogIKEv2LogThread *thread = SCCalloc(1, sizeof(*thread));
137  if (unlikely(thread == NULL)) {
138  return TM_ECODE_FAILED;
139  }
140 
141  if (initdata == NULL) {
142  SCLogDebug("Error getting context for EveLogIKEv2. \"initdata\" is NULL.");
143  SCFree(thread);
144  return TM_ECODE_FAILED;
145  }
146 
147  thread->buffer = MemBufferCreateNew(JSON_OUTPUT_BUFFER_SIZE);
148  if (unlikely(thread->buffer == NULL)) {
149  SCFree(thread);
150  return TM_ECODE_FAILED;
151  }
152 
153  thread->ikev2log_ctx = ((OutputCtx *)initdata)->data;
154  *data = (void *)thread;
155 
156  return TM_ECODE_OK;
157 }
158 
159 static TmEcode JsonIKEv2LogThreadDeinit(ThreadVars *t, void *data)
160 {
161  LogIKEv2LogThread *thread = (LogIKEv2LogThread *)data;
162  if (thread == NULL) {
163  return TM_ECODE_OK;
164  }
165  if (thread->buffer != NULL) {
166  MemBufferFree(thread->buffer);
167  }
168  SCFree(thread);
169  return TM_ECODE_OK;
170 }
171 
172 void JsonIKEv2LogRegister(void)
173 {
174  /* Register as an eve sub-module. */
175  OutputRegisterTxSubModule(LOGGER_JSON_IKEV2, "eve-log", "JsonIKEv2Log",
176  "eve-log.ikev2", OutputIKEv2LogInitSub, ALPROTO_IKEV2,
177  JsonIKEv2Logger, JsonIKEv2LogThreadInit,
178  JsonIKEv2LogThreadDeinit, NULL);
179 
180  SCLogDebug("IKEv2 JSON logger registered.");
181 }
182 
183 #else /* No JSON support. */
184 
185 void JsonIKEv2LogRegister(void)
186 {
187 }
188 
189 #endif /* HAVE_LIBJANSSON */
190 #else /* No rust support. */
191 
193 {
194 }
195 
196 #endif /* HAVE_RUST */
MemBuffer * MemBufferCreateNew(uint32_t size)
Definition: util-buffer.c:32
#define SCLogDebug(...)
Definition: util-debug.h:335
#define unlikely(expr)
Definition: util-optimize.h:35
#define MemBufferReset(mem_buffer)
Reset the mem buffer.
Definition: util-buffer.h:42
void JsonIKEv2LogRegister(void)
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:84
#define SCCalloc(nm, a)
Definition: util-mem.h:253
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
struct IKEV2Transaction_ IKEV2Transaction
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:400
Definition: conf.h:32
OutputCtx * ctx
Definition: output.h:42
#define SCFree(a)
Definition: util-mem.h:322
uint16_t tx_id
void * data
Definition: tm-modules.h:81
Per thread variable structure.
Definition: threadvars.h:57
Flow data structure.
Definition: flow.h:325
void MemBufferFree(MemBuffer *buffer)
Definition: util-buffer.c:82