scripts: fix setup app layer for output

using rust nowadays.

Also remove useless code about files that do not need changes
anymore
pull/8815/head
Philippe Antoine 3 years ago committed by Victor Julien
parent 5b2605bdfe
commit e1046239ea

@ -210,16 +210,6 @@ def logger_patch_suricata_yaml_in(proto):
open(filename, "w").write(output.getvalue())
def logger_patch_suricata_common_h(proto):
filename = "src/suricata-common.h"
print("Patching %s." % (filename))
output = io.StringIO()
with open(filename) as infile:
for line in infile:
if line.find("LOGGER_JSON_TEMPLATE,") > -1:
output.write(line.replace("TEMPLATE", proto.upper()))
output.write(line)
open(filename, "w").write(output.getvalue())
def logger_patch_output_c(proto):
filename = "src/output.c"
@ -239,9 +229,9 @@ def logger_copy_templates(proto):
lower = proto.lower()
pairs = (
("src/output-json-template-rust.h",
("src/output-json-template.h",
"src/output-json-%s.h" % (lower)),
("src/output-json-template-rust.c",
("src/output-json-template.c",
"src/output-json-%s.c" % (lower)),
("rust/src/applayertemplate/logger.rs",
"rust/src/applayer%s/logger.rs" % (lower)),
@ -260,16 +250,6 @@ def logger_patch_makefile_am(protoname):
output.write(line)
open(filename, "w").write(output.getvalue())
def logger_patch_util_profiling_c(proto):
filename = "src/util-profiling.c"
print("Patching %s." % (filename))
output = io.StringIO()
with open(filename) as infile:
for line in infile:
if line.find("(LOGGER_JSON_TEMPLATE);") > -1:
output.write(line.replace("TEMPLATE", proto.upper()))
output.write(line)
open(filename, "w").write(output.getvalue())
def detect_copy_templates(proto, buffername):
lower = proto.lower()
@ -432,10 +412,8 @@ def main():
logger_copy_templates(proto)
patch_rust_applayer_mod_rs(proto)
logger_patch_makefile_am(proto)
logger_patch_suricata_common_h(proto)
logger_patch_output_c(proto)
logger_patch_suricata_yaml_in(proto)
logger_patch_util_profiling_c(proto)
if detect:
if not proto_exists(proto):

@ -425,7 +425,7 @@ noinst_HEADERS = \
output-json-snmp.h \
output-json-ssh.h \
output-json-stats.h \
output-json-template-rust.h \
output-json-template.h \
output-json-tftp.h \
output-json-tls.h \
output-eve-syslog.h \
@ -1034,7 +1034,7 @@ libsuricata_c_a_SOURCES = \
output-json-snmp.c \
output-json-ssh.c \
output-json-stats.c \
output-json-template-rust.c \
output-json-template.c \
output-json-tftp.c \
output-json-tls.c \
output-eve-syslog.c \

@ -1,178 +0,0 @@
/* 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-rust.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 JsonTemplateRustLogRegister(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.");
}

@ -1,4 +1,4 @@
/* Copyright (C) 2015-2021 Open Information Security Foundation
/* 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
@ -49,11 +49,11 @@
#include "app-layer.h"
#include "app-layer-parser.h"
#include "app-layer-template.h"
#include "output-json-template.h"
#include "rust.h"
typedef struct LogTemplateFileCtx_ {
uint32_t flags;
uint32_t flags;
OutputJsonCtx *eve_ctx;
} LogTemplateFileCtx;
@ -62,14 +62,12 @@ typedef struct LogTemplateLogThread_ {
OutputJsonThreadCtx *ctx;
} LogTemplateLogThread;
static int JsonTemplateLogger(ThreadVars *tv, void *thread_data,
const Packet *p, Flow *f, void *state, void *tx, uint64_t tx_id)
static int JsonTemplateLogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f,
void *state, void *tx, uint64_t tx_id)
{
TemplateTransaction *templatetx = tx;
SCLogNotice("JsonTemplateLogger");
LogTemplateLogThread *thread = thread_data;
SCLogNotice("Logging template transaction %"PRIu64".", templatetx->tx_id);
JsonBuilder *js =
CreateEveHeader(p, LOG_DIR_PACKET, "template", NULL, thread->templatelog_ctx->eve_ctx);
if (unlikely(js == NULL)) {
@ -77,26 +75,19 @@ static int JsonTemplateLogger(ThreadVars *tv, void *thread_data,
}
jb_open_object(js, "template");
/* Log the request buffer. */
if (templatetx->request_buffer != NULL) {
jb_set_string_from_bytes(js, "request", templatetx->request_buffer,
templatetx->request_buffer_len);
if (!rs_template_logger_log(tx, js)) {
goto error;
}
/* Log the response buffer. */
if (templatetx->response_buffer != NULL) {
jb_set_string_from_bytes(js, "response", templatetx->response_buffer,
templatetx->response_buffer_len);
}
/* Close template. */
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)
@ -106,8 +97,7 @@ static void OutputTemplateLogDeInitCtxSub(OutputCtx *output_ctx)
SCFree(output_ctx);
}
static OutputInitResult OutputTemplateLogInitSub(ConfNode *conf,
OutputCtx *parent_ctx)
static OutputInitResult OutputTemplateLogInitSub(ConfNode *conf, OutputCtx *parent_ctx)
{
OutputInitResult result = { NULL, false };
OutputJsonCtx *ajt = parent_ctx->data;

@ -24,6 +24,6 @@
#ifndef __OUTPUT_JSON_TEMPLATE_RUST_H__
#define __OUTPUT_JSON_TEMPLATE_RUST_H__
void JsonTemplateRustLogRegister(void);
void JsonTemplateLogRegister(void);
#endif /* __OUTPUT_JSON_TEMPLATE_RUST_H__ */

@ -78,7 +78,7 @@
#include "output-json-rfb.h"
#include "output-json-mqtt.h"
#include "output-json-pgsql.h"
#include "output-json-template-rust.h"
#include "output-json-template.h"
#include "output-json-rdp.h"
#include "output-json-http2.h"
#include "output-lua.h"
@ -1115,8 +1115,8 @@ void OutputRegisterLoggers(void)
JsonMQTTLogRegister();
/* Pgsql JSON logger. */
JsonPgsqlLogRegister();
/* Template Rust JSON logger. */
JsonTemplateRustLogRegister();
/* Template JSON logger. */
JsonTemplateLogRegister();
/* RDP JSON logger. */
JsonRdpLogRegister();
/* DCERPC JSON logger. */

Loading…
Cancel
Save