suricata
detect-tls-cert-subject.c
Go to the documentation of this file.
1 /* Copyright (C) 2007-2016 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_subject 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"
39 
40 #include "flow.h"
41 #include "flow-util.h"
42 #include "flow-var.h"
43 
44 #include "util-debug.h"
45 #include "util-unittest.h"
46 #include "util-spm.h"
47 #include "util-print.h"
48 
49 #include "stream-tcp.h"
50 
51 #include "app-layer.h"
52 #include "app-layer-ssl.h"
53 
54 #include "util-unittest.h"
55 #include "util-unittest-helper.h"
56 
57 static int DetectTlsSubjectSetup(DetectEngineCtx *, Signature *, const char *);
58 #ifdef UNITTESTS
59 static void DetectTlsSubjectRegisterTests(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 int g_tls_cert_subject_buffer_id = 0;
66 
67 /**
68  * \brief Registration function for keyword: tls.cert_subject
69  */
71 {
72  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].name = "tls.cert_subject";
73  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].alias = "tls_cert_subject";
74  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].desc = "content modifier to match specifically and only on the TLS cert subject buffer";
75  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].url = DOC_URL DOC_VERSION "/rules/tls-keywords.html#tls-cert-subject";
76  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].Setup = DetectTlsSubjectSetup;
77 #ifdef UNITTESTS
78  sigmatch_table[DETECT_AL_TLS_CERT_SUBJECT].RegisterTests = DetectTlsSubjectRegisterTests;
79 #endif
82 
86 
87  DetectAppLayerMpmRegister2("tls.cert_subject", SIG_FLAG_TOCLIENT, 2,
90 
91  DetectBufferTypeSetDescriptionByName("tls.cert_subject",
92  "TLS certificate subject");
93 
94  g_tls_cert_subject_buffer_id = DetectBufferTypeGetByName("tls.cert_subject");
95 }
96 
97 /**
98  * \brief this function setup the tls.cert_subject modifier keyword used in the rule
99  *
100  * \param de_ctx Pointer to the Detection Engine Context
101  * \param s Pointer to the Signature to which the current keyword belongs
102  * \param str Should hold an empty string always
103  *
104  * \retval 0 On success
105  * \retval -1 On failure
106  */
107 static int DetectTlsSubjectSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str)
108 {
109  if (DetectBufferSetActiveList(s, g_tls_cert_subject_buffer_id) < 0)
110  return -1;
111 
113  return -1;
114 
115  return 0;
116 }
117 
118 static InspectionBuffer *GetData(DetectEngineThreadCtx *det_ctx,
119  const DetectEngineTransforms *transforms, Flow *f,
120  const uint8_t flow_flags, void *txv, const int list_id)
121 {
122  InspectionBuffer *buffer = InspectionBufferGet(det_ctx, list_id);
123  if (buffer->inspect == NULL) {
124  const SSLState *ssl_state = (SSLState *)f->alstate;
125 
126  if (ssl_state->server_connp.cert0_subject == NULL) {
127  return NULL;
128  }
129 
130  const uint32_t data_len = strlen(ssl_state->server_connp.cert0_subject);
131  const uint8_t *data = (uint8_t *)ssl_state->server_connp.cert0_subject;
132 
133  InspectionBufferSetup(buffer, data, data_len);
134  InspectionBufferApplyTransforms(buffer, transforms);
135  }
136 
137  return buffer;
138 }
139 
140 #ifdef UNITTESTS
142 #endif
void DetectTlsSubjectRegister(void)
Registration function for keyword: tls.cert_subject.
SigTableElmt sigmatch_table[DETECT_TBLSIZE]
Definition: detect.h:1448
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1186
char * cert0_subject
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
SSLStateConnp server_connp
InspectionBuffer * InspectionBufferGet(DetectEngineThreadCtx *det_ctx, const int list_id)
const char * name
Definition: detect.h:1200
Signature container.
Definition: detect.h:522
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
main detection engine ctx
Definition: detect.h:761
SSLv[2.0|3.[0|1|2|3]] state structure.
void * alstate
Definition: flow.h:438
int DetectBufferTypeGetByName(const char *name)
#define str(s)
#define SIG_FLAG_TOCLIENT
Definition: detect.h:237
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1393
void DetectAppLayerInspectEngineRegister2(const char *name, AppProto alproto, uint32_t dir, int progress, InspectEngineFuncPtr2 Callback2, InspectionBufferGetDataPtr GetData)
register inspect engine at start up time
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.
const char * desc
Definition: detect.h:1202
int PrefilterGenericMpmRegister(DetectEngineCtx *de_ctx, SigGroupHead *sgh, MpmCtx *mpm_ctx, const DetectBufferMpmRegistery *mpm_reg, int list_id)
const char * alias
Definition: detect.h:1201
void InspectionBufferSetup(InspectionBuffer *buffer, const uint8_t *data, const uint32_t data_len)
setup the buffer with our initial data
void InspectionBufferApplyTransforms(InspectionBuffer *buffer, const DetectEngineTransforms *transforms)
#define SIGMATCH_NOOPT
Definition: detect.h:1369
const char * url
Definition: detect.h:1203
int DetectBufferSetActiveList(Signature *s, const int list)
const uint8_t * inspect
Definition: detect.h:343
#define DOC_URL
Definition: suricata.h:86
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
#define DOC_VERSION
Definition: suricata.h:91
uint16_t flags
Definition: detect.h:1194
Flow data structure.
Definition: flow.h:325
void(* RegisterTests)(void)
Definition: detect.h:1192