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