suricata
detect-tls-ja3-hash.c
Go to the documentation of this file.
1 /* Copyright (C) 2017 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 ja3.hash 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-ja3-hash.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
66 
67 #ifdef HAVE_JA3
68 static int DetectTlsJa3HashSetup(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 void DetectTlsJa3HashSetupCallback(const DetectEngineCtx *de_ctx,
74  Signature *s);
75 static bool DetectTlsJa3HashValidateCallback(const Signature *s,
76  const char **sigerror);
77 static int g_tls_ja3_hash_buffer_id = 0;
78 #endif
79 
80 /**
81  * \brief Registration function for keyword: ja3_hash
82  */
84 {
87  sigmatch_table[DETECT_AL_TLS_JA3_HASH].desc = "sticky buffer to match the JA3 hash buffer";
88  sigmatch_table[DETECT_AL_TLS_JA3_HASH].url = "/rules/ja3-keywords.html#ja3-hash";
89 #ifdef HAVE_JA3
90  sigmatch_table[DETECT_AL_TLS_JA3_HASH].Setup = DetectTlsJa3HashSetup;
91 #else /* HAVE_JA3 */
92  sigmatch_table[DETECT_AL_TLS_JA3_HASH].Setup = DetectJA3SetupNoSupport;
93 #endif /* HAVE_JA3 */
96 
97 #ifdef HAVE_JA3
100 
102  "ja3.hash", SIG_FLAG_TOSERVER, 2, PrefilterGenericMpmRegister, GetData, ALPROTO_TLS, 0);
103 
105  Ja3DetectGetHash, ALPROTO_QUIC, 1);
106 
108  DetectEngineInspectBufferGeneric, Ja3DetectGetHash);
109 
110  DetectBufferTypeSetDescriptionByName("ja3.hash", "TLS JA3 hash");
111 
113  DetectTlsJa3HashSetupCallback);
114 
116  DetectTlsJa3HashValidateCallback);
117 
118  g_tls_ja3_hash_buffer_id = DetectBufferTypeGetByName("ja3.hash");
119 #endif /* HAVE_JA3 */
120 }
121 
122 #ifdef HAVE_JA3
123 /**
124  * \brief this function setup the ja3.hash modifier keyword used in the rule
125  *
126  * \param de_ctx Pointer to the Detection Engine Context
127  * \param s Pointer to the Signature to which the current keyword belongs
128  * \param str Should hold an empty string always
129  *
130  * \retval 0 On success
131  * \retval -1 On failure
132  * \retval -2 on failure that should be silent after the first
133  */
134 static int DetectTlsJa3HashSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
135 {
136  if (DetectBufferSetActiveList(de_ctx, s, g_tls_ja3_hash_buffer_id) < 0)
137  return -1;
138 
139  if (s->alproto != ALPROTO_UNKNOWN && s->alproto != ALPROTO_TLS && s->alproto != ALPROTO_QUIC) {
140  SCLogError("rule contains conflicting protocols.");
141  return -1;
142  }
143 
144  /* try to enable JA3 */
145  SSLEnableJA3();
146 
147  /* Check if JA3 is disabled */
148  if (!RunmodeIsUnittests() && Ja3IsDisabled("rule")) {
150  SCLogError("ja3 support is not enabled");
151  }
152  return -2;
153  }
155 
156  return 0;
157 }
158 
159 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
160  const DetectEngineTransforms *transforms, Flow *f,
161  const uint8_t flow_flags, void *txv, const int list_id)
162 {
163  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
164  if (buffer->inspect == NULL) {
165  const SSLState *ssl_state = (SSLState *)f->alstate;
166 
167  if (ssl_state->client_connp.ja3_hash == NULL) {
168  return NULL;
169  }
170 
171  const uint32_t data_len = strlen(ssl_state->client_connp.ja3_hash);
172  const uint8_t *data = (uint8_t *)ssl_state->client_connp.ja3_hash;
173 
174  InspectionBufferSetup(det_ctx, list_id, buffer, data, data_len);
175  InspectionBufferApplyTransforms(buffer, transforms);
176  }
177 
178  return buffer;
179 }
180 
181 static bool DetectTlsJa3HashValidateCallback(const Signature *s,
182  const char **sigerror)
183 {
184  for (uint32_t x = 0; x < s->init_data->buffer_index; x++) {
185  if (s->init_data->buffers[x].id != (uint32_t)g_tls_ja3_hash_buffer_id)
186  continue;
187  const SigMatch *sm = s->init_data->buffers[x].head;
188  for (; sm != NULL; sm = sm->next) {
189  if (sm->type != DETECT_CONTENT)
190  continue;
191 
192  const DetectContentData *cd = (DetectContentData *)sm->ctx;
193 
194  if (cd->flags & DETECT_CONTENT_NOCASE) {
195  *sigerror = "ja3.hash should not be used together with "
196  "nocase, since the rule is automatically "
197  "lowercased anyway which makes nocase redundant.";
198  SCLogWarning("rule %u: %s", s->id, *sigerror);
199  }
200 
201  if (cd->content_len == SC_MD5_HEX_LEN)
202  return true;
203 
204  *sigerror = "Invalid length of the specified JA3 hash (should "
205  "be 32 characters long). This rule will therefore "
206  "never match.";
207  SCLogWarning("rule %u: %s", s->id, *sigerror);
208  return false;
209  }
210  }
211  return true;
212 }
213 
214 static void DetectTlsJa3HashSetupCallback(const DetectEngineCtx *de_ctx,
215  Signature *s)
216 {
217  for (uint32_t x = 0; x < s->init_data->buffer_index; x++) {
218  if (s->init_data->buffers[x].id != (uint32_t)g_tls_ja3_hash_buffer_id)
219  continue;
220  SigMatch *sm = s->init_data->buffers[x].head;
221  for (; sm != NULL; sm = sm->next) {
222  if (sm->type != DETECT_CONTENT)
223  continue;
224 
226 
227  bool changed = false;
228  uint32_t u;
229  for (u = 0; u < cd->content_len; u++) {
230  if (isupper(cd->content[u])) {
231  cd->content[u] = u8_tolower(cd->content[u]);
232  changed = true;
233  }
234  }
235 
236  /* recreate the context if changes were made */
237  if (changed) {
238  SpmDestroyCtx(cd->spm_ctx);
239  cd->spm_ctx =
241  }
242  }
243  }
244 }
245 #endif
DETECT_CONTENT_NOCASE
#define DETECT_CONTENT_NOCASE
Definition: detect-content.h:29
SigTableElmt_::url
const char * url
Definition: detect.h:1307
SignatureInitDataBuffer_::head
SigMatch * head
Definition: detect.h:535
SSLState_
SSLv[2.0|3.[0|1|2|3]] state structure.
Definition: app-layer-ssl.h:296
detect-content.h
DetectTlsJa3HashRegister
void DetectTlsJa3HashRegister(void)
Registration function for keyword: ja3_hash.
Definition: detect-tls-ja3-hash.c:83
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1512
SigTableElmt_::desc
const char * desc
Definition: detect.h:1306
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:127
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:2142
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1304
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:408
SSLState_::client_connp
SSLStateConnp client_connp
Definition: app-layer-ssl.h:314
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:70
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:33
Signature_::alproto
AppProto alproto
Definition: detect.h:606
ALPROTO_QUIC
@ ALPROTO_QUIC
Definition: app-layer-protos.h:51
DetectBufferSetActiveList
int DetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine.c:1356
SSLStateConnp_::ja3_hash
char * ja3_hash
Definition: app-layer-ssl.h:278
InspectionBuffer
Definition: detect.h:373
threads.h
Flow_
Flow data structure.
Definition: flow.h:356
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:1287
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1298
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:841
u8_tolower
#define u8_tolower(c)
Definition: suricata-common.h:436
util-ja3.h
SignatureInitData_::init_flags
uint32_t init_flags
Definition: detect.h:553
DetectContentData_
Definition: detect-content.h:93
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1289
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1500
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1093
DETECT_AL_TLS_JA3_HASH
@ DETECT_AL_TLS_JA3_HASH
Definition: detect-engine-register.h:258
Ja3IsDisabled
int Ja3IsDisabled(const char *type)
Definition: util-ja3.c:325
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:267
decode.h
util-debug.h
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror))
Definition: detect-engine.c:1305
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1093
util-print.h
detect-engine-mpm.h
detect.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:353
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistry *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:750
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
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
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:352
conf-yaml-loader.h
conf.h
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:104
SSLEnableJA3
void SSLEnableJA3(void)
if not explicitly disabled in config, enable ja3 support
Definition: app-layer-ssl.c:3340
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:670
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:251
SIG_FLAG_INIT_JA
#define SIG_FLAG_INIT_JA
Definition: detect.h:297
SigMatchSilentErrorEnabled
bool SigMatchSilentErrorEnabled(const DetectEngineCtx *de_ctx, const enum DetectKeywordId id)
Definition: detect-parse.c:378
SigTableElmt_::alias
const char * alias
Definition: detect.h:1305
suricata-common.h
SigMatch_::type
uint16_t type
Definition: detect.h:350
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1699
util-spm.h
DetectContentData_::content
uint8_t * content
Definition: detect-content.h:94
DetectContentData_::spm_ctx
SpmCtx * spm_ctx
Definition: detect-content.h:111
SignatureInitData_::buffers
SignatureInitDataBuffer * buffers
Definition: detect.h:591
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:374
str
#define str(s)
Definition: suricata-common.h:291
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:261
InspectionBufferSetup
void InspectionBufferSetup(DetectEngineThreadCtx *det_ctx, const int list_id, InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1595
Flow_::alstate
void * alstate
Definition: flow.h:481
Signature_::id
uint32_t id
Definition: detect.h:636
detect-parse.h
SignatureInitDataBuffer_::id
uint32_t id
Definition: detect.h:528
Signature_
Signature container.
Definition: detect.h:601
SigMatch_
a single match condition for a signature
Definition: detect.h:349
ALPROTO_UNKNOWN
@ ALPROTO_UNKNOWN
Definition: app-layer-protos.h:29
detect-tls-ja3-hash.h
DetectContentData_::content_len
uint16_t content_len
Definition: detect-content.h:95
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1488
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:240
DetectEngineCtx_::spm_global_thread_ctx
SpmGlobalThreadCtx * spm_global_thread_ctx
Definition: detect.h:895
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1190
flow.h
SpmDestroyCtx
void SpmDestroyCtx(SpmCtx *ctx)
Definition: util-spm.c:183
SignatureInitData_::buffer_index
uint32_t buffer_index
Definition: detect.h:592
flow-var.h
SpmInitCtx
SpmCtx * SpmInitCtx(const uint8_t *needle, uint16_t needle_len, int nocase, SpmGlobalThreadCtx *global_thread_ctx)
Definition: util-spm.c:173
app-layer-ssl.h
app-layer.h