summaryrefslogtreecommitdiffstats
path: root/src/output-json-template.c
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-19 17:39:49 +0000
commita0aa2307322cd47bbf416810ac0292925e03be87 (patch)
tree37076262a026c4b48c8a0e84f44ff9187556ca35 /src/output-json-template.c
parentInitial commit. (diff)
downloadsuricata-a0aa2307322cd47bbf416810ac0292925e03be87.tar.xz
suricata-a0aa2307322cd47bbf416810ac0292925e03be87.zip
Adding upstream version 1:7.0.3.upstream/1%7.0.3
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'src/output-json-template.c')
-rw-r--r--src/output-json-template.c178
1 files changed, 178 insertions, 0 deletions
diff --git a/src/output-json-template.c b/src/output-json-template.c
new file mode 100644
index 0000000..76d42ad
--- /dev/null
+++ b/src/output-json-template.c
@@ -0,0 +1,178 @@
+/* Copyright (C) 2018-2022 Open Information Security Foundation
+ *
+ * You can copy, redistribute or modify this Program under the terms of
+ * the GNU General Public License version 2 as published by the Free
+ * Software Foundation.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+ * GNU General Public License for more details.
+ *
+ * You should have received a copy of the GNU General Public License
+ * version 2 along with this program; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301, USA.
+ */
+
+/*
+ * TODO: Update \author in this file and in output-json-template.h.
+ * TODO: Remove SCLogNotice statements, or convert to debug.
+ * TODO: Implement your app-layers logging.
+ */
+
+/**
+ * \file
+ *
+ * \author FirstName LastName <yourname@domain>
+ *
+ * Implement JSON/eve logging app-layer Template.
+ */
+
+#include "suricata-common.h"
+#include "detect.h"
+#include "pkt-var.h"
+#include "conf.h"
+
+#include "threads.h"
+#include "threadvars.h"
+#include "tm-threads.h"
+
+#include "util-unittest.h"
+#include "util-buffer.h"
+#include "util-debug.h"
+#include "util-byte.h"
+
+#include "output.h"
+#include "output-json.h"
+
+#include "app-layer.h"
+#include "app-layer-parser.h"
+
+#include "output-json-template.h"
+#include "rust.h"
+
+typedef struct LogTemplateFileCtx_ {
+ uint32_t flags;
+ OutputJsonCtx *eve_ctx;
+} LogTemplateFileCtx;
+
+typedef struct LogTemplateLogThread_ {
+ LogTemplateFileCtx *templatelog_ctx;
+ OutputJsonThreadCtx *ctx;
+} LogTemplateLogThread;
+
+static int JsonTemplateLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f,
+ void *state, void *tx, uint64_t tx_id)
+{
+ SCLogNotice("JsonTemplateLogger");
+ LogTemplateLogThread *thread = thread_data;
+
+ JsonBuilder *js =
+ CreateEveHeader(p, LOG_DIR_PACKET, "template", NULL, thread->templatelog_ctx->eve_ctx);
+ if (unlikely(js == NULL)) {
+ return TM_ECODE_FAILED;
+ }
+
+ jb_open_object(js, "template");
+ if (!rs_template_logger_log(tx, js)) {
+ goto error;
+ }
+ jb_close(js);
+
+ OutputJsonBuilderBuffer(js, thread->ctx);
+ jb_free(js);
+
+ return TM_ECODE_OK;
+
+error:
+ jb_free(js);
+ return TM_ECODE_FAILED;
+}
+
+static void OutputTemplateLogDeInitCtxSub(OutputCtx *output_ctx)
+{
+ LogTemplateFileCtx *templatelog_ctx = (LogTemplateFileCtx *)output_ctx->data;
+ SCFree(templatelog_ctx);
+ SCFree(output_ctx);
+}
+
+static OutputInitResult OutputTemplateLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
+{
+ OutputInitResult result = { NULL, false };
+ OutputJsonCtx *ajt = parent_ctx->data;
+
+ LogTemplateFileCtx *templatelog_ctx = SCCalloc(1, sizeof(*templatelog_ctx));
+ if (unlikely(templatelog_ctx == NULL)) {
+ return result;
+ }
+ templatelog_ctx->eve_ctx = ajt;
+
+ OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
+ if (unlikely(output_ctx == NULL)) {
+ SCFree(templatelog_ctx);
+ return result;
+ }
+ output_ctx->data = templatelog_ctx;
+ output_ctx->DeInit = OutputTemplateLogDeInitCtxSub;
+
+ SCLogNotice("Template log sub-module initialized.");
+
+ AppLayerParserRegisterLogger(IPPROTO_TCP, ALPROTO_TEMPLATE);
+
+ result.ctx = output_ctx;
+ result.ok = true;
+ return result;
+}
+
+static TmEcode JsonTemplateLogThreadInit(ThreadVars *t, const void *initdata, void **data)
+{
+ LogTemplateLogThread *thread = SCCalloc(1, sizeof(*thread));
+ if (unlikely(thread == NULL)) {
+ return TM_ECODE_FAILED;
+ }
+
+ if (initdata == NULL) {
+ SCLogDebug("Error getting context for EveLogTemplate. \"initdata\" is NULL.");
+ goto error_exit;
+ }
+
+ thread->templatelog_ctx = ((OutputCtx *)initdata)->data;
+ thread->ctx = CreateEveThreadCtx(t, thread->templatelog_ctx->eve_ctx);
+ if (!thread->ctx) {
+ goto error_exit;
+ }
+ *data = (void *)thread;
+
+ return TM_ECODE_OK;
+
+error_exit:
+ SCFree(thread);
+ return TM_ECODE_FAILED;
+}
+
+static TmEcode JsonTemplateLogThreadDeinit(ThreadVars *t, void *data)
+{
+ LogTemplateLogThread *thread = (LogTemplateLogThread *)data;
+ if (thread == NULL) {
+ return TM_ECODE_OK;
+ }
+ FreeEveThreadCtx(thread->ctx);
+ SCFree(thread);
+ return TM_ECODE_OK;
+}
+
+void JsonTemplateLogRegister(void)
+{
+ /* TEMPLATE_START_REMOVE */
+ if (ConfGetNode("app-layer.protocols.template") == NULL) {
+ return;
+ }
+ /* TEMPLATE_END_REMOVE */
+ /* Register as an eve sub-module. */
+ OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonTemplateLog", "eve-log.template",
+ OutputTemplateLogInitSub, ALPROTO_TEMPLATE, JsonTemplateLogger,
+ JsonTemplateLogThreadInit, JsonTemplateLogThreadDeinit, NULL);
+
+ SCLogNotice("Template JSON logger registered.");
+}