suricata
detect-dns-name.c
Go to the documentation of this file.
1 /* Copyright (C) 2025 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  * Detect keyword for DNS rrnames:
22  * - dns.queries.rrname
23  * - dns.answers.rrname
24  * - dns.authorities.name
25  * - dns.additionals.name
26  */
27 
28 #include "detect.h"
29 #include "detect-parse.h"
30 #include "detect-engine.h"
31 #include "detect-engine-buffer.h"
33 #include "detect-engine-helper.h"
34 #include "detect-dns-name.h"
35 #include "rust.h"
36 
37 enum DnsSection {
38  DNS_QUERY = 0,
42 };
43 
44 static int query_buffer_id = 0;
45 static int answer_buffer_id = 0;
46 static int authority_buffer_id = 0;
47 static int additional_buffer_id = 0;
48 
49 static int DetectSetup(DetectEngineCtx *de_ctx, Signature *s, const char *str, int id)
50 {
51  if (SCDetectBufferSetActiveList(de_ctx, s, id) < 0) {
52  return -1;
53  }
55  return -1;
56  }
57 
58  return 0;
59 }
60 
61 static int SetupQueryBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
62 {
63  return DetectSetup(de_ctx, s, str, query_buffer_id);
64 }
65 
66 static int SetupAnswerBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
67 {
68  return DetectSetup(de_ctx, s, str, answer_buffer_id);
69 }
70 
71 static int SetupAdditionalsBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
72 {
73  return DetectSetup(de_ctx, s, str, additional_buffer_id);
74 }
75 
76 static int SetupAuthoritiesBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
77 {
78  return DetectSetup(de_ctx, s, str, authority_buffer_id);
79 }
80 
81 static int Register(const char *keyword, const char *desc, const char *doc,
82  int (*Setup)(DetectEngineCtx *, Signature *, const char *),
84 {
85  int keyword_id = SCDetectHelperNewKeywordId();
86  sigmatch_table[keyword_id].name = keyword;
87  sigmatch_table[keyword_id].desc = desc;
88  sigmatch_table[keyword_id].url = doc;
89  sigmatch_table[keyword_id].Setup = Setup;
90  sigmatch_table[keyword_id].flags |= SIGMATCH_NOOPT;
92 
93  DetectAppLayerMultiRegister(keyword, ALPROTO_DNS, SIG_FLAG_TOSERVER, 1, GetBufferFn, 2);
94  DetectAppLayerMultiRegister(keyword, ALPROTO_DNS, SIG_FLAG_TOCLIENT, 1, GetBufferFn, 2);
95 
96  DetectBufferTypeSetDescriptionByName(keyword, keyword);
98 
99  return DetectBufferTypeGetByName(keyword);
100 }
101 
103 {
104  query_buffer_id = Register("dns.queries.rrname", "DNS query rrname sticky buffer",
105  "/rules/dns-keywords.html#dns.queries.rrname", SetupQueryBuffer, SCDnsTxGetQueryName);
106  answer_buffer_id = Register("dns.answers.rrname", "DNS answer rrname sticky buffer",
107  "/rules/dns-keywords.html#dns.answers.rrname", SetupAnswerBuffer, SCDnsTxGetAnswerName);
108  additional_buffer_id =
109  Register("dns.additionals.rrname", "DNS additionals rrname sticky buffer",
110  "/rules/dns-keywords.html#dns-additionals-rrname", SetupAdditionalsBuffer,
111  SCDnsTxGetAdditionalName);
112  authority_buffer_id = Register("dns.authorities.rrname", "DNS authorities rrname sticky buffer",
113  "/rules/dns-keywords.html#dns-authorities-rrname", SetupAuthoritiesBuffer,
114  SCDnsTxGetAuthorityName);
115 }
DNS_ANSWER
@ DNS_ANSWER
Definition: detect-dns-name.c:39
SigTableElmt_::url
const char * url
Definition: detect.h:1431
DetectSignatureSetAppProto
int DetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:2313
detect-engine.h
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect.h:1645
SigTableElmt_::desc
const char * desc
Definition: detect.h:1430
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:155
SCDetectHelperNewKeywordId
int SCDetectHelperNewKeywordId(void)
Definition: detect-engine-helper.c:103
ALPROTO_DNS
@ ALPROTO_DNS
Definition: app-layer-protos.h:47
SigTableElmt_::name
const char * name
Definition: detect.h:1428
DNS_AUTHORITY
@ DNS_AUTHORITY
Definition: detect-dns-name.c:40
DnsSection
DnsSection
Definition: detect-dns-name.c:37
SigTableElmt_::flags
uint16_t flags
Definition: detect.h:1422
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:931
DetectBufferTypeSupportsMultiInstance
void DetectBufferTypeSupportsMultiInstance(const char *name)
Definition: detect-engine.c:1107
rust.h
SCDetectBufferSetActiveList
int SCDetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine-buffer.c:29
detect-dns-name.h
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:271
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1413
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1157
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:18
detect.h
DetectDnsNameRegister
void DetectDnsNameRegister(void)
Definition: detect-dns-name.c:102
detect-engine-helper.h
InspectionMultiBufferGetDataPtr
bool(* InspectionMultiBufferGetDataPtr)(struct DetectEngineThreadCtx_ *det_ctx, const void *txv, const uint8_t flow_flags, uint32_t local_id, const uint8_t **buf, uint32_t *buf_len)
Definition: detect.h:427
detect-engine-content-inspection.h
DNS_QUERY
@ DNS_QUERY
Definition: detect-dns-name.c:38
detect-engine-buffer.h
str
#define str(s)
Definition: suricata-common.h:308
detect-parse.h
Signature_
Signature container.
Definition: detect.h:670
DNS_ADDITIONAL
@ DNS_ADDITIONAL
Definition: detect-dns-name.c:41
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect.h:1620
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1254
DetectAppLayerMultiRegister
void DetectAppLayerMultiRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectionMultiBufferGetDataPtr GetData, int priority)
Definition: detect-engine.c:2153