suricata
detect-tls-ja3s-string.c
Go to the documentation of this file.
1 /* Copyright (C) 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  * \file
20  *
21  * \author Mats Klepsland <mats.klepsland@gmail.com>
22  *
23  * Implements support for ja3s.string keyword.
24  */
25 
26 #include "suricata-common.h"
27 #include "threads.h"
28 #include "decode.h"
29 #include "detect.h"
30 
31 #include "detect-parse.h"
32 #include "detect-engine.h"
33 #include "detect-engine-mpm.h"
35 #include "detect-content.h"
36 #include "detect-pcre.h"
37 #include "detect-tls-ja3s-string.h"
38 
39 #include "flow.h"
40 #include "flow-util.h"
41 #include "flow-var.h"
42 
43 #include "conf.h"
44 #include "conf-yaml-loader.h"
45 
46 #include "util-debug.h"
47 #include "util-spm.h"
48 #include "util-print.h"
49 #include "util-ja3.h"
50 
51 #include "stream-tcp.h"
52 
53 #include "app-layer.h"
54 #include "app-layer-ssl.h"
55 
56 #include "util-unittest.h"
57 #include "util-unittest-helper.h"
58 
59 #ifndef HAVE_JA3
60 static int DetectJA3SetupNoSupport(DetectEngineCtx *a, Signature *b, const char *c)
61 {
62  SCLogError("no JA3 support built in");
63  return -1;
64 }
65 #endif /* HAVE_JA3 */
66 
67 #ifdef HAVE_JA3
68 static int DetectTlsJa3SStringSetup(DetectEngineCtx *, Signature *, const char *);
69 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
70  const DetectEngineTransforms *transforms,
71  Flow *f, const uint8_t flow_flags,
72  void *txv, const int list_id);
73 static int g_tls_ja3s_str_buffer_id = 0;
74 #endif
75 
76 /**
77  * \brief Registration function for keyword: ja3s.string
78  */
80 {
82  sigmatch_table[DETECT_TLS_JA3S_STRING].desc = "sticky buffer to match the JA3S string buffer";
83  sigmatch_table[DETECT_TLS_JA3S_STRING].url = "/rules/ja3-keywords.html#ja3s-string";
84 #ifdef HAVE_JA3
85  sigmatch_table[DETECT_TLS_JA3S_STRING].Setup = DetectTlsJa3SStringSetup;
86 #else /* HAVE_JA3 */
87  sigmatch_table[DETECT_TLS_JA3S_STRING].Setup = DetectJA3SetupNoSupport;
88 #endif /* HAVE_JA3 */
91 
92 #ifdef HAVE_JA3
95 
97  GetData, ALPROTO_TLS, 0);
98 
100  Ja3DetectGetString, ALPROTO_QUIC, 1);
101 
103  DetectEngineInspectBufferGeneric, Ja3DetectGetString);
104 
105  DetectBufferTypeSetDescriptionByName("ja3s.string", "TLS JA3S string");
106 
107  g_tls_ja3s_str_buffer_id = DetectBufferTypeGetByName("ja3s.string");
108 #endif /* HAVE_JA3 */
109 }
110 
111 #ifdef HAVE_JA3
112 /**
113  * \brief this function setup the ja3s.string modifier keyword used in the rule
114  *
115  * \param de_ctx Pointer to the Detection Engine Context
116  * \param s Pointer to the Signature to which the current keyword belongs
117  * \param str Should hold an empty string always
118  *
119  * \retval 0 On success
120  * \retval -1 On failure
121  */
122 static int DetectTlsJa3SStringSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
123 {
124  if (DetectBufferSetActiveList(de_ctx, s, g_tls_ja3s_str_buffer_id) < 0)
125  return -1;
126 
128  if (DetectSignatureSetMultiAppProto(s, alprotos) < 0) {
129  SCLogError("rule contains conflicting protocols.");
130  return -1;
131  }
132 
133  /* try to enable JA3 */
134  SSLEnableJA3();
135 
136  /* Check if JA3 is disabled */
137  if (!RunmodeIsUnittests() && Ja3IsDisabled("rule")) {
139  SCLogError("ja3(s) support is not enabled");
140  }
141  return -2;
142  }
143 
144  return 0;
145 }
146 
147 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
148  const DetectEngineTransforms *transforms, Flow *f,
149  const uint8_t flow_flags, void *txv, const int list_id)
150 {
151  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
152  if (buffer->inspect == NULL) {
153  const SSLState *ssl_state = (SSLState *)f->alstate;
154 
155  if (ssl_state->server_connp.ja3_str == NULL ||
156  ssl_state->server_connp.ja3_str->data == NULL) {
157  return NULL;
158  }
159 
160  const uint32_t data_len = strlen(ssl_state->server_connp.ja3_str->data);
161  const uint8_t *data = (uint8_t *)ssl_state->server_connp.ja3_str->data;
162 
164  det_ctx, list_id, buffer, data, data_len, transforms);
165  }
166 
167  return buffer;
168 }
169 #endif
SigTableElmt_::url
const char * url
Definition: detect.h:1329
SSLState_
SSLv[2.0|3.[0|1|2|3]] state structure.
Definition: app-layer-ssl.h:297
detect-content.h
detect-engine.h
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
flow-util.h
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
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:409
DetectSignatureSetMultiAppProto
int DetectSignatureSetMultiAppProto(Signature *s, const AppProto *alprotos)
this function is used to set multiple possible app-layer protos
Definition: detect-parse.c:1792
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:39
SSLState_::server_connp
SSLStateConnp server_connp
Definition: app-layer-ssl.h:316
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:85
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
threads.h
Flow_
Flow data structure.
Definition: flow.h:354
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1320
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:860
JA3Buffer_::data
char * data
Definition: util-ja3.h:32
util-ja3.h
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:270
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1311
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1521
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1114
Ja3IsDisabled
int Ja3IsDisabled(const char *type)
Definition: util-ja3.c:324
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEngineThreadCtx_
Definition: detect.h:1116
DETECT_TLS_JA3S_STRING
@ DETECT_TLS_JA3S_STRING
Definition: detect-engine-register.h:264
util-print.h
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-yaml-loader.h
conf.h
SSLEnableJA3
void SSLEnableJA3(void)
if not explicitly disabled in config, enable ja3 support
Definition: app-layer-ssl.c:3375
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:255
SigMatchSilentErrorEnabled
bool SigMatchSilentErrorEnabled(const DetectEngineCtx *de_ctx, const enum DetectKeywordId id)
Definition: detect-parse.c:404
suricata-common.h
util-spm.h
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:375
str
#define str(s)
Definition: suricata-common.h:300
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
Flow_::alstate
void * alstate
Definition: flow.h:477
detect-parse.h
Signature_
Signature container.
Definition: detect.h:618
DetectTlsJa3SStringRegister
void DetectTlsJa3SStringRegister(void)
Registration function for keyword: ja3s.string.
Definition: detect-tls-ja3s-string.c:79
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
detect-tls-ja3s-string.h
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
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1211
flow.h
SSLStateConnp_::ja3_str
JA3Buffer * ja3_str
Definition: app-layer-ssl.h:278
flow-var.h
app-layer-ssl.h
app-layer.h