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 mdns_query_buffer_id = 0;
50 static int mdns_answer_buffer_id = 0;
51 static int mdns_authority_buffer_id = 0;
52 static int mdns_additional_buffer_id = 0;
53 
54 static int llmnr_query_buffer_id = 0;
55 static int llmnr_answer_buffer_id = 0;
56 static int llmnr_authority_buffer_id = 0;
57 static int llmnr_additional_buffer_id = 0;
58 
59 static int DetectSetupDNS(DetectEngineCtx *de_ctx, Signature *s, const char *str, int id)
60 {
61  if (SCDetectBufferSetActiveList(de_ctx, s, id) < 0) {
62  return -1;
63  }
65  return -1;
66  }
67 
68  return 0;
69 }
70 
71 static int DetectSetupMDNS(DetectEngineCtx *de_ctx, Signature *s, const char *str, int id)
72 {
73  if (SCDetectBufferSetActiveList(de_ctx, s, id) < 0) {
74  return -1;
75  }
77  return -1;
78  }
79 
80  return 0;
81 }
82 
83 static int DetectSetupLLMNR(DetectEngineCtx *de_ctx, Signature *s, const char *str, int id)
84 {
85  if (SCDetectBufferSetActiveList(de_ctx, s, id) < 0) {
86  return -1;
87  }
89  return -1;
90  }
91 
92  return 0;
93 }
94 
95 static int SetupQueryBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
96 {
97  return DetectSetupDNS(de_ctx, s, str, query_buffer_id);
98 }
99 
100 static int SetupAnswerBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
101 {
102  return DetectSetupDNS(de_ctx, s, str, answer_buffer_id);
103 }
104 
105 static int SetupAdditionalsBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
106 {
107  return DetectSetupDNS(de_ctx, s, str, additional_buffer_id);
108 }
109 
110 static int SetupAuthoritiesBuffer(DetectEngineCtx *de_ctx, Signature *s, const char *str)
111 {
112  return DetectSetupDNS(de_ctx, s, str, authority_buffer_id);
113 }
114 
115 static int SetupQueryBufferMdns(DetectEngineCtx *de_ctx, Signature *s, const char *str)
116 {
117  return DetectSetupMDNS(de_ctx, s, str, mdns_query_buffer_id);
118 }
119 
120 static int SetupAnswerBufferMdns(DetectEngineCtx *de_ctx, Signature *s, const char *str)
121 {
122  return DetectSetupMDNS(de_ctx, s, str, mdns_answer_buffer_id);
123 }
124 
125 static int SetupAdditionalsBufferMdns(DetectEngineCtx *de_ctx, Signature *s, const char *str)
126 {
127  return DetectSetupMDNS(de_ctx, s, str, mdns_additional_buffer_id);
128 }
129 
130 static int SetupAuthoritiesBufferMdns(DetectEngineCtx *de_ctx, Signature *s, const char *str)
131 {
132  return DetectSetupMDNS(de_ctx, s, str, mdns_authority_buffer_id);
133 }
134 
135 static int SetupQueryBufferLlmnr(DetectEngineCtx *de_ctx, Signature *s, const char *str)
136 {
137  return DetectSetupLLMNR(de_ctx, s, str, llmnr_query_buffer_id);
138 }
139 
140 static int SetupAnswerBufferLlmnr(DetectEngineCtx *de_ctx, Signature *s, const char *str)
141 {
142  return DetectSetupLLMNR(de_ctx, s, str, llmnr_answer_buffer_id);
143 }
144 
145 static int SetupAdditionalsBufferLlmnr(DetectEngineCtx *de_ctx, Signature *s, const char *str)
146 {
147  return DetectSetupLLMNR(de_ctx, s, str, llmnr_additional_buffer_id);
148 }
149 
150 static int SetupAuthoritiesBufferLlmnr(DetectEngineCtx *de_ctx, Signature *s, const char *str)
151 {
152  return DetectSetupLLMNR(de_ctx, s, str, llmnr_authority_buffer_id);
153 }
154 
155 static int Register(const char *keyword, const char *desc, const char *doc,
156  int (*Setup)(DetectEngineCtx *, Signature *, const char *),
157  InspectionMultiBufferGetDataPtr GetBufferFn, AppProto alproto)
158 {
159  int keyword_id = SCDetectHelperNewKeywordId();
160  sigmatch_table[keyword_id].name = keyword;
161  sigmatch_table[keyword_id].desc = desc;
162  sigmatch_table[keyword_id].url = doc;
163  sigmatch_table[keyword_id].Setup = Setup;
164  sigmatch_table[keyword_id].flags |= SIGMATCH_NOOPT;
166 
167  DetectAppLayerMultiRegister(keyword, alproto, SIG_FLAG_TOSERVER, 1, GetBufferFn, 2);
168  DetectAppLayerMultiRegister(keyword, alproto, SIG_FLAG_TOCLIENT, 1, GetBufferFn, 2);
169 
170  DetectBufferTypeSetDescriptionByName(keyword, keyword);
172 
173  return DetectBufferTypeGetByName(keyword);
174 }
175 
177 {
178  query_buffer_id = Register("dns.queries.rrname", "DNS query rrname sticky buffer",
179  "/rules/dns-keywords.html#dns-queries-rrname", SetupQueryBuffer, SCDnsTxGetQueryName,
180  ALPROTO_DNS);
181  answer_buffer_id = Register("dns.answers.rrname", "DNS answer rrname sticky buffer",
182  "/rules/dns-keywords.html#dns-answers-rrname", SetupAnswerBuffer, SCDnsTxGetAnswerName,
183  ALPROTO_DNS);
184  additional_buffer_id =
185  Register("dns.additionals.rrname", "DNS additionals rrname sticky buffer",
186  "/rules/dns-keywords.html#dns-additionals-rrname", SetupAdditionalsBuffer,
187  SCDnsTxGetAdditionalName, ALPROTO_DNS);
188  authority_buffer_id = Register("dns.authorities.rrname", "DNS authorities rrname sticky buffer",
189  "/rules/dns-keywords.html#dns-authorities-rrname", SetupAuthoritiesBuffer,
190  SCDnsTxGetAuthorityName, ALPROTO_DNS);
191 
192  mdns_query_buffer_id = Register("mdns.queries.rrname", "mDNS query rrname sticky buffer",
193  "/rules/mdns-keywords.html#mdns-queries-rrname", SetupQueryBufferMdns,
194  SCDnsTxGetQueryName, ALPROTO_MDNS);
195  mdns_answer_buffer_id = Register("mdns.answers.rrname", "mDNS answer rrname sticky buffer",
196  "/rules/mdns-keywords.html#mdns-answers-rrname", SetupAnswerBufferMdns,
197  SCMdnsTxGetAnswerName, ALPROTO_MDNS);
198  mdns_additional_buffer_id =
199  Register("mdns.additionals.rrname", "mDNS additionals rrname sticky buffer",
200  "/rules/mdns-keywords.html#mdns-additionals-rrname", SetupAdditionalsBufferMdns,
201  SCDnsTxGetAdditionalName, ALPROTO_MDNS);
202  mdns_authority_buffer_id =
203  Register("mdns.authorities.rrname", "mDNS authorities rrname sticky buffer",
204  "/rules/mdns-keywords.html#mdns-authorities-rrname", SetupAuthoritiesBufferMdns,
205  SCDnsTxGetAuthorityName, ALPROTO_MDNS);
206 
207  llmnr_query_buffer_id = Register("llmnr.queries.rrname", "LLMNR query rrname sticky buffer",
208  "/rules/llmnr-keywords.html#llmnr-queries-rrname", SetupQueryBufferLlmnr,
209  SCDnsTxGetQueryName, ALPROTO_LLMNR);
210  llmnr_answer_buffer_id = Register("llmnr.answers.rrname", "LLMNR answer rrname sticky buffer",
211  "/rules/llmnr-keywords.html#llmnr-answers-rrname", SetupAnswerBufferLlmnr,
212  SCDnsTxGetAnswerName, ALPROTO_LLMNR);
213  llmnr_additional_buffer_id =
214  Register("llmnr.additionals.rrname", "LLMNR additionals rrname sticky buffer",
215  "/rules/llmnr-keywords.html#llmnr-additionals-rrname",
216  SetupAdditionalsBufferLlmnr, SCDnsTxGetAdditionalName, ALPROTO_LLMNR);
217  llmnr_authority_buffer_id =
218  Register("llmnr.authorities.rrname", "LLMNR authorities rrname sticky buffer",
219  "/rules/llmnr-keywords.html#llmnr-authorities-rrname",
220  SetupAuthoritiesBufferLlmnr, SCDnsTxGetAuthorityName, ALPROTO_LLMNR);
221 }
DNS_ANSWER
@ DNS_ANSWER
Definition: detect-dns-name.c:39
SigTableElmt_::url
const char * url
Definition: detect.h:1512
detect-engine.h
SIGMATCH_NOOPT
#define SIGMATCH_NOOPT
Definition: detect-engine-register.h:311
SigTableElmt_::desc
const char * desc
Definition: detect.h:1511
sigmatch_table
SigTableElmt * sigmatch_table
Definition: detect-parse.c:79
SCDetectHelperNewKeywordId
int SCDetectHelperNewKeywordId(void)
Definition: detect-engine-helper.c:125
ALPROTO_DNS
@ ALPROTO_DNS
Definition: app-layer-protos.h:47
SigTableElmt_::name
const char * name
Definition: detect.h:1509
SigTableElmt_::flags
uint32_t flags
Definition: detect.h:1500
AppProto
uint16_t AppProto
Definition: app-layer-protos.h:87
DNS_AUTHORITY
@ DNS_AUTHORITY
Definition: detect-dns-name.c:40
DnsSection
DnsSection
Definition: detect-dns-name.c:37
DetectEngineCtx_
main detection engine ctx
Definition: detect.h:973
DetectBufferTypeSupportsMultiInstance
void DetectBufferTypeSupportsMultiInstance(const char *name)
Definition: detect-engine.c:1334
rust.h
SCDetectBufferSetActiveList
int SCDetectBufferSetActiveList(DetectEngineCtx *de_ctx, Signature *s, const int list)
Definition: detect-engine-buffer.c:29
detect-dns-name.h
SCDetectSignatureSetAppProto
int SCDetectSignatureSetAppProto(Signature *s, AppProto alproto)
Definition: detect-parse.c:2301
SIG_FLAG_TOCLIENT
#define SIG_FLAG_TOCLIENT
Definition: detect.h:271
SigTableElmt_::Setup
int(* Setup)(DetectEngineCtx *, Signature *, const char *)
Definition: detect.h:1491
DetectBufferTypeGetByName
int DetectBufferTypeGetByName(const char *name)
Definition: detect-engine.c:1384
SIGMATCH_INFO_MULTI_BUFFER
#define SIGMATCH_INFO_MULTI_BUFFER
Definition: detect-engine-register.h:343
SIG_FLAG_TOSERVER
#define SIG_FLAG_TOSERVER
Definition: detect.h:270
de_ctx
DetectEngineCtx * de_ctx
Definition: fuzz_siginit.c:22
detect.h
DetectDnsNameRegister
void DetectDnsNameRegister(void)
Definition: detect-dns-name.c:176
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-engine-helper.h:42
detect-engine-content-inspection.h
DNS_QUERY
@ DNS_QUERY
Definition: detect-dns-name.c:38
ALPROTO_LLMNR
@ ALPROTO_LLMNR
Definition: app-layer-protos.h:73
detect-engine-buffer.h
str
#define str(s)
Definition: suricata-common.h:316
ALPROTO_MDNS
@ ALPROTO_MDNS
Definition: app-layer-protos.h:72
detect-parse.h
Signature_
Signature container.
Definition: detect.h:675
SIGMATCH_INFO_STICKY_BUFFER
#define SIGMATCH_INFO_STICKY_BUFFER
Definition: detect-engine-register.h:333
DNS_ADDITIONAL
@ DNS_ADDITIONAL
Definition: detect-dns-name.c:41
DetectBufferTypeSetDescriptionByName
void DetectBufferTypeSetDescriptionByName(const char *name, const char *desc)
Definition: detect-engine.c:1481
DetectAppLayerMultiRegister
void DetectAppLayerMultiRegister(const char *name, AppProto alproto, uint32_t dir, int progress, InspectionMultiBufferGetDataPtr GetData, int priority)
Definition: detect-engine.c:2205