22802647571

Committed 07 Mar 2026 04:23PM UTC coverage: 75.827% (-3.4%) from 79.233%

Build # 22802647571

Build Type

push

github

Committed by

jasonish

Commit Message

github-ci: add schema ordering check for yaml schema

Run Details

253365 of 334137 relevant lines covered (75.83%)

3384729.69 hits per line

Source File
Press 'n' to go to next uncovered line, 'b' for previous

84.16

/src/detect-http-method.c

/* 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 Brian Rectanus <brectanu@gmail.com>
 *
 * Implements the http_method 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 "detect-http-method.h"
#include "stream-tcp.h"

static int g_http_method_buffer_id = 0;
static int DetectHttpMethodSetup(DetectEngineCtx *, Signature *, const char *);
static int DetectHttpMethodSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str);
#ifdef UNITTESTS
void DetectHttpMethodRegisterTests(void);
#endif
void DetectHttpMethodFree(void *);
static bool DetectHttpMethodValidateCallback(
        const Signature *s, const char **sigerror, const DetectBufferType *dbt);
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);

/**
 * \brief Registration function for keyword: http_method
 */
void DetectHttpMethodRegister(void)
{
    /* http_method content modifier */
    sigmatch_table[DETECT_HTTP_METHOD_CM].name = "http_method";
    sigmatch_table[DETECT_HTTP_METHOD_CM].desc =
            "content modifier to match only on the HTTP method-buffer";
    sigmatch_table[DETECT_HTTP_METHOD_CM].url = "/rules/http-keywords.html#http-method";
    sigmatch_table[DETECT_HTTP_METHOD_CM].Match = NULL;
    sigmatch_table[DETECT_HTTP_METHOD_CM].Setup = DetectHttpMethodSetup;
#ifdef UNITTESTS
    sigmatch_table[DETECT_HTTP_METHOD_CM].RegisterTests = DetectHttpMethodRegisterTests;
#endif
    sigmatch_table[DETECT_HTTP_METHOD_CM].flags |= SIGMATCH_NOOPT | SIGMATCH_INFO_CONTENT_MODIFIER;
    sigmatch_table[DETECT_HTTP_METHOD_CM].alternative = DETECT_HTTP_METHOD;

    /* http.method sticky buffer */
    sigmatch_table[DETECT_HTTP_METHOD].name = "http.method";
    sigmatch_table[DETECT_HTTP_METHOD].desc = "sticky buffer to match specifically and only on the HTTP method buffer";
    sigmatch_table[DETECT_HTTP_METHOD].url = "/rules/http-keywords.html#http-method";
    sigmatch_table[DETECT_HTTP_METHOD].Setup = DetectHttpMethodSetupSticky;
    sigmatch_table[DETECT_HTTP_METHOD].flags |= SIGMATCH_NOOPT|SIGMATCH_INFO_STICKY_BUFFER;

    DetectAppLayerInspectEngineRegister("http_method", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,
            HTP_REQUEST_PROGRESS_LINE, DetectEngineInspectBufferGeneric, GetData);

    DetectAppLayerMpmRegister("http_method", SIG_FLAG_TOSERVER, 4, PrefilterGenericMpmRegister,
            GetData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_LINE);

    DetectAppLayerInspectEngineRegister("http_method", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,
            HTTP2StateDataClient, DetectEngineInspectBufferGeneric, GetData2);

    DetectAppLayerMpmRegister("http_method", SIG_FLAG_TOSERVER, 4, PrefilterGenericMpmRegister,
            GetData2, ALPROTO_HTTP2, HTTP2StateDataClient);

    DetectBufferTypeSetDescriptionByName("http_method",
            "http request method");

    DetectBufferTypeRegisterValidateCallback("http_method",
            DetectHttpMethodValidateCallback);

    g_http_method_buffer_id = DetectBufferTypeGetByName("http_method");

    SCLogDebug("registering http_method rule option");
}

/**
 * \brief This function is used to add the parsed "http_method" option
 *        into the current signature.
 *
 * \param de_ctx Pointer to the Detection Engine Context.
 * \param s      Pointer to the Current Signature.
 * \param str    Pointer to the user provided option string.
 *
 * \retval  0 on Success.
 * \retval -1 on Failure.
 */
static int DetectHttpMethodSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
{
    return DetectEngineContentModifierBufferSetup(
            de_ctx, s, str, DETECT_HTTP_METHOD_CM, g_http_method_buffer_id, ALPROTO_HTTP1);
}

/**
 * \brief this function setup the http.method 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 DetectHttpMethodSetupSticky(DetectEngineCtx *de_ctx, Signature *s, const char *str)
{
    if (SCDetectBufferSetActiveList(de_ctx, s, g_http_method_buffer_id) < 0)
        return -1;

    if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)
        return -1;

    return 0;
}

/**
 *  \retval 1 valid
 *  \retval 0 invalid
 */
static bool DetectHttpMethodValidateCallback(
        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)
                continue;
            const DetectContentData *cd = (const DetectContentData *)sm->ctx;
            if (cd->content && cd->content_len) {
                if (cd->content[cd->content_len - 1] == 0x20) {
                    *sigerror = "http_method pattern with trailing space";
                    SCLogError("%s", *sigerror);
                    return false;
                } else if (cd->content[0] == 0x20) {
                    *sigerror = "http_method pattern with leading space";
                    SCLogError("%s", *sigerror);
                    return false;
                } else if (cd->content[cd->content_len - 1] == 0x09) {
                    *sigerror = "http_method pattern with trailing tab";
                    SCLogError("%s", *sigerror);
                    return false;
                } else if (cd->content[0] == 0x09) {
                    *sigerror = "http_method pattern with leading tab";
                    SCLogError("%s", *sigerror);
                    return false;
                }
            }
        }
    }
    return true;
}

static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
        const DetectEngineTransforms *transforms, Flow *_f,
        const uint8_t _flow_flags, void *txv, const int list_id)
{
    InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
    if (buffer->inspect == NULL) {
        htp_tx_t *tx = (htp_tx_t *)txv;

        if (htp_tx_request_method(tx) == NULL)
            return NULL;

        const uint32_t data_len = (uint32_t)bstr_len(htp_tx_request_method(tx));
        const uint8_t *data = bstr_ptr(htp_tx_request_method(tx));

        InspectionBufferSetupAndApplyTransforms(
                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 = InspectionBufferGet(det_ctx, list_id);
    if (buffer->inspect == NULL) {
        uint32_t b_len = 0;
        const uint8_t *b = NULL;

        if (SCHttp2TxGetMethod(txv, &b, &b_len) != 1)
            return NULL;
        if (b == NULL || b_len == 0)
            return NULL;

        InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
    }

    return buffer;
}

#ifdef UNITTESTS
#include "tests/detect-http-method.c"
#endif

/**
 * @}
 */

1	/* Copyright (C) 2007-2019 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	* \ingroup httplayer
20	*
21	* @{
22	*/
23
24
25	/**
26	* \file
27	*
28	* \author Brian Rectanus <brectanu@gmail.com>
29	*
30	* Implements the http_method keyword
31	*/
32
33	#include "suricata-common.h"
34	#include "threads.h"
35	#include "decode.h"
36	#include "detect.h"
37
38	#include "detect-parse.h"
39	#include "detect-engine.h"
40	#include "detect-engine-buffer.h"
41	#include "detect-engine-mpm.h"
42	#include "detect-engine-prefilter.h"
43	#include "detect-content.h"
44	#include "detect-pcre.h"
45
46	#include "flow.h"
47	#include "flow-var.h"
48	#include "flow-util.h"
49
50	#include "util-debug.h"
51	#include "util-unittest.h"
52	#include "util-unittest-helper.h"
53	#include "util-spm.h"
54
55	#include "app-layer.h"
56	#include "app-layer-parser.h"
57
58	#include "app-layer-htp.h"
59	#include "detect-http-method.h"
60	#include "stream-tcp.h"
61
62	static int g_http_method_buffer_id = 0;
63	static int DetectHttpMethodSetup(DetectEngineCtx , Signature , const char *);
64	static int DetectHttpMethodSetupSticky(DetectEngineCtx de_ctx, Signature s, const char *str);
65	#ifdef UNITTESTS
66	void DetectHttpMethodRegisterTests(void);
67	#endif
68	void DetectHttpMethodFree(void *);
69	static bool DetectHttpMethodValidateCallback(
70	const Signature s, const char sigerror, const DetectBufferType dbt);
71	static InspectionBuffer GetData(DetectEngineThreadCtx det_ctx,
72	const DetectEngineTransforms transforms, Flow _f,
73	const uint8_t _flow_flags, void *txv, const int list_id);
74	static InspectionBuffer GetData2(DetectEngineThreadCtx det_ctx,
75	const DetectEngineTransforms transforms, Flow _f, const uint8_t _flow_flags, void *txv,
76	const int list_id);
77
78	/**
79	* \brief Registration function for keyword: http_method
80	*/
81	void DetectHttpMethodRegister(void)
82	{	2,193✔
83	/* http_method content modifier */
84	sigmatch_table[DETECT_HTTP_METHOD_CM].name = "http_method";	2,193✔
85	sigmatch_table[DETECT_HTTP_METHOD_CM].desc =	2,193✔
86	"content modifier to match only on the HTTP method-buffer";	2,193✔
87	sigmatch_table[DETECT_HTTP_METHOD_CM].url = "/rules/http-keywords.html#http-method";	2,193✔
88	sigmatch_table[DETECT_HTTP_METHOD_CM].Match = NULL;	2,193✔
89	sigmatch_table[DETECT_HTTP_METHOD_CM].Setup = DetectHttpMethodSetup;	2,193✔
90	#ifdef UNITTESTS	3✔
91	sigmatch_table[DETECT_HTTP_METHOD_CM].RegisterTests = DetectHttpMethodRegisterTests;	3✔
92	#endif	3✔
93	sigmatch_table[DETECT_HTTP_METHOD_CM].flags \|= SIGMATCH_NOOPT \| SIGMATCH_INFO_CONTENT_MODIFIER;	2,193✔
94	sigmatch_table[DETECT_HTTP_METHOD_CM].alternative = DETECT_HTTP_METHOD;	2,193✔
95
96	/* http.method sticky buffer */
97	sigmatch_table[DETECT_HTTP_METHOD].name = "http.method";	2,193✔
98	sigmatch_table[DETECT_HTTP_METHOD].desc = "sticky buffer to match specifically and only on the HTTP method buffer";	2,193✔
99	sigmatch_table[DETECT_HTTP_METHOD].url = "/rules/http-keywords.html#http-method";	2,193✔
100	sigmatch_table[DETECT_HTTP_METHOD].Setup = DetectHttpMethodSetupSticky;	2,193✔
101	sigmatch_table[DETECT_HTTP_METHOD].flags \|= SIGMATCH_NOOPT\|SIGMATCH_INFO_STICKY_BUFFER;	2,193✔
102
103	DetectAppLayerInspectEngineRegister("http_method", ALPROTO_HTTP1, SIG_FLAG_TOSERVER,	2,193✔
104	HTP_REQUEST_PROGRESS_LINE, DetectEngineInspectBufferGeneric, GetData);	2,193✔
105
106	DetectAppLayerMpmRegister("http_method", SIG_FLAG_TOSERVER, 4, PrefilterGenericMpmRegister,	2,193✔
107	GetData, ALPROTO_HTTP1, HTP_REQUEST_PROGRESS_LINE);	2,193✔
108
109	DetectAppLayerInspectEngineRegister("http_method", ALPROTO_HTTP2, SIG_FLAG_TOSERVER,	2,193✔
110	HTTP2StateDataClient, DetectEngineInspectBufferGeneric, GetData2);	2,193✔
111
112	DetectAppLayerMpmRegister("http_method", SIG_FLAG_TOSERVER, 4, PrefilterGenericMpmRegister,	2,193✔
113	GetData2, ALPROTO_HTTP2, HTTP2StateDataClient);	2,193✔
114
115	DetectBufferTypeSetDescriptionByName("http_method",	2,193✔
116	"http request method");	2,193✔
117
118	DetectBufferTypeRegisterValidateCallback("http_method",	2,193✔
119	DetectHttpMethodValidateCallback);	2,193✔
120
121	g_http_method_buffer_id = DetectBufferTypeGetByName("http_method");	2,193✔
122
123	SCLogDebug("registering http_method rule option");	2,193✔
124	}	2,193✔
125
126	/**
127	* \brief This function is used to add the parsed "http_method" option
128	* into the current signature.
129	*
130	* \param de_ctx Pointer to the Detection Engine Context.
131	* \param s Pointer to the Current Signature.
132	* \param str Pointer to the user provided option string.
133	*
134	* \retval 0 on Success.
135	* \retval -1 on Failure.
136	*/
137	static int DetectHttpMethodSetup(DetectEngineCtx de_ctx, Signature s, const char *str)
138	{	131✔
139	return DetectEngineContentModifierBufferSetup(	131✔
140	de_ctx, s, str, DETECT_HTTP_METHOD_CM, g_http_method_buffer_id, ALPROTO_HTTP1);	131✔
141	}	131✔
142
143	/**
144	* \brief this function setup the http.method keyword used in the rule
145	*
146	* \param de_ctx Pointer to the Detection Engine Context
147	* \param s Pointer to the Signature to which the current keyword belongs
148	* \param str Should hold an empty string always
149	*
150	* \retval 0 On success
151	*/
152	static int DetectHttpMethodSetupSticky(DetectEngineCtx de_ctx, Signature s, const char *str)
153	{	14,488✔
154	if (SCDetectBufferSetActiveList(de_ctx, s, g_http_method_buffer_id) < 0)	14,488✔
155	return -1;	×
156
157	if (SCDetectSignatureSetAppProto(s, ALPROTO_HTTP) < 0)	14,488✔
158	return -1;	×
159
160	return 0;	14,488✔
161	}	14,488✔
162
163	/**
164	* \retval 1 valid
165	* \retval 0 invalid
166	*/
167	static bool DetectHttpMethodValidateCallback(
168	const Signature s, const char sigerror, const DetectBufferType dbt)
169	{	14,547✔
170	for (uint32_t x = 0; x < s->init_data->buffer_index; x++) {	58,741✔
171	if (s->init_data->buffers[x].id != (uint32_t)dbt->id)	44,194✔
172	continue;	29,647✔
173	const SigMatch *sm = s->init_data->buffers[x].head;	14,547✔
174	for (; sm != NULL; sm = sm->next) {	29,153✔
175	if (sm->type != DETECT_CONTENT)	14,606✔
176	continue;	80✔
177	const DetectContentData cd = (const DetectContentData )sm->ctx;	14,526✔
178	if (cd->content && cd->content_len) {	14,526✔
179	if (cd->content[cd->content_len - 1] == 0x20) {	14,526✔
180	*sigerror = "http_method pattern with trailing space";	×
181	SCLogError("%s", *sigerror);	×
182	return false;	×
183	} else if (cd->content[0] == 0x20) {	14,526✔
184	*sigerror = "http_method pattern with leading space";	×
185	SCLogError("%s", *sigerror);	×
186	return false;	×
187	} else if (cd->content[cd->content_len - 1] == 0x09) {	14,526✔
188	*sigerror = "http_method pattern with trailing tab";	×
189	SCLogError("%s", *sigerror);	×
190	return false;	×
191	} else if (cd->content[0] == 0x09) {	14,526✔
192	*sigerror = "http_method pattern with leading tab";	×
193	SCLogError("%s", *sigerror);	×
194	return false;	×
195	}	×
196	}	14,526✔
197	}	14,526✔
198	}	14,547✔
199	return true;	14,547✔
200	}	14,547✔
201
202	static InspectionBuffer GetData(DetectEngineThreadCtx det_ctx,
203	const DetectEngineTransforms transforms, Flow _f,
204	const uint8_t _flow_flags, void *txv, const int list_id)
205	{	6,292✔
206	InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);	6,292✔
207	if (buffer->inspect == NULL) {	6,292✔
208	htp_tx_t tx = (htp_tx_t )txv;	2,735✔
209
210	if (htp_tx_request_method(tx) == NULL)	2,735✔
211	return NULL;	79✔
212
213	const uint32_t data_len = (uint32_t)bstr_len(htp_tx_request_method(tx));	2,656✔
214	const uint8_t *data = bstr_ptr(htp_tx_request_method(tx));	2,656✔
215
216	InspectionBufferSetupAndApplyTransforms(	2,656✔
217	det_ctx, list_id, buffer, data, data_len, transforms);	2,656✔
218	}	2,656✔
219
220	return buffer;	6,213✔
221	}	6,292✔
222
223	static InspectionBuffer GetData2(DetectEngineThreadCtx det_ctx,
224	const DetectEngineTransforms transforms, Flow _f, const uint8_t _flow_flags, void *txv,
225	const int list_id)
226	{	210✔
227	InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);	210✔
228	if (buffer->inspect == NULL) {	210✔
229	uint32_t b_len = 0;	174✔
230	const uint8_t *b = NULL;	174✔
231
232	if (SCHttp2TxGetMethod(txv, &b, &b_len) != 1)	174✔
233	return NULL;	103✔
234	if (b == NULL \|\| b_len == 0)	71✔
235	return NULL;	×
236
237	InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);	71✔
238	}	71✔
239
240	return buffer;	107✔
241	}	210✔
242
243	#ifdef UNITTESTS
244	#include "tests/detect-http-method.c"
245	#endif
246
247	/**
248	* @}
249	*/

jasonish / suricata / 22802647571

Source File Press 'n' to go to next uncovered line, 'b' for previous

Source File
Press 'n' to go to next uncovered line, 'b' for previous