suricata
output-json-mqtt.c
Go to the documentation of this file.
1 /* Copyright (C) 2020-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 Sascha Steinbiss <sascha@steinbiss.name>
22  */
23 
24 #include "suricata-common.h"
25 #include "detect.h"
26 #include "pkt-var.h"
27 #include "conf.h"
28 
29 #include "threads.h"
30 #include "threadvars.h"
31 #include "tm-threads.h"
32 
33 #include "util-unittest.h"
34 #include "util-buffer.h"
35 #include "util-debug.h"
36 #include "util-byte.h"
37 
38 #include "output.h"
39 #include "output-json.h"
40 
41 #include "app-layer.h"
42 #include "app-layer-parser.h"
43 
44 #include "output-json-mqtt.h"
45 #include "rust.h"
46 
47 #define MQTT_LOG_PASSWORDS BIT_U32(0)
48 #define MQTT_DEFAULTS (MQTT_LOG_PASSWORDS)
49 
50 typedef struct LogMQTTFileCtx_ {
51  uint32_t flags;
54 
55 typedef struct LogMQTTLogThread_ {
57  uint32_t count;
60 
61 bool JsonMQTTAddMetadata(void *vtx, JsonBuilder *js)
62 {
63  return rs_mqtt_logger_log(vtx, MQTT_DEFAULTS, js);
64 }
65 
66 static int JsonMQTTLogger(ThreadVars *tv, void *thread_data,
67  const Packet *p, Flow *f, void *state, void *tx, uint64_t tx_id)
68 {
69  LogMQTTLogThread *thread = thread_data;
70  enum OutputJsonLogDirection dir;
71 
72  if (rs_mqtt_tx_is_toclient((MQTTTransaction*) tx)) {
74  } else {
76  }
77 
78  JsonBuilder *js = CreateEveHeader(p, dir, "mqtt", NULL, thread->mqttlog_ctx->eve_ctx);
79  if (unlikely(js == NULL)) {
80  return TM_ECODE_FAILED;
81  }
82 
83  if (!rs_mqtt_logger_log(tx, thread->mqttlog_ctx->flags, js))
84  goto error;
85 
86  OutputJsonBuilderBuffer(js, thread->ctx);
87  jb_free(js);
88 
89  return TM_ECODE_OK;
90 
91 error:
92  jb_free(js);
93  return TM_ECODE_FAILED;
94 }
95 
96 static void OutputMQTTLogDeInitCtxSub(OutputCtx *output_ctx)
97 {
98  LogMQTTFileCtx *mqttlog_ctx = (LogMQTTFileCtx *)output_ctx->data;
99  SCFree(mqttlog_ctx);
100  SCFree(output_ctx);
101 }
102 
103 static void JsonMQTTLogParseConfig(ConfNode *conf, LogMQTTFileCtx *mqttlog_ctx)
104 {
105  const char *query = ConfNodeLookupChildValue(conf, "passwords");
106  if (query != NULL) {
107  if (ConfValIsTrue(query)) {
108  mqttlog_ctx->flags |= MQTT_LOG_PASSWORDS;
109  } else {
110  mqttlog_ctx->flags &= ~MQTT_LOG_PASSWORDS;
111  }
112  } else {
113  mqttlog_ctx->flags |= MQTT_LOG_PASSWORDS;
114  }
115 }
116 
117 static OutputInitResult OutputMQTTLogInitSub(ConfNode *conf,
118  OutputCtx *parent_ctx)
119 {
120  OutputInitResult result = { NULL, false };
121  OutputJsonCtx *ajt = parent_ctx->data;
122 
123  LogMQTTFileCtx *mqttlog_ctx = SCCalloc(1, sizeof(*mqttlog_ctx));
124  if (unlikely(mqttlog_ctx == NULL)) {
125  return result;
126  }
127  mqttlog_ctx->eve_ctx = ajt;
128 
129  OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
130  if (unlikely(output_ctx == NULL)) {
131  SCFree(mqttlog_ctx);
132  return result;
133  }
134  output_ctx->data = mqttlog_ctx;
135  output_ctx->DeInit = OutputMQTTLogDeInitCtxSub;
136 
137  JsonMQTTLogParseConfig(conf, mqttlog_ctx);
138 
140 
141  result.ctx = output_ctx;
142  result.ok = true;
143  return result;
144 }
145 
146 static TmEcode JsonMQTTLogThreadInit(ThreadVars *t, const void *initdata, void **data)
147 {
148  LogMQTTLogThread *thread = SCCalloc(1, sizeof(*thread));
149  if (unlikely(thread == NULL)) {
150  return TM_ECODE_FAILED;
151  }
152 
153  if (initdata == NULL) {
154  SCLogDebug("Error getting context for EveLogMQTT. \"initdata\" is NULL.");
155  SCFree(thread);
156  return TM_ECODE_FAILED;
157  }
158 
159  thread->mqttlog_ctx = ((OutputCtx *)initdata)->data;
160  thread->ctx = CreateEveThreadCtx(t, thread->mqttlog_ctx->eve_ctx);
161  if (unlikely(thread->ctx == NULL)) {
162  SCFree(thread);
163  return TM_ECODE_FAILED;
164  }
165 
166  *data = (void *)thread;
167 
168  return TM_ECODE_OK;
169 }
170 
171 static TmEcode JsonMQTTLogThreadDeinit(ThreadVars *t, void *data)
172 {
173  LogMQTTLogThread *thread = (LogMQTTLogThread *)data;
174  if (thread == NULL) {
175  return TM_ECODE_OK;
176  }
177  FreeEveThreadCtx(thread->ctx);
178  SCFree(thread);
179  return TM_ECODE_OK;
180 }
181 
183 {
184  OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonMQTTLog", "eve-log.mqtt",
185  OutputMQTTLogInitSub, ALPROTO_MQTT, JsonMQTTLogger, JsonMQTTLogThreadInit,
186  JsonMQTTLogThreadDeinit, NULL);
187 }
util-byte.h
tm-threads.h
unlikely
#define unlikely(expr)
Definition: util-optimize.h:35
output-json-mqtt.h
LogMQTTLogThread_
Definition: output-json-mqtt.c:55
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:269
FreeEveThreadCtx
void FreeEveThreadCtx(OutputJsonThreadCtx *ctx)
Definition: output-json-common.c:58
threads.h
OutputJsonCtx_
Definition: output-json.h:81
Flow_
Flow data structure.
Definition: flow.h:356
OutputJsonBuilderBuffer
int OutputJsonBuilderBuffer(JsonBuilder *js, OutputJsonThreadCtx *ctx)
Definition: output-json.c:931
CreateEveThreadCtx
OutputJsonThreadCtx * CreateEveThreadCtx(ThreadVars *t, OutputJsonCtx *ctx)
Definition: output-json-common.c:29
rust.h
LogMQTTLogThread_::ctx
OutputJsonThreadCtx * ctx
Definition: output-json-mqtt.c:58
MQTT_LOG_PASSWORDS
#define MQTT_LOG_PASSWORDS
Definition: output-json-mqtt.c:47
TM_ECODE_FAILED
@ TM_ECODE_FAILED
Definition: tm-threads-common.h:85
util-unittest.h
ConfValIsTrue
int ConfValIsTrue(const char *val)
Check if a value is true.
Definition: conf.c:537
OutputCtx_::data
void * data
Definition: tm-modules.h:88
TM_ECODE_OK
@ TM_ECODE_OK
Definition: tm-threads-common.h:84
OutputCtx_
Definition: tm-modules.h:85
OutputJsonThreadCtx_
Definition: output-json.h:89
LogMQTTFileCtx_::flags
uint32_t flags
Definition: output-json-mqtt.c:51
util-debug.h
OutputInitResult_::ctx
OutputCtx * ctx
Definition: output.h:47
output-json.h
AppLayerParserRegisterLogger
void AppLayerParserRegisterLogger(uint8_t ipproto, AppProto alproto)
Definition: app-layer-parser.c:463
CreateEveHeader
JsonBuilder * CreateEveHeader(const Packet *p, enum OutputJsonLogDirection dir, const char *event_type, JsonAddrInfo *addr, OutputJsonCtx *eve_ctx)
Definition: output-json.c:780
detect.h
ThreadVars_
Per thread variable structure.
Definition: threadvars.h:57
pkt-var.h
OutputInitResult_::ok
bool ok
Definition: output.h:48
app-layer-parser.h
JsonMQTTLogRegister
void JsonMQTTLogRegister(void)
Definition: output-json-mqtt.c:182
Packet_
Definition: decode.h:482
conf.h
TmEcode
TmEcode
Definition: tm-threads-common.h:83
LOG_DIR_FLOW_TOCLIENT
@ LOG_DIR_FLOW_TOCLIENT
Definition: output-json.h:39
LogMQTTLogThread_::mqttlog_ctx
LogMQTTFileCtx * mqttlog_ctx
Definition: output-json-mqtt.c:56
OutputInitResult_
Definition: output.h:46
suricata-common.h
OutputCtx_::DeInit
void(* DeInit)(struct OutputCtx_ *)
Definition: tm-modules.h:91
LogMQTTFileCtx_::eve_ctx
OutputJsonCtx * eve_ctx
Definition: output-json-mqtt.c:52
LogMQTTFileCtx_
Definition: output-json-mqtt.c:50
OutputJsonLogDirection
OutputJsonLogDirection
Definition: output-json.h:36
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:405
tv
ThreadVars * tv
Definition: fuzz_decodepcapfile.c:32
threadvars.h
LOGGER_JSON_TX
@ LOGGER_JSON_TX
Definition: suricata-common.h:467
LOG_DIR_FLOW_TOSERVER
@ LOG_DIR_FLOW_TOSERVER
Definition: output-json.h:40
SCFree
#define SCFree(p)
Definition: util-mem.h:61
ConfNode_
Definition: conf.h:32
JsonMQTTAddMetadata
bool JsonMQTTAddMetadata(void *vtx, JsonBuilder *js)
Definition: output-json-mqtt.c:61
LogMQTTLogThread
struct LogMQTTLogThread_ LogMQTTLogThread
util-buffer.h
MQTT_DEFAULTS
#define MQTT_DEFAULTS
Definition: output-json-mqtt.c:48
ALPROTO_MQTT
@ ALPROTO_MQTT
Definition: app-layer-protos.h:56
LogMQTTLogThread_::count
uint32_t count
Definition: output-json-mqtt.c:57
SCCalloc
#define SCCalloc(nm, sz)
Definition: util-mem.h:53
output.h
app-layer.h
ConfNodeLookupChildValue
const char * ConfNodeLookupChildValue(const ConfNode *node, const char *name)
Lookup the value of a child configuration node by name.
Definition: conf.c:814
LogMQTTFileCtx
struct LogMQTTFileCtx_ LogMQTTFileCtx