suricata
app-layer-smb.c
Go to the documentation of this file.
1 /* Copyright (C) 2017-2021 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  * SMB protocol handling
22  */
23 
24 #include "suricata-common.h"
25 #include "suricata.h"
26 
27 #include "app-layer-protos.h"
28 #include "app-layer-detect-proto.h"
29 #include "app-layer-parser.h"
30 
31 #include "util-unittest.h"
32 
33 #include "rust.h"
34 #include "app-layer-smb.h"
35 #include "util-misc.h"
36 
37 
39 static SuricataFileContext sfc = { &sbcfg };
40 
41 #ifdef UNITTESTS
42 static void SMBParserRegisterTests(void);
43 #endif
44 
46 {
47  rs_smb_init(&sfc);
48  rs_smb_register_parser();
49 
50 #ifdef UNITTESTS
51  AppLayerParserRegisterProtocolUnittests(IPPROTO_TCP, ALPROTO_SMB, SMBParserRegisterTests);
52 #endif
53 
54  return;
55 }
56 
57 #ifdef UNITTESTS
58 #include "stream-tcp.h"
59 #include "util-unittest-helper.h"
60 
61 /** \test multi transactions and cleanup */
62 static int SMBParserTxCleanupTest(void)
63 {
64  uint64_t ret[4];
67 
68  StreamTcpInitConfig(true);
69  TcpSession ssn;
70  memset(&ssn, 0, sizeof(ssn));
71 
72  Flow *f = UTHBuildFlow(AF_INET, "1.2.3.4", "1.2.3.5", 1024, 445);
73  FAIL_IF_NULL(f);
74  f->protoctx = &ssn;
75  f->proto = IPPROTO_TCP;
76  f->alproto = ALPROTO_SMB;
77 
78  char req_str[] ="\x00\x00\x00\x79\xfe\x53\x4d\x42\x40\x00\x01\x00\x00\x00\x00\x00" \
79  "\x05\x00\xe0\x1e\x10\x00\x00\x00\x00\x00\x00\x00\x0b\x00\x00\x00" \
80  "\x00\x00\x00\x00\x00\x00\x00\x00\x10\x72\xd2\x9f\x36\xc2\x08\x14" \
81  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
82  "\x00\x00\x00\x00\x39\x00\x00\x00\x02\x00\x00\x00\x00\x00\x00\x00" \
83  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x80\x00\x00\x00" \
84  "\x00\x00\x00\x00\x07\x00\x00\x00\x01\x00\x00\x00\x00\x00\x00\x00" \
85  "\x78\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00";
86  req_str[28] = 0x01;
87  int r = AppLayerParserParse(NULL, alp_tctx, f, ALPROTO_SMB,
88  STREAM_TOSERVER | STREAM_START, (uint8_t *)req_str, sizeof(req_str));
89  FAIL_IF_NOT(r == 0);
90  req_str[28]++;
92  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
93  FAIL_IF_NOT(r == 0);
94  req_str[28]++;
96  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
97  FAIL_IF_NOT(r == 0);
98  req_str[28]++;
100  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
101  FAIL_IF_NOT(r == 0);
102  req_str[28]++;
104  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
105  FAIL_IF_NOT(r == 0);
106  req_str[28]++;
108  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
109  FAIL_IF_NOT(r == 0);
110  req_str[28]++;
112  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
113  FAIL_IF_NOT(r == 0);
114  req_str[28]++;
116  STREAM_TOSERVER, (uint8_t *)req_str, sizeof(req_str));
117  FAIL_IF_NOT(r == 0);
118  req_str[28]++;
119 
120  AppLayerParserTransactionsCleanup(f, STREAM_TOSERVER);
121  UTHAppLayerParserStateGetIds(f->alparser, &ret[0], &ret[1], &ret[2], &ret[3]);
122  FAIL_IF_NOT(ret[0] == 0); // inspect_id[0]
123  FAIL_IF_NOT(ret[1] == 0); // inspect_id[1]
124  FAIL_IF_NOT(ret[2] == 0); // log_id
125  FAIL_IF_NOT(ret[3] == 0); // min_id
126 
127  char resp_str[] = "\x00\x00\x00\x98\xfe\x53\x4d\x42\x40\x00\x01\x00\x00\x00\x00\x00" \
128  "\x05\x00\x21\x00\x11\x00\x00\x00\x00\x00\x00\x00\x0b\x00\x00\x00" \
129  "\x00\x00\x00\x00\x00\x00\x00\x00\x10\x72\xd2\x9f\x36\xc2\x08\x14" \
130  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00" \
131  "\x00\x00\x00\x00\x59\x00\x00\x00\x01\x00\x00\x00\x48\x38\x40\xb3" \
132  "\x0f\xa8\xd3\x01\x84\x9a\x2b\x46\xf7\xa8\xd3\x01\x48\x38\x40\xb3" \
133  "\x0f\xa8\xd3\x01\x48\x38\x40\xb3\x0f\xa8\xd3\x01\x00\x00\x00\x00" \
134  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x10\x00\x00\x00" \
135  "\x00\x00\x00\x00\x9e\x8f\xb8\x91\x00\x00\x00\x00\x01\x5b\x11\xbb" \
136  "\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00\x00";
137 
138  resp_str[28] = 0x01;
140  STREAM_TOCLIENT | STREAM_START, (uint8_t *)resp_str, sizeof(resp_str));
141  FAIL_IF_NOT(r == 0);
142  resp_str[28] = 0x04;
144  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
145  FAIL_IF_NOT(r == 0);
146  resp_str[28] = 0x05;
148  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
149  FAIL_IF_NOT(r == 0);
150  resp_str[28] = 0x06;
152  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
153  FAIL_IF_NOT(r == 0);
154  resp_str[28] = 0x08;
156  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
157  FAIL_IF_NOT(r == 0);
158  resp_str[28] = 0x02;
160  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
161  FAIL_IF_NOT(r == 0);
162  resp_str[28] = 0x07;
164  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
165  FAIL_IF_NOT(r == 0);
166  AppLayerParserTransactionsCleanup(f, STREAM_TOCLIENT);
167 
168  UTHAppLayerParserStateGetIds(f->alparser, &ret[0], &ret[1], &ret[2], &ret[3]);
169  FAIL_IF_NOT(ret[0] == 2); // inspect_id[0]
170  FAIL_IF_NOT(ret[1] == 2); // inspect_id[1]
171  FAIL_IF_NOT(ret[2] == 2); // log_id
172  FAIL_IF_NOT(ret[3] == 2); // min_id
173 
174  resp_str[28] = 0x03;
176  STREAM_TOCLIENT, (uint8_t *)resp_str, sizeof(resp_str));
177  FAIL_IF_NOT(r == 0);
178  AppLayerParserTransactionsCleanup(f, STREAM_TOCLIENT);
179 
180  UTHAppLayerParserStateGetIds(f->alparser, &ret[0], &ret[1], &ret[2], &ret[3]);
181  FAIL_IF_NOT(ret[0] == 8); // inspect_id[0]
182  FAIL_IF_NOT(ret[1] == 8); // inspect_id[1]
183  FAIL_IF_NOT(ret[2] == 8); // log_id
184  FAIL_IF_NOT(ret[3] == 8); // min_id
185 
186  req_str[28] = 0x09;
188  STREAM_TOSERVER | STREAM_EOF, (uint8_t *)req_str, sizeof(req_str));
189  FAIL_IF_NOT(r == 0);
190  AppLayerParserTransactionsCleanup(f, STREAM_TOSERVER);
191 
192  UTHAppLayerParserStateGetIds(f->alparser, &ret[0], &ret[1], &ret[2], &ret[3]);
193  FAIL_IF_NOT(ret[0] == 8); // inspect_id[0] not updated by ..Cleanup() until full tx is done
194  FAIL_IF_NOT(ret[1] == 8); // inspect_id[1]
195  FAIL_IF_NOT(ret[2] == 8); // log_id
196  FAIL_IF_NOT(ret[3] == 8); // min_id
197 
198  resp_str[28] = 0x09;
200  STREAM_TOCLIENT | STREAM_EOF, (uint8_t *)resp_str, sizeof(resp_str));
201  FAIL_IF_NOT(r == 0);
202  AppLayerParserTransactionsCleanup(f, STREAM_TOCLIENT);
203 
204  UTHAppLayerParserStateGetIds(f->alparser, &ret[0], &ret[1], &ret[2], &ret[3]);
205  FAIL_IF_NOT(ret[0] == 9); // inspect_id[0]
206  FAIL_IF_NOT(ret[1] == 9); // inspect_id[1]
207  FAIL_IF_NOT(ret[2] == 9); // log_id
208  FAIL_IF_NOT(ret[3] == 9); // min_id
209 
211  StreamTcpFreeConfig(true);
212  UTHFreeFlow(f);
213 
214  PASS;
215 }
216 
217 static void SMBParserRegisterTests(void)
218 {
219  UtRegisterTest("SMBParserTxCleanupTest", SMBParserTxCleanupTest);
220 }
221 
222 #endif /* UNITTESTS */
FAIL_IF_NULL
#define FAIL_IF_NULL(expr)
Fail a test if expression evaluates to NULL.
Definition: util-unittest.h:89
RegisterSMBParsers
void RegisterSMBParsers(void)
Definition: app-layer-smb.c:45
stream-tcp.h
AppLayerParserTransactionsCleanup
void AppLayerParserTransactionsCleanup(Flow *f, const uint8_t pkt_dir)
remove obsolete (inspected and logged) transactions
Definition: app-layer-parser.c:919
UtRegisterTest
void UtRegisterTest(const char *name, int(*TestFn)(void))
Register unit test.
Definition: util-unittest.c:103
Flow_::proto
uint8_t proto
Definition: flow.h:372
STREAMING_BUFFER_CONFIG_INITIALIZER
#define STREAMING_BUFFER_CONFIG_INITIALIZER
Definition: util-streaming-buffer.h:74
Flow_
Flow data structure.
Definition: flow.h:350
AppLayerParserThreadCtxFree
void AppLayerParserThreadCtxFree(AppLayerParserThreadCtx *tctx)
Destroys the app layer parser thread context obtained using AppLayerParserThreadCtxAlloc().
Definition: app-layer-parser.c:312
rust.h
Flow_::protoctx
void * protoctx
Definition: flow.h:440
util-unittest.h
util-unittest-helper.h
FAIL_IF_NOT
#define FAIL_IF_NOT(expr)
Fail a test if expression evaluates to false.
Definition: util-unittest.h:82
Flow_::alparser
AppLayerParserState * alparser
Definition: flow.h:474
app-layer-detect-proto.h
StreamTcpInitConfig
void StreamTcpInitConfig(bool)
To initialize the stream global configuration data.
Definition: stream-tcp.c:359
UTHBuildFlow
Flow * UTHBuildFlow(int family, const char *src, const char *dst, Port sp, Port dp)
Definition: util-unittest-helper.c:501
PASS
#define PASS
Pass the test.
Definition: util-unittest.h:105
alp_tctx
AppLayerParserThreadCtx * alp_tctx
Definition: fuzz_applayerparserparse.c:22
app-layer-parser.h
AppLayerParserRegisterProtocolUnittests
void AppLayerParserRegisterProtocolUnittests(uint8_t ipproto, AppProto alproto, void(*RegisterUnittests)(void))
Definition: app-layer-parser.c:1908
UTHFreeFlow
void UTHFreeFlow(Flow *flow)
Definition: util-unittest-helper.c:506
AppLayerParserThreadCtxAlloc
AppLayerParserThreadCtx * AppLayerParserThreadCtxAlloc(void)
Gets a new app layer protocol's parser thread context.
Definition: app-layer-parser.c:291
StreamTcpFreeConfig
void StreamTcpFreeConfig(bool quiet)
Definition: stream-tcp.c:690
AppLayerParserParse
int AppLayerParserParse(ThreadVars *tv, AppLayerParserThreadCtx *alp_tctx, Flow *f, AppProto alproto, uint8_t flags, const uint8_t *input, uint32_t input_len)
Definition: app-layer-parser.c:1303
suricata-common.h
StreamingBufferConfig_
Definition: util-streaming-buffer.h:65
SuricataFileContext_
Definition: rust-context.h:69
UTHAppLayerParserStateGetIds
void UTHAppLayerParserStateGetIds(void *ptr, uint64_t *i1, uint64_t *i2, uint64_t *log, uint64_t *min)
Definition: app-layer-parser.c:215
app-layer-protos.h
suricata.h
app-layer-smb.h
ALPROTO_SMB
@ ALPROTO_SMB
Definition: app-layer-protos.h:37
AppLayerParserThreadCtx_
Definition: app-layer-parser.c:65
TcpSession_
Definition: stream-tcp-private.h:283
util-misc.h
Flow_::alproto
AppProto alproto
application level protocol
Definition: flow.h:449