suricata
detect-tls-cert-serial.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 tls.cert_serial 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 
39 #include "flow.h"
40 #include "flow-util.h"
41 #include "flow-var.h"
42 
43 #include "util-debug.h"
44 #include "util-unittest.h"
45 #include "util-spm.h"
46 #include "util-print.h"
47 
48 #include "stream-tcp.h"
49 
50 #include "app-layer.h"
51 #include "app-layer-ssl.h"
52 #include "detect-tls-cert-serial.h"
53 
54 #include "util-unittest.h"
55 #include "util-unittest-helper.h"
56 
57 static int DetectTlsSerialSetup(DetectEngineCtx *, Signature *, const char *);
58 #ifdef UNITTESTS
59 static void DetectTlsSerialRegisterTests(void);
60 #endif
61 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
62  const DetectEngineTransforms *transforms,
63  Flow *f, const uint8_t flow_flags,
64  void *txv, const int list_id);
65 static void DetectTlsSerialSetupCallback(const DetectEngineCtx *de_ctx,
66  Signature *s);
67 static bool DetectTlsSerialValidateCallback(const Signature *s,
68  const char **sigerror);
69 static int g_tls_cert_serial_buffer_id = 0;
70 
71 /**
72  * \brief Registration function for keyword: tls.cert_serial
73  */
75 {
76  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].name = "tls.cert_serial";
77  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].alias = "tls_cert_serial";
78  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].desc = "content modifier to match the TLS cert serial buffer";
79  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].url = "/rules/tls-keywords.html#tls-cert-serial";
80  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].Setup = DetectTlsSerialSetup;
81 #ifdef UNITTESTS
82  sigmatch_table[DETECT_AL_TLS_CERT_SERIAL].RegisterTests = DetectTlsSerialRegisterTests;
83 #endif
86 
90 
91  DetectAppLayerMpmRegister2("tls.cert_serial", SIG_FLAG_TOCLIENT, 2,
94 
95  DetectBufferTypeSetDescriptionByName("tls.cert_serial",
96  "TLS certificate serial number");
97 
98  DetectBufferTypeRegisterSetupCallback("tls.cert_serial",
99  DetectTlsSerialSetupCallback);
100 
102  DetectTlsSerialValidateCallback);
103 
104  g_tls_cert_serial_buffer_id = DetectBufferTypeGetByName("tls.cert_serial");
105 }
106 
107 /**
108  * \brief this function setup the tls_cert_serial modifier keyword used in the rule
109  *
110  * \param de_ctx Pointer to the Detection Engine Context
111  * \param s Pointer to the Signature to which the current keyword belongs
112  * \param str Should hold an empty string always
113  *
114  * \retval 0 On success
115  * \retval -1 On failure
116  */
117 static int DetectTlsSerialSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
118 {
119  if (DetectBufferSetActiveList(s, g_tls_cert_serial_buffer_id) < 0)
120  return -1;
121 
123  return -1;
124 
125  return 0;
126 }
127 
128 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
129  const DetectEngineTransforms *transforms, Flow *f,
130  const uint8_t flow_flags, void *txv, const int list_id)
131 {
132  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
133  if (buffer->inspect == NULL) {
134  const SSLState *ssl_state = (SSLState *)f->alstate;
135 
136  if (ssl_state->server_connp.cert0_serial == NULL) {
137  return NULL;
138  }
139 
140  const uint32_t data_len = strlen(ssl_state->server_connp.cert0_serial);
141  const uint8_t *data = (uint8_t *)ssl_state->server_connp.cert0_serial;
142 
143  InspectionBufferSetup(buffer, data, data_len);
144  InspectionBufferApplyTransforms(buffer, transforms);
145  }
146 
147  return buffer;
148 }
149 
150 static bool DetectTlsSerialValidateCallback(const Signature *s,
151  const char **sigerror)
152 {
153  const SigMatch *sm = s->init_data->smlists[g_tls_cert_serial_buffer_id];
154  for ( ; sm != NULL; sm = sm->next)
155  {
156  if (sm->type != DETECT_CONTENT)
157  continue;
158 
159  const DetectContentData *cd = (DetectContentData *)sm->ctx;
160 
161  if (cd->flags & DETECT_CONTENT_NOCASE) {
162  *sigerror = "tls.cert_serial should not be used together "
163  "with nocase, since the rule is automatically "
164  "uppercased anyway which makes nocase redundant.";
165  SCLogWarning(SC_WARN_POOR_RULE, "rule %u: %s", s->id, *sigerror);
166  }
167 
168  /* no need to worry about this if the content is short enough */
169  if (cd->content_len <= 2)
170  return TRUE;
171 
172  uint32_t u;
173  for (u = 0; u < cd->content_len; u++)
174  if (cd->content[u] == ':')
175  return TRUE;
176 
177  *sigerror = "No colon delimiters ':' detected in content after "
178  "tls.cert_serial. This rule will therefore never "
179  "match.";
180  SCLogWarning(SC_WARN_POOR_RULE, "rule %u: %s", s->id, *sigerror);
181 
182  return FALSE;
183  }
184 
185  return TRUE;
186 }
187 
188 static void DetectTlsSerialSetupCallback(const DetectEngineCtx *de_ctx,
189  Signature *s)
190 {
191  SigMatch *sm = s->init_data->smlists[g_tls_cert_serial_buffer_id];
192  for ( ; sm != NULL; sm = sm->next)
193  {
194  if (sm->type != DETECT_CONTENT)
195  continue;
196 
198 
199  bool changed = FALSE;
200  uint32_t u;
201  for (u = 0; u < cd->content_len; u++)
202  {
203  if (islower(cd->content[u])) {
204  cd->content[u] = toupper(cd->content[u]);
205  changed = TRUE;
206  }
207  }
208 
209  /* recreate the context if changes were made */
210  if (changed) {
211  SpmDestroyCtx(cd->spm_ctx);
212  cd->spm_ctx = SpmInitCtx(cd->content, cd->content_len, 1,
214  }
215  }
216 }
217 
218 #ifdef UNITTESTS
220 #endif
DETECT_CONTENT_NOCASE
#define DETECT_CONTENT_NOCASE
Definition: detect-content.h:29
SigTableElmt_::url
const char * url
Definition: detect.h:1214
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:1480
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:1404
SigTableElmt_::desc
const char * desc
Definition: detect.h:1213
flow-util.h
DetectTlsSerialRegister
void DetectTlsSerialRegister(void)
Registration function for keyword: tls.cert_serial.
Definition: detect-tls-cert-serial.c:74
SigTableElmt_::name
const char * name
Definition: detect.h:1211
stream-tcp.h
DetectEngineTransforms
Definition: detect.h:376
DETECT_CONTENT
@ DETECT_CONTENT
Definition: detect-engine-register.h:59
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:33
detect-tls-cert-serial.c
SSLState_::server_connp
SSLStateConnp server_connp
Definition: app-layer-ssl.h:251
InspectionBuffer
Definition: detect.h:344
threads.h
Flow_
Flow data structure.
Definition: flow.h:347
DetectBufferTypeRegisterSetupCallback
void DetectBufferTypeRegisterSetupCallback(const char *name, void(*SetupCallback)(const DetectEngineCtx *, Signature *))
Definition: detect-engine.c:953
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:1205
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:767
DetectContentData_
Definition: detect-content.h:86
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:237
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1196
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
InspectionBufferGet
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
Definition: detect-engine.c:1061
util-unittest-helper.h
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:880
SC_WARN_POOR_RULE
@ SC_WARN_POOR_RULE
Definition: util-error.h:309
decode.h
util-debug.h
DetectBufferTypeRegisterValidateCallback
void DetectBufferTypeRegisterValidateCallback(const char *name, bool(*ValidateCallback)(const Signature *, const char **sigerror))
Definition: detect-engine.c:972
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:17
DetectEngineThreadCtx_
Definition: detect.h:1010
TLS_STATE_CERT_READY
@ TLS_STATE_CERT_READY
Definition: app-layer-ssl.h:70
util-print.h
detect-engine-mpm.h
detect.h
SigMatch_::next
struct SigMatch_ * next
Definition: detect.h:324
TRUE
#define TRUE
Definition: suricata-common.h:33
SigMatch_::ctx
SigMatchCtx * ctx
Definition: detect.h:323
FALSE
#define FALSE
Definition: suricata-common.h:34
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:1641
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:232
DetectContentData_::flags
uint32_t flags
Definition: detect-content.h:97
Signature_::init_data
SignatureInitData * init_data
Definition: detect.h:597
SignatureInitData_::smlists
struct SigMatch_ ** smlists
Definition: detect.h:522
SigMatch_::type
uint8_t type
Definition: detect.h:321
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
SigTableElmt_::alias
const char * alias
Definition: detect.h:1212
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:1120
InspectionBufferApplyTransforms
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
Definition: detect-engine.c:1211
sigmatch_table
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect-parse.c:73
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:345
str
#define str(s)
Definition: suricata-common.h:273
SCLogWarning
#define SCLogWarning(err_code,...)
Macro used to log WARNING messages.
Definition: util-debug.h:244
Flow_::alstate
void * alstate
Definition: flow.h:476
Signature_::id
uint32_t id
Definition: detect.h:561
detect-parse.h
Signature_
Signature container.
Definition: detect.h:528
SigMatch_
a single match condition for a signature
Definition: detect.h:320
DetectContentData_::content_len
uint16_t content_len
Definition: detect-content.h:88
DETECT_AL_TLS_CERT_SERIAL
@ DETECT_AL_TLS_CERT_SERIAL
Definition: detect-engine-register.h:219
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1380
detect-tls-cert-serial.h
DetectEngineCtx_::spm_global_thread_ctx
SpmGlobalThreadCtx * spm_global_thread_ctx
Definition: detect.h:821
DetectBufferSetActiveList
int DetectBufferSetActiveList(Signature *s, const int list)
Definition: detect-engine.c:992
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:908
flow.h
SpmDestroyCtx
void SpmDestroyCtx(SpmCtx *ctx)
Definition: util-spm.c:184
flow-var.h
SSLStateConnp_::cert0_serial
char * cert0_serial
Definition: app-layer-ssl.h:204
SpmInitCtx
SpmCtx * SpmInitCtx(const uint8_t *needle, uint16_t needle_len, int nocase, SpmGlobalThreadCtx *global_thread_ctx)
Definition: util-spm.c:174
app-layer-ssl.h
debug.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1203
app-layer.h