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 static int DetectTlsJa3HashSetup(DetectEngineCtx *, Signature *, const char *);
60 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
61  const DetectEngineTransforms *transforms,
62  Flow *f, const uint8_t flow_flags,
63  void *txv, const int list_id);
64 static void DetectTlsJa3HashSetupCallback(const DetectEngineCtx *de_ctx,
65  Signature *s);
66 static bool DetectTlsJa3HashValidateCallback(const Signature *s,
67  const char **sigerror);
68 static int g_tls_ja3_hash_buffer_id = 0;
69 
70 /**
71  * \brief Registration function for keyword: ja3_hash
72  */
74 {
77  sigmatch_table[DETECT_AL_TLS_JA3_HASH].desc = "sticky buffer to match the JA3 hash buffer";
78  sigmatch_table[DETECT_AL_TLS_JA3_HASH].url = "/rules/ja3-keywords.html#ja3-hash";
79  sigmatch_table[DETECT_AL_TLS_JA3_HASH].Setup = DetectTlsJa3HashSetup;
82 
85 
88 
91 
94 
95  DetectBufferTypeSetDescriptionByName("ja3.hash", "TLS JA3 hash");
96 
98  DetectTlsJa3HashSetupCallback);
99 
101  DetectTlsJa3HashValidateCallback);
102 
103  g_tls_ja3_hash_buffer_id = DetectBufferTypeGetByName("ja3.hash");
104 }
105 
106 /**
107  * \brief this function setup the ja3.hash modifier keyword used in the rule
108  *
109  * \param de_ctx Pointer to the Detection Engine Context
110  * \param s Pointer to the Signature to which the current keyword belongs
111  * \param str Should hold an empty string always
112  *
113  * \retval 0 On success
114  * \retval -1 On failure
115  * \retval -2 on failure that should be silent after the first
116  */
117 static int DetectTlsJa3HashSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
118 {
119  if (DetectBufferSetActiveList(s, g_tls_ja3_hash_buffer_id) < 0)
120  return -1;
121 
122  if (s->alproto != ALPROTO_UNKNOWN && s->alproto != ALPROTO_TLS && s->alproto != ALPROTO_QUIC) {
123  SCLogError("rule contains conflicting protocols.");
124  return -1;
125  }
126 
127  /* try to enable JA3 */
128  SSLEnableJA3();
129 
130  /* Check if JA3 is disabled */
131  if (!RunmodeIsUnittests() && Ja3IsDisabled("rule")) {
133  SCLogError("ja3 support is not enabled");
134  }
135  return -2;
136  }
138 
139  return 0;
140 }
141 
142 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
143  const DetectEngineTransforms *transforms, Flow *f,
144  const uint8_t flow_flags, void *txv, const int list_id)
145 {
146  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
147  if (buffer->inspect == NULL) {
148  const SSLState *ssl_state = (SSLState *)f->alstate;
149 
150  if (ssl_state->client_connp.ja3_hash == NULL) {
151  return NULL;
152  }
153 
154  const uint32_t data_len = strlen(ssl_state->client_connp.ja3_hash);
155  const uint8_t *data = (uint8_t *)ssl_state->client_connp.ja3_hash;
156 
157  InspectionBufferSetup(det_ctx, list_id, buffer, data, data_len);
158  InspectionBufferApplyTransforms(buffer, transforms);
159  }
160 
161  return buffer;
162 }
163 
164 static bool DetectTlsJa3HashValidateCallback(const Signature *s,
165  const char **sigerror)
166 {
167  const SigMatch *sm = s->init_data->smlists[g_tls_ja3_hash_buffer_id];
168  for ( ; sm != NULL; sm = sm->next)
169  {
170  if (sm->type != DETECT_CONTENT)
171  continue;
172 
173  const DetectContentData *cd = (DetectContentData *)sm->ctx;
174 
175  if (cd->flags & DETECT_CONTENT_NOCASE) {
176  *sigerror = "ja3.hash should not be used together with "
177  "nocase, since the rule is automatically "
178  "lowercased anyway which makes nocase redundant.";
179  SCLogWarning("rule %u: %s", s->id, *sigerror);
180  }
181 
182  if (cd->content_len == SC_MD5_HEX_LEN)
183  return true;
184 
185  *sigerror = "Invalid length of the specified JA3 hash (should "
186  "be 32 characters long). This rule will therefore "
187  "never match.";
188  SCLogWarning("rule %u: %s", s->id, *sigerror);
189  return false;
190  }
191 
192  return true;
193 }
194 
195 static void DetectTlsJa3HashSetupCallback(const DetectEngineCtx *de_ctx,
196  Signature *s)
197 {
198  SigMatch *sm = s->init_data->smlists[g_tls_ja3_hash_buffer_id];
199  for ( ; sm != NULL; sm = sm->next)
200  {
201  if (sm->type != DETECT_CONTENT)
202  continue;
203 
205 
206  bool changed = false;
207  uint32_t u;
208  for (u = 0; u < cd->content_len; u++)
209  {
210  if (isupper(cd->content[u])) {
211  cd->content[u] = u8_tolower(cd->content[u]);
212  changed = true;
213  }
214  }
215 
216  /* recreate the context if changes were made */
217  if (changed) {
218  SpmDestroyCtx(cd->spm_ctx);
219  cd->spm_ctx = SpmInitCtx(cd->content, cd->content_len, 1,
221  }
222  }
223 }
DETECT_CONTENT_NOCASE
#define DETECT_CONTENT_NOCASE
Definition: detect-content.h:29
Ja3DetectGetHash
InspectionBuffer * Ja3DetectGetHash(DetectEngineThreadCtx *det_ctx, const DetectEngineTransforms *transforms, Flow *_f, const uint8_t _flow_flags, void *txv, const int list_id)
Definition: util-ja3.c:259
SigTableElmt_::url
const char * url
Definition: detect.h:1241
SSLState_
SSLv[2.0|3.[0|1|2|3]] state structure.
Definition: app-layer-ssl.h:288
detect-content.h
DetectTlsJa3HashRegister
void DetectTlsJa3HashRegister(void)
Registration function for keyword: ja3_hash.
Definition: detect-tls-ja3-hash.c:73
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1447
SigTableElmt_::desc
const char * desc
Definition: detect.h:1240
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:1991
flow-util.h
SIG_FLAG_INIT_JA3
#define SIG_FLAG_INIT_JA3
Definition: detect.h:258
SigTableElmt_::name
const char * name
Definition: detect.h:1238
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:372
SSLState_::client_connp
SSLStateConnp client_connp
Definition: app-layer-ssl.h:306
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:62
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:33
Signature_::alproto
AppProto alproto
Definition: detect.h:544
ALPROTO_QUIC
@ ALPROTO_QUIC
Definition: app-layer-protos.h:51
SSLStateConnp_::ja3_hash
char * ja3_hash
Definition: app-layer-ssl.h:272
InspectionBuffer
Definition: detect.h:337
threads.h
Flow_
Flow data structure.
Definition: flow.h:357
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:1255
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:749
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1232
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:785
u8_tolower
#define u8_tolower(c)
Definition: suricata-common.h:425
util-ja3.h
SignatureInitData_::init_flags
uint32_t init_flags
Definition: detect.h:503
DetectContentData_
Definition: detect-content.h:86
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1223
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1364
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1079
DETECT_AL_TLS_JA3_HASH
@ DETECT_AL_TLS_JA3_HASH
Definition: detect-engine-register.h:235
Ja3IsDisabled
int Ja3IsDisabled(const char *type)
Check if JA3 is disabled.
Definition: util-ja3.c:246
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:228
decode.h
util-debug.h
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror))
Definition: detect-engine.c:1273
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1025
util-print.h
detect-engine-mpm.h
detect.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:317
SCLogWarning
#define SCLogWarning(...)
Macro used to log WARNING messages.
Definition: util-debug.h:249
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:316
conf-yaml-loader.h
DetectAppLayerInspectEngineRegister2
void DetectAppLayerInspectEngineRegister2(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr2 Callback2, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
Definition: detect-engine.c:224
conf.h
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:97
SSLEnableJA3
void SSLEnableJA3(void)
if not explicitly disabled in config, enable ja3 support
Definition: app-layer-ssl.c:3091
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:611
SignatureInitData_::smlists
struct SigMatch_ ** smlists
Definition: detect.h:534
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:232
DetectAppLayerMpmRegister2
void DetectAppLayerMpmRegister2(const char *name, int direction, int priority, int(*PrefilterRegister)(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id), InspectionBufferGetDataPtr GetData, AppProto alproto, int tx_min_progress)
register a MPM engine
Definition: detect-engine-mpm.c:89
SigMatchSilentErrorEnabled
bool SigMatchSilentErrorEnabled(const DetectEngineCtx *de_ctx, const enum DetectKeywordId id)
Definition: detect-parse.c:296
SigTableElmt_::alias
const char * alias
Definition: detect.h:1239
suricata-common.h
SigMatch_::type
uint16_t type
Definition: detect.h:314
SC_MD5_HEX_LEN
#define SC_MD5_HEX_LEN
Definition: rust.h:36
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1550
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:76
util-spm.h
DetectContentData_::content
uint8_t * content
Definition: detect-content.h:87
DetectContentData_::spm_ctx
SpmCtx * spm_ctx
Definition: detect-content.h:104
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:338
str
#define str(s)
Definition: suricata-common.h:280
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:1446
Flow_::alstate
void * alstate
Definition: flow.h:482
Signature_::id
uint32_t id
Definition: detect.h:574
detect-parse.h
Signature_
Signature container.
Definition: detect.h:540
SigMatch_
a single match condition for a signature
Definition: detect.h:313
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:88
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1423
DetectEngineCtx_::spm_global_thread_ctx
SpmGlobalThreadCtx * spm_global_thread_ctx
Definition: detect.h:840
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:1293
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1176
flow.h
SpmDestroyCtx
void SpmDestroyCtx(SpmCtx *ctx)
Definition: util-spm.c:183
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