suricata
detect-tls-ja3-string.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.string keyword.
24  */
25 
26 #include "suricata-common.h"
27 #include "threads.h"
28 #include "debug.h"
29 #include "decode.h"
30 #include "detect.h"
31 
32 #include "detect-parse.h"
33 #include "detect-engine.h"
34 #include "detect-engine-mpm.h"
36 #include "detect-content.h"
37 #include "detect-pcre.h"
38 #include "detect-tls-ja3-string.h"
39 
40 #include "flow.h"
41 #include "flow-util.h"
42 #include "flow-var.h"
43 
44 #include "conf.h"
45 #include "conf-yaml-loader.h"
46 
47 #include "util-debug.h"
48 #include "util-unittest.h"
49 #include "util-spm.h"
50 #include "util-print.h"
51 #include "util-ja3.h"
52 
53 #include "stream-tcp.h"
54 
55 #include "app-layer.h"
56 #include "app-layer-ssl.h"
57 
58 #include "util-unittest.h"
59 #include "util-unittest-helper.h"
60 
61 static int DetectTlsJa3StringSetup(DetectEngineCtx *, Signature *, const char *);
62 #ifdef UNITTESTS
63 static void DetectTlsJa3StringRegisterTests(void);
64 #endif
65 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
66  const DetectEngineTransforms *transforms,
67  Flow *f, const uint8_t flow_flags,
68  void *txv, const int list_id);
69 static int g_tls_ja3_str_buffer_id = 0;
70 
71 /**
72  * \brief Registration function for keyword: ja3.string
73  */
75 {
78  sigmatch_table[DETECT_AL_TLS_JA3_STRING].desc = "content modifier to match the JA3 string buffer";
79  sigmatch_table[DETECT_AL_TLS_JA3_STRING].url = "/rules/ja3-keywords.html#ja3-string";
80  sigmatch_table[DETECT_AL_TLS_JA3_STRING].Setup = DetectTlsJa3StringSetup;
81 #ifdef UNITTESTS
82  sigmatch_table[DETECT_AL_TLS_JA3_STRING].RegisterTests = DetectTlsJa3StringRegisterTests;
83 #endif
86 
89 
92 
93  DetectBufferTypeSetDescriptionByName("ja3.string", "TLS JA3 string");
94 
95  g_tls_ja3_str_buffer_id = DetectBufferTypeGetByName("ja3.string");
96 }
97 
98 /**
99  * \brief this function setup the ja3.string modifier keyword used in the rule
100  *
101  * \param de_ctx Pointer to the Detection Engine Context
102  * \param s Pointer to the Signature to which the current keyword belongs
103  * \param str Should hold an empty string always
104  *
105  * \retval 0 On success
106  * \retval -1 On failure
107  */
108 static int DetectTlsJa3StringSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
109 {
110  if (DetectBufferSetActiveList(s, g_tls_ja3_str_buffer_id) < 0)
111  return -1;
112 
114  return -1;
115 
116  /* try to enable JA3 */
117  SSLEnableJA3();
118 
119  /* Check if JA3 is disabled */
120  if (!RunmodeIsUnittests() && Ja3IsDisabled("rule")) {
122  SCLogError(SC_WARN_JA3_DISABLED, "ja3(s) support is not enabled");
123  }
124  return -2;
125  }
126 
127  return 0;
128 }
129 
130 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
131  const DetectEngineTransforms *transforms, Flow *f,
132  const uint8_t flow_flags, void *txv, const int list_id)
133 {
134  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
135  if (buffer->inspect == NULL) {
136  const SSLState *ssl_state = (SSLState *)f->alstate;
137 
138  if (ssl_state->client_connp.ja3_str == NULL ||
139  ssl_state->client_connp.ja3_str->data == NULL) {
140  return NULL;
141  }
142 
143  const uint32_t data_len = strlen(ssl_state->client_connp.ja3_str->data);
144  const uint8_t *data = (uint8_t *)ssl_state->client_connp.ja3_str->data;
145 
146  InspectionBufferSetup(buffer, data, data_len);
147  InspectionBufferApplyTransforms(buffer, transforms);
148  }
149 
150  return buffer;
151 }
152 
153 #ifdef UNITTESTS
155 #endif
SigTableElmt_::url
const char * url
Definition: detect.h:1212
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1471
SSLState_
SSLv[2.0|3.[0|1|2|3]] state structure.
Definition: app-layer-ssl.h:233
detect-content.h
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1402
SigTableElmt_::desc
const char * desc
Definition: detect.h:1211
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1209
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:375
SSLState_::client_connp
SSLStateConnp client_connp
Definition: app-layer-ssl.h:250
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:33
DetectTlsJa3StringRegister
void DetectTlsJa3StringRegister(void)
Registration function for keyword: ja3.string.
Definition: detect-tls-ja3-string.c:74
InspectionBuffer
Definition: detect.h:343
threads.h
Flow_
Flow data structure.
Definition: flow.h:343
SC_WARN_JA3_DISABLED
@ SC_WARN_JA3_DISABLED
Definition: util-error.h:342
PrefilterGenericMpmRegister
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
Definition: detect-engine-prefilter.c:611
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1203
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:766
detect-tls-ja3-string.h
JA3Buffer_::data
char * data
Definition: util-ja3.h:30
util-ja3.h
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1195
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1060
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:879
Ja3IsDisabled
int Ja3IsDisabled(const char *type)
Check if JA3 is disabled.
Definition: util-ja3.c:263
detect-tls-ja3-string.c
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:236
decode.h
util-debug.h
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1009
util-print.h
detect-engine-mpm.h
detect.h
DETECT_AL_TLS_JA3_STRING
@ DETECT_AL_TLS_JA3_STRING
Definition: detect-engine-register.h:214
DetectEngineInspectBufferGeneric
int 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:1640
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:231
conf.h
SSLEnableJA3
void SSLEnableJA3(void)
if not explicitly disabled in config, enable ja3 support
Definition: app-layer-ssl.c:3057
RunmodeIsUnittests
int RunmodeIsUnittests(void)
Definition: suricata.c:263
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:292
SigTableElmt_::alias
const char * alias
Definition: detect.h:1210
suricata-common.h
InspectionBufferSetup
void InspectionBufferSetup(InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
Definition: detect-engine.c:1119
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1210
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
util-spm.h
SCLogError
#define SCLogError(err_code,...)
Macro used to log ERROR messages.
Definition: util-debug.h:257
InspectionBuffer::inspect
const uint8_t * inspect
Definition: detect.h:344
str
#define str(s)
Definition: suricata-common.h:273
Flow_::alstate
void * alstate
Definition: flow.h:454
detect-parse.h
Signature_
Signature container.
Definition: detect.h:527
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1378
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:991
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:907
flow.h
SSLStateConnp_::ja3_str
JA3Buffer * ja3_str
Definition: app-layer-ssl.h:218
flow-var.h
app-layer-ssl.h
debug.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1201
app-layer.h