summaryrefslogtreecommitdiff
path: root/src/analysis/scan/context.c
blob: 55311c4387cad2c63f2715e945eded1465fb10af (plain)
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
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719

/* Chrysalide - Outil d'analyse de fichiers binaires
 * context.c - suivi d'analyses via contextes
 *
 * Copyright (C) 2022 Cyrille Bagard
 *
 *  This file is part of Chrysalide.
 *
 *  Chrysalide is free software; you can redistribute it and/or modify
 *  it under the terms of the GNU General Public License as published by
 *  the Free Software Foundation; either version 3 of the License, or
 *  (at your option) any later version.
 *
 *  Chrysalide 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 Foobar.  If not, see <http://www.gnu.org/licenses/>.
 */


#include "context.h"


#include <assert.h>
#include <malloc.h>
#include <stdlib.h>
#include <string.h>


#include "context-int.h"
#include "exprs/literal.h"
#include "matches/area.h"
#include "matches/bytes.h"
#include "../../common/sort.h"



/* --------------------- MEMORISATION DE PROGRESSIONS D'ANALYSE --------------------- */


/* Initialise la classe des contextes de suivi d'analyses. */
static void g_scan_context_class_init(GScanContextClass *);

/* Initialise une instance de contexte de suivi d'analyse. */
static void g_scan_context_init(GScanContext *);

/* Supprime toutes les références externes. */
static void g_scan_context_dispose(GScanContext *);

/* Procède à la libération totale de la mémoire. */
static void g_scan_context_finalize(GScanContext *);



/* ---------------------------------------------------------------------------------- */
/*                       MEMORISATION DE PROGRESSIONS D'ANALYSE                       */
/* ---------------------------------------------------------------------------------- */


/* Indique le type défini pour un contexte de suivi d'analyse. */
G_DEFINE_TYPE(GScanContext, g_scan_context, G_TYPE_OBJECT);


/******************************************************************************
*                                                                             *
*  Paramètres  : klass = classe à initialiser.                                *
*                                                                             *
*  Description : Initialise la classe des contextes de suivi d'analyses.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_context_class_init(GScanContextClass *klass)
{
    GObjectClass *object;                   /* Autre version de la classe  */

    object = G_OBJECT_CLASS(klass);

    object->dispose = (GObjectFinalizeFunc/* ! */)g_scan_context_dispose;
    object->finalize = (GObjectFinalizeFunc)g_scan_context_finalize;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à initialiser.                            *
*                                                                             *
*  Description : Initialise une instance de contexte de suivi d'analyse.      *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_context_init(GScanContext *context)
{
    context->options = NULL;

    context->content = NULL;
    context->scan_done = false;

    context->match_storages = NULL;
    context->storages_count = 0;

    context->full_trackers = g_hash_table_new_full(NULL, NULL, g_object_unref, g_object_unref);

    context->global = true;

    context->conditions = NULL;
    context->cond_count = 0;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance d'objet GLib à traiter.                   *
*                                                                             *
*  Description : Supprime toutes les références externes.                     *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_context_dispose(GScanContext *context)
{
    size_t i;                               /* Boucle de parcours          */

    g_clear_object(&context->options);

    g_clear_object(&context->content);

    for (i = 0; i < context->storages_count; i++)
        g_clear_object(&context->match_storages[i]);

    if (context->full_trackers != NULL)
    {
        g_hash_table_destroy(context->full_trackers);
        context->full_trackers = NULL;
    }

    for (i = 0; i < context->cond_count; i++)
        g_clear_object(&context->conditions[i].expr);

    G_OBJECT_CLASS(g_scan_context_parent_class)->dispose(G_OBJECT(context));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance d'objet GLib à traiter.                   *
*                                                                             *
*  Description : Procède à la libération totale de la mémoire.                *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

static void g_scan_context_finalize(GScanContext *context)
{
    size_t i;                               /* Boucle de parcours          */

    if (context->match_storages != NULL)
        free(context->match_storages);

    if (context->conditions != NULL)
    {
        for (i = 0; i < context->cond_count; i++)
            free(context->conditions[i].name);

        free(context->conditions);

    }

    G_OBJECT_CLASS(g_scan_context_parent_class)->finalize(G_OBJECT(context));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : options = ensemble d'options d'analyses à respecter.         *
*                                                                             *
*  Description : Définit un contexte pour suivi d'analyse.                    *
*                                                                             *
*  Retour      : Fonction mise en place.                                      *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanContext *g_scan_context_new(GScanOptions *options)
{
    GScanContext *result;                   /* Structure à retourner       */

    result = g_object_new(G_TYPE_SCAN_CONTEXT, NULL);

    result->options = options;
    g_object_ref(G_OBJECT(options));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à consulter.                              *
*                                                                             *
*  Description : Fournit l'ensemble des options à respecter pour les analyses.*
*                                                                             *
*  Retour      : Ensemble d'options en vigueur.                               *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanOptions *g_scan_context_get_options(const GScanContext *context)
{
    GScanOptions *result;                   /* Ensemble à retourner        */

    result = context->options;

    g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context   = instance à consulter.                            *
*                content   = contenu binaire en cours d'analyse.              *
*                ids_count = nombre d'identifiants enregistrés.               *
*                                                                             *
*  Description : Définit le contenu principal à analyser.                     *
*                                                                             *
*  Retour      : Content binaire associé au context.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_context_set_content(GScanContext *context, GBinContent *content, size_t ids_count)
{
    size_t i;                               /* Boucle de parcours          */

    g_clear_object(&context->content);

    context->content = content;

    g_object_ref(G_OBJECT(content));

    context->match_storages = calloc(ids_count, sizeof(GUMemSlice *));
    context->storages_count = ids_count;

    for (i = 0; i < ids_count; i++)
        context->match_storages[i] = g_umem_slice_new(sizeof(match_area_t));

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à consulter.                              *
*                                                                             *
*  Description : Fournit une référence au contenu principal analysé.          *
*                                                                             *
*  Retour      : Content binaire associé au context.                          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GBinContent *g_scan_context_get_content(const GScanContext *context)
{
    GBinContent *result;                    /* Instance à retourner        */

    result = context->content;

    g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à consulter.                              *
*                                                                             *
*  Description : Indique si la phase d'analyse de contenu est terminée.       *
*                                                                             *
*  Retour      : true si la phase de scan est terminée, false sinon.          *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_context_is_scan_done(const GScanContext *context)
{
    bool result;                            /* Statut à retourner          */

    result = context->scan_done;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                                                                             *
*  Description : Note que la phase d'analyse de contenu est terminée.         *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_context_mark_scan_as_done(GScanContext *context)
{
    context->scan_done = true;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                count   = nombre d'allocateurs en place. [OUT]               *
*                                                                             *
*  Description : Fournit la liste des allocateurs mémorisant des emplacements.*
*                                                                             *
*  Retour      : Liste des allocateurs assurant un suivi des correspondances. *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GUMemSlice **g_scan_context_get_match_storages(GScanContext *context, size_t *count)
{
    GUMemSlice **result;                    /* Allocateur à renvoyer       */

    result = context->match_storages;

    *count = context->storages_count;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                id      = identifiant du motif trouvé.                       *
*                                                                             *
*  Description : Retourne tous les correspondances partielles notées.         *
*                                                                             *
*  Retour      : Liste interne des localisations conservées.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GUMemSlice *g_scan_context_get_atom_matches(const GScanContext *context, patid_t id)
{
    GUMemSlice *result;              /* Liste constituée à renvoyer */

    result = context->match_storages[id];

    g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                pattern = definition initiale d'un motif recherché.          *
*                matches = mémorisation de correspondances établies.          *
*                                                                             *
*  Description : Enregistre toutes les correspondances établies pour un motif.*
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_context_register_full_matches(GScanContext *context, GSearchPattern *pattern, GScanMatches *matches)
{
#ifndef NDEBUG
    GSearchPattern *matches_pattern;        /* Clef d'un suivi             */
#endif

    assert(!g_hash_table_contains(context->full_trackers, pattern));

#ifndef NDEBUG

    matches_pattern = g_scan_matches_get_source(matches);

    assert(matches_pattern == pattern);

    g_object_unref(G_OBJECT(matches_pattern));

#endif

    g_object_ref(G_OBJECT(pattern));
    g_object_ref(G_OBJECT(matches));

    g_hash_table_insert(context->full_trackers, pattern, matches);

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                pattern = motif dont des correspondances sont à retrouver.   *
*                                                                             *
*  Description : Fournit la liste de toutes les correspondances pour un motif.*
*                                                                             *
*  Retour      : Liste courante de correspondances établies.                  *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

GScanMatches *g_scan_context_get_full_matches(const GScanContext *context, const GSearchPattern *pattern)
{
    GScanMatches *result;                   /* Correspondance à renvoyer   */

    result = g_hash_table_lookup(context->full_trackers, pattern);

    if (result != NULL)
        g_object_ref(G_OBJECT(result));

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = instance à mettre à jour.                          *
*                pattern = motif dont des correspondances sont à retrouver.   *
*                                                                             *
*  Description : Dénombre les correspondances associées à un motif.           *
*                                                                             *
*  Retour      : Quantité de correspondances établies pour un motif entier.   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

size_t g_scan_context_count_full_matches(const GScanContext *context, const GSearchPattern *pattern)
{
    size_t result;                          /* Quantité à retourner        */
    GScanMatches *matches;                  /* Ensemble de Correspondances */

    matches = g_hash_table_lookup(context->full_trackers, pattern);

    if (matches != NULL)
        result = g_scan_bytes_matches_count(matches);
    else
        result = 0;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = mémoire de résultats d'analyse à compléter.        *
*                name    = désignation de la règle ciblée.                    *
*                expr    = expression de condition à réduire.                 *
*                                                                             *
*  Description : Intègre une condition de correspondance pour règle.          *
*                                                                             *
*  Retour      : Bilan final d'une intégration (false si nom déjà présent).   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_context_set_rule_condition(GScanContext *context, const char *name, GScanExpression *expr)
{
    bool result;                            /* Bilan à retourner           */
    size_t i;                               /* Boucle de parcours          */
    rule_condition_t *new;                  /* Nouvel élément à intégrer   */

    result = true;

    /* Recherche d'antécédent */

    for (i = 0; i < context->cond_count; i++)
        if (strcmp(name, context->conditions[i].name) == 0)
        {
            result = false;
            break;
        }

    /* Ajout d'un nouvel élément ? */

    if (result)
    {
        context->conditions = realloc(context->conditions, ++context->cond_count * sizeof(rule_condition_t));

        new = &context->conditions[context->cond_count - 1];

        new->name = strdup(name);
        new->name_hash = fnv_64a_hash(name);

        new->expr = expr;
        g_object_ref(G_OBJECT(expr));
        new->final_reduced = false;

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = mémoire de résultats d'analyse à consulter.        *
*                name    = désignation de la règle ciblée.                    *
*                                                                             *
*  Description : Indique si un nom donné correspond à une règle.              *
*                                                                             *
*  Retour      : Bilan de la présence d'une règle désignée.                   *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_context_has_rule_for_name(const GScanContext *context, const char *name)
{
    bool result;                            /* Bilan à retourner           */
    fnv64_t hash;                           /* Empreinte du nom à retrouver*/
    size_t i;                               /* Boucle de parcours          */
    const rule_condition_t *cond;           /* Condition connue du contexte*/

    result = false;

    hash = fnv_64a_hash(name);

    for (i = 0; i < context->cond_count; i++)
    {
        cond = context->conditions + i;

        if (cond->name_hash != hash)
            continue;

        if (strcmp(cond->name, name) == 0)
        {
            result = true;
            break;
        }

    }

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = mémoire de résultats d'analyse à consulter.        *
*                                                                             *
*  Description : Indique le bilan des règles globales.                        *
*                                                                             *
*  Retour      : Bilan global des analyses menées.                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_context_has_global_match(const GScanContext *context)
{
    bool result;                            /* Bilan global à retourner    */

    result = context->global;

    return result;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = mémoire de résultats d'analyse à actualiser.       *
*                global  = bilan global des analyses menées.                  *
*                                                                             *
*  Description : Définit le bilan des règles globales.                        *
*                                                                             *
*  Retour      : -                                                            *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

void g_scan_context_set_global_match(GScanContext *context, bool global)
{
    context->global = global;

}


/******************************************************************************
*                                                                             *
*  Paramètres  : context = mémoire de résultats d'analyse à consulter.        *
*                name    = désignation de la règle ciblée.                    *
*                                                                             *
*  Description : Indique si une correspondance globale a pu être établie.     *
*                                                                             *
*  Retour      : Bilan final d'une analyse (false par défaut).                *
*                                                                             *
*  Remarques   : -                                                            *
*                                                                             *
******************************************************************************/

bool g_scan_context_has_match_for_rule(GScanContext *context, const char *name)
{
    bool result;                            /* Bilan à retourner           */
    size_t i;                               /* Boucle de parcours          */
    rule_condition_t *cond;                 /* Condition à considérer      */
    GScanScope *scope;                      /* Définition de portées       */
    GScanExpression *new;                   /* Nouvelle expression réduite */
    ScanReductionState state;               /* Statut d'une réduction      */
    bool valid;                             /* Validité d'une récupération */

    result = false;

    if (!context->global)
        goto exit;

    /* Recherche de la règle visée */

    cond = NULL;

    for (i = 0; i < context->cond_count; i++)
        if (strcmp(name, context->conditions[i].name) == 0)
        {
            cond = &context->conditions[i];
            break;
        }

    if (cond == NULL)
        goto exit;

    /* Tentative de réduction finale */

    if (!cond->final_reduced)
    {
        scope = g_scan_scope_new(name);

        state = g_scan_expression_reduce(cond->expr, context, scope, &new);
        if (state == SRS_UNRESOLVABLE) goto exit_reduction;

        g_object_unref(G_OBJECT(cond->expr));
        cond->expr = new;

        valid = g_scan_expression_reduce_to_boolean(cond->expr, context, scope, &new);
        if (!valid || new == NULL) goto exit_reduction;

        g_object_unref(G_OBJECT(cond->expr));
        cond->expr = new;

        cond->final_reduced = true;

 exit_reduction:

        g_object_unref(G_OBJECT(scope));

    }

    /* Tentative de récupération d'un bilan final */

    if (cond->final_reduced)
    {
        valid = g_scan_literal_expression_get_boolean_value(G_SCAN_LITERAL_EXPRESSION(cond->expr), &result);

        if (!valid)
        {
            assert(!result);
            result = false;
        }

    }

 exit:

    return result;

}