-
Notifications
You must be signed in to change notification settings - Fork 15
/
sfksearch.cc
679 lines (576 loc) · 13.7 KB
/
sfksearch.cc
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
//--------------------------------------------------------------------------
// Copyright (C) 2001 Marc Norton
// Copyright (C) 2014-2024 Cisco and/or its affiliates. All rights reserved.
// Copyright (C) 2003-2013 Sourcefire, Inc.
//
// This program is free software; you can redistribute it and/or modify it
// under the terms of the GNU General Public License Version 2 as published
// by the Free Software Foundation. You may not use, modify or distribute
// this program under any other version of the GNU General Public License.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
// General Public License for more details.
//
// You should have received a copy of the GNU General Public License along
// with this program; if not, write to the Free Software Foundation, Inc.,
// 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
//--------------------------------------------------------------------------
/*
* ksearch.c
*
* Basic Keyword Search Trie - uses linked lists to build the finite automata
*
* Keyword-Match: Performs the equivalent of a multi-string strcmp()
* - use for token testing after parsing the language tokens using lex or the like.
*
* Keyword-Search: searches the input text for one of multiple keywords,
* and supports case sensitive and case insensitive patterns.
*/
#include "sfksearch.h"
#include <cassert>
#include "main/thread.h"
#include "utils/util.h"
static void KTrieFree(KTRIENODE* n);
static unsigned int mtot = 0;
unsigned int KTrieMemUsed()
{
return mtot;
}
void KTrieInitMemUsed()
{
mtot = 0;
}
/*
* Allocate Memory
*/
static void* KTRIE_MALLOC(int n)
{
assert(n > 0);
void* p = snort_calloc(n);
mtot += n;
return p;
}
/*
* Free Memory
*/
static void KTRIE_FREE(void* p)
{
if ( p )
snort_free(p);
}
/*
* Local/Tmp nocase array
*/
static THREAD_LOCAL uint8_t Tnocase[65*1024];
/*
** Case Translation Table
*/
static uint8_t xlatcase[256];
/*
*
*/
void KTrie_init_xlatcase()
{
for (int i=0; i<256; i++)
{
xlatcase[ i ] = (uint8_t)tolower(i);
}
}
/*
*
*/
static inline void ConvertCaseEx(uint8_t* d, const uint8_t* s, int m)
{
int i;
for ( i=0; i < m; i++ )
{
d[i] = xlatcase[ s[i] ];
}
}
/*
*
*/
KTRIE_STRUCT* KTrieNew(int method, const MpseAgent* agent)
{
KTRIE_STRUCT* ts = (KTRIE_STRUCT*)KTRIE_MALLOC(sizeof(*ts));
ts->memory = sizeof(*ts);
ts->nchars = 0;
ts->npats = 0;
ts->end_states = 0;
ts->method = method; /* - old method, 1 = queue */
ts->agent = agent;
return ts;
}
int KTriePatternCount(KTRIE_STRUCT* k)
{
return k->npats;
}
/*
* Deletes memory that was used in creating trie
* and nodes
*/
void KTrieDelete(KTRIE_STRUCT* k)
{
if ( !k )
return;
KTRIEPATTERN* p = k->patrn;
KTRIEPATTERN* pnext = nullptr;
while ( p )
{
pnext = p->next;
if (k->agent)
{
if (p->user)
k->agent->user_free(p->user);
if (p->rule_option_tree)
k->agent->tree_free(&p->rule_option_tree);
if (p->neg_list)
k->agent->list_free(&p->neg_list);
}
KTRIE_FREE(p->P);
KTRIE_FREE(p->Pcase);
KTRIE_FREE(p);
p = pnext;
}
for ( int i = 0; i < KTRIE_ROOT_NODES; i++ )
KTrieFree(k->root[i]);
KTRIE_FREE(k);
}
/*
* Recursively delete all nodes in trie
*/
static void KTrieFree(KTRIENODE* n)
{
if ( !n )
return;
KTrieFree(n->child);
KTrieFree(n->sibling);
KTRIE_FREE(n);
}
/*
*
*/
static KTRIEPATTERN* KTrieNewPattern(const uint8_t* P, unsigned n)
{
if (n < 1)
return nullptr;
KTRIEPATTERN* p = (KTRIEPATTERN*)KTRIE_MALLOC(sizeof(*p));
/* Save as a nocase string */
p->P = (uint8_t*)KTRIE_MALLOC(n);
ConvertCaseEx(p->P, P, n);
/* Save Case specific version */
p->Pcase = (uint8_t*)KTRIE_MALLOC(n);
memcpy(p->Pcase, P, n);
p->n = n;
p->next = nullptr;
return p;
}
/*
* Add Pattern info to the list of patterns
*/
int KTrieAddPattern(
KTRIE_STRUCT* ts, const uint8_t* P, unsigned n,
bool nocase, bool negative, void* user)
{
KTRIEPATTERN* pnew;
if ( !ts->patrn )
{
pnew = ts->patrn = KTrieNewPattern(P, n);
if ( !pnew )
return -1;
}
else
{
pnew = KTrieNewPattern(P, n);
if ( !pnew )
return -1;
pnew->next = ts->patrn; /* insert at head of list */
ts->patrn = pnew;
}
pnew->nocase = nocase;
pnew->negative = negative;
pnew->user = user;
pnew->mnext = nullptr;
ts->npats++;
ts->memory += sizeof(KTRIEPATTERN) + 2 * n; /* Case and nocase */
return 0;
}
/*
*
*/
static KTRIENODE* KTrieCreateNode(KTRIE_STRUCT* ts)
{
KTRIENODE* t = (KTRIENODE*)KTRIE_MALLOC(sizeof(*t));
ts->memory += sizeof(*t);
return t;
}
/*
* Insert a Pattern in the Trie
*/
static int KTrieInsert(KTRIE_STRUCT* ts, KTRIEPATTERN* px)
{
int type = 0;
int n = px->n;
uint8_t* P = px->P;
KTRIENODE* root;
/* Make sure we at least have a root character for the tree */
if ( !ts->root[*P] )
{
ts->root[*P] = root = KTrieCreateNode(ts);
if ( !root )
return -1;
root->edge = *P;
}
else
{
root = ts->root[*P];
}
/* Walk existing Patterns */
while ( n )
{
if ( root->edge == *P )
{
P++;
n--;
if ( n && root->child )
{
root=root->child;
}
else /* cannot continue */
{
type = 0; /* Expand the tree via the child */
break;
}
}
else
{
if ( root->sibling )
{
root=root->sibling;
}
else /* cannot continue */
{
type = 1; /* Expand the tree via the sibling */
break;
}
}
}
/*
* Add the next char of the Keyword, if any
*/
if ( n )
{
if ( type == 0 )
{
/*
* Start with a new child to finish this Keyword
*/
root->child= KTrieCreateNode(ts);
if ( !root->child )
return -1;
root=root->child;
root->edge = *P;
P++;
n--;
ts->nchars++;
}
else
{
/*
* Start a new sibling branch to finish this Keyword
*/
root->sibling= KTrieCreateNode(ts);
if ( !root->sibling )
return -1;
root=root->sibling;
root->edge = *P;
P++;
n--;
ts->nchars++;
}
}
/*
* Finish the keyword as child nodes
*/
while ( n )
{
root->child = KTrieCreateNode(ts);
if ( !root->child )
return -1;
root=root->child;
root->edge = *P;
P++;
n--;
ts->nchars++;
}
if ( root->pkeyword )
{
px->mnext = root->pkeyword; /* insert duplicates at front of list */
root->pkeyword = px;
ts->duplicates++;
}
else
{
root->pkeyword = px;
ts->end_states++;
}
return 0;
}
/*
*
*/
static void Build_Bad_Character_Shifts(KTRIE_STRUCT* kt)
{
KTRIEPATTERN* plist;
/* Calc the min pattern size */
kt->bcSize = 32000;
for ( plist=kt->patrn; plist; plist=plist->next )
{
if ( plist->n < kt->bcSize )
{
kt->bcSize = plist->n; /* smallest pattern size */
}
}
/*
* Initialize the Bad Character shift table.
*/
for ( int i = 0; i < KTRIE_ROOT_NODES; i++ )
{
kt->bcShift[i] = (unsigned short)kt->bcSize;
}
/*
* Finish the Bad character shift table
*/
for ( plist=kt->patrn; plist; plist=plist->next )
{
for ( int k=0; k<kt->bcSize; k++ )
{
int shift = kt->bcSize - 1 - k;
int cindex = plist->P[ k ];
if ( shift < kt->bcShift[ cindex ] )
{
kt->bcShift[ cindex ] = (unsigned short)shift;
}
}
}
}
static int KTrieBuildMatchStateNode(
snort::SnortConfig* sc, KTRIENODE* root, KTRIE_STRUCT* ts)
{
int cnt = 0;
KTRIEPATTERN* p;
if (!root)
return 0;
/* each and every prefix match at this root*/
if (root->pkeyword)
{
for (p = root->pkeyword; p; p = p->mnext)
{
if (p->user)
{
if (p->negative)
{
ts->agent->negate_list(p->user, &root->pkeyword->neg_list);
}
else
{
ts->agent->build_tree(sc, p->user, &root->pkeyword->rule_option_tree);
}
}
cnt++;
}
/* Last call to finalize the tree for this root */
ts->agent->build_tree(sc, nullptr, &root->pkeyword->rule_option_tree);
}
/* for child of this root */
if (root->child)
{
cnt += KTrieBuildMatchStateNode(sc, root->child, ts);
}
/* 1st sibling of this root -- other siblings will be processed from
* within the processing for root->sibling. */
if (root->sibling)
{
cnt += KTrieBuildMatchStateNode(sc, root->sibling, ts);
}
return cnt;
}
static int KTrieBuildMatchStateTrees(snort::SnortConfig* sc, KTRIE_STRUCT* ts)
{
int cnt = 0;
/* Find the states that have a MatchList */
for (int i = 0; i < KTRIE_ROOT_NODES; i++)
{
KTRIENODE* root = ts->root[i];
/* each and every prefix match at this root*/
if ( root and ts->agent )
{
cnt += KTrieBuildMatchStateNode(sc, root, ts);
}
}
return cnt;
}
/*
* Build the Keyword TRIE
*
*/
static inline int _KTrieCompile(KTRIE_STRUCT* ts)
{
KTRIEPATTERN* p;
/*
static int tmem=0; // unused
*/
/*
* Build the Keyword TRIE
*/
for ( p=ts->patrn; p; p=p->next )
{
if ( KTrieInsert(ts, p) )
return -1;
}
/*
* Build A Setwise Bad Character Shift Table
*/
Build_Bad_Character_Shifts(ts);
/*
tmem += ts->memory;
printf(" Compile stats: %d patterns, %d chars, %d duplicate patterns, %d bytes, %d total-bytes\n",ts->npats,ts->nchars,ts->duplicates,ts->memory,tmem);
*/
return 0;
}
int KTrieCompile(snort::SnortConfig* sc, KTRIE_STRUCT* ts)
{
int rval;
if ((rval = _KTrieCompile(ts)))
return rval;
if ( ts->agent )
KTrieBuildMatchStateTrees(sc, ts);
return 0;
}
void sfksearch_print_qinfo()
{
}
/*
* Search - Algorithm
*
* This routine will log any substring of T that matches a keyword,
* and processes all prefix matches. This is used for generic
* pattern searching with a set of keywords and a body of text.
*
*
*
* kt- Trie Structure
* T - nocase text
* Tc- case specific text
* n - text length
*
* returns:
* # pattern matches
*/
static inline int KTriePrefixMatch(
KTRIE_STRUCT* kt, const uint8_t* T, const uint8_t*, const uint8_t* bT, int n,
MpseMatch match, void* context)
{
KTRIENODE* root = kt->root[ *T ];
int nfound = 0;
KTRIEPATTERN* pk;
int index;
/* Check if any keywords start with this character */
if ( !root )
return 0;
while ( n )
{
if ( root->edge == *T )
{
T++;
n--;
pk = root->pkeyword;
if (pk)
{
index = (int)(T - bT);
nfound++;
if (match (pk->user, pk->rule_option_tree, index, context, pk->neg_list) > 0)
{
return nfound;
}
}
if ( n && root->child )
{
root = root->child;
}
else /* cannot continue -- match is over */
{
break;
}
}
else
{
if ( root->sibling )
{
root = root->sibling;
}
else /* cannot continue */
{
break;
}
}
}
return nfound;
}
/*
*
*/
static inline int KTrieSearchNoBC(
KTRIE_STRUCT* ks, const uint8_t* Tx, int n, MpseMatch match, void* context)
{
int nfound = 0;
const uint8_t* T, * bT;
ConvertCaseEx(Tnocase, Tx, n);
T = Tnocase;
bT = T;
for (; n>0; n--, T++, Tx++ )
{
nfound += KTriePrefixMatch(ks, T, Tx, bT, n, match, context);
}
return nfound;
}
/*
*
*/
static inline int KTrieSearchBC(
KTRIE_STRUCT* ks, const uint8_t* Tx, int n, MpseMatch match, void* context)
{
const uint8_t* Tend;
const uint8_t* T, * bT;
int nfound = 0;
short* bcShift = (short*)ks->bcShift;
int bcSize = ks->bcSize;
ConvertCaseEx(Tnocase, Tx, n);
T = Tnocase;
bT = T;
Tend = T + n - bcSize;
bcSize--;
for (; T <= Tend; n--, T++, Tx++ )
{
int tshift;
while ( (tshift = bcShift[ *( T + bcSize ) ]) > 0 )
{
T += tshift;
Tx += tshift;
if ( T > Tend )
return nfound;
}
nfound += KTriePrefixMatch(ks, T, Tx, bT, n, match, context);
}
return nfound;
}
int KTrieSearch(
KTRIE_STRUCT* ks, const uint8_t* T, int n, MpseMatch match, void* context)
{
if ( ks->bcSize < 3 )
return KTrieSearchNoBC(ks, T, n, match, context);
else
return KTrieSearchBC(ks, T, n, match, context);
}