suricata
detect-quic-sni.c
Go to the documentation of this file.
1 /* Copyright (C) 2022 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  *
20  * Implements the quic.sni
21  */
22 
23 #include "suricata-common.h"
24 #include "conf.h"
25 #include "detect.h"
26 #include "detect-parse.h"
27 #include "detect-engine.h"
29 #include "detect-engine-mpm.h"
31 #include "detect-engine-uint.h"
32 #include "detect-quic-sni.h"
33 #include "util-byte.h"
34 #include "util-unittest.h"
35 #include "rust.h"
36 
37 #ifdef UNITTESTS
38 static void DetectQuicSniRegisterTests(void);
39 #endif
40 
41 #define BUFFER_NAME "quic_sni"
42 #define KEYWORD_NAME "quic.sni"
43 
44 static int quic_sni_id = 0;
45 
46 static int DetectQuicSniSetup(DetectEngineCtx *, Signature *, const char *);
47 
48 static InspectionBuffer *GetSniData(DetectEngineThreadCtx *det_ctx,
49  const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv,
50  const int list_id)
51 {
52  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
53  if (buffer->inspect == NULL) {
54  uint32_t b_len = 0;
55  const uint8_t *b = NULL;
56 
57  if (rs_quic_tx_get_sni(txv, &b, &b_len) != 1)
58  return NULL;
59  if (b == NULL || b_len == 0)
60  return NULL;
61 
62  InspectionBufferSetupAndApplyTransforms(det_ctx, list_id, buffer, b, b_len, transforms);
63  }
64  return buffer;
65 }
66 
67 /**
68  * \brief Registration function for quic.sni: keyword
69  */
71 {
73  sigmatch_table[DETECT_QUIC_SNI].desc = "match Quic sni";
74  sigmatch_table[DETECT_QUIC_SNI].url = "/rules/quic-keywords.html#quic-sni";
75  sigmatch_table[DETECT_QUIC_SNI].Setup = DetectQuicSniSetup;
77 #ifdef UNITTESTS
78  sigmatch_table[DETECT_QUIC_SNI].RegisterTests = DetectQuicSniRegisterTests;
79 #endif
80 
82  GetSniData, ALPROTO_QUIC, 1);
83 
86 
88 }
89 
90 /**
91  * \internal
92  * \brief this function is used to add the parsed sigmatch into the current signature
93  *
94  * \param de_ctx pointer to the Detection Engine Context
95  * \param s pointer to the Current Signature
96  * \param rawstr pointer to the user provided options
97  *
98  * \retval 0 on Success
99  * \retval -1 on Failure
100  */
101 static int DetectQuicSniSetup(DetectEngineCtx *de_ctx, Signature *s, const char *rawstr)
102 {
103  if (DetectBufferSetActiveList(de_ctx, s, quic_sni_id) < 0)
104  return -1;
105 
107  return -1;
108 
109  return 0;
110 }
111 
112 #ifdef UNITTESTS
113 
114 /**
115  * \test QuicSniTestParse01 is a test for a valid value
116  *
117  * \retval 1 on success
118  * \retval 0 on failure
119  */
120 static int QuicSniTestParse01(void)
121 {
124 
126  de_ctx, "alert ip any any -> any any (quic.sni; content:\"googe.com\"; sid:1; rev:1;)");
127  FAIL_IF_NULL(sig);
128 
129  sig = DetectEngineAppendSig(
130  de_ctx, "alert ip any any -> any any (quic.sni; content:\"|00|\"; sid:2; rev:1;)");
131  FAIL_IF_NULL(sig);
132 
134 
135  PASS;
136 }
137 
138 /**
139  * \test QuicSniTestParse03 is a test for an invalid value
140  *
141  * \retval 1 on success
142  * \retval 0 on failure
143  */
144 static int QuicSniTestParse03(void)
145 {
148 
149  Signature *sig =
150  DetectEngineAppendSig(de_ctx, "alert ip any any -> any any (quic.sni:; sid:1; rev:1;)");
151  FAIL_IF_NOT_NULL(sig);
152 
154 
155  PASS;
156 }
157 
158 /**
159  * \brief this function registers unit tests for QuicSni
160  */
161 void DetectQuicSniRegisterTests(void)
162 {
163  UtRegisterTest("QuicSniTestParse01", QuicSniTestParse01);
164  UtRegisterTest("QuicSniTestParse03", QuicSniTestParse03);
165 }
166 
167 #endif /* UNITTESTS */
util-byte.h
detect-engine-uint.h
SigTableElmt_::url
const char * url
Definition: detect.h:1329
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1870
detect-engine.h
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1534
SigTableElmt_::desc
const char * desc
Definition: detect.h:1328
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:153
DetectEngineInspectBufferGeneric
uint8_t DetectEngineInspectBufferGeneric(DetectEngineCtx *de_ctx, DetectEngineThreadCtx *det_ctx, const DetectEngineAppInspectionEngine *engine, const Signature *s, Flow *f, uint8_t flags, void *alstate, void *txv, uint64_t tx_id)
Do the content inspection & validation for a signature.
Definition: detect-engine.c:2195
SigTableElmt_::name
const char * name
Definition: detect.h:1326
InspectionBufferSetupAndApplyTransforms
void InspectionBufferSetupAndApplyTransforms(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len, const DetectEngineTransforms *transforms)
setup the buffer with our initial data
Definition: detect-engine.c:1662
DetectEngineTransforms
Definition: detect.h:409
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
ALPROTO_QUIC
@ ALPROTO_QUIC
Definition: app-layer-protos.h:57
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1377
InspectionBuffer
Definition: detect.h:374
Flow_
Flow data structure.
Definition: flow.h:354
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-quic-sni.c:42
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1320
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:860
DetectEngineCtxFree
void DetectEngineCtxFree(DetectEngineCtx *)
Free a DetectEngineCtx::
Definition: detect-engine.c:2742
rust.h
DetectEngineAppendSig
Signature * DetectEngineAppendSig(DetectEngineCtx *, const char *)
Parse and append a Signature into the Detection Engine Context signature list.
Definition: detect-parse.c:2822
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1311
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1521
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1114
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:269
FAIL_IF_NOT_NULL
#define FAIL_IF_NOT_NULL(expr)
Fail a test if expression evaluates to non-NULL.
Definition: util-unittest.h:96
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DETECT_QUIC_SNI
@ DETECT_QUIC_SNI
Definition: detect-engine-register.h:298
DetectEngineThreadCtx_
Definition: detect.h:1116
detect-engine-mpm.h
detect.h
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:761
DetectAppLayerMpmRegister
void DetectAppLayerMpmRegister(const char *name, int direction, int priority, PrefilterRegisterFunc PrefilterRegister, InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register an app layer keyword for mpm
Definition: detect-engine-mpm.c:151
conf.h
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-quic-sni.c:41
DetectQuicSniRegister
void DetectQuicSniRegister(void)
Registration function for quic.sni: keyword.
Definition: detect-quic-sni.c:70
detect-engine-content-inspection.h
suricata-common.h
detect-quic-sni.h
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:375
detect-parse.h
Signature_
Signature container.
Definition: detect.h:618
DetectEngineCtxInit
DetectEngineCtx * DetectEngineCtxInit(void)
Definition: detect-engine.c:2703
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1510
DetectAppLayerInspectEngineRegister
void DetectAppLayerInspectEngineRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr Callback, InspectionBufferGetDataPtr GetData)
Registers an app inspection engine.
Definition: detect-engine.c:245
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1318