suricata
detect-tls-certs.c
Go to the documentation of this file.
1 /* Copyright (C) 2019-2022 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.certs 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-buffer.h"
34 #include "detect-engine-mpm.h"
37 #include "detect-content.h"
38 #include "detect-pcre.h"
39 #include "detect-tls-certs.h"
40 #include "detect-engine-uint.h"
41 
42 #include "flow.h"
43 #include "flow-util.h"
44 #include "flow-var.h"
45 
46 #include "util-debug.h"
47 #include "util-spm.h"
48 #include "util-print.h"
49 
50 #include "stream-tcp.h"
51 
52 #include "app-layer.h"
53 #include "app-layer-ssl.h"
54 
55 #include "util-profiling.h"
56 #include "util-unittest.h"
57 #include "util-unittest-helper.h"
58 
59 static int DetectTlsCertsSetup(DetectEngineCtx *, Signature *, const char *);
60 #ifdef UNITTESTS
61 static void DetectTlsCertsRegisterTests(void);
62 #endif
63 
64 static int g_tls_certs_buffer_id = 0;
65 
66 static bool TlsCertsGetData(DetectEngineThreadCtx *det_ctx, const void *txv, const uint8_t flags,
67  uint32_t local_id, const uint8_t **buf, uint32_t *buf_len)
68 {
69  const SSLState *ssl_state = (SSLState *)txv;
70  const SSLStateConnp *connp;
71 
72  if (flags & STREAM_TOSERVER) {
73  connp = &ssl_state->client_connp;
74  } else {
75  connp = &ssl_state->server_connp;
76  }
77 
78  if (TAILQ_EMPTY(&connp->certs)) {
79  return false;
80  }
81 
82  SSLCertsChain *cert;
83  if (local_id == 0) {
84  cert = TAILQ_FIRST(&connp->certs);
85  } else {
86  // TODO optimize ?
87  cert = TAILQ_FIRST(&connp->certs);
88  for (uint32_t i = 0; i < local_id; i++) {
89  cert = TAILQ_NEXT(cert, next);
90  }
91  }
92  if (cert == NULL) {
93  return false;
94  }
95 
96  *buf = cert->cert_data;
97  *buf_len = cert->cert_len;
98  return true;
99 }
100 
101 /**
102  * \brief Registration function for keyword: tls.certs
103  */
105 {
106  sigmatch_table[DETECT_TLS_CERTS].name = "tls.certs";
107  sigmatch_table[DETECT_TLS_CERTS].desc = "sticky buffer to match the TLS certificate buffer";
108  sigmatch_table[DETECT_TLS_CERTS].url = "/rules/tls-keywords.html#tls-certs";
109  sigmatch_table[DETECT_TLS_CERTS].Setup = DetectTlsCertsSetup;
110 #ifdef UNITTESTS
111  sigmatch_table[DETECT_TLS_CERTS].RegisterTests = DetectTlsCertsRegisterTests;
112 #endif
116 
118  TLS_STATE_SERVER_CERT_DONE, TlsCertsGetData, 2);
120  TLS_STATE_CLIENT_CERT_DONE, TlsCertsGetData, 2);
121 
122  DetectBufferTypeSetDescriptionByName("tls.certs", "TLS certificate");
123 
125 
126  g_tls_certs_buffer_id = DetectBufferTypeGetByName("tls.certs");
127 }
128 
129 /**
130  * \brief This function setup the tls.certs modifier keyword
131  *
132  * \param de_ctx Pointer to the Detect Engine Context
133  * \param s Pointer to the Signature to which the keyword belongs
134  * \param str Should hold an empty string always
135  *
136  * \retval 0 On success
137  * \retval -1 On failure
138  */
139 static int DetectTlsCertsSetup(DetectEngineCtx *de_ctx, Signature *s,
140  const char *str)
141 {
142  if (SCDetectBufferSetActiveList(de_ctx, s, g_tls_certs_buffer_id) < 0)
143  return -1;
144 
146  return -1;
147 
148  return 0;
149 }
150 
151 static int g_tls_cert_buffer_id = 0;
152 #define BUFFER_NAME "tls:server_cert_done:generic"
153 #define KEYWORD_ID DETECT_TLS_CHAIN_LEN
154 #define KEYWORD_NAME "tls.cert_chain_len"
155 #define KEYWORD_DESC "match TLS certificate chain length"
156 #define KEYWORD_URL "/rules/tls-keywords.html#tls-cert-chain-len"
157 
158 /**
159  * \internal
160  * \brief Function to match cert chain length in TLS
161  *
162  * \param t Pointer to thread vars.
163  * \param det_ctx Pointer to the pattern matcher thread.
164  * \param f Pointer to the current flow.
165  * \param flags Flags.
166  * \param state App layer state.
167  * \param s Pointer to the Signature.
168  * \param m Pointer to the sigmatch that we will cast into
169  * DetectU64Data.
170  *
171  * \retval 0 no match.
172  * \retval 1 match.
173  */
174 static int DetectTLSCertChainLenMatch(DetectEngineThreadCtx *det_ctx, Flow *f, uint8_t flags,
175  void *state, void *txv, const Signature *s, const SigMatchCtx *ctx)
176 {
177  SCEnter();
178 
179  SSLState *ssl_state = state;
180  if (flags & STREAM_TOCLIENT) {
181  SSLStateConnp *connp = &ssl_state->server_connp;
182  uint32_t cnt = 0;
183  SSLCertsChain *cert;
184  TAILQ_FOREACH (cert, &connp->certs, next) {
185  cnt++;
186  }
187  SCLogDebug("%u certs in chain", cnt);
188 
189  const DetectU32Data *dd = (const DetectU32Data *)ctx;
190  if (DetectU32Match(cnt, dd)) {
191  SCReturnInt(1);
192  }
193  }
194  SCReturnInt(0);
195 }
196 
197 /**
198  * \internal
199  * \brief Function to free memory associated with DetectU64Data.
200  *
201  * \param de_ptr Pointer to DetectU64Data.
202  */
203 static void DetectTLSCertChainLenFree(DetectEngineCtx *de_ctx, void *ptr)
204 {
205  SCDetectU32Free(ptr);
206 }
207 
208 /**
209  * \brief Function to add the parsed tls cert chain len field into the current signature.
210  *
211  * \param de_ctx Pointer to the Detection Engine Context.
212  * \param s Pointer to the Current Signature.
213  * \param rawstr Pointer to the user provided flags options.
214  * \param type Defines if this is notBefore or notAfter.
215  *
216  * \retval 0 on Success.
217  * \retval -1 on Failure.
218  */
219 static int DetectTLSCertChainLenSetup(DetectEngineCtx *de_ctx, Signature *s, const char *rawstr)
220 {
222  return -1;
223 
224  DetectU32Data *dd = DetectU32Parse(rawstr);
225  if (dd == NULL) {
226  SCLogError("Parsing \'%s\' failed for %s", rawstr, sigmatch_table[KEYWORD_ID].name);
227  return -1;
228  }
229 
230  if (SCSigMatchAppendSMToList(de_ctx, s, KEYWORD_ID, (SigMatchCtx *)dd, g_tls_cert_buffer_id) ==
231  NULL) {
232  SCDetectU32Free(dd);
233  return -1;
234  }
235  return 0;
236 }
237 
239 {
243  sigmatch_table[KEYWORD_ID].AppLayerTxMatch = DetectTLSCertChainLenMatch;
244  sigmatch_table[KEYWORD_ID].Setup = DetectTLSCertChainLenSetup;
245  sigmatch_table[KEYWORD_ID].Free = DetectTLSCertChainLenFree;
247 
248  g_tls_cert_buffer_id = DetectBufferTypeGetByName(BUFFER_NAME);
249 }
250 
251 #ifdef UNITTESTS
252 #include "tests/detect-tls-certs.c"
253 #endif
detect-engine-uint.h
SigTableElmt_::url
const char * url
Definition: detect.h:1460
SSLState_
SSLv[2.0|3.[0|1|2|3]] state structure.
Definition: app-layer-ssl.h:227
detect-content.h
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1674
DetectU32Match
int DetectU32Match(const uint32_t parg, const DetectUintData_u32 *du32)
Definition: detect-engine-uint.c:31
SSLCertsChain_::cert_len
uint32_t cert_len
Definition: app-layer-ssl.h:163
SigTableElmt_::desc
const char * desc
Definition: detect.h:1459
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
SigTableElmt_::Free
void(* Free)(DetectEngineCtx *, void *)
Definition: detect.h:1444
flow-util.h
SigTableElmt_::name
const char * name
Definition: detect.h:1457
stream-tcp.h
SSLState_::client_connp
SSLStateConnp client_connp
Definition: app-layer-ssl.h:248
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1448
ALPROTO_TLS
@ ALPROTO_TLS
Definition: app-layer-protos.h:39
SCLogDebug
#define SCLogDebug(...)
Definition: util-debug.h:279
DetectU32Parse
DetectUintData_u32 * DetectU32Parse(const char *u32str)
This function is used to parse u32 options passed via some u32 keyword.
Definition: detect-engine-uint.c:45
next
struct HtpBodyChunk_ * next
Definition: app-layer-htp.h:0
SSLState_::server_connp
SSLStateConnp server_connp
Definition: app-layer-ssl.h:249
SSLStateConnp_
Definition: app-layer-ssl.h:167
KEYWORD_NAME
#define KEYWORD_NAME
Definition: detect-tls-certs.c:154
threads.h
Flow_
Flow data structure.
Definition: flow.h:348
ctx
struct Thresholds ctx
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:932
TAILQ_EMPTY
#define TAILQ_EMPTY(head)
Definition: queue.h:248
DetectBufferTypeSupportsMultiInstance
void DetectBufferTypeSupportsMultiInstance(const char *name)
Definition: detect-engine.c:1228
TAILQ_FOREACH
#define TAILQ_FOREACH(var, head, field)
Definition: queue.h:252
SigTableElmt_::AppLayerTxMatch
int(* AppLayerTxMatch)(DetectEngineThreadCtx *, Flow *, uint8_t flags, void *alstate, void *txv, const Signature *, const SigMatchCtx *)
Definition: detect.h:1422
SCDetectBufferSetActiveList
int SCDetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine-buffer.c:29
SCDetectSignatureSetAppProto
int SCDetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:2229
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:272
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1439
detect-pcre.h
detect-engine-prefilter.h
util-unittest.h
util-unittest-helper.h
KEYWORD_ID
#define KEYWORD_ID
Definition: detect-tls-certs.c:153
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1278
SIGMATCH_INFO_UINT32
#define SIGMATCH_INFO_UINT32
Definition: detect.h:1690
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:271
KEYWORD_DESC
#define KEYWORD_DESC
Definition: detect-tls-certs.c:155
decode.h
util-debug.h
TAILQ_FIRST
#define TAILQ_FIRST(head)
Definition: queue.h:250
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
DetectEngineThreadCtx_
Definition: detect.h:1244
SSLCertsChain_
Definition: app-layer-ssl.h:161
util-print.h
SCEnter
#define SCEnter(...)
Definition: util-debug.h:281
detect-engine-mpm.h
SCSigMatchAppendSMToList
SigMatch * SCSigMatchAppendSMToList(DetectEngineCtx *de_ctx, Signature *s, uint16_t type, SigMatchCtx *ctx, const int list)
Append a SigMatch to the list type.
Definition: detect-parse.c:388
detect.h
BUFFER_NAME
#define BUFFER_NAME
Definition: detect-tls-certs.c:152
util-profiling.h
name
const char * name
Definition: tm-threads.c:2163
TLS_STATE_SERVER_CERT_DONE
@ TLS_STATE_SERVER_CERT_DONE
Definition: app-layer-ssl.h:88
DetectTlsCertsRegister
void DetectTlsCertsRegister(void)
Registration function for keyword: tls.certs.
Definition: detect-tls-certs.c:104
SSLCertsChain_::cert_data
uint8_t * cert_data
Definition: app-layer-ssl.h:162
detect-engine-content-inspection.h
SigMatchCtx_
Used to start a pointer to SigMatch context Should never be dereferenced without casting to something...
Definition: detect.h:351
detect-tls-certs.c
cnt
uint32_t cnt
Definition: tmqh-packetpool.h:7
flags
uint8_t flags
Definition: decode-gre.h:0
suricata-common.h
DetectU32Data
DetectUintData_u32 DetectU32Data
Definition: detect-engine-uint.h:41
TAILQ_NEXT
#define TAILQ_NEXT(elm, field)
Definition: queue.h:307
util-spm.h
detect-engine-buffer.h
KEYWORD_URL
#define KEYWORD_URL
Definition: detect-tls-certs.c:156
TLS_STATE_CLIENT_CERT_DONE
@ TLS_STATE_CLIENT_CERT_DONE
Definition: app-layer-ssl.h:80
SIGMATCH_INFO_MULTI_BUFFER
#define SIGMATCH_INFO_MULTI_BUFFER
Definition: detect.h:1684
detect-tls-certs.h
str
#define str(s)
Definition: suricata-common.h:308
SCLogError
#define SCLogError(...)
Macro used to log ERROR messages.
Definition: util-debug.h:271
detect-parse.h
Signature_
Signature container.
Definition: detect.h:668
DETECT_TLS_CERTS
@ DETECT_TLS_CERTS
Definition: detect-engine-register.h:247
DetectTlsCertChainLenRegister
void DetectTlsCertChainLenRegister(void)
Definition: detect-tls-certs.c:238
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1649
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1375
DetectAppLayerMultiRegister
void DetectAppLayerMultiRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectionMultiBufferGetDataPtr GetData, int priority)
Definition: detect-engine.c:2099
flow.h
SCReturnInt
#define SCReturnInt(x)
Definition: util-debug.h:285
flow-var.h
app-layer-ssl.h
SigTableElmt_::RegisterTests
void(* RegisterTests)(void)
Definition: detect.h:1446
app-layer.h