suricata/src/output-json-ike.c

/* Copyright (C) 2018-2021 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.
 */

/**
 * \file
 *
 * \author Pierre Chifflier <chifflier@wzdftpd.net>
 * \author Frank Honza <frank.honza@dcso.de>
 *
 * Implement JSON/eve logging app-layer IKE.
 */

#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 "app-layer-ike.h"
#include "output-json-ike.h"

#include "rust.h"

#define LOG_IKE_DEFAULT  0
#define LOG_IKE_EXTENDED (1 << 0)

typedef struct LogIKEFileCtx_ {
    uint32_t flags;
    OutputJsonCtx *eve_ctx;
} LogIKEFileCtx;

typedef struct LogIKELogThread_ {
    LogIKEFileCtx *ikelog_ctx;
    OutputJsonThreadCtx *ctx;
} LogIKELogThread;

bool EveIKEAddMetadata(const Flow *f, uint64_t tx_id, SCJsonBuilder *js)
{
    IKEState *state = FlowGetAppState(f);
    if (state) {
        IKETransaction *tx = AppLayerParserGetTx(f->proto, ALPROTO_IKE, state, tx_id);
        if (tx) {
            return SCIkeLoggerLog(state, tx, LOG_IKE_EXTENDED, js);
        }
    }

    return false;
}

static int JsonIKELogger(ThreadVars *tv, void *thread_data, const Packet *p, Flow *f, void *state,
        void *tx, uint64_t tx_id)
{
    LogIKELogThread *thread = thread_data;
    SCJsonBuilder *jb =
            CreateEveHeader((Packet *)p, LOG_DIR_PACKET, "ike", NULL, thread->ikelog_ctx->eve_ctx);
    if (unlikely(jb == NULL)) {
        return TM_ECODE_FAILED;
    }

    LogIKEFileCtx *ike_ctx = thread->ikelog_ctx;
    if (!SCIkeLoggerLog(state, tx, ike_ctx->flags, jb)) {
        goto error;
    }

    OutputJsonBuilderBuffer(tv, p, p->flow, jb, thread->ctx);

    SCJbFree(jb);
    return TM_ECODE_OK;

error:
    SCJbFree(jb);
    return TM_ECODE_FAILED;
}

static void OutputIKELogDeInitCtxSub(OutputCtx *output_ctx)
{
    LogIKEFileCtx *ikelog_ctx = (LogIKEFileCtx *)output_ctx->data;
    SCFree(ikelog_ctx);
    SCFree(output_ctx);
}

static OutputInitResult OutputIKELogInitSub(SCConfNode *conf, OutputCtx *parent_ctx)
{
    OutputInitResult result = { NULL, false };
    OutputJsonCtx *ajt = parent_ctx->data;

    LogIKEFileCtx *ikelog_ctx = SCCalloc(1, sizeof(*ikelog_ctx));
    if (unlikely(ikelog_ctx == NULL)) {
        return result;
    }
    ikelog_ctx->eve_ctx = ajt;

    OutputCtx *output_ctx = SCCalloc(1, sizeof(*output_ctx));
    if (unlikely(output_ctx == NULL)) {
        SCFree(ikelog_ctx);
        return result;
    }

    ikelog_ctx->flags = LOG_IKE_DEFAULT;
    const char *extended = SCConfNodeLookupChildValue(conf, "extended");
    if (extended) {
        if (SCConfValIsTrue(extended)) {
            ikelog_ctx->flags = LOG_IKE_EXTENDED;
        }
    }

    output_ctx->data = ikelog_ctx;
    output_ctx->DeInit = OutputIKELogDeInitCtxSub;

    SCAppLayerParserRegisterLogger(IPPROTO_UDP, ALPROTO_IKE);

    result.ctx = output_ctx;
    result.ok = true;
    return result;
}

static TmEcode JsonIKELogThreadInit(ThreadVars *t, const void *initdata, void **data)
{
    LogIKELogThread *thread = SCCalloc(1, sizeof(*thread));
    if (unlikely(thread == NULL)) {
        return TM_ECODE_FAILED;
    }

    if (initdata == NULL) {
        SCLogDebug("Error getting context for EveLogIKE.  \"initdata\" is NULL.");
        goto error_exit;
    }

    thread->ikelog_ctx = ((OutputCtx *)initdata)->data;
    thread->ctx = CreateEveThreadCtx(t, thread->ikelog_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 JsonIKELogThreadDeinit(ThreadVars *t, void *data)
{
    LogIKELogThread *thread = (LogIKELogThread *)data;
    if (thread == NULL) {
        return TM_ECODE_OK;
    }
    FreeEveThreadCtx(thread->ctx);
    SCFree(thread);
    return TM_ECODE_OK;
}

void JsonIKELogRegister(void)
{
    /* Register as an eve sub-module. */
    OutputRegisterTxSubModule(LOGGER_JSON_TX, "eve-log", "JsonIKELog", "eve-log.ike",
            OutputIKELogInitSub, ALPROTO_IKE, JsonIKELogger, JsonIKELogThreadInit,
            JsonIKELogThreadDeinit);
}