/* Copyright (C) 2007-2019 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.

 */

/**

 * \ingroup httplayer

 *

 * @{

 */

/**

 * \file

 *

 * \author Anoop Saldanha <anoopsaldanha@gmail.com>

 *

 * Implements support for the http_host keyword.

 */

#include "suricata-common.h"

#include "threads.h"

#include "decode.h"

#include "detect.h"

#include "detect-parse.h"

#include "detect-engine.h"

#include "detect-engine-buffer.h"

#include "detect-engine-mpm.h"

#include "detect-engine-prefilter.h"

#include "detect-content.h"

#include "detect-pcre.h"

#include "flow.h"

#include "flow-var.h"

#include "flow-util.h"

#include "util-debug.h"

#include "util-unittest.h"

#include "util-unittest-helper.h"

#include "util-spm.h"

#include "app-layer.h"

#include "app-layer-parser.h"

#include "app-layer-htp.h"

#include "stream-tcp.h"

#include "detect-http-host.h"

static int DetectHttpHHSetup(DetectEngineCtx *, Signature *, const char *);

#ifdef UNITTESTS

static void DetectHttpHHRegisterTests(void);

#endif

static bool DetectHttpHostValidateCallback(

        const Signature *s, const char **sigerror, const DetectBufferType *dbt);

static int DetectHttpHostSetup(DetectEngineCtx *, Signature *, const char *);

static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms,

        Flow *_f, const uint8_t _flow_flags,

        void *txv, const int list_id);

static InspectionBuffer *GetData2(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,

        const int list_id);

static int DetectHttpHRHSetup(DetectEngineCtx *, Signature *, const char *);

static int g_http_raw_host_buffer_id = 0;

static int DetectHttpHostRawSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str);

static InspectionBuffer *GetRawData(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f,

        const uint8_t _flow_flags, void *txv, const int list_id);

static InspectionBuffer *GetRawData2(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,

        const int list_id);

static int g_http_host_buffer_id = 0;

static int g_http2_thread_id = 0;

static int g_http2_raw_thread_id = 0;

/**

 * \brief Registers the keyword handlers for the "http_host" keyword.

 */

void DetectHttpHHRegister(void)

{

    /* http_host content modifier */

    sigmatch_table[DETECT_HTTP_HOST_CM].name = "http_host";

    sigmatch_table[DETECT_HTTP_HOST_CM].desc = "content modifier to match on the HTTP hostname";

    // no doc url for this obsolete keyword, see http.host

    sigmatch_table[DETECT_HTTP_HOST_CM].Setup = DetectHttpHHSetup;

#ifdef UNITTESTS

    sigmatch_table[DETECT_HTTP_HOST_CM].RegisterTests = DetectHttpHHRegisterTests;

#endif

    sigmatch_table[DETECT_HTTP_HOST_CM].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_CONTENT_MODIFIER;

    sigmatch_table[DETECT_HTTP_HOST_CM].alternative = DETECT_HTTP_HOST;

    /* http.host sticky buffer */

    sigmatch_table[DETECT_HTTP_HOST].name = "http.host";

    sigmatch_table[DETECT_HTTP_HOST].desc = "sticky buffer to match on the HTTP Host buffer";

    sigmatch_table[DETECT_HTTP_HOST].url = "/rules/http-keywords.html#http-host";

    sigmatch_table[DETECT_HTTP_HOST].Setup = DetectHttpHostSetup;

    sigmatch_table[DETECT_HTTP_HOST].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_STICKY_BUFFER;

    DetectAppLayerInspectEngineRegister("http_host", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,

            HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetData);

    DetectAppLayerMpmRegister("http_host", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,

            GetData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);

    DetectAppLayerInspectEngineRegisterSubState("http_host", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,

            HTTP2TxTypeStream, HTTP2ProgHeaders, DetectEngineInspectBufferGeneric, GetData2);

    DetectAppLayerMpmRegisterSubState("http_host", SIG_FLAG_TOSERVER, 2,

            PrefilterGenericMpmRegister, GetData2, ALPROTO_HTTP2, HTTP2TxTypeStream,

            HTTP2ProgHeaders);

    DetectBufferTypeRegisterValidateCallback("http_host",

            DetectHttpHostValidateCallback);

    DetectBufferTypeSetDescriptionByName("http_host",

            "http host");

    g_http2_thread_id = SCDetectRegisterThreadCtxGlobalFuncs(

            "http_host", SCDetectThreadBufDataInit, NULL, SCDetectThreadBufDataFree);

    g_http_host_buffer_id = DetectBufferTypeGetByName("http_host");

    /* http_raw_host content modifier */

    sigmatch_table[DETECT_HTTP_RAW_HOST].name = "http_raw_host";

    sigmatch_table[DETECT_HTTP_RAW_HOST].desc = "content modifier to match on the HTTP host header "

                                                "or the raw hostname from the HTTP uri";

    // no doc url for this obsolete keyword, see http.host.raw

    sigmatch_table[DETECT_HTTP_RAW_HOST].Setup = DetectHttpHRHSetup;

    sigmatch_table[DETECT_HTTP_RAW_HOST].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_CONTENT_MODIFIER;

    sigmatch_table[DETECT_HTTP_RAW_HOST].alternative = DETECT_HTTP_HOST_RAW;

    /* http.host sticky buffer */

    sigmatch_table[DETECT_HTTP_HOST_RAW].name = "http.host.raw";

    sigmatch_table[DETECT_HTTP_HOST_RAW].desc = "sticky buffer to match on the HTTP host header or the raw hostname from the HTTP uri";

    sigmatch_table[DETECT_HTTP_HOST_RAW].url = "/rules/http-keywords.html#http-host-raw";

    sigmatch_table[DETECT_HTTP_HOST_RAW].Setup = DetectHttpHostRawSetupSticky;

    sigmatch_table[DETECT_HTTP_HOST_RAW].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_STICKY_BUFFER;

    DetectAppLayerInspectEngineRegister("http_raw_host", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,

            HTP_REQUEST_PROGRESS_HEADERS, DetectEngineInspectBufferGeneric, GetRawData);

    DetectAppLayerMpmRegister("http_raw_host", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister,

            GetRawData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_HEADERS);

    DetectAppLayerInspectEngineRegisterSubState("http_raw_host", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,

            HTTP2TxTypeStream, HTTP2ProgHeaders, DetectEngineInspectBufferGeneric, GetRawData2);

    DetectAppLayerMpmRegisterSubState("http_raw_host", SIG_FLAG_TOSERVER, 2,

            PrefilterGenericMpmRegister, GetRawData2, ALPROTO_HTTP2, HTTP2TxTypeStream,

            HTTP2ProgHeaders);

    DetectBufferTypeSetDescriptionByName("http_raw_host",

            "http raw host header");

    g_http2_raw_thread_id = SCDetectRegisterThreadCtxGlobalFuncs(

            "http_raw_host", SCDetectThreadBufDataInit, NULL, SCDetectThreadBufDataFree);

    g_http_raw_host_buffer_id = DetectBufferTypeGetByName("http_raw_host");

}

/**

 * \brief The setup function for the http_host keyword for a signature.

 *

 * \param de_ctx Pointer to the detection engine context.

 * \param s      Pointer to the signature for the current Signature being

 *               parsed from the rules.

 * \param m      Pointer to the head of the SigMatch for the current rule

 *               being parsed.

 * \param arg    Pointer to the string holding the keyword value.

 *

 * \retval  0 On success

 * \retval -1 On failure

 */

static int DetectHttpHHSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)

{

    return DetectEngineContentModifierBufferSetup(

            de_ctx, s, arg, DETECT_HTTP_HOST_CM, g_http_host_buffer_id, ALPROTO_HTTP1);

}

static bool DetectHttpHostValidateCallback(

        const Signature *s, const char **sigerror, const DetectBufferType *dbt)

{

    for (uint32_t x = 0; x < s->init_data->buffer_index; x++) {

        if (s->init_data->buffers[x].id != (uint32_t)dbt->id)

            continue;

        const SigMatch *sm = s->init_data->buffers[x].head;

        for (; sm != NULL; sm = sm->next) {

            if (sm->type == DETECT_CONTENT) {

                DetectContentData *cd = (DetectContentData *)sm->ctx;

                if (cd->flags & DETECT_CONTENT_NOCASE) {

                    *sigerror = "http.host keyword "

                                "specified along with \"nocase\". "

                                "The hostname buffer is normalized "

                                "to lowercase, specifying "

                                "nocase is redundant.";

                    SCLogWarning("rule %u: %s", s->id, *sigerror);

                    return false;

                } else {

                    uint32_t u;

                    for (u = 0; u < cd->content_len; u++) {

                        if (isupper(cd->content[u]))

                            break;

                    }

                    if (u != cd->content_len) {

                        *sigerror = "A pattern with "

                                    "uppercase characters detected for http.host. "

                                    "The hostname buffer is normalized to lowercase, "

                                    "please specify a lowercase pattern.";

                        SCLogWarning("rule %u: %s", s->id, *sigerror);

                        return false;

                    }

                }

            }

        }

    }

    return true;

}

/**

 * \brief this function setup the http.host keyword used in the rule

 *

 * \param de_ctx   Pointer to the Detection Engine Context

 * \param s        Pointer to the Signature to which the current keyword belongs

 * \param str      Should hold an empty string always

 *

 * \retval 0       On success

 */

static int DetectHttpHostSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)

{

    if (SCDetectBufferSetActiveList(de_ctx, s, g_http_host_buffer_id) < 0)

        return -1;

    if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)

        return -1;

    return 0;

}

static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f,

        const uint8_t _flow_flags, void *txv, const int list_id)

{

    InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);

    if (buffer->inspect == NULL) {

        htp_tx_t *tx = (htp_tx_t *)txv;

        if (htp_tx_request_hostname(tx) == NULL)

            return NULL;

        const uint32_t data_len = (uint32_t)bstr_len(htp_tx_request_hostname(tx));

        const uint8_t *data = bstr_ptr(htp_tx_request_hostname(tx));

        SCInspectionBufferSetupAndApplyTransforms(

                det_ctx, list_id, buffer, data, data_len, transforms);

    }

    return buffer;

}

static InspectionBuffer *GetData2(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,

        const int list_id)

{

    InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);

    if (buffer->inspect == NULL) {

        uint32_t b_len = 0;

        const uint8_t *b = NULL;

        void *thread_buf = SCDetectThreadCtxGetGlobalKeywordThreadCtx(det_ctx, g_http2_thread_id);

        if (thread_buf == NULL)

            return NULL;

        if (SCHttp2TxGetHostNorm(txv, &b, &b_len, thread_buf) != 1)

            return NULL;

        if (b == NULL || b_len == 0)

            return NULL;

        SCInspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);

    }

    return buffer;

}

static InspectionBuffer *GetRawData2(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,

        const int list_id)

{

    InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);

    if (buffer->inspect == NULL) {

        uint32_t b_len = 0;

        const uint8_t *b = NULL;

        void *thread_buf =

                SCDetectThreadCtxGetGlobalKeywordThreadCtx(det_ctx, g_http2_raw_thread_id);

        if (thread_buf == NULL)

            return NULL;

        if (SCHttp2TxGetHost(txv, &b, &b_len, thread_buf) != 1)

            return NULL;

        if (b == NULL || b_len == 0)

            return NULL;

        SCInspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);

    }

    return buffer;

}

/**

 * \brief The setup function for the http_raw_host keyword for a signature.

 *

 * \param de_ctx Pointer to the detection engine context.

 * \param s      Pointer to the signature for the current Signature being

 *               parsed from the rules.

 * \param m      Pointer to the head of the SigMatch for the current rule

 *               being parsed.

 * \param arg    Pointer to the string holding the keyword value.

 *

 * \retval  0 On success

 * \retval -1 On failure

 */

int DetectHttpHRHSetup(DetectEngineCtx *de_ctx, Signature *s, const char *arg)

{

    return DetectEngineContentModifierBufferSetup(

            de_ctx, s, arg, DETECT_HTTP_RAW_HOST, g_http_raw_host_buffer_id, ALPROTO_HTTP1);

}

/**

 * \brief this function setup the http.host keyword used in the rule

 *

 * \param de_ctx   Pointer to the Detection Engine Context

 * \param s        Pointer to the Signature to which the current keyword belongs

 * \param str      Should hold an empty string always

 *

 * \retval 0       On success

 */

static int DetectHttpHostRawSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)

{

    if (SCDetectBufferSetActiveList(de_ctx, s, g_http_raw_host_buffer_id) < 0)

        return -1;

    if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)

        return -1;

    return 0;

}

static InspectionBuffer *GetRawData(DetectEngineThreadCtx *det_ctx,

        const DetectEngineTransforms *transforms, Flow *_f,

        const uint8_t _flow_flags, void *txv, const int list_id)

{

    InspectionBuffer *buffer = SCInspectionBufferGet(det_ctx, list_id);

    if (buffer->inspect == NULL) {

        htp_tx_t *tx = (htp_tx_t *)txv;

        const uint8_t *data = NULL;

        uint32_t data_len = 0;

        if (htp_uri_hostname(htp_tx_parsed_uri(tx)) == NULL) {

            if (htp_tx_request_headers(tx) == NULL)

                return NULL;

            const htp_header_t *h = htp_tx_request_header(tx, "Host");

            if (h == NULL || htp_header_value(h) == NULL)

                return NULL;

            data = htp_header_value_ptr(h);

            data_len = (uint32_t)htp_header_value_len(h);

        } else {

            data = (const uint8_t *)bstr_ptr(htp_uri_hostname(htp_tx_parsed_uri(tx)));

            data_len = (uint32_t)bstr_len(htp_uri_hostname(htp_tx_parsed_uri(tx)));

        }

        SCInspectionBufferSetupAndApplyTransforms(

                det_ctx, list_id, buffer, data, data_len, transforms);

    }

    return buffer;

}

/************************************Unittests*********************************/

#ifdef UNITTESTS

#include "tests/detect-http-host.c"

#endif /* UNITTESTS */

/**

 * @}

 */